Merge branch 'master' into args-kwargs

.flake8

@@ -1,4 +1,5 @@
 [flake8]
+max-line-length = 120
 extend-ignore = E203,C901
 exclude =
     .git,

.github/workflows/checkdocs.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -e ".[test]"
+          python -m pip install -e . -r tests/requirements.txt
       - name: Check Docs
         run: |
           python setup.py checkdocs

.github/workflows/test.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -e ".[test]"
+          python -m pip install -e . -r tests/requirements.txt
       - name: Unit tests
         env:
           CACHIER_TEST_HOST: ${{ secrets.CACHIER_TEST_HOST  }}

.pre-commit-config.yaml

@@ -0,0 +1,73 @@
+default_language_version:
+  python: python3
+
+ci:
+  autofix_prs: true
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit suggestions"
+  autoupdate_schedule: quarterly
+  # submodules: true
+
+repos:
+# todo: let's enable also al these but as separate PR
+#  - repo: https://github.com/pre-commit/pre-commit-hooks
+#    rev: v4.5.0
+#    hooks:
+#      - id: end-of-file-fixer
+#      - id: trailing-whitespace
+#      - id: check-json
+#      - id: check-yaml
+#      - id: check-toml
+#      - id: check-docstring-first
+#      - id: check-executables-have-shebangs
+#      - id: check-case-conflict
+#      - id: check-added-large-files
+#      - id: detect-private-key
+
+# todo: another great hook
+#  - repo: https://github.com/crate-ci/typos
+#    rev: v1.16.26
+#    hooks:
+#      - id: typos
+#        # empty to do not write fixes
+#        args: []
+#        exclude: pyproject.toml
+
+#  - repo: https://github.com/PyCQA/docformatter
+#    rev: v1.7.5
+#    hooks:
+#      - id: docformatter
+#        additional_dependencies: [tomli]
+#        args: ["--in-place"]
+
+#  - repo: https://github.com/psf/black-pre-commit-mirror
+#    rev: 24.1.1
+#    hooks:
+#      - id: black
+#        name: Format code
+#        args:
+#          - "--skip-string-normalization"
+
+# todo: unify formatting all GH actions files
+#  - repo: https://github.com/pre-commit/mirrors-prettier
+#    rev: v3.1.0
+#    hooks:
+#      - id: prettier
+#        # https://prettier.io/docs/en/options.html#print-width
+#        args: ["--print-width=120"]
+
+#  - repo: https://github.com/pre-commit/mirrors-mypy
+#    rev: v1.8.0
+#    hooks:
+#      - id: mypy
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+
+# todo: replacement for flake8
+#  - repo: https://github.com/astral-sh/ruff-pre-commit
+#    rev: v0.1.9
+#    hooks:
+#      - id: ruff
+#        args: ["--fix"]

README.rst

@@ -363,7 +363,7 @@ Install in development mode with test dependencies:
 .. code-block:: bash
 
   cd cachier
-  pip install -e ".[test]"
+  pip install -e . -r tests/requirements.txt
 
 
 Running the tests

setup.py

@@ -14,21 +14,6 @@
 
 import versioneer
 
-TEST_REQUIRES = [
-    # tests and coverages
-    'pytest', 'coverage', 'pytest-cov', 'birch',
-    # linting and code quality
-    'bandit', 'flake8', 'pylint', 'safety',
-    # type checking
-    'mypy', 'types-setuptools', 'pandas-stubs',
-    # to connect to the test mongodb server
-    'pymongo', 'dnspython', 'pymongo-inmemory',
-    # to test pandas dataframe as-param hashing with mongodb core
-    'pandas',
-    # to be able to run `python setup.py checkdocs`
-    'collective.checkdocs', 'pygments',
-]
-
 README_RST = ''
 with open('README.rst') as f:
     README_RST = f.read()
@@ -54,9 +39,6 @@
         'watchdog', 'portalocker',
         'setuptools>=67.6.0',  # to avoid vulnerability in 56.0.0
     ],
-    extras_require={
-        'test': TEST_REQUIRES,
-    },
     platforms=['linux', 'osx', 'windows'],
     keywords=['cache', 'persistence', 'mongo', 'memoization', 'decorator'],
     classifiers=[

tests/requirements.txt

@@ -0,0 +1,15 @@
+# todo: add some version range or pinning latest versions
+# tests and coverages
+pytest
+coverage
+pytest-cov
+birch
+# to connect to the test mongodb server
+pymongo
+dnspython
+pymongo-inmemory
+# to test pandas dataframe as-param hashing with mongodb core
+pandas
+# to be able to run `python setup.py checkdocs`
+collective.checkdocs
+pygments

tests/test_quality.py

@@ -2,14 +2,7 @@
 import subprocess
 
 
-def test_flake8():
-    """Flake8 linter passes with no warnings or errors."""
-    command = ['flake8']
-    parameters = ['--max-line-length=120', 'cachier', 'tests']
-    subprocess.check_call(command + parameters)
-
-
-@pytest.mark.skip
+@pytest.mark.skip  # todo: dead check, so let's replace it with Ruff
 def test_pylint():
     """Pylint linter passes with no warnings or errors."""
     command = ['pylint']

tests/test_security.py

@@ -2,7 +2,7 @@
 import subprocess
 
 
-@pytest.mark.skip
+@pytest.mark.skip  # todo: dead check, so let's replace it with Ruff
 def test_bandit():
     """Bandit security scan passes with no warnings or errors."""
     command = ['bandit']
@@ -12,7 +12,7 @@ def test_bandit():
     subprocess.check_call(command + parameters)
 
 
-@pytest.mark.skip
+@pytest.mark.skip  # todo: dead check, so let's enable it in separate PR within pre-commit
 def test_safety():
     """Safety security scan passes with no warnings or errors."""
     command = ['safety']