Add pre-commit config (#1406)

Author: alexrudd2

.github/workflows/ci.yml

@@ -37,11 +37,8 @@ jobs:
           - name: flake8
             cmd: flake8
             type: lint
-          - name: isort
-            cmd: isort --check .
-            type: lint
-          - name: black
-            cmd: black --check --safe --quiet examples/ pymodbus/ test/
+          - name: precommit (isort and black)
+            cmd: pre-commit run --all-files
             type: lint
           - name: docs
             cmd: make -C doc/ html

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    # -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        exclude: ^(doc/_build|venv|.venv|.git|pymodbus/client/serial_asyncio)
+-   repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+    -   id: black
+        args: [--safe,--quiet]
+        files: (examples|pymodbus|test)/

README.rst

@@ -224,7 +224,9 @@ Then:
 
    pip install -e .
 
-This installs pymodbus in your virtual environment with pointers directly to the pymodbus directory, so any change you make is immediately available as if installed.
+   pre-commit --install
+
+This installs pymodbus in your virtual environment with pointers directly to the pymodbus directory, so any change you make is immediately available as if installed.  It will also install `pre-commit` git hooks.
 
 Either method will install all the required dependencies
 (at their appropriate versions) for your current python distribution.

TODO_add_checks

@@ -1,6 +1,2 @@
-1) add .pre-commit and commit-hook
-
-2) new checks
+New checks
 - prettier
-- mypy
-

check_ci.sh

@@ -6,8 +6,7 @@ trap 'echo "\"${last_command}\" command filed with exit code $?."' EXIT
 
 
 codespell
-black --safe --quiet examples/ pymodbus/ test/
-isort .
+pre-commit run --all-files
 pylint --recursive=y examples pymodbus test
 flake8
 mypy pymodbus

examples/v2.5.3/rx_messages

@@ -88,7 +88,7 @@
 # Modbus RTU Messages
 # ------------------------------------------------------------
 # [Address ][ Function Code] [ Data ][ CRC ]
-#  1b         1b               Nb      2b   
+#  1b         1b               Nb      2b
 #
 # ./message-parser -b -p rtu -f messages
 # ------------------------------------------------------------

examples/v2.5.3/tx_messages

@@ -88,7 +88,7 @@
 # Modbus RTU Messages
 # ------------------------------------------------------------
 # [Address ][ Function Code] [ Data ][ CRC ]
-#  1b         1b               Nb      2b   
+#  1b         1b               Nb      2b
 #
 # ./message-parser -b -p rtu -f messages
 # ------------------------------------------------------------

pymodbus/repl/client/main.py

@@ -231,7 +231,7 @@ def _(event):
             continue  # Control-C pressed. Try again.
         except EOFError:
             break  # Control-D pressed.
-        except Exception as exc:  # Handle all other exceptions pylint: disable=broad-except
+        except Exception as exc:  # pylint: disable=broad-except
             click.secho(str(exc), fg="red")
 
     click.secho("GoodBye!", fg="blue")

requirements.txt

@@ -52,15 +52,14 @@ sphinx-rtd-theme==1.1.1
 # -------------------------------------------------------------------
 # install:development
 bandit==1.7.4
-black==22.12.0
 codespell==2.2.2
 coverage==7.1.0
 flake8==6.0.0
 flake8-docstrings==1.7.0
 flake8-noqa==1.3.0
 flake8-comprehensions==3.10.1
-isort==5.11.4
 mypy==1.0.1
+pre-commit==3.1.1
 pyflakes==3.0.1
 pydocstyle==6.3.0
 pycodestyle==2.10.0