docs.

plq · plq · commit d36af71ef8a1 · 2012-08-28T05:18:33.000+03:00
diff --git a/doc/source/reference/auxproc.rst b/doc/source/reference/auxproc.rst
@@ -4,6 +4,8 @@
 Auxiliary Processors
 ====================
 
+.. automodule:: spyne.auxproc
+
 AuxProcBase
 -----------
 
diff --git a/doc/source/reference/interface.rst b/doc/source/reference/interface.rst
@@ -5,12 +5,19 @@ Interfaces
 The `spyne.interface` package contains the implementations of various schema
 definition standards.
 
-Interface Base Class
+Interface Class
 --------------------
 
-.. automodule:: spyne.interface._base
+.. autoclass:: spyne.interface.Interface
     :members:
-    :inherited-members:
+    :show-inheritance:
+
+Interface Document Base Class
+-----------------------------
+
+.. autoclass:: spyne.interface.InterfaceDocumentBase
+    :members:
+    :show-inheritance:
 
 XML Schema
 ----------
diff --git a/doc/source/reference/protocol/http.rst b/doc/source/reference/protocol/http.rst
@@ -7,3 +7,4 @@ Http
 .. automodule:: spyne.protocol.http
     :members:
     :show-inheritance:
+    :undoc-members:
diff --git a/doc/source/reference/protocol/soap.rst b/doc/source/reference/protocol/soap.rst
@@ -7,3 +7,5 @@ Soap 1.1
 .. automodule:: spyne.protocol.soap.soap11
     :members:
     :show-inheritance:
+    :undoc-members:
+
diff --git a/spyne/interface/_base.py b/spyne/interface/_base.py
@@ -17,10 +17,6 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 #
 
-
-"""This module contains the Interface and InterfaceDocumentBase class and its
-helper objects."""
-
 import logging
 logger = logging.getLogger(__name__)
 
@@ -38,7 +34,11 @@
 
 
 class Interface(object):
-    """The base class for all interface document generators."""
+    """The ``Interface`` class holds all information needed to build an
+    interface document.
+
+    :param app: A :class:`spyne.application.Application` instance.
+    """
 
     def __init__(self, app=None, import_base_namespaces=False):
         self.__ns_counter = 0
diff --git a/spyne/interface/wsdl/wsdl11.py b/spyne/interface/wsdl/wsdl11.py
@@ -124,14 +124,16 @@ def _add_callbacks(service, root, types, service_name, url):
     return cb_port_type
 
 class Wsdl11(XmlSchema):
-    """The implementation of the Wsdl 1.1 interface definition document standard.
+    """The implementation of the Wsdl 1.1 interface definition document
+    standard which is avaible here: http://www.w3.org/TR/wsdl
 
     :param app: The parent application.
-    :param import_base_namespaces: Include imports for base namespaces like
-        xsd, xsi, wsdl, etc.
     :param _with_partnerlink: Include the partnerLink tag in the wsdl.
     """
 
+    #:param import_base_namespaces: Include imports for base namespaces like
+    #    xsd, xsi, wsdl, etc.
+
     def __init__(self, interface=None, _with_partnerlink=False):
         XmlSchema.__init__(self, interface)
 
diff --git a/spyne/protocol/_base.py b/spyne/protocol/_base.py
@@ -34,10 +34,7 @@
 from spyne.error import ResourceNotFoundError
 from spyne.error import RequestTooLongError
 from spyne.error import RequestNotAllowed
-from spyne.error import ValidationError
 
-from spyne.model.binary import File
-from spyne.model.binary import ByteArray
 from spyne.model.complex import ComplexModelBase
 
 
@@ -93,16 +90,16 @@ class ProtocolBase(object):
 
     The arguments the constructor takes are as follows:
 
-        :param app: The application this protocol belongs to.
-        :param validator: The type of validation this protocol should do on
-            incoming data.
-        :param mime_type: The mime_type this protocol should set for transports
-            that support this. This is a quick way to override the mime_type by
-            default instead of subclassing the releavant protocol implementation.
-        :param skip_depth: Number of wrapper classes to ignore. This is
+    :param app: The application this protocol belongs to.
+    :param validator: The type of validation this protocol should do on
+        incoming data.
+    :param mime_type: The mime_type this protocol should set for transports
+        that support this. This is a quick way to override the mime_type by
+        default instead of subclassing the releavant protocol implementation.
+    :param skip_depth: Number of wrapper classes to ignore. This is
         typically one of (0, 1, 2) but higher numbers may also work for your
         case.
-        """
+    """
 
     allowed_http_verbs = None
     mime_type = 'application/octet-stream'
@@ -124,10 +121,6 @@ def __init__(self, app=None, validator=None, mime_type=None, skip_depth=0):
 
     @property
     def app(self):
-        """The :class:`spyne.application.Application` instance this protocol
-        belongs to.
-        """
-
         return self.__app
 
     def set_app(self, value):
diff --git a/spyne/protocol/json/__init__.py b/spyne/protocol/json/__init__.py
@@ -18,7 +18,7 @@
 #
 
 """The ``spyne.protocol.json`` package contains the Json-related protocols.
-Currently, only :class:spyne.protocol.json.JsonObject is supported.
+Currently, only :class:`spyne.protocol.json.JsonObject` is supported.
 
 Initially released in 2.8.0-rc.
 
@@ -63,14 +63,14 @@
 
 
 class JsonObject(DictObject):
-    """An implementation of the json protocol that uses simplejson or json
-    packages.
+    """An implementation of the json protocol that uses simplejson package when
+    available, json package otherwise.
     """
 
     mime_type = 'application/json'
 
     def create_in_document(self, ctx, in_string_encoding=None):
-        """Sets ``ctx.in_document``,  using ``ctx.in_string``."""
+        """Sets ``ctx.in_document``  using ``ctx.in_string``."""
 
         if in_string_encoding is None:
             in_string_encoding = 'UTF-8'
@@ -82,4 +82,5 @@ def create_in_document(self, ctx, in_string_encoding=None):
             raise Fault('Client.JsonDecodeError', repr(e))
 
     def create_out_string(self, ctx, out_string_encoding='utf8'):
+        """Sets ``ctx.out_string`` using ``ctx.out_document``."""
         ctx.out_string = (json.dumps(o) for o in ctx.out_document)
diff --git a/spyne/protocol/xml/_base.py b/spyne/protocol/xml/_base.py
@@ -17,6 +17,10 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 #
 
+"""The ``spyne.protocol.xml`` package contains an xml-based protocol that
+serializes python objects to xml using Xml Schema conventions.
+"""
+
 import logging
 logger = logging.getLogger('spyne.protocol.xml')
 
@@ -73,13 +77,13 @@ def __init__(self, faultstring):
 
 
 class XmlObject(ProtocolBase):
-    """The protocol that serializes python objects to xml using schema
-    conventions.
+    """The Xml Schema serialization protocol.
 
     See the following material for more (much much more!) information.
-    http://www.w3.org/TR/xmlschema-0/
-    http://www.w3.org/TR/xmlschema-1/
-    http://www.w3.org/TR/xmlschema-2/
+
+    * http://www.w3.org/TR/xmlschema-0/
+    * http://www.w3.org/TR/xmlschema-1/
+    * http://www.w3.org/TR/xmlschema-2/
 
     :param app: The owner application instance.
     :param validator: One of (None, 'soft', 'lxml', 'schema',
diff --git a/spyne/server/null.py b/spyne/server/null.py
@@ -45,12 +45,12 @@ class NullServer(ServerBase):
     It implicitly uses the 'sync' auxiliary processing mode.
 
     Note that:
-        1) **kwargs overwrite **args.
+        1) ``**kwargs`` overwrite ``*args``.
         2) You can do: ::
 
-                logging.getLogger('spyne.server.null').setLevel(logging.CRITICAL)
+            logging.getLogger('spyne.server.null').setLevel(logging.CRITICAL)
 
-            to hide context delimiters in logs.
+        to hide context delimiters in logs.
     """
 
     transport = 'noconn://null.spyne'
diff --git a/spyne/server/wsgi.py b/spyne/server/wsgi.py
@@ -91,7 +91,7 @@ def __init__(self, transport, req_env, content_type):
 
 
 class WsgiApplication(HttpBase):
-    '''A `PEP-3333 <http://www.python.org/dev/peps/pep-3333/#preface-for-readers-of-pep-333>`_
+    '''A `PEP-3333 <http://www.python.org/dev/peps/pep-3333>`_
     compliant callable class.
 
     Supported events:
@@ -111,6 +111,10 @@ class WsgiApplication(HttpBase):
 
         * ``wsgi_error``
             Called right before returning the exception to the client.
+
+        * ``wsgi_close``
+            Called after the whole data has been returned to the client. It's
+            called both from success and error cases.
     '''
 
     def __init__(self, app, chunked=True):
diff --git a/spyne/util/oset/__init__.py b/spyne/util/oset/__init__.py
@@ -1,4 +1,8 @@
 
+"""The ``spyne.util.oset`` package contains implementation of an ordered set
+that works on Python versions 2.4 through 2.7.
+"""
+
 try:
     from spyne.util.oset.new import oset
 except (SyntaxError, ImportError, AttributeError):
