Global PEP8 fixes.

Author: brianmay

benchmarks/models.py

@@ -7,7 +7,6 @@ class TestModel(models.Model):
     name = models.CharField(max_length=128)
 
 
-
 class DirectUser(UserObjectPermissionBase):
     content_object = models.ForeignKey('TestDirectModel')
 
@@ -18,4 +17,3 @@ class DirectGroup(GroupObjectPermissionBase):
 
 class TestDirectModel(models.Model):
     name = models.CharField(max_length=128)
-

benchmarks/run_benchmarks.py

@@ -39,7 +39,7 @@
 OBJECTS_WIHT_PERMS_COUNT = 100
 
 
-def random_string(length=25, chars=string.ascii_letters+string.digits):
+def random_string(length=25, chars=string.ascii_letters + string.digits):
     return ''.join(random.choice(chars) for i in range(length))
 
 
@@ -53,6 +53,7 @@ def get_model_name(model):
 
 
 class Call(object):
+
     def __init__(self, args, kwargs, start=None, finish=None):
         self.args = args
         self.kwargs = kwargs
@@ -85,14 +86,14 @@ def wrapper(*args, **kwargs):
                 func.calls.append(call)
                 if self.action:
                     print(" -> [%s] Done (Total time: %s)" % (self.action,
-                        call.delta()))
+                                                              call.delta()))
         return wrapper
 
 
 class Benchmark(object):
 
     def __init__(self, name, users_count, objects_count,
-            objects_with_perms_count, model, subquery):
+                 objects_with_perms_count, model, subquery):
         self.name = name
         self.users_count = users_count
         self.objects_count = objects_count
@@ -114,13 +115,13 @@ def prepare_db(self):
     @Timed("Creating users")
     def create_users(self):
         User.objects.bulk_create(User(id=x, username=random_string().capitalize())
-            for x in range(self.users_count))
+                                 for x in range(self.users_count))
 
     @Timed("Creating objects")
     def create_objects(self):
         Model = self.Model
         Model.objects.bulk_create(Model(id=x, name=random_string(20))
-            for x in range(self.objects_count))
+                                  for x in range(self.objects_count))
 
     @Timed("Grant permissions")
     def grant_perms(self):
@@ -187,6 +188,3 @@ def main():
 
 if __name__ == '__main__':
     main()
-
-
-

docs/conf.py

@@ -11,21 +11,22 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import sys
+import os
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__))))
 os.environ['DJANGO_SETTINGS_MODULE'] = 'guardian.testapp.testsettings'
-ANONYMOUS_USER_ID = -1 # Required by guardian
+ANONYMOUS_USER_ID = -1  # Required by guardian
 guardian = __import__('guardian')
 
 import django
 django.setup()
 
-# -- General configuration -----------------------------------------------------
+# -- General configuration -----------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -104,7 +105,7 @@
 #modindex_common_prefix = []
 
 
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output ---------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
@@ -181,7 +182,7 @@
 htmlhelp_basename = 'guardiandoc'
 
 
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output --------------------------------------------
 
 # The paper size ('letter' or 'a4').
 #latex_paper_size = 'letter'
@@ -192,8 +193,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'guardian.tex', u'guardian Documentation',
-   u'Lukasz Balcerzak', 'manual'),
+    ('index', 'guardian.tex', u'guardian Documentation',
+     u'Lukasz Balcerzak', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -217,8 +218,7 @@
     ('index', u'django-guardian', u'Documentation for django-guardian',
         u'Lukasz Balcerzak'),
 ]
-pdf_stylesheets = ['sphinx','kerning','a4']
+pdf_stylesheets = ['sphinx', 'kerning', 'a4']
 pdf_break_level = 2
 pdf_inline_footnotes = True
 #pdf_extensions = ['vectorpdf', 'dotted_toc']
-

docs/exts.py

@@ -1,43 +1,42 @@
 
 def setup(app):
     app.add_crossref_type(
-        directivename = "admin",
-        rolename      = "admin",
-        indextemplate = "pair: %s; admin",
+        directivename="admin",
+        rolename="admin",
+        indextemplate="pair: %s; admin",
     )
     app.add_crossref_type(
-        directivename = "command",
-        rolename      = "command",
-        indextemplate = "pair: %s; command",
+        directivename="command",
+        rolename="command",
+        indextemplate="pair: %s; command",
     )
     app.add_crossref_type(
-        directivename = "form",
-        rolename      = "form",
-        indextemplate = "pair: %s; form",
+        directivename="form",
+        rolename="form",
+        indextemplate="pair: %s; form",
     )
     app.add_crossref_type(
-        directivename = "manager",
-        rolename      = "manager",
-        indextemplate = "pair: %s; manager",
+        directivename="manager",
+        rolename="manager",
+        indextemplate="pair: %s; manager",
     )
     app.add_crossref_type(
-        directivename = "mixin",
-        rolename      = "mixin",
-        indextemplate = "pair: %s; mixin",
+        directivename="mixin",
+        rolename="mixin",
+        indextemplate="pair: %s; mixin",
     )
     app.add_crossref_type(
-        directivename = "model",
-        rolename      = "model",
-        indextemplate = "pair: %s; model",
+        directivename="model",
+        rolename="model",
+        indextemplate="pair: %s; model",
     )
     app.add_crossref_type(
-        directivename = "setting",
-        rolename      = "setting",
-        indextemplate = "pair: %s; setting",
+        directivename="setting",
+        rolename="setting",
+        indextemplate="pair: %s; setting",
     )
     app.add_crossref_type(
-        directivename = "shortcut",
-        rolename      = "shortcut",
-        indextemplate = "pair: %s; shortcut",
+        directivename="shortcut",
+        rolename="shortcut",
+        indextemplate="pair: %s; shortcut",
     )
-

example_project/core/migrations/0001_initial.py

@@ -17,20 +17,33 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='CustomUser',
             fields=[
-                ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('password', models.CharField(max_length=128, verbose_name='password')),
-                ('last_login', models.DateTimeField(null=True, verbose_name='last login', blank=True)),
-                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
-                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, max_length=30, validators=[django.core.validators.RegexValidator('^[\\w.@+-]+$', 'Enter a valid username. This value may contain only letters, numbers and @/./+/-/_ characters.', 'invalid')], help_text='Required. 30 characters or fewer. Letters, digits and @/./+/-/_ only.', unique=True, verbose_name='username')),
-                ('first_name', models.CharField(max_length=30, verbose_name='first name', blank=True)),
-                ('last_name', models.CharField(max_length=30, verbose_name='last name', blank=True)),
-                ('email', models.EmailField(max_length=254, verbose_name='email address', blank=True)),
-                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
-                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
-                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('id', models.AutoField(verbose_name='ID',
+                                        serialize=False, auto_created=True, primary_key=True)),
+                ('password', models.CharField(
+                    max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(
+                    null=True, verbose_name='last login', blank=True)),
+                ('is_superuser', models.BooleanField(default=False,
+                                                     help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, max_length=30, validators=[django.core.validators.RegexValidator(
+                    '^[\\w.@+-]+$', 'Enter a valid username. This value may contain only letters, numbers and @/./+/-/_ characters.', 'invalid')], help_text='Required. 30 characters or fewer. Letters, digits and @/./+/-/_ only.', unique=True, verbose_name='username')),
+                ('first_name', models.CharField(max_length=30,
+                                                verbose_name='first name', blank=True)),
+                ('last_name', models.CharField(max_length=30,
+                                               verbose_name='last name', blank=True)),
+                ('email', models.EmailField(max_length=254,
+                                            verbose_name='email address', blank=True)),
+                ('is_staff', models.BooleanField(default=False,
+                                                 help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(
+                    default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(
+                    default=django.utils.timezone.now, verbose_name='date joined')),
                 ('birth_date', models.DateField(null=True, blank=True)),
-                ('groups', models.ManyToManyField(related_query_name='user', related_name='user_set', to='auth.Group', blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', verbose_name='groups')),
-                ('user_permissions', models.ManyToManyField(related_query_name='user', related_name='user_set', to='auth.Permission', blank=True, help_text='Specific permissions for this user.', verbose_name='user permissions')),
+                ('groups', models.ManyToManyField(related_query_name='user', related_name='user_set', to='auth.Group', blank=True,
+                                                  help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(related_query_name='user', related_name='user_set', to='auth.Permission',
+                                                            blank=True, help_text='Specific permissions for this user.', verbose_name='user permissions')),
             ],
             options={
                 'abstract': False,

example_project/posts/migrations/0001_initial.py

@@ -13,11 +13,13 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='Post',
             fields=[
-                ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
+                ('id', models.AutoField(verbose_name='ID',
+                                        serialize=False, auto_created=True, primary_key=True)),
                 ('title', models.CharField(max_length=64, verbose_name=b'title')),
                 ('slug', models.SlugField(max_length=64)),
                 ('content', models.TextField(verbose_name=b'content')),
-                ('created_at', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('created_at', models.DateTimeField(
+                    auto_now_add=True, db_index=True)),
             ],
             options={
                 'get_latest_by': 'created_at',

extras.py

@@ -47,6 +47,7 @@ def check(filename):
                 reporter.flake(m)
         return len(real_messages)
 
+
 class RunFlakesCommand(Command):
     """
     Runs pyflakes against guardian codebase.
@@ -62,7 +63,7 @@ def finalize_options(self):
 
     def run(self):
         try:
-            import pyflakes # pyflakes:ignore
+            import pyflakes  # pyflakes:ignore
         except ImportError:
             sys.stderr.write("No pyflakes installed!\n")
             sys.exit(-1)
@@ -71,16 +72,17 @@ def run(self):
         warns = 0
         # Define top-level directories
         for topdir, dirnames, filenames in os.walk(guardiandir):
-            paths = (os.path.join(topdir, f) for f in filenames if f .endswith('.py'))
+            paths = (os.path.join(topdir, f)
+                     for f in filenames if f .endswith('.py'))
             for path in paths:
                 if path.endswith('tests/__init__.py'):
-                    # ignore that module (it should only gather test cases with *)
+                    # ignore that module (it should only gather test cases with
+                    # *)
                     continue
                 warns += check(path)
         if warns > 0:
-            sys.stderr.write("ERROR: Finished with total %d warnings.\n" % warns)
+            sys.stderr.write(
+                "ERROR: Finished with total %d warnings.\n" % warns)
             sys.exit(1)
         else:
             print("No problems found in source codes.")
-
-

guardian/admin.py

@@ -27,6 +27,7 @@ class AdminUserObjectPermissionsForm(UserObjectPermissionsForm):
     ``get_obj_perms_field_widget`` method so it return
     ``django.contrib.admin.widgets.FilteredSelectMultiple`` widget.
     """
+
     def get_obj_perms_field_widget(self):
         return FilteredSelectMultiple(_("Permissions"), False)
 
@@ -37,6 +38,7 @@ class AdminGroupObjectPermissionsForm(GroupObjectPermissionsForm):
     ``get_obj_perms_field_widget`` method so it return
     ``django.contrib.admin.widgets.FilteredSelectMultiple`` widget.
     """
+
     def get_obj_perms_field_widget(self):
         return FilteredSelectMultiple(_("Permissions"), False)
 
@@ -98,16 +100,19 @@ def get_urls(self):
         if self.include_object_permissions_urls:
             info = self.model._meta.app_label, get_model_name(self.model)
             myurls = [
-                              url(r'^(?P<object_pk>.+)/permissions/$',
-                                  view=self.admin_site.admin_view(self.obj_perms_manage_view),
-                                  name='%s_%s_permissions' % info),
-                              url(r'^(?P<object_pk>.+)/permissions/user-manage/(?P<user_id>\-?\d+)/$',
-                                  view=self.admin_site.admin_view(self.obj_perms_manage_user_view),
-                                  name='%s_%s_permissions_manage_user' % info),
-                              url(r'^(?P<object_pk>.+)/permissions/group-manage/(?P<group_id>\-?\d+)/$',
-                                  view=self.admin_site.admin_view(self.obj_perms_manage_group_view),
-                                  name='%s_%s_permissions_manage_group' % info),
-                              ]
+                url(r'^(?P<object_pk>.+)/permissions/$',
+                    view=self.admin_site.admin_view(
+                        self.obj_perms_manage_view),
+                    name='%s_%s_permissions' % info),
+                url(r'^(?P<object_pk>.+)/permissions/user-manage/(?P<user_id>\-?\d+)/$',
+                    view=self.admin_site.admin_view(
+                        self.obj_perms_manage_user_view),
+                    name='%s_%s_permissions_manage_user' % info),
+                url(r'^(?P<object_pk>.+)/permissions/group-manage/(?P<group_id>\-?\d+)/$',
+                    view=self.admin_site.admin_view(
+                        self.obj_perms_manage_group_view),
+                    name='%s_%s_permissions_manage_group' % info),
+            ]
             urls = myurls + urls
         return urls
 
@@ -147,11 +152,14 @@ def obj_perms_manage_view(self, request, object_pk):
         except ImportError:
             # django < 1.7
             from django.contrib.admin.util import unquote
-        obj = get_object_or_404(self.get_queryset(request), pk=unquote(object_pk))
+        obj = get_object_or_404(self.get_queryset(
+            request), pk=unquote(object_pk))
         users_perms = OrderedDict(
             sorted(
-                get_users_with_perms(obj, attach_perms=True, with_group_users=False).items(),
-                key=lambda user: getattr(user[0], get_user_model().USERNAME_FIELD)
+                get_users_with_perms(obj, attach_perms=True,
+                                     with_group_users=False).items(),
+                key=lambda user: getattr(
+                    user[0], get_user_model().USERNAME_FIELD)
             )
         )
 
@@ -421,8 +429,10 @@ class AuthorAdmin(GuardedModelAdmin):
 class UserManage(forms.Form):
     user = forms.CharField(label=_("User identification"),
                            max_length=200,
-                           error_messages={'does_not_exist': _("This user does not exist")},
-                           help_text=_('Enter a value compatible with User.USERNAME_FIELD')
+                           error_messages={'does_not_exist': _(
+                               "This user does not exist")},
+                           help_text=_(
+                               'Enter a value compatible with User.USERNAME_FIELD')
                            )
 
     def clean_user(self):
@@ -445,7 +455,7 @@ def clean_user(self):
 
 class GroupManage(forms.Form):
     group = forms.CharField(max_length=80, error_messages={'does_not_exist':
-                            _("This group does not exist")})
+                                                           _("This group does not exist")})
 
     def clean_group(self):
         """