Add missing docstrings, convert instance to static methods where poss…

…ible.

kotti/__init__.py

@@ -252,6 +252,12 @@ def base_configure(global_config, **settings):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     import kotti.views.util
 
     settings = config.get_settings()

kotti/migrate.py

@@ -98,7 +98,8 @@ def _make_config(location):
         cfg.set_main_option("sqlalchemy.url", get_settings()['sqlalchemy.url'])
         return cfg
 
-    def _make_script_dir(self, alembic_cfg):
+    @staticmethod
+    def _make_script_dir(alembic_cfg):
         script_dir = ScriptDirectory.from_config(alembic_cfg)
         script_dir.__class__ = ScriptDirectoryWithDefaultEnvPy  # O_o
         return script_dir

kotti/sanitizers.py

@@ -153,6 +153,11 @@ def handler(event):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
 
     _setup_sanitizers(config.registry.settings)
     _setup_listeners(config.registry.settings)

kotti/testing.py

@@ -60,14 +60,27 @@ def asset(name):
 
 
 def includeme_login(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.add_view(
         login_view,
         name='login',
         renderer='kotti:templates/login.pt')
 
 
 def includeme_layout(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     # override edit master layout with view master layout
+
     config.override_asset(
         to_override='kotti:templates/edit/master.pt',
         override_with='kotti:templates/view/master.pt')
@@ -262,6 +275,12 @@ def dummy_view(context, request):
 
 
 def include_testing_view(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.add_view(
         dummy_view,
         context=TestingRootFactory,

kotti/traversal.py

@@ -125,7 +125,7 @@ def __call__(self, request):
         else:
             vpath_tuple = split_path_info(vpath)
             traversed_nodes = self.traverse(root, vpath_tuple)
-            if len(traversed_nodes) == 0:
+            if not traversed_nodes:
                 view_name = vpath_tuple[0]
                 if view_name[:lvs] == vs:
                     view_name = view_name[lvs:]
@@ -179,7 +179,8 @@ def traverse(root, vpath_tuple):
 
         return nodes
 
-    def _traverse_cte(self, root, vpath_tuple):  # pragma: no cover
+    @staticmethod
+    def _traverse_cte(root, vpath_tuple):  # pragma: no cover
         """ Version of the traverse method, that uses a CTE instead of the
         Node.path attribute.  Unfortunately this is **much** slower and works
         only on PostgreSQL.
@@ -233,4 +234,10 @@ def _traverse_cte(self, root, vpath_tuple):  # pragma: no cover
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.add_traverser(NodeTreeTraverser, Node)

kotti/views/__init__.py

@@ -25,6 +25,12 @@ def __init__(self, context, request):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.add_static_view('static-kotti', 'kotti:static')
 
     # deform stuff

kotti/views/cache.py

@@ -131,4 +131,10 @@ def set_cache_headers(event):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan(__name__)

kotti/views/edit/__init__.py

@@ -37,4 +37,10 @@ def _states(context, request):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     pass

kotti/views/edit/actions.py

@@ -603,6 +603,12 @@ def actions(context, request):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     import warnings
     with warnings.catch_warnings():
         warnings.simplefilter("ignore")

kotti/views/edit/content.py

@@ -134,6 +134,12 @@ def add(self, **appstruct):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.add_view(
         DocumentEditForm,
         context=Document,

kotti/views/edit/default_views.py

@@ -119,4 +119,10 @@ def set_default_view(self):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan('.default_views')

kotti/views/edit/upload.py

@@ -166,4 +166,10 @@ def process_upload(self):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan(__name__)

kotti/views/file.py

@@ -22,6 +22,12 @@ def attachment_view(context, request):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan(__name__)
 
 

kotti/views/login.py

@@ -379,4 +379,10 @@ def forbidden_view_html(request):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan(__name__)

kotti/views/navigation.py

@@ -52,6 +52,12 @@ def ch(node):
 
 
 def includeme_local_navigation(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     # Import is needed in function scope to resolve circular imports caused by
     # compatibility imports in slots.py.
     from kotti.views.slots import assign_slot
@@ -60,4 +66,10 @@ def includeme_local_navigation(config):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan(__name__)

kotti/views/users.py

@@ -612,4 +612,10 @@ def __call__(self):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan(__name__)

kotti/views/view.py

@@ -76,4 +76,10 @@ def notfound_view(context, request):
 
 
 def includeme(config):
+    """ Pyramid includeme hook.
+
+    :param config: app config
+    :type config: :class:`pyramid.config.Configurator`
+    """
+
     config.scan(__name__)