Merge pull request #658 from pradyunsg/better-linting

Better linting setup

Author: pradyunsg

.github/CONTRIBUTING.rst

@@ -45,13 +45,9 @@ data to the new models.
 Code Convention
 ---------------
 
-We follow the `Django Coding Style`_ and enforce it using `flake8`_.
-
-In general, if flake8 is happy with your code, you should be fine. To use
-``flake8`` to check your code, you can use the following command::
-
-   $ flake8 --max-complexity=24 --statistics --benchmark --ignore=E5,F4 <project_dir>/
+We follow the `Black Coding Style`_, and sort our imports with `isort`_. This
+code style is enforced with automation.
 
 .. _`issue tracker`: https://github.com/pythonindia/junction/issues
-.. _`flake8`: https://flake8.readthedocs.org/en/latest/
-.. _`Django Coding Style`: https://docs.djangoproject.com/en/2.2/internals/contributing/writing-code/coding-style/
+.. _`isort`: https://isort.readthedocs.org/en/latest/
+.. _`Black Coding Style`: https://black.readthedocs.io/en/latest/the_black_code_style.html

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+repos:
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.5.0
+  hooks:
+  - id: check-builtin-literals
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: forbid-new-submodules
+  - id: trailing-whitespace
+
+- repo: https://github.com/pre-commit/pygrep-hooks
+  rev: v1.4.1
+  hooks:
+  - id: python-no-log-warn
+  - id: python-no-eval
+  - id: rst-backticks
+
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.7.9
+  hooks:
+  - id: flake8
+    exclude: .*/migrations/.*|settings/.*
+
+- repo: https://github.com/timothycrosley/isort
+  rev: 4.3.21
+  hooks:
+  - id: isort
+    files: \.py$
+
+- repo: https://github.com/psf/black
+  rev: stable
+  hooks:
+  - id: black
+    language_version: python3.6
+    exclude: .*/migrations/.*

.travis.yml

@@ -31,6 +31,12 @@ jobs:
       python: 3.7
 
 install:
+  # Enable Python 3.6.x, when python: 3.5 (because black is Py3.6+)
+  - |
+    if [ "${TRAVIS_PYTHON_VERSION}" == "3.5" ]; then
+      pyenv shell system:3.6.7
+    fi
+
   # Get the latest pip
   - python -m pip install --upgrade pip
   # Reinstall pip, using the latest pip

docs/source/conf.py

@@ -1,17 +1,17 @@
-project = 'Junction'
-copyright = '2019, Junction Developers'
-author = 'Junction Developers'
+project = "Junction"
+copyright = "2019, Junction Developers"
+author = "Junction Developers"
 
 
 # -- 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.
-extensions = ['recommonmark']
+extensions = ["recommonmark"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -20,32 +20,29 @@
 
 # The suffix of source filenames.
 source_suffix = {
-    '.rst': 'restructuredtext',
-    '.md': 'markdown',
+    ".rst": "restructuredtext",
+    ".md": "markdown",
 }
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # -- Recommonmark/Markdown stuff ---------------------------------------------
 # NOTE: This entire section should be removed once the old/ folder is removed
 #       from the docs/ directory.
 
-from recommonmark.parser import CommonMarkParser
-from recommonmark.transform import AutoStructify
+from recommonmark.transform import AutoStructify  # noqa: E402
 
 
 def setup(app):
-    app.add_config_value('recommonmark_config', {
-        'enable_auto_toc_tree': True,
-    }, True)
+    app.add_config_value("recommonmark_config", {"enable_auto_toc_tree": True}, True)
     app.add_transform(AutoStructify)

junction/__init__.py

@@ -1,6 +1,11 @@
 # -*- coding: utf-8 -*-
-__version__ = '0.3.2'
-__version_info__ = tuple([int(num) if num.isdigit() else num for num in __version__.replace('-', '.', 1).split('.')])
+__version__ = "0.3.2"
+__version_info__ = tuple(
+    [
+        int(num) if num.isdigit() else num
+        for num in __version__.replace("-", ".", 1).split(".")
+    ]
+)
 
 # This will make sure the app is always imported when
 # Django starts so that shared_task will use this app.

junction/base/admin.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, unicode_literals
 
-# Third Party Stuff
 from django.contrib import admin
 
 
@@ -17,12 +16,18 @@ def save_model(self, request, obj, form, change):
 
 
 class TimeAuditAdmin(admin.ModelAdmin):
-    list_display = ('created_at', 'modified_at',)
+    list_display = (
+        "created_at",
+        "modified_at",
+    )
 
 
 class AuditAdmin(TimeAuditAdmin):
-    list_display = ('created_by', 'modified_by',) + TimeAuditAdmin.list_display
-    exclude = ('created_by', 'modified_by',)
+    list_display = ("created_by", "modified_by",) + TimeAuditAdmin.list_display
+    exclude = (
+        "created_by",
+        "modified_by",
+    )
 
     def save_model(self, request, obj, form, change):
         save_model(self, request, obj, form, change)

junction/base/apps.py

@@ -1,10 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, print_function, unicode_literals
 
-# Standard Library
 import sys
 
-# Third Party Stuff
 from django.apps import AppConfig
 
 from . import monkey

junction/base/constants.py

@@ -1,14 +1,12 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, unicode_literals
 
-# Standard Library
 import inspect
 
 
 def _user_attributes(cls):
-    defaults = dir(type(str('defaults'), (object,), {}))  # gives all inbuilt attrs
-    return [
-        item[0] for item in inspect.getmembers(cls) if item[0] not in defaults]
+    defaults = dir(type(str("defaults"), (object,), {}))  # gives all inbuilt attrs
+    return [item[0] for item in inspect.getmembers(cls) if item[0] not in defaults]
 
 
 def choices(cls):
@@ -20,7 +18,7 @@ def choices(cls):
         val = getattr(cls, attr)
         setattr(cls, attr[1:], val[0])
         _choices.append((val[0], val[1]))
-    setattr(cls, 'CHOICES', tuple(_choices))
+    setattr(cls, "CHOICES", tuple(_choices))
     return cls
 
 
@@ -72,8 +70,8 @@ class ProposalReviewVote:
 # FIXME: `ProposalReviewerComment` should be Boolean
 @choices
 class ProposalReviewerComment:
-    _COMMENTED = ['True', 'Yes']
-    _NOT_COMMENTED = ['False', 'No']
+    _COMMENTED = ["True", "Yes"]
+    _NOT_COMMENTED = ["False", "No"]
 
 
 @choices
@@ -89,24 +87,29 @@ class ConferenceSettingConstants:
     ALLOW_PUBLIC_VOTING_ON_PROPOSALS = {
         "name": "allow_public_voting_on_proposals",
         "value": True,
-        "description": "Allow public to vote on proposals"}
+        "description": "Allow public to vote on proposals",
+    }
 
-    DISPLAY_PROPOSALS_IN_PUBLIC = {"name": "display_proposals_in_public",
-                                   "value": True,
-                                   "description": "Display proposals in public"}
+    DISPLAY_PROPOSALS_IN_PUBLIC = {
+        "name": "display_proposals_in_public",
+        "value": True,
+        "description": "Display proposals in public",
+    }
 
-    ALLOW_PLUS_ZERO_REVIEWER_VOTE = {"name": "allow_plus_zero_reviewer_vote",
-                                     "value": True,
-                                     "description": "Allow +0 vote in reviewer votes"}
+    ALLOW_PLUS_ZERO_REVIEWER_VOTE = {
+        "name": "allow_plus_zero_reviewer_vote",
+        "value": True,
+        "description": "Allow +0 vote in reviewer votes",
+    }
 
 
 @choices
 class PSRVotePhase:
-    _PRIMARY = [0, 'Initial voting']
-    _SECONDARY = [1, 'Second phase voting']
+    _PRIMARY = [0, "Initial voting"]
+    _SECONDARY = [1, "Second phase voting"]
 
 
 @choices
 class ProposalCommentType:
-    _GENERAL = [0, 'All general comments']
-    _SECONDARY_VOTING = [1, 'Second phase voting']
+    _GENERAL = [0, "All general comments"]
+    _SECONDARY_VOTING = [1, "Second phase voting"]

junction/base/context_processors.py

@@ -1,9 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, unicode_literals
 
-# Third Party Stuff
 from django.conf import settings
 
 
 def site_info(request):
-    return {'SITE_INFO': settings.SITE_VARIABLES}
+    return {"SITE_INFO": settings.SITE_VARIABLES}

junction/base/emailer.py

@@ -1,10 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, unicode_literals
 
-# Standard Library
 from os import path
 
-# Third Party Stuff
 from django.conf import settings
 from django.core.mail import send_mail
 from django.template.loader import render_to_string
@@ -21,18 +19,24 @@ def send_email(to, context, template_dir):
     :rtype: None
 
     """
+
     def to_str(template_name):
         return render_to_string(path.join(template_dir, template_name), context).strip()
 
-    subject = to_str('subject.txt')
-    text_message = to_str('message.txt')
-    html_message = to_str('message.html')
+    subject = to_str("subject.txt")
+    text_message = to_str("message.txt")
+    html_message = to_str("message.html")
     from_email = settings.DEFAULT_FROM_EMAIL
     recipient_list = [_format_email(to)]
 
-    return send_mail(subject, text_message, from_email, recipient_list, html_message=html_message)
+    return send_mail(
+        subject, text_message, from_email, recipient_list, html_message=html_message
+    )
 
 
 def _format_email(user):
-    return user.email if user.first_name and user.last_name else \
-        '"{} {}" <{}>'.format(user.first_name, user.last_name, user.email)
+    return (
+        user.email
+        if user.first_name and user.last_name
+        else '"{} {}" <{}>'.format(user.first_name, user.last_name, user.email)
+    )