Merge pull request #516 from Pylons/docs-add-api-csrfschema

Add CSRFSchema to API docs

Author: stevepiercy

deform/__init__.py

@@ -8,6 +8,7 @@
 from .field import Field  # API
 from .form import Button  # API
 from .form import Form  # API
+from .schema import CSRFSchema  # API
 from .schema import FileData  # API
 from .template import ZPTRendererFactory  # API
 from .template import default_renderer  # API

deform/field.py

@@ -269,7 +269,7 @@ def __init__(
         self.set_appstruct(appstruct)
 
     def found_first(self):
-        """ Set have_first_input of ancestors """
+        """Set have_first_input of ancestors"""
         self.have_first_input = True
         if self.parent is not None:
             self.parent.found_first()
@@ -281,7 +281,7 @@ def parent(self):
         return self._parent()
 
     def get_root(self):
-        """ Return the root field in the field hierarchy (the form field) """
+        """Return the root field in the field hierarchy (the form field)"""
         node = self
         while True:
             parent = node.parent
@@ -353,7 +353,7 @@ def translate(self, msgid):
         return msgid
 
     def __iter__(self):
-        """ Iterate over the children fields of this field. """
+        """Iterate over the children fields of this field."""
         return iter(self.children)
 
     def __getitem__(self, name):
@@ -626,7 +626,7 @@ def serialize(self, cstruct=_marker, **kw):
         return self.widget.serialize(**values)
 
     def deserialize(self, pstruct):
-        """ Deserialize the pstruct into a cstruct and return the cstruct."""
+        """Deserialize the pstruct into a cstruct and return the cstruct."""
         return self.widget.deserialize(self, pstruct)
 
     def render(self, appstruct=_marker, **kw):

deform/schema.py

@@ -141,25 +141,25 @@ class CSRFSchema(colander.Schema):
 
     .. code-block:: python
 
-    import colander
-    from deform.schema import CSRFSchema
+        import colander
+        from deform.schema import CSRFSchema
 
-    class MySchema(CSRFSchema):
-        my_field = colander.SchemaNode(colander.String())
+        class MySchema(CSRFSchema):
+            my_field = colander.SchemaNode(colander.String())
 
     And in your application code, *bind* the schema, passing the request as a
     keyword argument:
 
     .. code-block:: python
 
-    def view(request):
-      schema = MySchema().bind(request=request)
+        def view(request):
+          schema = MySchema().bind(request=request)
 
     When using Pyramid 1.7+, the CSRF token is validated by CSRF view deriver.
 
     More information
 
-    https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/sessions.html#checking-csrf-tokens-automatically  # noqa: E501
+    https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/security.html#checking-csrf-tokens-automatically
     """
 
     csrf_token = colander.SchemaNode(

docs/api.rst

@@ -29,6 +29,9 @@ Type-Related
 .. autoclass:: FileData
    :members:
 
+.. autoclass:: CSRFSchema
+   :members:
+
 See also the type- and schema-related documentation in :term:`Colander`.
 
 Exception-Related