Formatting

Author: dralley

.pep8speaks.yml

@@ -1,8 +1,9 @@
 pycodestyle:
     max-line-length: 100  # Default is 79 in PEP8
     ignore:  # Errors and warnings to ignore
-        - E401 # multiple imports on one line
     exclude:
         - "./docs/*"
         - "*/build/*"
         - "*/migrations/*"
+
+# E401: multiple imports on one line

.travis/install.sh

@@ -5,9 +5,6 @@ export COMMIT_MSG=$(git show HEAD^2 -s)
 export PULP_PR_NUMBER=$(echo $COMMIT_MSG | grep -oP 'Required\ PR:\ https\:\/\/github\.com\/pulp\/pulp\/pull\/(\d+)' | awk -F'/' '{print $7}')
 export PULP_SMASH_PR_NUMBER=$(echo $COMMIT_MSG | grep -oP 'Required\ PR:\ https\:\/\/github\.com\/PulpQE\/pulp-smash\/pull\/(\d+)' | awk -F'/' '{print $7}')
 
-# temporary workaround until a newer RQ release is available
-pip install git+https://github.com/rq/rq.git@3133d94b58e59cb86e8f4677492d48b2addcf5f8
-
 pip install -r test_requirements.txt
 
 cd .. && git clone https://github.com/pulp/pulp.git

docs/conf.py

@@ -186,8 +186,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'PulpPythonSupport.tex', u'Pulp Python Support Documentation',
-   u'Pulp Project', 'manual'),
+    ('index', 'PulpPythonSupport.tex', u'Pulp Python Support Documentation',
+     u'Pulp Project', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -217,7 +217,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'pulppythonsupport', u'Pulp Python Support Documentation',
-     [u'Pulp Project'], 1)
+     [u'Pulp Project'], 1),
 ]
 
 # If true, show URL addresses after external links.
@@ -230,9 +230,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'PulpPythonSupport', u'Pulp Python Support Documentation',
-   u'Pulp Project', 'PulpPythonSupport', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'PulpPythonSupport', u'Pulp Python Support Documentation',
+     u'Pulp Project', 'PulpPythonSupport', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -244,12 +244,17 @@
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
 
-extlinks = {'redmine': ('https://pulp.plan.io/issues/%s', '#'),
-            'fixedbugs_pulp_python': ('https://pulp.plan.io/projects/pulp_python/issues?c%%5B%%5D='
-                                      'tracker&c%%5B%%5D=status&c%%5B%%5D=priority&c%%5B%%5D=cf_5&'
-                                      'c%%5B%%5D=subject&c%%5B%%5D=author&c%%5B%%5D=assigned_to&c%'
-                                      '%5B%%5D=cf_3&f%%5B%%5D=cf_11&f%%5B%%5D=tracker_id&f%%5B%%5D'
-                                      '=&group_by=&op%%5Bcf_11%%5D=%%3D&op%%5Btracker_id%%5D=%%3D&'
-                                      'set_filter=1&sort=priority%%3Adesc%%2Ccf_5%%3Adesc%%2Cstatu'
-                                      's&utf8=%%E2%%9C%%93&v%%5Bcf_11%%5D%%5B%%5D=%s&v%%5Btracker_'
-                                      'id%%5D%%5B%%5D=1', 'bugs fixed in '),}
+extlinks = {
+    "redmine": ("https://pulp.plan.io/issues/%s", "#"),
+    "fixedbugs_pulp_python": (
+        "https://pulp.plan.io/projects/pulp_python/issues?c%%5B%%5D="
+        "tracker&c%%5B%%5D=status&c%%5B%%5D=priority&c%%5B%%5D=cf_5&"
+        "c%%5B%%5D=subject&c%%5B%%5D=author&c%%5B%%5D=assigned_to&c%"
+        "%5B%%5D=cf_3&f%%5B%%5D=cf_11&f%%5B%%5D=tracker_id&f%%5B%%5D"
+        "=&group_by=&op%%5Bcf_11%%5D=%%3D&op%%5Btracker_id%%5D=%%3D&"
+        "set_filter=1&sort=priority%%3Adesc%%2Ccf_5%%3Adesc%%2Cstatu"
+        "s&utf8=%%E2%%9C%%93&v%%5Bcf_11%%5D%%5B%%5D=%s&v%%5Btracker_"
+        "id%%5D%%5B%%5D=1",
+        "bugs fixed in ",
+    ),
+}

flake8.cfg

@@ -1,5 +1,16 @@
 [flake8]
 exclude = ./docs/*,*/migrations/*
-# E401: multiple imports on one line
-ignore = E401
+ignore = Q000,D100,D104,D106,D200,D402
 max-line-length = 100
+
+# Flake8-quotes extension codes
+# -----------------------------
+# Q000: double or single quotes only, default is double (don't want to enforce this)
+
+# Flake8-docstring extension codes
+# --------------------------------
+# D100: missing docstring in public module
+# D104: missing docstring in public package
+# D106: missing docstring in public nested class (complains about "class Meta:" and documenting those is silly)
+# D200: one-line docstring should fit on one line with quotes
+# D402: first line should not be the function’s “signature” (false positives)

pulp_python/app/__init__.py

@@ -3,7 +3,7 @@
 
 class PulpPythonPluginAppConfig(PulpPluginAppConfig):
     """
-    Entry point for pulp_python plugin
+    Entry point for pulp_python plugin.
     """
 
     name = 'pulp_python.app'

pulp_python/app/models.py

@@ -2,20 +2,26 @@
 
 from django.db import models
 
-from pulpcore.plugin.models import Content, Remote, Model, Publisher
+from pulpcore.plugin.models import Content, Model, Publisher, Remote
 
 log = getLogger(__name__)
 
 
-PACKAGE_TYPES = (("bdist_dmg", "bdist_dmg"), ("bdist_dumb", "bdist_dumb"),
-                 ("bdist_egg", "bdist_egg"), ("bdist_msi", "bdist_msi"),
-                 ("bdist_rpm", "bdist_rpm"), ("bdist_wheel", "bdist_wheel"),
-                 ("bdist_wininst", "bdist_wininst"), ("sdist", "sdist"))
+PACKAGE_TYPES = (
+    ("bdist_dmg", "bdist_dmg"),
+    ("bdist_dumb", "bdist_dumb"),
+    ("bdist_egg", "bdist_egg"),
+    ("bdist_msi", "bdist_msi"),
+    ("bdist_rpm", "bdist_rpm"),
+    ("bdist_wheel", "bdist_wheel"),
+    ("bdist_wininst", "bdist_wininst"),
+    ("sdist", "sdist"),
+)
 
 
 class Classifier(Model):
     """
-    Custom tags for classifier
+    Custom tags for classifier.
 
     Fields:
 
@@ -25,25 +31,30 @@ class Classifier(Model):
 
         python_package_content (models.ForeignKey): The PythonPackageContent this classifier
         is associated with.
-
     """
 
     name = models.TextField()
-    python_package_content = models.ForeignKey("PythonPackageContent", related_name="classifiers",
-                                               related_query_name="classifier",
-                                               on_delete=models.CASCADE)
+    python_package_content = models.ForeignKey(
+        "PythonPackageContent",
+        related_name="classifiers",
+        related_query_name="classifier",
+        on_delete=models.CASCADE
+    )
 
 
 class DistributionDigest(Model):
     """
     A model of digests on an individual distribution.
     """
+
     type = models.TextField()
     digest = models.TextField()
-    project_specifier = models.ForeignKey("ProjectSpecifier",
-                                          related_name="digests",
-                                          related_query_name="distributiondigest",
-                                          on_delete=models.CASCADE)
+    project_specifier = models.ForeignKey(
+        "ProjectSpecifier",
+        related_name="digests",
+        related_query_name="distributiondigest",
+        on_delete=models.CASCADE
+    )
 
 
 class ProjectSpecifier(Model):
@@ -69,16 +80,20 @@ class ProjectSpecifier(Model):
 
     name = models.TextField()
     version_specifier = models.TextField(blank=True, default="")
-    remote = models.ForeignKey("PythonRemote",
-                               related_name="projects",
-                               related_query_name="projectspecifier",
-                               on_delete=models.CASCADE)
+    remote = models.ForeignKey(
+        "PythonRemote",
+        related_name="projects",
+        related_query_name="projectspecifier",
+        on_delete=models.CASCADE
+    )
 
 
 class PythonPackageContent(Content):
     """
-    A Content Type representing Python's Distribution Package as
-    defined in pep-0426 and pep-0345
+    A Content Type representing Python's Distribution Package.
+
+    As defined in pep-0426 and pep-0345.
+
     https://www.python.org/dev/peps/pep-0491/
     https://www.python.org/dev/peps/pep-0345/
     """
@@ -112,20 +127,30 @@ class PythonPackageContent(Content):
 
     @property
     def artifact(self):
+        """
+        Return the artifact id (there is only one for this content type).
+        """
         return self.artifacts.get().pk
 
     class Meta:
-        unique_together = (
-            'filename',
-        )
+        unique_together = ('filename',)
 
     def __str__(self):
         """
-        Overrides Content.str to provide the distribution version and type at the end.
+        Provide more useful repr information.
+
+        Overrides Content.str to provide the distribution version and type at
+        the end.
+
         e.g. <PythonPackageContent: shelf-reader [version] (whl)>
+
         """
-        return '<{}: {} [{}] ({})>'.format(
-            self._meta.object_name, self.name, self.version, self.packagetype)
+        return '<{obj_name}: {name} [{version}] ({type})>'.format(
+            obj_name=self._meta.object_name,
+            name=self.name,
+            version=self.version,
+            type=self.packagetype
+        )
 
 
 class PythonPublisher(Publisher):
@@ -139,9 +164,6 @@ class PythonPublisher(Publisher):
 class PythonRemote(Remote):
     """
     A Remote for Python Content.
-
-    Attributes:
-        projects (list): A list of python projects to sync
     """
 
     TYPE = 'python'

pulp_python/app/serializers.py

@@ -12,7 +12,7 @@
 
 class ClassifierSerializer(serializers.ModelSerializer):
     """
-    A serializer for Python Classifiers
+    A serializer for Python Classifiers.
     """
 
     name = serializers.CharField(
@@ -26,12 +26,12 @@ class Meta:
 
 class DistributionDigestSerializer(serializers.ModelSerializer):
     """
-    A serializer for the Distribution Digest in a Project Specifier
+    A serializer for the Distribution Digest in a Project Specifier.
     """
+
     type = serializers.CharField(
         help_text=_("A type of digest: i.e. sha256, md5")
     )
-
     digest = serializers.CharField(
         help_text=_("The digest of the distribution")
     )
@@ -43,32 +43,30 @@ class Meta:
 
 class ProjectSpecifierSerializer(serializers.ModelSerializer):
     """
-    A serializer for Python project specifiers
+    A serializer for Python project specifiers.
     """
 
     name = serializers.CharField(
         help_text=_("A python project name.")
     )
-
     version_specifier = serializers.CharField(
-        help_text=_("A version specifier, accepts standard python versions "
-                    "syntax: >=, <=, ==, ~=, >, <, ! can be used in conjunction with"
-                    "other specifiers i.e. >1,<=3,!=3.0.2. Note that the specifiers "
-                    "treat pre-released versions as < released versions, so 3.0.0a1 < 3.0.0."
-                    "Not setting the version_specifier will sync all the pre-released and"
-                    "released versions."),
+        help_text=_(
+            "A version specifier, accepts standard python versions syntax:"
+            " >=, <=, ==, ~=, >, <, ! can be used in conjunction with other specifiers i.e."
+            " >1,<=3,!=3.0.2. Note that the specifiers treat pre-released versions as < released"
+            " versions, so 3.0.0a1 < 3.0.0. Not setting the version_specifier will sync all the "
+            "pre-released and released versions."),
         required=False,
         allow_blank=True
     )
-
     digests = DistributionDigestSerializer(
         required=False,
         many=True
     )
 
     def validate_version_specifier(self, value):
         """
-        Check that the Version Specifier is valid
+        Check that the Version Specifier is valid.
         """
         try:
             specifiers.SpecifierSet(value)
@@ -199,17 +197,17 @@ class PythonPackageContentSerializer(core_serializers.ContentSerializer):
 
     def create(self, validated_data):
         """
-        Creates a PythonPackageContent
+        Create a PythonPackageContent.
+
         Overriding default create() to write the classifiers nested field
 
-         args:
-            validated_data (dict): data used to create the PythonPackageContent
+        Args:
+            validated_data (dict): Data used to create the PythonPackageContent
 
-        returns:
-            models.PythonPackageContent: the created PythonPackageContent
+        Returns:
+            models.PythonPackageContent: The created PythonPackageContent
 
         """
-
         classifiers = validated_data.pop('classifiers')
         artifact = validated_data.pop('artifact')
 
@@ -253,19 +251,18 @@ class Meta:
     @transaction.atomic
     def update(self, instance, validated_data):
         """
-        Updates a PythonRemote
+        Update a PythonRemote.
+
         Overriding default update() to write the projects nested field
 
-        args:
+        Args:
             instance (models.PythonRemote): instance of the python remote to update
             validated_data (dict): of validated data to update
-            partial (bool): True for partial update, False otherwise
 
-        returns:
+        Returns:
             models.PythonRemote: the updated PythonRemote
 
         """
-
         projects = validated_data.pop('projects', [])
 
         python_remote = python_models.PythonRemote.objects.get(pk=instance.pk)
@@ -288,17 +285,17 @@ def update(self, instance, validated_data):
     @transaction.atomic
     def create(self, validated_data):
         """
-        Creates a PythonRemote
+        Create a PythonRemote.
+
         Overriding default create() to write the projects nested field, and the nested digest field
 
-        args:
+        Args:
             validated_data (dict): data used to create the remote
 
-        returns:
+        Returns:
             models.PythonRemote: the created PythonRemote
 
         """
-
         projects = validated_data.pop('projects', [])
 
         python_remote = python_models.PythonRemote.objects.create(**validated_data)

pulp_python/app/tasks/__init__.py

@@ -1,2 +1,6 @@
-from .publish import publish  # noqa
-from .sync import sync  # noqa
+"""
+Asynchronous task definitions.
+"""
+
+from .publish import publish  # noqa:E722
+from .sync import sync  # noqa:E722