Added patterns. Fixed some typos.

Author: shabda

source/misc.txt

@@ -97,8 +97,102 @@ If slugs do not make sense, instead use a CRC algorithm.::
             import zlib
             #Use permalink in real case
             return '/customer/%s/' % zlib.crc32(self.pk)
+            
+Prefer ModelForm to Form
+--------------------------
+ModelForm already know the correct UI widgets for your underlying Models. In
+most of the cases ModelForm would suffice instead of Forms.
+
+Some common scnarios
+
+Hiding some fields from ModelForm which are needed for a DB save.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Eg, you want too create a profile for the logged in user.::
+
+    #in Forms.py
+    class ProfileForm(forms.ModelForm):
+        class Meta:
+            model = Profile
+            exclude =['user',]
+            
+    #In Views:
+    form = ProfileForm(request.POST)
+    profile = form.save(commit = False)
+    profile.user = request.user
+    profile.save()
+
+Or::
+
+    #Todo test this
+    class ProfileForm(forms.ModelForm):
+        class Meta:
+            model = Profile
+            exclude =['user',]
+        def __init__(self, user, *args, **kwargs)
+            self.user = user
+            super(ProfileForm, self).__init__(*args, **kwargs)
+            
+        def save(*args, **kwargs):
+            self.instance.user = self.user
+            super(ProfileForm, self).save(*args, **kwargs)
+
+Saving multiple Objects in one form
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+As::
+
+    class ProfileForm(forms.ModelForm):
+        class Meta:
+            model = Profile
+            exclude =['user',]
+            
+    class UserForm(forms.ModelForm):
+        class Meta:
+            model = User
+            exclude =[...]
+            
+    #in views.py
+    userform = UserForm(request.POST)
+    profileform =  ProfileForm(request.POST)
+    if userform.is_valid() and profileform.is_valid():
+        #Only if both are valid together
+        user = userform.save()
+        profile = profileform.save(commit = False)
+        profile.user = user
+        profile.save()
+        
+    {# In templates #}
+    <form ...>
+    {{ userform }}
+    {{ profileform }}
+    <input type="submit" />
+    </form>
 
 
 
+    
+Forms should know how to save themselves.
+---------------------------------------------
+if your forms is a forms.ModelForm, it already knows how to save its data. If you
+write a forms.Form, it should have a `.save()`. This keeps things symmetrical with
+`ModelForms`, and allows you to do::
+
+    #in views.py
+    def view_func(request):
+        if request.method == 'POST':
+            form  = FormClass(request.POST)
+            if form.is_valid():
+                obj = form.save()
+                ...
+            ...
+
+Instead of::
+
+            if form.is_valid():
+                #handle the saving in DB inside of views.
+                
+The `.save()` should return a Model Object
+
 
 

source/models.txt

@@ -9,7 +9,8 @@ do not want to display any object on your site which is unapproved(is_approved =
 False in your Model).::
 
     class ModelClassApprovedOnlyManager(models.Manager):
-        self.get_query_set().filter(is_approved = True)
+        def get_query_set():
+            self.get_query_set().filter(is_approved = True)
 
     class ModelClass(models.Model):
         ...
@@ -154,6 +155,13 @@ One way to do so would be to override, `save` and `delete`.::
 Other option would be to attach listeners for `post_save` and `post_delete`.
 #TODO
 
+    
+Abstract custom queries in Manager methods.
+----------------------------------------------
+
+If you have some complex Sql query, not easily representable via Django ORM,
+you can write custom Sql. These should be abstracted as Manager methods.
+
 
 
 

source/workflow.txt

@@ -18,7 +18,7 @@ south is propbably more popular.
 
 Create various entries in your /etc/hosts mapped to localhost
 ------------------------------------------------------------------
-While development you probably want varius users logged in to the site
+While development you probably want various users logged in to the site
 simulataneously. For example, while developing, I have one user logged in the admin, one normal
 user using the site. If both try to access the site from localhost, one will be
 logged out when other logs in.