Use black for formatting the code (#887)

* Add black, isort and pre-commit hooks

* Add black configuration
* Run black as part of flake8 testenv in tox
* Add editorconfig to ensure indent style in tox.ini/setup.cfg
* Add pre-commit hooks to check flake8, black, isort and common errors
* Update isort configuration to be black-compatible
* Update contributing documentation
* Add myself to AUTHORS
* Skip migrations in black/isort/pre-commit

* Run black over the source tree

This is the result of running `black .` over the repository.

By-hand improvements of the blackened code will be in follow up commits,
to make it easier to reapply this commit to future updates, if
necessary - IE to remove this commit and re-run black over a fresh tree,
rather than trying to merge new changes in to this commit.

* Hand tweak some of black's autoformatting

Some minor hand tweaks:

    oauth2_provider/contrib/rest_framework/authentication.py
    oauth2_provider/oauth2_validators.py
        Construct OrderedDict in a clearer, still black compliant way
        (one line per dict entry)

    tests/test_token_revocation.py
        Remove empty method docstrings

* Apply isort over codebase

Co-authored-by: Tom Evans <[email protected]>

Author: tevansuk

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{Makefile,tox.ini,setup.cfg}]
+indent_style = tab
+
+[*.{yml,yaml}]
+indent_size = 2

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/ambv/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        exclude: ^(oauth2_provider/migrations/|tests/migrations/)
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: check-ast
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-json
+      - id: check-xml
+      - id: check-yaml
+      - id: mixed-line-ending
+        args: ['--fix=lf']
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.6.3
+    hooks:
+      - id: isort
+        exclude: ^(oauth2_provider/migrations/|tests/migrations/)
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+      - id: flake8
+        exclude: ^(oauth2_provider/migrations/|tests/migrations/)

AUTHORS

@@ -32,3 +32,4 @@ Stéphane Raimbault
 Jun Zhou
 David Smith
 Łukasz Skarżyński
+Tom Evans

docs/conf.py

@@ -32,27 +32,33 @@
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'rfc', 'm2r',]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "rfc",
+    "m2r",
+]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Django OAuth Toolkit'
-copyright = u'2013, Evonove'
+project = "Django OAuth Toolkit"
+copyright = "2013, Evonove"
 
 
 # The version info for the project you're documenting, acts as replacement for
@@ -66,181 +72,176 @@
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # http://www.sphinx-doc.org/en/1.5.1/ext/intersphinx.html
-extensions.append('sphinx.ext.intersphinx')
-intersphinx_mapping = {'python3': ('https://docs.python.org/3.6', None),
-                       'django': ('http://django.readthedocs.org/en/latest/', None)}
-
+extensions.append("sphinx.ext.intersphinx")
+intersphinx_mapping = {
+    "python3": ("https://docs.python.org/3.6", None),
+    "django": ("http://django.readthedocs.org/en/latest/", None),
+}
 
 
 # -- 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 = 'classic'
+# html_theme = 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # 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']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'DjangoOAuthToolkitdoc'
+htmlhelp_basename = "DjangoOAuthToolkitdoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'DjangoOAuthToolkit.tex', u'Django OAuth Toolkit Documentation',
-   u'Evonove', 'manual'),
+    ("index", "DjangoOAuthToolkit.tex", "Django OAuth Toolkit Documentation", "Evonove", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'djangooauthtoolkit', u'Django OAuth Toolkit Documentation',
-     [u'Evonove'], 1)
-]
+man_pages = [("index", "djangooauthtoolkit", "Django OAuth Toolkit Documentation", ["Evonove"], 1)]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -249,19 +250,25 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'DjangoOAuthToolkit', u'Django OAuth Toolkit Documentation',
-   u'Evonove', 'DjangoOAuthToolkit', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        "index",
+        "DjangoOAuthToolkit",
+        "Django OAuth Toolkit Documentation",
+        "Evonove",
+        "DjangoOAuthToolkit",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False

docs/contributing.rst

@@ -24,6 +24,34 @@ You can find the list of bugs, enhancements and feature requests on the
 `issue tracker <https://github.com/jazzband/django-oauth-toolkit/issues>`_. If you want to fix an issue, pick up one and
 add a comment stating you're working on it.
 
+Code Style
+==========
+
+The project uses `flake8 <https://flake8.pycqa.org/en/latest/>`_ for linting,
+`black <https://black.readthedocs.io/en/stable/>`_ for formatting the code,
+`isort <https://pycqa.github.io/isort/>`_ for formatting and sorting imports,
+and `pre-commit <https://pre-commit.com/>`_ for checking/fixing commits for
+correctness before they are made.
+
+You will need to install ``pre-commit`` yourself, and then ``pre-commit`` will
+take care of installing ``flake8``, ``black`` and ``isort``.
+
+After cloning your repository, go into it and run::
+
+    pre-commit install
+
+to install the hooks. On the next commit that you make, ``pre-commit`` will
+download and install the necessary hooks (a one off task). If anything in the
+commit would fail the hooks, the commit will be abandoned. For ``black`` and
+``isort``, any necessary changes will be made automatically, but not staged.
+Review the changes, and then re-stage and commit again.
+
+Using ``pre-commit`` ensures that code that would fail in QA does not make it
+into a commit in the first place, and will save you time in the long run. You
+can also (largely) stop worrying about code style, although you should always
+check how the code looks after ``black`` has formatted it, and think if there
+is a better way to structure the code so that it is more readable.
+
 Pull requests
 =============