Add pre-commit hook for linters

- config taken from pyfakefs
- add changes from autoblack
- fix some warnings from the linters
- increase max line length to 88 (black conform)

Author: mrbean-bremen

.github/workflows/pythontests.yml

@@ -8,32 +8,6 @@ defaults:
     shell: bash
 
 jobs:
-  linter:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        python-version:  [3.8]
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Get pip cache dir
-      id: pip-cache
-      run: |
-        echo "::set-output name=dir::$(pip cache dir)"
-    - name: pip cache
-      uses: actions/cache@v3
-      with:
-        path: ${{ steps.pip-cache.outputs.dir }}
-        key: py${{ matrix.python-version }}-${{ matrix.os }}-pip
-    - name: Install linter
-      run: python -m pip install flake8
-    - name: Check syntax and style
-      run: python -m flake8 .
-
   test:
     runs-on: ${{ matrix.os }}
     strategy:

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+default_language_version:
+  python: "3.10"
+
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=wronly,afile
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black
+        args: [ --safe, --quiet ]
+  - repo: https://github.com/asottile/blacken-docs
+    rev: 1.15.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [ black==22.12.0 ]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: fix-encoding-pragma
+        args: [ --remove ]
+      - id: check-yaml
+      - id: debug-statements
+        language_version: python3
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.2.0
+    hooks:
+      - id: autoflake
+        name: autoflake
+        args: ["--in-place", "--remove-unused-variables", "--remove-all-unused-imports"]
+        language: python
+        files: \.py$
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        language_version: python3
+        additional_dependencies:
+          - flake8-bugbear
+        args: ["--extend-ignore=E203", "--max-line-length=88"]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.4.1
+    hooks:
+      - id: mypy
+        exclude: (docs|pyfakefs/tests)

.vscode/launch.json

@@ -12,4 +12,4 @@
             "args": ["-v"]
         }
     ]
-}
+}

.vscode/settings.json

@@ -2,9 +2,9 @@
     "restructuredtext.confPath": "${workspaceFolder}\\docs\\source",
     "python.formatting.blackArgs": [
         "--line-length",
-        "79",
+        "88",
         "--skip-string-normalization"
     ],
     "python.formatting.provider": "black",
     "editor.rulers": [79, 87]
-}
+}

AUTHORS

@@ -7,4 +7,3 @@ Jonas Zinn <[email protected]>
 Andrew Gilbert <[email protected]>
 Bartosz Peszek <[email protected]>
 mrbean-bremen <[email protected]>
-

CHANGELOG.md

@@ -1,5 +1,8 @@
 # pytest-order Release Notes
 
+### Infrastructure
+* add pre-commit hook for linters
+
 ## [Version 1.1.0](https://pypi.org/project/pytest-order/1.1.0/) (2023-03-10)
 Adds support for executing tests more than once using order marks.
 
@@ -29,24 +32,24 @@ First Python 3 only version.
 
 ### Breaking changes
 - removed support for Python 2.7 and 3.5
-- removed official support for pytest < 5.0.0 (older versions may still 
+- removed official support for pytest < 5.0.0 (older versions may still
   work, but they are not tested)
 - changed notation of relative markers in other modules - instead of using
   the dot notation, the standard pytest nodeid is used,
   see [#24](https://github.com/pytest-dev/pytest-order/issues/24)
-- using parametrized test names that include the parameter is no longer 
-  supported, just use the name without the parameter instead 
+- using parametrized test names that include the parameter is no longer
+  supported, just use the name without the parameter instead
 
 ### New features
 - added support for the ``pytest-dependency`` option ``automark_dependency``
-- added support for relative ordering of parametrized tests using the test 
+- added support for relative ordering of parametrized tests using the test
   name without the parameter value,
   see [#38](https://github.com/pytest-dev/pytest-order/issues/38)
-  
+
 ### Infrastructure
 - re-added Python 3.10 to CI tests (for pytest >= 6.2.4)
 - added type hints
-  
+
 ## [Version 0.11.0](https://pypi.org/project/pytest-order/0.11.0/) (2021-04-11)
 Adds support for multiple relative markers for the same test.
 
@@ -63,7 +66,7 @@ Adds support for class-level relative markers and directory level scope.
 - added support for class level relative markers,
   see [#7](https://github.com/pytest-dev/pytest-order/issues/7)
 - added option `--order-scope-level` which allows grouping tests on the
-  same directory level, 
+  same directory level,
   see [#8](https://github.com/pytest-dev/pytest-order/issues/8)
 
 ### Fixes
@@ -76,26 +79,26 @@ Adds support for class-level relative markers and directory level scope.
 
 ## [Version 0.9.5](https://pypi.org/project/pytest-order/0.9.5/) (2021-02-16)
 Introduces hierarchical ordering option and fixes ordering of session-scoped
-dependency markers. 
+dependency markers.
 
 ### Changes
 - tests with unresolved relative markers are now handled like tests
-  without order markers instead of being enqueued after all other tests   
+  without order markers instead of being enqueued after all other tests
 
 ### New features
 - added `group-order-scope` option to allow hierarchical ordering on module
-  and class scope, 
+  and class scope,
   see [#6](https://github.com/pytest-dev/pytest-order/issues/6)
-  
+
 ### Fixes
-- the dependency marker scope is now considered for resolving marker names 
+- the dependency marker scope is now considered for resolving marker names
   (module scope had been assumed before)
 - dependency markers in session scope referenced by the nodeid are now
   correctly sorted if using the `order-dependencies` option
- 
+
 
 ## [Version 0.9.4](https://pypi.org/project/pytest-order/0.9.4/) (2021-01-27)
-Patch release to make packaging easier. 
+Patch release to make packaging easier.
 
 ### Infrastructure
 - use codecov instead of coveralls, that is failing
@@ -107,7 +110,7 @@ Patch release to make packaging easier.
 Bugfix release.
 
 ### Fixes
-- fixed handling of more than one attribute in an order marker 
+- fixed handling of more than one attribute in an order marker
 
 ## [Version 0.9.2](https://pypi.org/project/pytest-order/0.9.2/) (2020-11-13)
 Friday the 13th release.
@@ -117,7 +120,7 @@ Friday the 13th release.
   delimiter)
 
 ### Fixes
-- fixed handling of before/after markers in different classes and modules 
+- fixed handling of before/after markers in different classes and modules
 - fixed handling of names in dependencies - did not match the actual
   behavior of `pytest-dependency`
 
@@ -126,7 +129,7 @@ This is a bugfix only release.
 
 ### Fixes
 - fixed handling of relative markers in classes
-- fixed handling of dependencies (could have been added twice) 
+- fixed handling of dependencies (could have been added twice)
 
 ## [Version 0.9.0](https://pypi.org/project/pytest-order/0.9.0/) (2020-11-08)
 This is the last major version that will support Python 2 - Python 2 support
@@ -139,9 +142,9 @@ demand-driven.
 
 ### New features
 - added configuration option for sparse sorting, e.g. the possibility to
-  fill gaps between ordinals with unordered tests (see also 
+  fill gaps between ordinals with unordered tests (see also
   [this issue](https://github.com/ftobia/pytest-ordering/issues/14) in
-  `pytest-ordering`) 
+  `pytest-ordering`)
 - ignore ordering if it would break a dependency defined by the
   `pytest-dependency` plugin
 - experimental: added configuration option for ordering all dependencies
@@ -150,11 +153,11 @@ demand-driven.
 
 ### Fixes
 - correctly handle combined index and dependency attributes
-  
+
 ### Infrastructure
 - added list of open issues in `pytest-ordering` with respective state
-  in `pytest-order` 
- 
+  in `pytest-order`
+
 ## [Version 0.8.1](https://pypi.org/project/pytest-order/0.8.1/) (2020-11-02)
 
 ### New features
@@ -163,16 +166,16 @@ demand-driven.
 
 ## [Version 0.8.0](https://pypi.org/project/pytest-order/0.8.0/) (2020-10-30)
 This release is mostly related to the consolidation of infrastructure
-(documentation build and tests in CI build) and documentation.  
+(documentation build and tests in CI build) and documentation.
 
 ### Fixes
 - fixed the handling of unknown marker attributes (test had been skipped)
 
 ### Infrastructure
-- added automatic documentation build on change 
+- added automatic documentation build on change
 - added Python 3.9, pypy3 and pytest 6.0 and 6.1 to CI builds
 - use GitHub Actions for CI builds to speed them up, added Windows CI builds
-- added regression test for ``pytest-xdist`` 
+- added regression test for ``pytest-xdist``
   (imported from [PR #52](https://github.com/ftobia/pytest-ordering/pull/52))
 
 ## [Version 0.7.1](https://pypi.org/project/pytest-order/0.7.1/) (2020-10-24)
@@ -182,12 +185,12 @@ Update after renaming the repository and the package.
 - renamed repository and package from ``pytest-ordering2`` to ``pytest-order``
 - changed the used marker from ``run`` to ``order``, removed all additional
   markers (see [#38](https://github.com/ftobia/pytest-ordering/issues/38))
-  
+
 ### Documentation
 - use separate documentation pages for release and development versions
 
 ## Version 0.7.0 (2020-10-22)
-Imported version from [pytest-ordering](https://github.com/ftobia/pytest-ordering), 
+Imported version from [pytest-ordering](https://github.com/ftobia/pytest-ordering),
 including some PRs (manually merged).
 Note: this version has been removed from PyPi to avoid confusion with the
 changed name in the next release.

LICENSE

@@ -19,4 +19,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -5,14 +5,14 @@ _pytest-order_ - a pytest plugin to order test execution
 
 `pytest-order` is a pytest plugin that allows you to customize the order in which
 your tests are run. It uses the marker `order` that defines when a specific
-test shall run, either by using an ordinal number, or by specifying the  
-relationship to other tests. 
+test shall run, either by using an ordinal number, or by specifying the
+relationship to other tests.
 
 `pytest-order` is a fork of
 [pytest-ordering](https://github.com/ftobia/pytest-ordering) that provides
 additional features like ordering relative to other tests.
 
-`pytest-order` works with Python 3.7 - 3.11, with pytest 
+`pytest-order` works with Python 3.7 - 3.11, with pytest
 versions >= 5.0.0 for all versions up to Python 3.9, and for pytest >=
 6.2.4 for Python 3.10 and 3.11. `pytest-order` runs on Linux, macOS and Windows.
 
@@ -21,7 +21,7 @@ Documentation
 Apart from this overview, the following information is available:
 - usage documentation for the [latest release](https://pytest-order.readthedocs.io/en/stable/)
 - usage documentation for the [current main branch](https://pytest-order.readthedocs.io/en/latest/)
-- most examples shown in the documentation can also be found in the 
+- most examples shown in the documentation can also be found in the
   [repository](https://github.com/pytest-dev/pytest-order/tree/main/example)
 - the [Release Notes](https://github.com/pytest-dev/pytest-order/blob/main/CHANGELOG.md)
   with a list of changes in the latest versions
@@ -40,13 +40,13 @@ Features
   [order-scope](https://pytest-order.readthedocs.io/en/stable/configuration.html#order-scope) option
 - directory scope ordering via the
   [order-scope-level](https://pytest-order.readthedocs.io/en/stable/configuration.html#order-scope-level) option
-- hierarchical module and class-level ordering via the 
+- hierarchical module and class-level ordering via the
   [order-group-scope](https://pytest-order.readthedocs.io/en/stable/configuration.html#order-group-scope) option
 - ordering tests with `pytest-dependency` markers if using the
-  [order-dependencies](hhttps://pytest-order.readthedocs.io/en/stable/configuration.html#order-dependencies) option, 
+  [order-dependencies](hhttps://pytest-order.readthedocs.io/en/stable/configuration.html#order-dependencies) option,
   more information about `pytest-dependency` compatibility
-  [here](https://pytest-order.readthedocs.io/en/stable/other_plugins.html#relationship-with-pytest-dependency) 
-- sparse ordering of tests via the 
+  [here](https://pytest-order.readthedocs.io/en/stable/other_plugins.html#relationship-with-pytest-dependency)
+- sparse ordering of tests via the
   [sparse-ordering](https://pytest-order.readthedocs.io/en/stable/configuration.html#sparse-ordering) option
 
 Overview
@@ -64,7 +64,7 @@ Install with:
     pip install pytest-order
 
 This defines the ``order`` marker that you can use in your code with
-different attributes. 
+different attributes.
 
 For example, this code:
 
@@ -93,7 +93,7 @@ yields the output:
 
 Contributing
 ------------
-Contributions are very welcome. Tests can be run with 
+Contributions are very welcome. Tests can be run with
 [tox](https://tox.readthedocs.io/en/latest/), please ensure
 the coverage at least stays the same before you submit a pull request.
 
@@ -106,18 +106,18 @@ History
 -------
 This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
 That project is not maintained anymore, and there are several helpful PRs
-that are now integrated into `pytest-order`. The idea and most of the 
+that are now integrated into `pytest-order`. The idea and most of the
 initial code has been created by Frank Tobia, the author of that plugin, and
 [contributors](https://github.com/pytest-dev/pytest-order/blob/main/AUTHORS).
 
 While derived from `pytest_ordering`, `pytest-order` is **not** compatible
 with `pytest-ordering` due to the changed marker name (`order` instead of
-`run`). Additional markers defined `pytest_ordering` are all integrated 
+`run`). Additional markers defined `pytest_ordering` are all integrated
 into the `order` marker (for a rationale see also
 [this issue](https://github.com/ftobia/pytest-ordering/issues/38)).
 
 Ordering relative to other tests and all the configuration options are not
 available in the released version of `pytest-ordering`.
-However, most of these features are derived from or inspired by  
+However, most of these features are derived from or inspired by
 [issues](https://github.com/pytest-dev/pytest-order/blob/main/old_issues.md)
 and pull requests already existing in `pytest-ordering`.

docs/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from typing import List, Dict
 
 # pytest-order documentation build configuration file, created by
@@ -192,10 +191,8 @@
 latex_elements: Dict[str, str] = {
     # The paper size ("letterpaper" or "a4paper").
     # "papersize": "letterpaper",
-
     # The font size ("10pt", "11pt" or "12pt").
     # "pointsize": "10pt",
-
     # Additional stuff for the LaTeX preamble.
     # "preamble": "",
 }