Add precommit hooks

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# where are the environments stored https://stackoverflow.com/a/62539529
+# inspired by https://github.com/pronovic/apologies
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+        files:  '.*\.(py|rst|json|yaml)'
+    -   id: end-of-file-fixer
+        files:  '.*\.(py|rst|json|yaml)'
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: local
+    hooks:
+      - id: system
+        name: Black
+        entry: poetry run black src tests
+        pass_filenames: false
+        language: system
+-   repo: local
+    hooks:
+      - id: system
+        name: isort
+        entry: poetry run isort src --profile black
+        pass_filenames: false
+        language: system
+# -   repo: local
+#     hooks:
+#       - id: system
+#         name: Safety
+#         entry: poetry run safety check
+#         pass_filenames: false
+#         language: system
+
+# Disabled until mypy support structural pattern matching
+# -   repo: local
+#     hooks:
+#       - id: system
+#         name: MyPy
+#         entry: poetry run mypy -p design_by_contract
+#         pass_filenames: false
+#         language: system
+-   repo: local
+    hooks:
+      - id: system
+        name: Pylint
+        entry: poetry run pylint -j0 design_by_contract --disable=R,C,W
+        pass_filenames: false
+        language: system

Readme.md

@@ -147,6 +147,9 @@ Note that evaluation is not optimized. In production, you might consider disabli
   * [x] Tested with pytest
   * [x] Type annotations
   * [x] code formatted ([black](https://github.com/psf/black)), linted ([pylint](https://pylint.org/)). Linting with [mypy](http://www.mypy-lang.org/) does not support pattern matching yet.
+  * [x] GitHub action for GitHub pages
+  * [ ] GitHub action for linting and formatting
+  * [x] Precommit for linting and formatting
 * [ ] Speed. Well.. maybe. I haven't tested it yet.
 
 ## Why?

pyproject.toml

@@ -30,6 +30,7 @@ pytest = "^6.2.5"
 ipykernel = "^6.9.1"
 sphinx-book-theme = "^0.2.0"
 myst-parser = "^0.17.0"
+pre-commit = "^2.17.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

src/design_by_contract.py

@@ -1,7 +1,8 @@
-from dataclasses import dataclass
 import logging
+from dataclasses import dataclass
 from inspect import get_annotations, getfullargspec
-from typing import Annotated, Callable, Any, TypeVar, ParamSpec, Optional
+from typing import Annotated, Any, Callable, Optional, ParamSpec, TypeVar
+
 from decorator import decorator
 
 logger = logging.getLogger(__name__)
@@ -124,7 +125,9 @@ def evaluate_annotations(annotations: dict[str, Any]) -> None:
                                     raise ContractViolationError(f"Contract violated for argument: `{arg_name}`")
 
                                 if any([i.value is None for i in symbols.values()]):
-                                    raise ContractLogicError(f"Not all symbols were resolved `{symbols}`", )
+                                    raise ContractLogicError(
+                                        f"Not all symbols were resolved `{symbols}`",
+                                    )
 
                                 injectables |= {k: v.value for k, v in symbols.items()}