Merge pull request #60 from python-parsy/github-actions-linters

Fixes to workflows to use black, cleanups

Author: spookylukey

.github/workflows/tests.yml

@@ -45,7 +45,7 @@ jobs:
           env_vars: PYTHON
           fail_ci_if_error: true
 
-  isort:
+  linters:
     runs-on: ubuntu-latest
 
     steps:
@@ -57,55 +57,24 @@ jobs:
       - uses: actions/cache@v2
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('tests/requirements-isort.txt') }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('tests/requirements-linters.txt') }}
       - name: Install deps
         run: |
           python -m pip install --upgrade pip
-          pip install -r tests/requirements-isort.txt
+          pip install -r tests/requirements-linters.txt
       - name: Run isort
         run: |
           isort --version
           isort -c .
-
-  flake8:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('tests/requirements-flake8.txt') }}
-      - name: Install deps
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r tests/requirements-flake8.txt
       - name: Run flake8
+        if: failure() || success()
         run: |
           flake8 --version
-          flake8
-
-  check-manifest:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('test/requirements-check-manifest.txt') }}
-      - name: Install deps
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r tests/requirements-check-manifest.txt
       - name: Run check-manifest
+        if: failure() || success()
         run: |
           check-manifest
+      - uses: psf/black@stable
+        with:
+          version: "22.3.0"
+        if: failure() || success()

.pre-commit-config.yaml

@@ -14,12 +14,6 @@ repos:
     hooks:
       - id: isort
         language_version: python3.9
-  - repo: https://github.com/rtts/djhtml
-    rev: v1.4.9
-    hooks:
-      - id: djhtml
-        entry: djhtml -t 2 -i
-        language_version: python3.9
   - repo: https://github.com/ikamensh/flynt/
     rev: '0.69'
     hooks:
@@ -43,7 +37,7 @@ repos:
       - id: autopep8
         language_version: python3.9
   - repo: https://github.com/psf/black
-    rev: 21.8b0
+    rev: 22.3.0
     hooks:
       - id: black
         language_version: python3

conftest.py

@@ -4,4 +4,4 @@
 
 if sys.version_info < (3, 7):
     # Python 3.6 and below don't have `dataclasses`
-    collect_ignore = ['examples/sql_select.py']
+    collect_ignore = ["examples/sql_select.py"]

docs/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # parsy documentation build configuration file, created by
 # sphinx-quickstart on Mon Sep 25 22:24:17 2017.
@@ -33,33 +32,33 @@
 # 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.viewcode']
+extensions = ["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"
 
 # General information about the project.
-project = 'parsy'
-copyright = '2017, Jeanine Adkisson, Luke Plant'
-author = 'Jeanine Adkisson'
+project = "parsy"
+copyright = "2017, Jeanine Adkisson, Luke Plant"
+author = "Jeanine Adkisson"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '2.0'
+version = "2.0"
 # The full version, including alpha/beta/rc tags.
-release = '2.0-dev'
+release = "2.0-dev"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -71,10 +70,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to 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 = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -85,7 +84,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
@@ -96,13 +95,13 @@
 # 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"]
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'parsydoc'
+htmlhelp_basename = "parsydoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -111,15 +110,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',
@@ -129,19 +125,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'parsy.tex', 'parsy Documentation',
-     'Jeanine Adkisson', 'manual'),
+    (master_doc, "parsy.tex", "parsy Documentation", "Jeanine Adkisson", "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, 'parsy', 'parsy Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "parsy", "parsy Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -150,7 +142,5 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'parsy', 'parsy Documentation',
-     author, 'parsy', 'One line description of project.',
-     'Miscellaneous'),
+    (master_doc, "parsy", "parsy Documentation", author, "parsy", "One line description of project.", "Miscellaneous"),
 ]

examples/json.py

@@ -43,8 +43,9 @@
 
 
 def test():
-    assert json_doc.parse(
-        r"""
+    assert (
+        json_doc.parse(
+            r"""
     {
         "int": 1,
         "string": "hello",
@@ -53,13 +54,15 @@ def test():
         "nested": {"x": "y"}
     }
 """
-    ) == {
-        "int": 1,
-        "string": "hello",
-        "a list": [1, 2, 3],
-        "escapes": "\n",
-        "nested": {"x": "y"},
-    }
+        )
+        == {
+            "int": 1,
+            "string": "hello",
+            "a list": [1, 2, 3],
+            "escapes": "\n",
+            "nested": {"x": "y"},
+        }
+    )
 
 
 if __name__ == "__main__":

examples/simple_eval.py

@@ -2,59 +2,54 @@
 
 
 def lexer(code):
-    whitespace = regex(r'\s*')
+    whitespace = regex(r"\s*")
     integer = digit.at_least(1).concat().map(int)
-    float_ = (
-        digit.many() + string('.').result(['.']) + digit.many()
-    ).concat().map(float)
-    parser = whitespace >> ((
-        float_ | integer  | regex(r'[()*/+-]')
-    ) << whitespace).many()
+    float_ = (digit.many() + string(".").result(["."]) + digit.many()).concat().map(float)
+    parser = whitespace >> ((float_ | integer | regex(r"[()*/+-]")) << whitespace).many()
     return parser.parse(code)
 
 
 def eval_tokens(tokens):
     # This function parses and evaluates at the same time.
 
-    lparen = match_item('(')
-    rparen = match_item(')')
+    lparen = match_item("(")
+    rparen = match_item(")")
 
     @generate
     def additive():
         res = yield multiplicative
-        sign = match_item('+') | match_item('-')
+        sign = match_item("+") | match_item("-")
         while True:
-            operation = yield sign | success('')
+            operation = yield sign | success("")
             if not operation:
                 break
             operand = yield multiplicative
-            if operation == '+':
+            if operation == "+":
                 res += operand
-            elif operation == '-':
+            elif operation == "-":
                 res -= operand
         return res
 
     @generate
     def multiplicative():
         res = yield simple
-        op = match_item('*') | match_item('/')
+        op = match_item("*") | match_item("/")
         while True:
-            operation = yield op | success('')
+            operation = yield op | success("")
             if not operation:
                 break
             operand = yield simple
-            if operation == '*':
+            if operation == "*":
                 res *= operand
-            elif operation == '/':
+            elif operation == "/":
                 res /= operand
         return res
 
     @generate
     def number():
-        sign = yield match_item('+') | match_item('-') | success('+')
-        value = yield test_item(
-            lambda x: isinstance(x, (int, float)), 'number')
-        return value if sign == '+' else -value
+        sign = yield match_item("+") | match_item("-") | success("+")
+        value = yield test_item(lambda x: isinstance(x, (int, float)), "number")
+        return value if sign == "+" else -value
 
     expr = additive
     simple = (lparen >> expr << rparen) | number
@@ -67,8 +62,9 @@ def simple_eval(expr):
 
 
 import pytest  # noqa  isort:skip
+
 test_item = pytest.mark.skip(test_item)  # This is not a test
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     print(simple_eval(input()))

examples/simple_logo_lexer.py

@@ -11,11 +11,13 @@
 from parsy import eof, regex, seq, string, string_from, whitespace
 
 command = string_from("fd", "bk", "rt", "lt")
-number = regex(r'[0-9]+').map(int)
-optional_whitespace = regex(r'\s*')
+number = regex(r"[0-9]+").map(int)
+optional_whitespace = regex(r"\s*")
 eol = string("\n")
-line = seq(optional_whitespace >> command,
-           whitespace >> number,
-           (eof | eol | (whitespace >> eol)).result("\n"))
+line = seq(
+    optional_whitespace >> command,
+    whitespace >> number,
+    (eof | eol | (whitespace >> eol)).result("\n"),
+)
 flatten_list = lambda ls: sum(ls, [])
 lexer = line.many().map(flatten_list)