black and flake8

Author: shaypal5

.github/workflows/ci-test.yml

@@ -22,11 +22,11 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
         os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
-        backend: ["local", "db"]
+        backend: ["local", "mongodb"]
         exclude:
           # ToDo: take if back when the connection become stable
           #  or resolve using `InMemoryMongoClient`
-          - { os: "macOS-latest", backend: "db" }
+          - { os: "macOS-latest", backend: "mongodb" }
     env:
       CACHIER_TEST_HOST: "localhost"
       CACHIER_TEST_PORT: "27017"
@@ -53,21 +53,21 @@ jobs:
         run: pytest -m "not mongo" --cov=cachier --cov-report=term --cov-report=xml:cov.xml
 
       - name: Setup docker (missing on MacOS)
-        if: runner.os == 'macOS' && matrix.backend == 'db'
+        if: runner.os == 'macOS' && matrix.backend == 'mongodb'
         run: |
           brew install docker
           colima start
           # For testcontainers to find the Colima socket
           sudo ln -sf $HOME/.colima/default/docker.sock /var/run/docker.sock
       # ToDo: find a way to cache docker images
       #- name: Cache Container Images
-      #  if: matrix.backend == 'db'
+      #  if: matrix.backend == 'mongodb'
       #  uses: borda/cache-container-images-action@b32a5e804cb39af3c3d134fc03ab76eac0bfcfa9
       #  with:
       #    prefix-key: "mongo-db"
       #    images: mongo:latest
       - name: Start MongoDB in docker
-        if: matrix.backend == 'db'
+        if: matrix.backend == 'mongodb'
         run: |
           # start MongoDB in a container
           docker run -d -p ${{ env.CACHIER_TEST_PORT }}:27017 --name mongodb mongo:latest
@@ -76,7 +76,7 @@ jobs:
           # show running containers
           docker ps -a
       - name: Unit tests (DB)
-        if: matrix.backend == 'db'
+        if: matrix.backend == 'mongodb'
         run: pytest -m "mongo" --cov=cachier --cov-report=term --cov-report=xml:cov.xml
       - name: Speed eval
         run: python tests/speed_eval.py

pyproject.toml

@@ -1,3 +1,5 @@
+# === Metadata & Build System ===
+
 [build-system]
 requires = [
   "setuptools",
@@ -43,12 +45,13 @@ dynamic = [
 ]
 dependencies = [
   "portalocker>=2.3.2",
-  "sqlalchemy>=2",
   "watchdog>=2.3.1",
 ]
 urls.Source = "https://github.com/python-cachier/cachier"
 scripts.cachier = "cachier.__main__:cli"
 
+# --- setuptools ---
+
 [tool.setuptools]
 include-package-data = true
 
@@ -64,6 +67,13 @@ include = [
 ] # package names should match these glob patterns (["*"] by default)
 namespaces = false # to disable scanning PEP 420 namespaces (true by default)
 
+
+# === Linting & Formatting ===
+
+[tool.black]
+line-length = 79
+
+# --- ruff ---
 [tool.ruff]
 target-version = "py38"
 line-length = 79
@@ -128,13 +138,55 @@ lint.unfixable = [
 # Unlike Flake8, default to a complexity level of 10.
 lint.mccabe.max-complexity = 10
 
+# --- pylint ---
+[tool.pylint.'MAIN']
+ignore = ["CVS"]
+load-plugins = ["pylint.extensions.docparams"]
+
+[tool.pylint.'FORMAT']
+good-names = ["x", "y", "X", "inter_X", "inter_y", "post_X", "post_y"]
+
+[tool.pylint.'DESIGN']
+exclude-too-few-public-methods = [".+"]
+
+[tool.pylint.'MESSAGES CONTROL']
+disable = ["R0911", "R0913", "R0903"]
+
+# --- flake8 ---
+[tool.flake8]
+ignore = ["C901", "E203", "W503"]
+exclude = [
+  ".git",
+  ".github",
+  ".pytest_cache",
+  ".venv",
+  ".vim",
+  ".eggs",
+  "__pycache__",
+  "docs",
+  "apidoc",
+  "notebooks",
+  "build",
+  "dist",
+  "versioneer.py",
+  "pdpipe/_version.py",
+  "*/_version.py",
+]
+max-complexity = 10
+max-line-length = 100
+
+# --- docformatter ---
 [tool.docformatter]
 recursive = true
 # some docstring start with r"""
 wrap-summaries = 79
 wrap-descriptions = 79
 blank = true
 
+
+# === Testing ===
+
+# --- pytest ---
 [tool.pytest.ini_options]
 testpaths = [
   "cachier",
@@ -158,6 +210,7 @@ markers = [
   "sql: test the SQL core",
 ]
 
+# --- coverage ---
 [tool.coverage.run]
 branch = true
 # dynamic_context = "test_function"

src/cachier/__init__.py

@@ -1,4 +1,4 @@
-from ._version import *  # noqa: F403
+from ._version import __version__
 from .config import (
     disable_caching,
     enable_caching,
@@ -17,4 +17,5 @@
     "get_global_params",
     "enable_caching",
     "disable_caching",
+    "__version__",
 ]

src/cachier/_version.py

@@ -18,7 +18,9 @@
 def _get_git_sha() -> str:
     from subprocess import DEVNULL, check_output
 
-    out = check_output(["git", "rev-parse", "--short", "HEAD"], stderr=DEVNULL)  # noqa: S603, S607
+    out = check_output(
+        ["git", "rev-parse", "--short", "HEAD"], stderr=DEVNULL
+    )  # noqa: S603, S607
     return out.decode("utf-8").strip()
 
 

src/cachier/core.py

@@ -144,7 +144,8 @@ def cachier(
         object with writing permissions. If unset a local pickle cache is used
         instead.
     sql_engine : str, Engine, or callable, optional
-        SQLAlchemy connection string, Engine, or callable returning an Engine. Used for the SQL backend.
+        SQLAlchemy connection string, Engine, or callable returning an Engine.
+        Used for the SQL backend.
     stale_after : datetime.timedelta, optional
         The time delta after which a cached result is considered stale. Calls
         made after the result goes stale will trigger a recalculation of the

src/cachier/cores/mongo.py

@@ -75,7 +75,9 @@ def get_entry_by_key(self, key: str) -> Tuple[str, Optional[CacheEntry]]:
         )
         if not res:
             return key, None
-        val = pickle.loads(res["value"]) if "value" in res else None  # noqa: S301
+        val = (
+            pickle.loads(res["value"]) if "value" in res else None
+        )  # noqa: S301
         entry = CacheEntry(
             value=val,
             time=res.get("time", None),

src/cachier/cores/sql.py

@@ -20,8 +20,7 @@
     update,
 )
 from sqlalchemy.engine import Engine
-from sqlalchemy.exc import OperationalError
-from sqlalchemy.orm import Session, declarative_base, sessionmaker
+from sqlalchemy.orm import declarative_base, sessionmaker
 
 from .._types import HashFunc
 from ..config import CacheEntry
@@ -71,7 +70,8 @@ def _resolve_engine(self, sql_engine):
         if callable(sql_engine):
             return sql_engine()
         raise ValueError(
-            "sql_engine must be a SQLAlchemy Engine, connection string, or callable returning an Engine."
+            "sql_engine must be a SQLAlchemy Engine, connection string, "
+            "or callable returning an Engine."
         )
 
     def set_func(self, func):
@@ -265,7 +265,7 @@ def clear_being_calculated(self) -> None:
                 .where(
                     and_(
                         CacheTable.function_id == self._func_str,
-                        CacheTable.processing == True,
+                        CacheTable.processing,
                     )
                 )
                 .values(processing=False)

tests/test_general.py

@@ -485,9 +485,9 @@ def fn_minus(a, b=2):
         assert cachier_(dummy_)(1) == expected, f"for {fn.__name__} wrapped"
 
         dummy_ = functools.partial(fn, b=2)
-        assert cachier_(dummy_)(1, b=2) == expected, (
-            f"for {fn.__name__} wrapped"
-        )
+        assert (
+            cachier_(dummy_)(1, b=2) == expected
+        ), f"for {fn.__name__} wrapped"
 
         assert cachier_(fn)(1, 2) == expected, f"for {fn.__name__} inline"
         assert cachier_(fn)(a=1, b=2) == expected, f"for {fn.__name__} inline"