Proper way to handle multiple forms on one page in Django

Question

I have a template page expecting two forms   If I just use one form  things are fine as in this typical example   if request method     POST       form   AuthorForm request POST       if form is valid            form save             do something  else      form   AuthorForm     If I want to work with multiple forms however  how do I let the view know that I m submitting only one of the forms and not the other  i e  it s still request POST but I only want to process the form for which the submit happened      This is the solution based on the answer where expectedphrase and bannedphrase are the names of the submit buttons for the different forms and expectedphraseform and bannedphraseform are the forms   if request method     POST       if  bannedphrase  in request POST          bannedphraseform   BannedPhraseForm request POST  prefix  banned           if bannedphraseform is valid                bannedphraseform save           expectedphraseform   ExpectedPhraseForm prefix  expected       elif  expectedphrase  in request POST          expectedphraseform   ExpectedPhraseForm request POST  prefix  expected           if expectedphraseform is valid                expectedphraseform save            bannedphraseform   BannedPhraseForm prefix  banned   else      bannedphraseform   BannedPhraseForm prefix  banned       expectedphraseform   ExpectedPhraseForm prefix  expected

User · Accepted Answer

You have a few options    Put different URLs in the action for the two forms   Then you ll have two different view functions to deal with the two different forms  Read the submit button values from the POST data   You can tell which submit button was clicked  How can I build multiple submit buttons django form

User · Answer

Here is simple way to handle the above   In Html Template we put Post   lt form action   useradd addnewroute   method  post  id  login-form  gt    csrf token      lt  -- add details of form here-- gt   lt form gt   lt form action   useradd addarea   method  post  id  login-form  gt    csrf token      lt  -- add details of form here-- gt    lt form gt    In View      def addnewroute request         if request method     POST              do something      def addarea request         if request method     POST              do something   In URL Give needed info like   urlpatterns   patterns     url r  addnewroute     views addnewroute  name  addnewroute    url r  addarea    include  usermodules urls

User · Answer

I needed multiple forms that are independently validated on the same page  The key concepts I was missing were 1  using the form prefix for the submit button name and 2  an unbounded form does not trigger validation  If it helps anyone else  here is my simplified example of two forms AForm and BForm using TemplateView based on the answers by  adam-nelson and  daniel-sokolowski and comment by  zeraien  https   stackoverflow com a 17303480 2680349      views py def  get form request  formcls  prefix       data   request POST if prefix in request POST else None     return formcls data  prefix prefix   class MyView TemplateView       template name    mytemplate html       def get self  request   args    kwargs           return self render to response   aform   AForm prefix  aform pre     bform   BForm prefix  bform pre          def post self  request   args    kwargs           aform    get form request  AForm   aform pre           bform    get form request  BForm   bform pre           if aform is bound and aform is valid                  Process aform and render response         elif bform is bound and bform is valid                  Process bform and render response         return self render to response   aform   aform   bform   bform      mytemplate html  lt form action    method  post  gt         csrf token           aform as p         lt input type  submit  name    aform prefix    value  Submit    gt         bform as p         lt input type  submit  name    bform prefix    value  Submit    gt   lt  form gt

User · Answer

Wanted to share my solution where Django Forms are not being used  I have multiple form elements on a single page and I want to use a single view to manage all the POST requests from all the forms    What I ve done is I have introduced an invisible input tag so that I can pass a parameter to the views to check which form has been submitted    lt form method  post  id  formOne  gt         csrf token        lt input type  hidden  name  form type  value  formOne  gt              lt  form gt           lt form method  post  id  formTwo  gt         csrf token         lt input type  hidden  name  form type  value  formTwo  gt           lt  form gt    views py  def handlemultipleforms request  template  handle multiple forms html                Handle Multiple  lt form gt  lt  form gt  elements             if request method     POST           if request POST get  form type       formOne                Handle Elements from first Form         elif request POST get  form type       formTwo                Handle Elements from second Form

User · Answer

Based on this answer by  ybendana  Again  we use is bound to check if the form is capable of validation  See this section of the documentation   Bound and unbound forms A Form instance is either bound to a set of data  or unbound   If it   s bound to a set of data  it   s capable of validating that data and rendering the form as HTML with the data displayed in the HTML  If it   s unbound  it cannot do validation  because there   s no data to validate    but it can still render the blank form as HTML    We use a list of tuples for form objects and their details allowing for more extensibility and less repetition  However  instead of overriding get    we override get context data   to make inserting a new  blank instance of the form  with prefix  into the response the default action for any request  In the context of a POST request  we override the post   method to   Use the prefix to check if each form has been submitted Validate the forms that have been submitted Process the valid forms using the cleaned data Return any invalid forms to the response by overwriting the context data    views py  class MultipleForms TemplateResponseMixin  ContextMixin  View        form list        context key  formcls  prefix            quot form a quot   FormA   quot prefix a quot              quot form b quot   FormB   quot prefix b quot              quot form c quot   FormC   quot prefix c quot                          quot form x quot   FormX   quot prefix x quot               def get context data self    kwargs           context   super   get context data   kwargs            Add blank forms to context with prefixes         for context key  formcls  prefix in self form list              context context key    formcls prefix prefix          return context      def post self  request   args    kwargs             Get object and context         self object   self get object           context   self get context data object self object            Process forms         for context key  formcls  prefix in self form list              if prefix in request POST                    Get the form object with prefix and pass it the POST data to                     validate and clean etc                  form   formcls request POST  prefix prefix                  if form is bound                        If the form is bound  i e  it is capable of validation                           check the validation                     if form is valid                              call the form s save   method or do whatever you                                 want with form cleaned data                         form save                       else                            overwrite context data for this form so that it is                               returned to the page with validation errors                         context context key    form           Pass context back to render to response   including any invalid forms         return self render to response context            This method allows repeated form entries on the same page  something I found did not work with  ybendana s answer  I believe it wouldn t be masses more work to fold this method into a Mixin class  taking the form list object as an attribute and hooking get context data   and post   as above  Edit  This already exists  See this repository  NB  This method required TemplateResponseMixin for render to response   and ContextMixin for get context data   to work  Either use these Mixins or a CBV that descends from them

User · Answer

This is a bit late  but this is the best solution I found  You make a look-up dictionary for the form name and its class  you also have to add an attribute to identify the form  and in your views you have to add it as a hidden field  with the form formlabel     form holder form holder          majeur              class   FormClass1              majsoft              class   FormClass2              tiers1              class   FormClass3              tiers2              class   FormClass4              tiers3              class   FormClass5              tiers4              class   FormClass6            for key in form holder keys          If the key is the same as the formlabel  we should use the posted data     if request POST get  formlabel   None     key            Get the form and initate it with the sent data         form   form holder get key  get  class                data request POST                      Validate the form         if form is valid                  Correct data entries             messages info request    u Configuration valid  e                  if form save                      Save succeeded                 messages success                      request                        u Donn  es enregistr  es avec succ  s                                  else                    Save failed                 messages warning                      request                        u Un probl  me est survenu pendant l enregistrement                         u des donn  es  merci de r  essayer plus tard                              else                Form is not valid  show feedback to the user             messages error                  request                    u Merci de corriger les erreurs suivantes                      else            Just initiate the form without data         form   form holder get key  get  class   key           Add the attribute for the name     setattr form   formlabel   key         Append it to the tempalte variable that will hold all the forms     forms append form    I hope this will help in the future

User · Answer

view   class AddProductView generic TemplateView   template name    manager add product html       def get self  request   args    kwargs       form   ProductForm self request GET or None  prefix  sch       sub form   ImageForm self request GET or None  prefix  loc       context   super AddProductView  self  get context data   kwargs      context  form     form     context  sub form     sub form     return self render to response context   def post self  request   args    kwargs       form   ProductForm request POST   prefix  sch       sub form   ImageForm request POST  prefix  loc             template      block container     lt div class  container  gt       lt br  gt       lt form action     url  manager add product      method  post  gt             csrf token               form as p               sub form as p             lt p gt               lt button type  submit  gt Submit lt  button gt           lt  p gt       lt  form gt   lt  div gt     endblock

User · Answer

If you are using approach with class-based views and different  action  attrs i mean      Put different URLs in the action for the two forms  Then you ll have two different view functions to deal with the two different forms    You can easily handle errors from different forms using overloaded get context data method  e x    views py   class LoginView FormView       form class   AuthFormEdited     success url           template name    main index html       def dispatch self  request   args    kwargs           return super LoginView  self  dispatch request   args    kwargs                 def get context data self    kwargs           context   super LoginView  self  get context data   kwargs          context  login view in action     True         return context  class SignInView FormView       form class   SignInForm     success url           template name    main index html       def dispatch self  request   args    kwargs           return super SignInView  self  dispatch request   args    kwargs                  def get context data self    kwargs           context   super SignInView  self  get context data   kwargs          context  login view in action     False         return context   template    lt div class  login-form  gt   lt form action   login   method  post  role  form  gt         csrf token           if login view in action               for e in form non field errors                 lt div class  alert alert-danger alert-dismissable  gt                     e                     lt a class  panel-close close  data-dismiss  alert  gt    lt  a gt               lt  div gt             endfor           endif                   lt  form gt   lt  div gt    lt div class  signin-form  gt   lt form action   registration   method  post  role  form  gt         csrf token           if not login view in action               for e in form non field errors                 lt div class  alert alert-danger alert-dismissable  gt                     e                     lt a class  panel-close close  data-dismiss  alert  gt    lt  a gt               lt  div gt             endfor           endif               lt  form gt   lt  div gt

User · Answer

A method for future reference is something like this   bannedphraseform is the first form and expectedphraseform is the second   If the first one is hit  the second one is skipped  which is a reasonable assumption in this case    if request method     POST       bannedphraseform   BannedPhraseForm request POST  prefix  banned       if bannedphraseform is valid            bannedphraseform save   else      bannedphraseform   BannedPhraseForm prefix  banned    if request method     POST  and not bannedphraseform is valid        expectedphraseform   ExpectedPhraseForm request POST  prefix  expected       bannedphraseform   BannedPhraseForm prefix  banned       if expectedphraseform is valid            expectedphraseform save    else      expectedphraseform   ExpectedPhraseForm prefix  expected

User · Answer

Django s class based views provide a generic FormView but for all intents and purposes it is designed to only handle one form    One way to handle multiple forms with same target action url using Django s generic views is to extend the  TemplateView  as shown below  I use this approach often enough that I have made it into an Eclipse IDE template   class NegotiationGroupMultifacetedView TemplateView           TemplateResponseMixin     template name    offers offer detail html           ContextMixin      def get context data self    kwargs               Adds extra content to our template             context   super NegotiationGroupDetailView  self  get context data   kwargs                        context  negotiation bid form     NegotiationBidForm              prefix  NegotiationBidForm                                  Multiple  submit  button paths should be handled in form s  save   clean               data   self request POST if bool set   NegotiationBidForm-submit-counter-bid                                                  NegotiationBidForm-submit-approve-bid                                                  NegotiationBidForm-submit-decline-further-bids    intersection                                                      self request POST   else None                        context  offer attachment form     NegotiationAttachmentForm              prefix  NegotiationAttachment                                data   self request POST if  NegotiationAttachment-submit  in self request POST else None              files   self request FILES if  NegotiationAttachment-submit  in self request POST else None                       context  offer contact form     NegotiationContactForm           return context          NegotiationGroupDetailView      def post self  request   args    kwargs           context   self get context data   kwargs           if context  negotiation bid form   is valid                instance   context  negotiation bid form   save               messages success request   Your offer bid   0  has been submitted   format instance pk           elif context  offer attachment form   is valid                instance   context  offer attachment form   save               messages success request   Your offer attachment   0  has been submitted   format instance pk                     advise of any errors          else              messages error  Error s  encountered during form processing  please review below and re-submit            return self render to response context    The html template is to the following effect         lt form id  offer negotiation form  class  content-form  action      enctype  multipart form-data  method  post  accept-charset  utf-8  gt         csrf token           negotiation bid form as p                 lt input type  submit  name     negotiation bid form prefix   -submit-counter-bid       title  Submit a counter bid      value  Counter Bid    gt   lt  form gt         lt form id  offer-attachment-form  class  content-form  action      enctype  multipart form-data  method  post  accept-charset  utf-8  gt         csrf token           offer attachment form as p          lt input name     offer attachment form prefix   -submit  type  submit  value  Submit    gt   lt  form gt

User · Answer

if request method     POST       expectedphraseform   ExpectedphraseForm request POST      bannedphraseform   BannedphraseForm request POST      if expectedphraseform is valid            expectedphraseform save           return HttpResponse  quot Success quot       if bannedphraseform is valid            bannedphraseform save           return HttpResponse  quot Success quot   else      bannedphraseform   BannedphraseForm       expectedphraseform   ExpectedphraseForm   return render request   some html    bannedphraseform  bannedphraseform   expectedphraseform  expectedphraseform    This worked for me accurately as I wanted  This Approach has a single problem that it validates both the form s errors  But works Totally fine

[python] Proper way to handle multiple forms on one page in Django

Examples related to python

Examples related to django

Examples related to forms