Use pre-commit to manage linters (#675)

Author: ssbarnea

.flake8

@@ -1,5 +1,10 @@
 [flake8]
-extend-ignore = E203, E266, E501, H301, H306
+extend-ignore =
+    E203,
+    E266,
+    E501,
+    H301,
+    H306
 # line length is intentionally set to 80 here because black uses Bugbear
 # See https://github.com/psf/black/blob/master/docs/the_black_code_style.md#line-length for more details
 max-line-length = 80

.github/workflows/tox.yml

@@ -6,7 +6,7 @@ on:
       - "**"
   push:  # only publishes pushes to the main branch to TestPyPI
     branches:  # any integration branch but not tag
-      - "master"
+      - "main"
   pull_request:
   release:
     types:

.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+---
+ci:
+  # format compatible with commitlint
+  autoupdate_commit_msg: "chore: pre-commit autoupdate"
+  autoupdate_schedule: monthly
+  autofix_commit_msg: |
+    chore: auto fixes from pre-commit.com hooks
+
+    for more information, see https://pre-commit.ci
+# exclude: >
+#   (?x)^(
+#   )$
+repos:
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+  - repo: https://github.com/pre-commit/pre-commit-hooks.git
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: fix-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: debug-statements
+        language_version: python3
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        args:
+          # https://github.com/pre-commit/mirrors-isort/issues/9#issuecomment-624404082
+          - --filter-files
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/pycqa/flake8.git
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        language_version: python3
+        additional_dependencies:
+          - flake8-bugbear
+          - flake8-comprehensions
+          - flake8-debugger
+          - flake8-logging-format
+          - flake8-pep3101
+          - flake8-print
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.991
+    hooks:
+      - id: mypy
+        # empty args needed in order to match mypy cli behavior
+        args: []  # [--strict]
+        additional_dependencies:
+          - types-paramiko
+          - types-setuptools
+          - setuptools-scm
+          - alabaster

LICENSE

@@ -173,4 +173,3 @@
       defend, and hold each Contributor harmless for any liability
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
-

MANIFEST.in

@@ -8,6 +8,7 @@ include tox.ini
 include .flake8
 include mypy.ini
 include Makefile
+include *.yaml
 include README.rst CONTRIBUTING.rst CHANGELOG.rst
 include MANIFEST.in
 include ansible.cfg

README.rst

@@ -17,7 +17,7 @@ a plugin to the powerful Pytest_ test engine
 License
 =======
 
-`Apache License 2.0 <https://github.com/pytest-dev/pytest-testinfra/blob/master/LICENSE>`_
+`Apache License 2.0 <https://github.com/pytest-dev/pytest-testinfra/blob/main/LICENSE>`_
 
 The logo is licensed under the `Creative Commons NoDerivatives 4.0 License <https://creativecommons.org/licenses/by-nd/4.0/>`_
 If you have some other use in mind, contact us.
@@ -30,7 +30,7 @@ Install testinfra using pip::
     $ pip install pytest-testinfra
 
     # or install the devel version
-    $ pip install 'git+https://github.com/pytest-dev/pytest-testinfra@master#egg=pytest-testinfra'
+    $ pip install 'git+https://github.com/pytest-dev/pytest-testinfra@main#egg=pytest-testinfra'
 
 
 Write your first tests file to `test_myinfra.py`:

dev-requirements.txt

@@ -1,4 +1,3 @@
 sphinx>=1.3
 alabaster>=0.7.2
-hacking>=4.0
 .

doc/source/conf.py

@@ -21,11 +21,11 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import os
-import sys
-
 import datetime
+import os
 import subprocess
+import sys
+from typing import Dict, List
 
 import alabaster
 
@@ -92,7 +92,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns: List[str] = []
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -222,7 +222,7 @@
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
+latex_elements: Dict[str, tuple] = {
     # The paper size ('letterpaper' or 'a4paper')
     # 'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').

doc/source/examples.rst

@@ -137,7 +137,7 @@ Integration with KitchenCI
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 KitchenCI (aka Test Kitchen) can use testinfra via its :code:`shell` verifier.
-Add the following to your :code:`.kitchen.yml`, this requires installing `paramiko` 
+Add the following to your :code:`.kitchen.yml`, this requires installing `paramiko`
 additionally (on your host machine, not in the VM handled by kitchen) ::
 
     verifier:

images/alpine/Dockerfile

@@ -12,5 +12,3 @@ RUN apk add --update --no-cache python3 openrc openssh && \
 
 EXPOSE 22
 CMD ["/sbin/init"]
-
-