pep8

Author: Arnaud Coomans

examples/factory/blog/frontend.py

@@ -12,6 +12,7 @@
 
 
 class User(object):
+
     def __init__(self, username):
         self.username = username
         users.append(self)
@@ -22,6 +23,7 @@ def __repr__(self):
 
 
 class Post(object):
+
     def __init__(self, title, content, author):
         self.title = title
         self.content = content

examples/simple/blog.py

@@ -13,6 +13,7 @@
 
 
 class User(object):
+
     def __init__(self, username):
         self.username = username
         users.append(self)
@@ -23,6 +24,7 @@ def __repr__(self):
 
 
 class Post(object):
+
     def __init__(self, title, content, author):
         self.title = title
         self.content = content

flask_autodoc/autodoc.py

@@ -51,18 +51,19 @@ def add_custom_nl2br_filters(self, app):
         @app.template_filter()
         @evalcontextfilter
         def nl2br(eval_ctx, value):
-            result = '\n\n'.join('%s' % p.replace('\n', '<br>\n') for p in _paragraph_re.split(value))
+            result = '\n\n'.join('%s' % p.replace('\n', '<br>\n')
+                                 for p in _paragraph_re.split(value))
             return result
 
     def doc(self, group=None, aa=None, groups=None):
-        """Decorator to add flask route to autodoc for automatic documentation\
+        """Add flask route to autodoc for automatic documentation
 
-        Any route decorated with this method will be added to the list of routes to be documented by the generate() or
-        html() methods.
+        Any route decorated with this method will be added to the list of
+        routes to be documented by the generate() or html() methods.
 
         By default, the route is added to the 'all' group.
-        By specifying group or groups argument, the route can be added to one or multiple other groups as well, besides
-        the 'all' group.
+        By specifying group or groups argument, the route can be added to one
+        or multiple other groups as well, besides the 'all' group.
         """
         def decorator(f):
             if groups:
@@ -78,7 +79,8 @@ def decorator(f):
         return decorator
 
     def generate(self, group='all', groups=[], sort=None):
-        """Returns a list of dict describing the routes specified by the doc() method
+        """Return a list of dict describing the routes specified by the
+        doc() method
 
         Each dict contains:
          - methods: the set of allowed methods (ie ['GET', 'POST'])
@@ -88,7 +90,8 @@ def generate(self, group='all', groups=[], sort=None):
          - args: function arguments
          - defaults: defaults values for the arguments
 
-        By specifying the group or groups arguments, only routes belonging to those groups will be returned.
+        By specifying the group or groups arguments, only routes belonging to
+        those groups will be returned.
 
         Routes are sorted alphabetically based on the rule.
         """
@@ -101,8 +104,8 @@ def generate(self, group='all', groups=[], sort=None):
             func = current_app.view_functions[rule.endpoint]
             arguments = rule.arguments if rule.arguments else ['None']
 
-            if (groups and [True for g in groups if func in self.groups[g]]) or \
-                    (not groups and func in self.groups[group]):
+            if (groups and [True for g in groups if func in self.groups[g]]) \
+                    or (not groups and func in self.groups[group]):
                 links.append(
                     dict(
                         methods=rule.methods,
@@ -119,16 +122,20 @@ def generate(self, group='all', groups=[], sort=None):
             return sorted(links, key=itemgetter('rule'))
 
     def html(self, template=None, group='all', groups=None, **context):
-        """Returns an html string of the routes specified by the doc() method
+        """Return an html string of the routes specified by the doc() method
 
-        A template can be specified. A list of routes is available under the 'autodoc' value (refer to the documentation
-        for the generate() for a description of available values). If no template is specified, a default template is
-        used.
+        A template can be specified. A list of routes is available under the
+        'autodoc' value (refer to the documentation for the generate() for a
+        description of available values). If no template is specified, a
+        default template is used.
 
-        By specifying the group or groups arguments, only routes belonging to those groups will be returned.
+        By specifying the group or groups arguments, only routes belonging to
+        those groups will be returned.
         """
         if template:
-            return render_template(template, autodoc=self.generate(group), **context)
+            return render_template(template,
+                                   autodoc=self.generate(group),
+                                   **context)
         else:
             filename = os.path.join(
                 os.path.dirname(__file__),
@@ -138,4 +145,7 @@ def html(self, template=None, group='all', groups=None, **context):
             with open(filename) as file:
                 content = file.read()
                 with current_app.app_context():
-                    return render_template_string(content, autodoc=self.generate(group=group, groups=groups), **context)
+                    return render_template_string(
+                        content,
+                        autodoc=self.generate(group=group, groups=groups),
+                        **context)

setup.py

@@ -2,7 +2,7 @@
 Flask-Autodoc
 -------------
 
-Flask autodoc automatically creates an online documentation for your flask application.
+Flask autodoc automatically creates an online documentation for your flask app.
 """
 from setuptools import setup
 
@@ -21,7 +21,7 @@ def readme():
     author_email='arnaud.coomans@gmail.com',
     description='Documentation generator for flask',
     long_description=readme(),
-    #py_modules=['flask_autodoc'],
+    # py_modules=['flask_autodoc'],
     # if you would be using a package instead use packages instead
     # of py_modules:
     packages=['flask_autodoc'],

tests/test_autodoc.py

@@ -68,7 +68,8 @@ def ab(param1, param2):
                 self.assertIsNone(d['docstring'])
 
                 if '/p1/p2' in d['rule']:
-                    self.assertDictEqual(d['defaults'], {'param2': 'b', 'param1': 'a'})
+                    self.assertDictEqual(d['defaults'],
+                                         {'param2': 'b', 'param1': 'a'})
                 elif '/p1/<string:param1>/p2/<int:param2>' in d['rule']:
                     self.assertFalse(d['defaults'])
 
@@ -167,7 +168,13 @@ def ab(param1, param2):
             doc = self.autodoc.html(title='hello')
             self.assertIn('/p1/p2', doc)
             if sys.version < '3':
-                self.assertRegexpMatches(doc, '\/p1\/.*string:param1.*\/p2\/.*int:param2.*')
+                self.assertRegexpMatches(
+                    doc,
+                    '\/p1\/.*string:param1.*\/p2\/.*int:param2.*'
+                )
             else:
-                self.assertRegex(doc, '\/p1\/.*string:param1.*\/p2\/.*int:param2.*')
+                self.assertRegex(
+                    doc,
+                    '\/p1\/.*string:param1.*\/p2\/.*int:param2.*'
+                )
             self.assertIn('Returns arguments', doc)