Black, linters and pre-commit. Fix all the things!

Author: spookylukey

.github/workflows/pythonpackage.yml

@@ -56,11 +56,11 @@ jobs:
       - uses: actions/cache@v2
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('tests/requirements-linters.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements-linters.txt') }}
       - name: Install deps
         run: |
           python -m pip install --upgrade pip
-          pip install -r tests/requirements-linters.txt
+          pip install -r requirements-linters.txt
       - name: Run isort
         run: |
           isort --version

.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+repos:
+  - repo: 'https://github.com/pre-commit/pre-commit-hooks'
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: 'https://gitlab.com/pycqa/flake8'
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+  - repo: 'https://github.com/pre-commit/mirrors-isort'
+    rev: v5.10.1
+    hooks:
+      - id: isort
+  - repo: 'https://github.com/mgedmin/check-manifest'
+    rev: '0.46'
+    hooks:
+      - id: check-manifest
+  - repo: 'https://github.com/myint/autoflake'
+    rev: v1.4
+    hooks:
+      - id: autoflake
+        args:
+          - '--remove-all-unused-imports'
+          - '-i'
+        language_version: python3.9
+  - repo: 'https://github.com/pre-commit/mirrors-autopep8'
+    rev: v1.5.7
+    hooks:
+      - id: autopep8
+        language_version: python3.9
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        language_version: python3.9
+  - repo: https://github.com/ikamensh/flynt/
+    rev: '0.76'
+    hooks:
+      - id: flynt
+        language_version: python3.9
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+      - id: pyupgrade
+        entry: pyupgrade --py3-plus --py36-plus --keep-runtime-typing
+        language_version: python3.9

CONTRIBUTING.rst

@@ -31,6 +31,21 @@ To contribute fixes and features, you'll need to get set up for development:
 
 If all that is successful, you are in good shape to start developing!
 
+We also have several linters and code formatters that we require use of,
+including `flake8 <http://flake8.pycqa.org/en/latest/>`_, `isort
+<https://github.com/timothycrosley/isort#readme>`_ and `black
+<https://github.com/psf/black>`_. These are most easily add by using `pre-commit
+<https://pre-commit.com/>`_:
+
+* Install pre-commit globally e.g. ``pipx install pre-commit`` if you already
+  have `pipx <https://github.com/pypa/pipx>`_.
+
+* Do ``pre-commit install`` in the repo.
+
+Now all the linters will run when you commit changes.
+
+To run tests on multiple Python versions locally you can also install and use
+``tox``.
 
 
 Fixes and features

README.rst

@@ -8,7 +8,7 @@ fluent-compiler
     :target: https://fluent-compiler.readthedocs.io
 
 .. image:: https://github.com/django-ftl/fluent-compiler/workflows/Python%20package/badge.svg
-    :target: https://github.com/django-ftl/fluent-compiler/actions?query=workflow%3A%22Python+package%22 
+    :target: https://github.com/django-ftl/fluent-compiler/actions?query=workflow%3A%22Python+package%22
 
 This is a Python implementation of `Project Fluent <https://www.projectfluent.org/>`_, a localization
 framework designed to unleash the entire expressive power of natural
@@ -77,5 +77,5 @@ master branch. It has now been pulled out as a separate package. This is why
 the repo's history contains `fluent.syntax` and early versions of `fluent.runtime`,
 but the parts that are left in this repo all derive from the original version
 of `fluent.runtime` contributed by @spookylukey from `a540993a085e36a9679e12f1ee7317ddc1ece5ad <https://github.com/django-ftl/fluent-compiler/commit/a540993a085e36a9679e12f1ee7317ddc1ece5ad>`_ onwards and the new compiler implementation in `d1481d61e0bc1a28a228a4b6d5258350d436e765 <https://github.com/django-ftl/fluent-compiler/commit/d1481d61e0bc1a28a228a4b6d5258350d436e765>`_ (which is squashed version of work done over a much longer period). Thats why
-we also `corrected <https://github.com/django-ftl/fluent-compiler/commit/33c1b5b586858132d3ab7af749c2bde1bb5205b5>`_ 
+we also `corrected <https://github.com/django-ftl/fluent-compiler/commit/33c1b5b586858132d3ab7af749c2bde1bb5205b5>`_
 the copyright notice from Mozilla to Luke Plant.

docs/Makefile

@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api/index.rst

@@ -8,4 +8,3 @@ API documentation
    bundle
    compiler
    resource
-

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
 #
@@ -15,19 +14,19 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'fluent_compiler'
-copyright = '2019, Luke Plant'
-author = 'Luke Plant'
+project = "fluent_compiler"
+copyright = "2019, Luke Plant"
+author = "Luke Plant"
 
 # The short X.Y version
-version = '0.3'
+version = "0.3"
 # The full version, including alpha/beta/rc tags
-release = '0.3'
+release = "0.3"
 
 
 # -- General configuration ---------------------------------------------------
@@ -40,21 +39,21 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -66,7 +65,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
@@ -77,7 +76,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+html_theme = "default"
 
 # 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
@@ -88,7 +87,7 @@
 # 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"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -104,7 +103,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'fluentcompilerdoc'
+htmlhelp_basename = "fluentcompilerdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -113,15 +112,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -131,19 +127,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'fluentcompiler.tex', 'fluent_compiler Documentation',
-     'Luke Plant', 'manual'),
+    (
+        master_doc,
+        "fluentcompiler.tex",
+        "fluent_compiler Documentation",
+        "Luke Plant",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'fluentcompiler', 'fluent_compiler Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "fluentcompiler", "fluent_compiler Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -152,9 +150,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'fluentcompiler', 'fluent_compiler Documentation',
-     author, 'fluentcompiler', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "fluentcompiler",
+        "fluent_compiler Documentation",
+        author,
+        "fluentcompiler",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -173,12 +177,12 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------
 
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

pyproject.toml

@@ -0,0 +1,11 @@
+[tool.black]
+line-length = 120
+# required-version = '22.3.0' # see https://github.com/psf/black/issues/2493
+target-version = ['py39']
+
+[tool.isort]
+profile = "black"
+line_length = 120
+known_first_party = ["fluent_compiler"]
+default_section= "THIRDPARTY"
+skip = [".tox", "dist", "build", ".git"]

requirements-linters.txt

@@ -0,0 +1,3 @@
+isort==5.10.1
+flake8==4.0.1
+check-manifest

requirements-test.txt

@@ -4,3 +4,4 @@ hypothesis>=4.9.0
 Markdown>=3.0.1
 MarkupSafe>=1.1.1
 pytest
+six