Try fixing the hooks (#56)

Signed-off-by: David ML Brown Jr <dmlb2000@gmail.com>

Author: dmlb2000

.github/workflows/pre-commit.yml

@@ -1,14 +1,20 @@
-name: pre-commit
+name: Run Pre-Commit
 
 on:
-  pull_request:
+  pull_request: {}
   push:
     branches: [main]
 
 jobs:
   pre-commit:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.8', '3.9']
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
       - uses: pre-commit/action@v2.0.3

.github/workflows/pypi.yml

@@ -0,0 +1,23 @@
+name: Publish to PyPi
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  deploy:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.10']
+    steps:
+      - name: Publish package
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/pytest.yml

@@ -1,6 +1,7 @@
 name: Run PyTest
+
 on:
-  pull_request:
+  pull_request: {}
   push:
     branches: [main]
 
@@ -24,7 +25,7 @@ jobs:
         run: |
           python --version
           pip --version
-          pip install coverage pep257 pre-commit pylint pytest readthedocs-sphinx-ext recommonmark setuptools sphinx sphinx-rtd-theme
+          pip install coverage pep257 pre-commit pylint pytest readthedocs-sphinx-ext recommonmark setuptools sphinx sphinx-rtd-theme wheel
           pip install .
           cd tests
           coverage run --include='*/site-packages/jsonpath2/*' --omit='*/site-packages/jsonpath2/parser/JSONPath*' -m pytest -xv

.github/workflows/sphinx.yml

@@ -1,3 +1,10 @@
+name: Run Sphinx Test
+
+on:
+  pull_request: {}
+  push:
+    branches: [main]
+
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -19,7 +26,7 @@ jobs:
         run: |
           python --version
           pip --version
-          pip install coverage pep257 pre-commit pylint pytest readthedocs-sphinx-ext recommonmark setuptools sphinx sphinx-rtd-theme
+          pip install coverage pep257 pre-commit pylint pytest readthedocs-sphinx-ext recommonmark setuptools sphinx sphinx-rtd-theme docutils==0.16
           pip install .
           cd docs
           sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html

.pre-commit-config.yaml

@@ -1,55 +1,40 @@
 exclude: 'jsonpath2/parser/JSONPath.*'
 repos:
--   repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.5.2
-    hooks:
-            -   id: autopep8
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.5.0
     hooks:
-            -   id: fix-encoding-pragma
-            -   id: trailing-whitespace
-            -   id: flake8
-                args: [--max-line-length=120]
-            -   id: check-merge-conflict
-            -   id: double-quote-string-fixer
-            -   id: end-of-file-fixer
-            -   id: debug-statements
-            -   id: check-added-large-files
-            -   id: check-ast
-            -   id: check-byte-order-marker
-            -   id: check-case-conflict
-            -   id: check-docstring-first
-            -   id: check-executables-have-shebangs
-                types: [python]
-            -   id: check-json
-            -   id: check-vcs-permalinks
-            -   id: mixed-line-ending
-            -   id: name-tests-test
-            -   id: pretty-format-json
-                args:
-                  - --autofix
-                  - --top-keys=_id
-            -   id: sort-simple-yaml
-                files: '.yaml$'
-            -   id: check-symlinks
-            -   id: check-yaml
-            -   id: detect-private-key
-            -   id: trailing-whitespace
--   repo: local
+      - id: fix-encoding-pragma
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: debug-statements
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-byte-order-marker
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+        types: [python]
+      - id: check-json
+      - id: check-vcs-permalinks
+      - id: mixed-line-ending
+      - id: name-tests-test
+      - id: pretty-format-json
+        args:
+          - --autofix
+          - --top-keys=_id
+      - id: sort-simple-yaml
+        files: '.yaml$'
+      - id: check-symlinks
+      - id: check-yaml
+      - id: detect-private-key
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
     hooks:
-            -   id: pep257
-                name: pep257
-                entry: python -m pep257
-                language: system
-                types: [python]
-            -   id: pylint
-                name: pylint
-                entry: python -m pylint --rcfile=pylintrc
-                language: system
-                types: [python]
--   repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.1.7
+      - id: black
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.1.13
     hooks:
-    -   id: remove-tabs
-    -   id: remove-crlf
+      - id: remove-tabs
+      - id: remove-crlf

docs/conf.py

@@ -21,18 +21,18 @@
 from recommonmark.parser import CommonMarkParser
 from recommonmark.transform import AutoStructify
 
-sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'tests'))
+sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "tests"))
 
 # -- Project information -----------------------------------------------------
 
-project = 'JSONPath2 Library'
-copyright = '2019, David Brown'
-author = 'David Brown'
+project = "JSONPath2 Library"
+copyright = "2019, David Brown"
+author = "David Brown"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = ''
+release = ""
 
 
 # -- General configuration ---------------------------------------------------
@@ -45,24 +45,24 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
-    'readthedocs_ext.readthedocs'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "readthedocs_ext.readthedocs",
 ]
 
 # 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': 'restructuredtext',
-    '.md': 'markdown',
+    ".rst": "restructuredtext",
+    ".md": "markdown",
 }
 
 # 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.
@@ -74,18 +74,18 @@
 # 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 = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- 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 = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # 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,7 +96,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.
@@ -112,7 +112,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'JSONPath2doc'
+htmlhelp_basename = "JSONPath2doc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -121,15 +121,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',
@@ -139,19 +136,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'JSONPath2.tex', 'Python JSONPath2 Documentation',
-     'David Brown', 'manual'),
+    (
+        master_doc,
+        "JSONPath2.tex",
+        "Python JSONPath2 Documentation",
+        "David Brown",
+        "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, 'jsonpath2', 'Python JSONPath2 Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "jsonpath2", "Python JSONPath2 Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -160,9 +159,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'JSONPath2', 'Python JSONPath2 Documentation',
-     author, 'JSONPath2', 'Python implementation for JSONPath expressions.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "JSONPath2",
+        "Python JSONPath2 Documentation",
+        author,
+        "JSONPath2",
+        "Python implementation for JSONPath expressions.",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -181,26 +186,30 @@
 # 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 -------------------------------------------------
 autodoc_default_options = {
-    'member-order': 'bysource',
-    'special-members': '__init__',
-    'undoc-members': None,
-    'exclude-members': '__weakref__'
+    "member-order": "bysource",
+    "special-members": "__init__",
+    "undoc-members": None,
+    "exclude-members": "__weakref__",
 }
 
 # app setup hook
 
 
 def setup(app):
     """Setup the hooks for recommonmark."""
-    app.add_config_value('recommonmark_config', {
-        # 'url_resolver': lambda url: github_doc_root + url,
-        'auto_toc_tree_section': 'Contents',
-        'enable_eval_rst': True,
-    }, True)
+    app.add_config_value(
+        "recommonmark_config",
+        {
+            # 'url_resolver': lambda url: github_doc_root + url,
+            "auto_toc_tree_section": "Contents",
+            "enable_eval_rst": True,
+        },
+        True,
+    )
     app.add_source_parser(CommonMarkParser)
     app.add_transform(AutoStructify)

jsonpath2/expression.py

@@ -13,6 +13,8 @@ def __eq__(self, other: object) -> bool:
         return isinstance(other, self.__class__) and (self.__dict__ == other.__dict__)
 
     @abstractmethod
-    def evaluate(self, root_value: object, current_value: object) -> bool:  # pragma: no cover abstract method
+    def evaluate(
+        self, root_value: object, current_value: object
+    ) -> bool:  # pragma: no cover abstract method
         """Abstract method to evaluate the expression."""
         raise NotImplementedError()