| blob | d7378ae5c940feac9309a41d98d00a2e3a965219 |
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
31 <html>
32 <head>
35 </script>
39 <title>The Django Form Validation Framework on Google App Engine - Google App Engine - Google Code</title>
41 (function(){function a(){this.t={};this.tick=function(c){this.t[c]=(new Date).getTime()};this.tick("start")}var b=new a;window.jstiming={Timer:a,load:b};if(window.external&&window.external.pageT)window.jstiming.pt=window.external.pageT;})();
46 //--></script>
50 <link rel="search" type="application/opensearchdescription+xml" title="Google Code" href="http://code.google.com/osd.xml">
52 <!--[if IE]><link rel="stylesheet" type="text/css" href="../../css/iehacks.css"><![endif]-->
58 </head>
65 <span>
67 <a id="lang-dropdown" class="dropdown" href="http://code.google.com" onclick="return false;"><img width="13" height="13" class="globeicon" src="../../images/globe2_small.png"
68 ><span style="text-decoration:underline">English</span> <span style="font-size:.75em;">▼</span></a>
70 </span>
71 </div>
81 </div>
87 <img src="../../images/code_logo.png" height="40" width="161" alt="Google Code" style="border:0;margin:3px 0 0 0;">
90 </a></div>
93 <form id="cse" action="http://www.google.com/cse" accept-charset="utf-8" class="gsc-search-box" onsubmit="executeGSearch(document.getElementById('gsearchInput').value); return false;">
94 <noscript>
96 </noscript>
98 <input id="gsearchInput" type="text" name="q" maxlength="2048" class="gsc-input" autocomplete="off" title="Google Code Search" style="width:345px">
100 <input title="Search" id="gsearchButton" class="gsc-search-button" name="sa" value="Search" type="submit">
102 </div>
103 </form>
122 </li>
126 </li>
129 <a href="../kb/index.html" title="Answers to frequently asked questions about Google App Engine">FAQ</a>
130 </li>
133 <a href="index.html" class="selected" title="Focused articles and tutorials for Google App Engine developers">Articles</a>
134 </li>
136 <li>
138 </li>
140 <li>
142 </li>
144 <li>
146 </li>
148 <li>
150 </li>
153 </ul>
160 <ul>
164 <li><a href="../business/index.html">App Engine for Business</a> <sup class="new">New!</sup></li>
165 </ul>
167 <ul>
169 <ul>
172 <ul>
178 <li><a href="../docs/java/gettingstarted/usingdatastore.html">Using the Datastore with JDO</a></li>
182 </ul>
183 </li>
185 <ul>
187 <li><a href="../docs/python/gettingstarted/devenvironment.html">The Development Environment</a></li>
189 <li><a href="../docs/python/gettingstarted/usingwebapp.html">Using the webapp Framework</a></li>
191 <li><a href="../docs/python/gettingstarted/handlingforms.html">Handling Forms With webapp</a></li>
197 </ul>
198 </li>
199 </ul>
200 </li>
201 </ul>
203 <ul>
205 <ul>
209 <ul>
213 <li><a href="../docs/java/datastore/creatinggettinganddeletingdata.html">Creating, Getting and Deleting Data</a></li>
219 <li><a href="../docs/java/javadoc/com/google/appengine/api/datastore/package-summary.html">Low-level API</a></li>
221 </ul>
222 </li>
224 <ul>
226 <ul>
229 <ul>
230 <li><a href="../docs/java/javadoc/com/google/appengine/api/blobstore/package-summary.html">API Reference</a></li>
231 </ul>
232 </li>
234 </ul>
235 </li>
237 <ul>
239 <li><a href="../docs/java/javadoc/com/google/appengine/api/images/package-summary.html">API Reference</a></li>
241 </ul>
242 </li>
244 <ul>
248 <li><a href="../docs/java/javadoc/com/google/appengine/api/mail/package-summary.html">Low-level API</a></li>
250 </ul>
251 </li>
253 <ul>
256 <li><a href="../docs/java/javadoc/com/google/appengine/api/memcache/package-summary.html">Low-level API</a></li>
258 </ul>
259 </li>
261 <ul>
265 <li><a href="../docs/java/javadoc/com/google/appengine/api/NamespaceManager.html">API Reference</a>
267 </ul>
268 </li>
270 <ul>
272 <li><a href="../docs/java/javadoc/com/google/appengine/api/oauth/package-summary.html">API Reference</a></li>
275 </ul>
276 </li>
278 <ul>
280 <li><a href="../docs/java/javadoc/com/google/appengine/api/labs/taskqueue/package-summary.html">API Reference</a></li>
282 </ul>
283 </li>
285 <ul>
288 <li><a href="../docs/java/javadoc/com/google/appengine/api/urlfetch/package-summary.html">Low-level API</a></li>
290 </ul>
291 </li>
293 <ul>
295 <li><a href="../docs/java/javadoc/com/google/appengine/api/users/package-summary.html">API Reference</a></li>
297 </ul>
298 </li>
300 <ul>
302 <li><a href="../docs/java/javadoc/com/google/appengine/api/xmpp/package-summary.html">API Reference</a></li>
304 </ul>
305 </li>
306 </ul>
307 </li>
311 <ul>
319 </ul>
320 </li>
322 <ul>
329 </ul>
330 </li>
332 <ul>
338 <ul>
340 </ul>
341 </li>
344 </ul>
345 </li>
347 <ul>
348 <li><a href="../docs/java/howto/maintenance.html">Handling Scheduled Maintenance Periods</a></li>
350 </ul>
351 </li>
353 </ul>
354 </li>
355 </ul>
357 <ul>
359 <ul>
363 <ul>
366 <li><a href="../docs/python/datastore/creatinggettinganddeletingdata.html">Creating, Getting and Deleting Data</a></li>
370 <li><a href="../docs/python/datastore/typesandpropertyclasses.html">Types and Property Classes</a></li>
375 <ul>
385 </ul>
386 </li>
388 </ul>
389 </li>
391 <ul>
393 <ul>
396 <ul>
402 </ul>
403 </li>
405 </ul>
406 </li>
408 <ul>
413 <ul>
417 </ul>
418 </li>
420 </ul>
421 </li>
423 <ul>
429 <ul>
434 </ul>
435 </li>
437 </ul>
438 </li>
440 <ul>
444 <ul>
447 </ul>
448 </li>
450 </ul>
451 </li>
453 <ul>
455 <li><a href="../docs/python/multitenancy/multitenancy.html">Multitenancy with Namespaces</a></li>
457 <li>Reference
458 <ul>
461 </ul>
462 </li>
464 </ul>
465 </li>
467 <ul>
470 <ul>
473 </ul>
474 </li>
476 </ul>
477 </li>
479 <ul>
482 <ul>
487 </ul>
488 </li>
490 </ul>
491 </li>
493 <ul>
496 <ul>
501 </ul>
502 </li>
504 </ul>
505 </li>
507 <ul>
514 <ul>
518 </ul>
519 </li>
521 </ul>
522 </li>
524 <ul>
527 <ul>
531 </ul>
532 </li>
534 </ul>
535 </li>
536 </ul>
537 </li>
539 <ul>
546 </ul>
547 </li>
549 <ul>
554 <ul>
559 <li><a href="../docs/python/tools/webapp/buildingtheresponse.html">Building the Response</a></li>
560 <li><a href="../docs/python/tools/webapp/redirects.html">Redirects, Headers and Status Codes</a></li>
564 <ul>
571 </ul>
572 </li>
574 </ul>
575 </li>
579 </ul>
580 </li>
582 <ul>
584 <li><a href="../docs/python/howto/maintenance.html">Handling Scheduled Maintenance Periods</a></li>
586 </ul>
587 </li>
589 </ul>
590 </li>
591 </ul>
593 <ul>
595 <ul>
600 </ul>
601 </li>
602 </ul>
604 <ul>
606 <ul>
614 <li>Launcher Code
615 <ul>
618 </ul>
619 </li>
621 </ul>
622 </li>
623 </ul>
625 <ul>
627 <li><a href="http://code.google.com/p/googleappengine/wiki/SdkReleaseNotes">Release Notes: Python</a></li>
628 <li><a href="http://code.google.com/p/googleappengine/wiki/SdkForJavaReleaseNotes">Release Notes: Java</a></li>
630 </ul>
633 </div>
648 <p>In this article we show how to use Django's form validation framework with the Google App Engine. This framework allows you to construct HTML forms from your data models, and handle the inputted information from the forms seamlessly when interacting with the datastore.</p>
651 <p>
652 Django's form validation framework is included with the Django project. It uses a database model to construct well formed HTML forms for your application. It also handles the server-side functionality to validate the entry and put the data entered in to your datastore. With the Django forms framework, you can easily turn your data model into a set of pages that can be used to insert and update data in a datastore. Once the data is in the datastore, you can use GQL queries to access this data.</p>
655 <p>The Google App Engine <a href="../docs/python/datastore/modelclass.html">model class</a>, <code>db.Model</code>, is not the same as the model class used by Django. As a result, you cannot directly use the Django forms framework with Google App Engine. However, Google App Engine includes a module, db.djangoforms, which casts between the datastore models used with Google App Engine and the Django models specification. In most cases, you can use db.djangoforms.ModelForm in the same manner as the Django framework.</p>
658 <p>We are going to develop a simple application uses Django forms which creates pages that allow you to add and edit items on a shopping list, then stores the information in our datastore. Finally we will use <a href="../docs/python/datastore/gqlreference.html">GQL</a> to query the data and display it in our application.</p>
659 <p>First, we specify the Python module imports and Google App Engine imports for our application. <b>Please note that you must import <code>google.appengine.webapp.template</code> before importing any Django modules:</b></p>
662 from google.appengine.api import users
663 from google.appengine.ext import db
664 from google.appengine.ext import webapp
665 from google.appengine.ext.webapp import template
666 from google.appengine.ext.webapp.util import run_wsgi_app
668 from google.appengine.ext.db import djangoforms
669 </pre>
672 <p>Next, we define our model for a shopping list entry as a subclass of the Google App Engine <code>db.Model</code> class. For each object, we note the name of the item, how many we want, what price we want to pay, the date we made the entry, and by whom it was made:</p>
674 name = db.StringProperty()
675 quantity = db.IntegerProperty(default=1)
676 target_price = db.FloatProperty()
677 priority = db.StringProperty(default='Medium',choices=[
678 'High', 'Medium', 'Low'])
679 entry_time = db.DateTimeProperty(auto_now_add=True)
680 added_by = db.UserProperty()
681 </pre>
682 <p>Next, we create the form object based on the model. To do this, we create a class that inherits from <code>djangofroms.ModelForm</code>, and create a subclass of that class called <code>Meta</code> in which we specify the model and any excluded fields that we do not need in our form. In this case, since we will utilize the Users API to get the person who added the item to the shopping list, we will not need to include the added_by field on our form:</p>
684 class Meta:
685 model = Item
686 exclude = ['added_by']
687 </pre>
688 <p>We also don't need to have the user specify the entrytime. However, DateTime fields with auto_now or auto_now_add set to true are automatically not displayed when a form is generated. Therefore, we do not need to include the entry_time field in the list for exclusions.</p>
692 <p>Now, let us create the request handlers for our shopping list. The form will be accessed at the root URL via HTTP GET, and the user will submit it to our application via an HTTP POST to the same URL.</p>
693 <p>One of the advantages of Django forms is the automatic form validation. If the user submitted data is invalid, it will produce an error and automatically display form messaging that will ask the user to fix their input errors.</p>
696 def get(self):
701 # This generates our shopping list form and writes it in the response
702 self.response.out.write(ItemForm())
706 </pre>
707 <p>The form will pre-populate the entries with default values where they are provided, and will otherwise leave blanks. Additionally, if a fixed list of choices are provided, a drop-down menu will be created.</p>
710 data = ItemForm(data=self.request.POST)
711 if data.is_valid():
712 # Save the data, and redirect to the view page
713 entity = data.save(commit=False)
714 entity.added_by = users.get_current_user()
715 entity.put()
716 self.redirect('/items.html')
717 else:
718 # Reprint the form
723 self.response.out.write(data)
727 </pre>
728 <p>We use <code>data.is_valid()</code> to check that there are no errors in the user input. If errors are found, the form is reprinted with the user entered information and appropriate error messages.</p>
729 <p>If the form input is valid, data.save will generate the datastore entity. Since we wish to add the user information to the entity, we specify <code>commit=False</code>. Without this flag, calling save() would save the entity directly to the datastore. We include the current user information, and then call the <code>put()</code> method to save the data to our datastore.</p>
731 <p class="note">Default values are very effective ways to initialize entities in your datastore. However, we cannot use this to initialize the current user with <code>users.get_current_user()</code>, because the value is cached between requests. The <a href="../docs/python/datastore/propertyclass.html">Property</a> page has more information.</p>
734 <p>After we have added items to our shopping list, we want to display them to the user when he requests the URL <code>/items.html</code>. We create another request handler for this page that queries the datastore using the GQL query language.</p>
736 def get(self):
737 query = db.GqlQuery("SELECT * FROM Item ORDER BY name")
738 for item in query:
739 self.response.out.write("%s - Need to buy %d, cost $%0.2f each<br>" %
740 (item.name, item.quantity, item.target_price))
741 </pre>
744 <p>After writing all our handler classes, we need to define the <code>main()</code> function for this program to handle the CGI requests:</p>
746 application = webapp.WSGIApplication(
747 [('/', MainPage),
748 ('/items.html', ItemPage),
749 ],
750 debug=True)
751 run_wsgi_app(application)
753 if __name__=="__main__":
754 main()
755 </pre>
756 <p>This main function directs each request to the appropriate handler class based on the URL request.</p>
759 <p>With Google App Engine, the <a href="../docs/python/config/appconfig.html">app.yaml</a> file contains the specification as to which script will handle an incoming request. Our application only has one script, form.py, so all requests will be handled by that script:</p>
761 version: 1
762 runtime: python
763 api_version: 1
765 handlers:
766 - url: .*
767 script: form.py
768 </pre>
771 <p>We can extend the above example by allowing the users of our shopping list to edit an existing shopping list entry.</p>
773 <p>First, when handling the item page request, we'll add a link next to each item that they can click on to edit the entry. The link will request the <code>/edit</code> URL, and include the item id as a query argument.</p>
775 def get(self):
776 query = db.GqlQuery("SELECT * FROM Item ORDER BY name")
777 for item in query:
779 item.key().id())
780 self.response.out.write("%s - Need to buy %d, cost $%0.2f each<br>" %
781 (item.name, item.quantity, item.target_price))
782 </pre>
785 <p>Now we must add the <code>EditPage</code> class to handle the edit request. This handler is similar to handlers used to add an item.</p>
786 <p>In the <code>get()</code> method, for our EditPage class, we first retrieve the instance we are editing from the datastore, and then pass that instance to form renderer so that the item information can be populated. Also, we add the item id as a hidden input to the form so that we can access the id information when the user submits the edited item:</p>
788 def get(self):
789 <b> id = int(self.request.get('id'))
790 item = Item.get(db.Key.from_path('Item', id))</b>
795 self.response.out.write(ItemForm(instance=item))
800 </pre>
801 <p>Next we write the method to handle the HTTP POST. We query our datastore for the item we are editing, and then validate the edited information using the validation framework available with Django forms. As before, if the information is valid, we put the change in the datastore, or else we allow the user to modify their input:</p>
803 <b> id = int(self.request.get('_id'))
804 item = Item.get(db.Key.from_path('Item', id))</b>
805 data = ItemForm(data=self.request.POST, instance=item)
806 if data.is_valid():
807 # Save the data, and redirect to the view page
808 entity = data.save(commit=False)
809 entity.added_by = users.get_current_user()
810 entity.put()
811 self.redirect('/items.html')
812 else:
813 # Reprint the form
818 self.response.out.write(data)
823 </pre>
828 application = webapp.WSGIApplication(
829 [('/', MainPage),
831 ('/items.html', ItemPage),
832 ],
833 debug=True)
835 run_wsgi_app(application)
836 </pre>
839 <p>Django's form validating framework does strict validation against data types. However, it does not provide Javascript validation on the client side of input. As a result, some data types, such as dates and lists, may be more difficult to use with Django forms, because users must enter the data in the specific format required.</p>
842 </div>
843 </div>
857 Except as otherwise <a
864 <!-- <rdf:RDF xmlns="http://web.resource.org/cc/"
865 xmlns:dc="http://purl.org/dc/elements/1.1/"
866 xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
867 <Work rdf:about="">
868 <license rdf:resource="http://creativecommons.org/licenses/by/3.0/" />
869 </Work>
870 <License rdf:about="http://creativecommons.org/licenses/by/3.0/">
871 <permits rdf:resource="http://web.resource.org/cc/Reproduction"/>
872 <permits rdf:resource="http://web.resource.org/cc/Distribution"/>
873 <requires rdf:resource="http://web.resource.org/cc/Notice"/>
874 <requires rdf:resource="http://web.resource.org/cc/Attribution"/>
875 <permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/>
876 </License>
877 </rdf:RDF> -->
878 </div>
879 Java is a registered trademark of Sun Microsystems, Inc.</div>
886 <br> <br>
887 Google Code offered in:
896 </div>
918 );
927 })();
928 </script>
933 </body>
934 </html>