general: cleanup/sync CI files/switch to hatch for publishing

Author: karlicoss

.bandit.yml

@@ -6,7 +6,6 @@ on:
     branches: '*'
     tags: 'v[0-9]+.*' # only trigger on 'release' tags for PyPi
     # Ideally I would put this in the pypi job... but github syntax doesn't allow for regexes there :shrug:
-    # P.S. fuck made up yaml DSLs.
   pull_request: # needed to trigger on others' PRs
   # Note that people who fork it need to go to "Actions" tab on their fork and click "I understand my workflows, go ahead and enable them".
   workflow_dispatch: # needed to trigger workflows manually
@@ -31,10 +30,18 @@ jobs:
 
     runs-on: ${{ matrix.platform }}
 
+    # useful for 'optional' pipelines
+    # continue-on-error: ${{ matrix.platform == 'windows-latest' }}
+
     steps:
     # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation
     - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
 
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-depth: 0  # nicer to have all git history when debugging/for tests
+
     - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
@@ -43,11 +50,6 @@ jobs:
       with:
         enable-cache: false  # we don't have lock files, so can't use them as cache key
 
-    - uses: actions/checkout@v4
-      with:
-        submodules: recursive
-        fetch-depth: 0  # nicer to have all git history when debugging/for tests
-
     - uses: mxschmitt/action-tmate@v3
       if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
 
@@ -72,6 +74,10 @@ jobs:
     # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation
     - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
 
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
     - uses: actions/setup-python@v5
       with:
         python-version: '3.10'
@@ -80,10 +86,6 @@ jobs:
       with:
         enable-cache: false  # we don't have lock files, so can't use them as cache key
 
-    - uses: actions/checkout@v4
-      with:
-        submodules: recursive
-
     - name: 'release to test pypi'
       # always deploy merged master to test pypi
       if: github.event_name != 'pull_request' && github.event.ref == 'refs/heads/master'

.github/workflows/main.yml

@@ -179,3 +179,5 @@ dmypy.json
 .pyre/
 
 # End of https://www.gitignore.io/api/python,emacs
+
+untracked/

.gitignore

@@ -16,20 +16,31 @@
    },
    "outputs": [],
    "source": [
-    "from pathlib import Path\n",
-    "import sys; sys.path.insert(0, str(Path('src').absolute()))\n",
-    "import os\n",
-    "cwd =os.getcwd()\n",
+    "from __future__ import annotations\n",
     "\n",
     "import ast\n",
     "import inspect\n",
+    "import sys\n",
+    "from pathlib import Path\n",
     "\n",
     "from IPython.display import Markdown as md\n",
     "\n",
-    "def flink(title: str, name: str=None):\n",
+    "##\n",
+    "sys.path.insert(0, str(Path('src').absolute()))\n",
+    "import cachew  # isort: skip\n",
+    "import cachew.extra  # isort: skip\n",
+    "import cachew.marshall.cachew  # isort: skip\n",
+    "import cachew.tests.test_cachew as tests  # isort: skip\n",
+    "sys.modules['tests'] = tests  # meh\n",
+    "##\n",
+    "\n",
+    "_CWD = Path.cwd()\n",
+    "\n",
+    "\n",
+    "def flink(title: str, name: str | None = None) -> str:\n",
     "    # name is method name\n",
     "    if name is None:\n",
-    "        name = title.replace('`', '') # meh\n",
+    "        name = title.replace('`', '')  # meh\n",
     "    split = name.rsplit('.', maxsplit=1)\n",
     "    if len(split) == 1:\n",
     "        modname = split[0]\n",
@@ -38,7 +49,7 @@
     "        [modname, fname] = split\n",
     "    module = sys.modules[modname]\n",
     "\n",
-    "    file = Path(module.__file__).relative_to(cwd)\n",
+    "    file = Path(module.__file__).relative_to(_CWD)\n",
     "\n",
     "    if fname is not None:\n",
     "        func = module\n",
@@ -50,13 +61,8 @@
     "        numbers = ''\n",
     "    return f'[{title}]({file}{numbers})'\n",
     "\n",
-    "dmd = lambda x: display(md(x.strip()))\n",
     "\n",
-    "import cachew\n",
-    "import cachew.extra\n",
-    "import cachew.marshall.cachew\n",
-    "import cachew.tests.test_cachew as tests\n",
-    "sys.modules['tests'] = tests  # meh"
+    "dmd = lambda x: display(md(x.strip()))"
    ]
   },
   {
@@ -72,10 +78,10 @@
    },
    "outputs": [],
    "source": [
-    "dmd(f'''\n",
+    "dmd('''\n",
     "<!--\n",
     "THIS FILE IS AUTOGENERATED BY README.ipynb.\n",
-    "Ideally you should edit README.ipynb and use 'generate-readme' to produce README.md. \n",
+    "Ideally you should edit README.ipynb and use 'generate-readme' to produce README.md.\n",
     "But it's okay to edit README.md too directly if you want to fix something -- I can run generate-readme myself later.\n",
     "-->\n",
     "''')"
@@ -221,21 +227,21 @@
    "outputs": [],
    "source": [
     "[composite] = [x\n",
-    " for x in ast.walk(ast.parse(inspect.getsource(cachew))) \n",
+    " for x in ast.walk(ast.parse(inspect.getsource(cachew)))\n",
     " if isinstance(x, ast.FunctionDef) and x.name == 'composite_hash'\n",
     "]\n",
     "\n",
-    "link = f'{Path(cachew.__file__).relative_to(cwd)}:#L{composite.lineno}'\n",
+    "link = f'{Path(cachew.__file__).relative_to(_CWD)}:#L{composite.lineno}'\n",
     "\n",
     "dmd(f'''\n",
     "# How it works\n",
     "\n",
-    "- first your objects get {flink('converted', 'cachew.marshall.cachew.CachewMarshall')} into a simpler JSON-like representation \n",
+    "- first your objects get {flink('converted', 'cachew.marshall.cachew.CachewMarshall')} into a simpler JSON-like representation\n",
     "- after that, they are mapped into byte blobs via [`orjson`](https://github.com/ijl/orjson).\n",
     "\n",
     "When the function is called, cachew [computes the hash of your function's arguments ]({link})\n",
     "and compares it against the previously stored hash value.\n",
-    "    \n",
+    "\n",
     "- If they match, it would deserialize and yield whatever is stored in the cache database\n",
     "- If the hash mismatches, the original function is called and new data is stored along with the new hash\n",
     "''')"
@@ -258,17 +264,17 @@
     "types = [f'`{t}`' for t in ['str', 'int', 'float', 'bool', 'datetime', 'date', 'Exception']]\n",
     "dmd(f\"\"\"\n",
     "* automatic schema inference: {flink('1', 'tests.test_return_type_inference')}, {flink('2', 'tests.test_return_type_mismatch')}\n",
-    "* supported types:    \n",
+    "* supported types:\n",
     "\n",
     "    * primitive: {', '.join(types)}\n",
-    "    \n",
+    "\n",
     "      See {flink('tests.test_types')}, {flink('tests.test_primitive')}, {flink('tests.test_dates')}, {flink('tests.test_exceptions')}\n",
     "    * {flink('@dataclass and NamedTuple', 'tests.test_dataclass')}\n",
     "    * {flink('Optional', 'tests.test_optional')} types\n",
     "    * {flink('Union', 'tests.test_union')} types\n",
     "    * {flink('nested datatypes', 'tests.test_nested')}\n",
-    "    \n",
-    "* detects {flink('datatype schema changes', 'tests.test_schema_change')} and discards old data automatically            \n",
+    "\n",
+    "* detects {flink('datatype schema changes', 'tests.test_schema_change')} and discards old data automatically\n",
     "\"\"\")\n",
     "# * custom hash function TODO example with mtime?"
    ]
@@ -302,24 +308,24 @@
    "source": [
     "dmd(f\"\"\"\n",
     "# Using\n",
-    "See {flink('docstring', 'cachew.cachew')} for up-to-date documentation on parameters and return types. \n",
+    "See {flink('docstring', 'cachew.cachew')} for up-to-date documentation on parameters and return types.\n",
     "You can also use {flink('extensive unit tests', 'tests')} as a reference.\n",
-    "    \n",
+    "\n",
     "Some useful (but optional) arguments of `@cachew` decorator:\n",
-    "    \n",
+    "\n",
     "* `cache_path` can be a directory, or a callable that {flink('returns a path', 'tests.test_callable_cache_path')} and depends on function's arguments.\n",
-    "    \n",
+    "\n",
     "   By default, `settings.DEFAULT_CACHEW_DIR` is used.\n",
-    "    \n",
+    "\n",
     "* `depends_on` is a function which determines whether your inputs have changed, and the cache needs to be invalidated.\n",
-    "    \n",
+    "\n",
     "   By default it just uses string representation of the arguments, you can also specify a custom callable.\n",
-    "    \n",
+    "\n",
     "   For instance, it can be used to {flink('discard cache', 'tests.test_custom_hash')} if the input file was modified.\n",
-    "    \n",
+    "\n",
     "* `cls` is the type that would be serialized.\n",
     "\n",
-    "   By default, it is inferred from return type annotations, but can be specified explicitly if you don't control the code you want to cache.    \n",
+    "   By default, it is inferred from return type annotations, but can be specified explicitly if you don't control the code you want to cache.\n",
     "\"\"\")"
    ]
   },
@@ -415,6 +421,7 @@
    "outputs": [],
    "source": [
     "import cachew.extra\n",
+    "\n",
     "dmd(f\"\"\"```python\n",
     "{inspect.getsource(cachew.extra.mcachew)}\n",
     "```\"\"\")"
@@ -442,7 +449,7 @@
     "- `DEFAULT_CACHEW_DIR`: override to set a different base directory. The default is the \"user cache directory\" (see [platformdirs docs](https://github.com/tox-dev/platformdirs?tab=readme-ov-file#example-output)).\n",
     "- `THROW_ON_ERROR`: by default, cachew is defensive and simply attemps to cause the original function on caching issues.\n",
     "   Set to `True` to catch errors earlier.\n",
-    "- `DEFAULT_BACKEND`: currently supported are `sqlite` and `file` (file is somewhat experimental, although should work too). \n",
+    "- `DEFAULT_BACKEND`: currently supported are `sqlite` and `file` (file is somewhat experimental, although should work too).\n",
     "\n",
     "''')"
    ]

README.ipynb

@@ -1,6 +1,6 @@
 <!--
 THIS FILE IS AUTOGENERATED BY README.ipynb.
-Ideally you should edit README.ipynb and use 'generate-readme' to produce README.md. 
+Ideally you should edit README.ipynb and use 'generate-readme' to produce README.md.
 But it's okay to edit README.md too directly if you want to fix something -- I can run generate-readme myself later.
 -->
 
@@ -125,12 +125,12 @@ Cachew gives the best of two worlds and makes it both **easy and efficient**. Th
 
 # How it works
 
-- first your objects get [converted](src/cachew/marshall/cachew.py#L30) into a simpler JSON-like representation 
+- first your objects get [converted](src/cachew/marshall/cachew.py#L30) into a simpler JSON-like representation
 - after that, they are mapped into byte blobs via [`orjson`](https://github.com/ijl/orjson).
 
-When the function is called, cachew [computes the hash of your function's arguments ](src/cachew/__init__.py:#L588)
+When the function is called, cachew [computes the hash of your function's arguments ](src/cachew/__init__.py:#L587)
 and compares it against the previously stored hash value.
-    
+
 - If they match, it would deserialize and yield whatever is stored in the cache database
 - If the hash mismatches, the original function is called and new data is stored along with the new hash
 
@@ -141,16 +141,16 @@ and compares it against the previously stored hash value.
 
 
 * automatic schema inference: [1](src/cachew/tests/test_cachew.py#L387), [2](src/cachew/tests/test_cachew.py#L401)
-* supported types:    
+* supported types:
 
     * primitive: `str`, `int`, `float`, `bool`, `datetime`, `date`, `Exception`
-    
+
       See [tests.test_types](src/cachew/tests/test_cachew.py#L687), [tests.test_primitive](src/cachew/tests/test_cachew.py#L725), [tests.test_dates](src/cachew/tests/test_cachew.py#L637), [tests.test_exceptions](src/cachew/tests/test_cachew.py#L1124)
     * [@dataclass and NamedTuple](src/cachew/tests/test_cachew.py#L602)
     * [Optional](src/cachew/tests/test_cachew.py#L531) types
     * [Union](src/cachew/tests/test_cachew.py#L832) types
     * [nested datatypes](src/cachew/tests/test_cachew.py#L447)
-    
+
 * detects [datatype schema changes](src/cachew/tests/test_cachew.py#L477) and discards old data automatically
 
 
@@ -165,21 +165,21 @@ You can find some of my performance tests in [benchmarks/](benchmarks) dir, and
 
 
 # Using
-See [docstring](src/cachew/__init__.py#L292) for up-to-date documentation on parameters and return types. 
+See [docstring](src/cachew/__init__.py#L292) for up-to-date documentation on parameters and return types.
 You can also use [extensive unit tests](src/cachew/tests/test_cachew.py) as a reference.
-    
+
 Some useful (but optional) arguments of `@cachew` decorator:
-    
+
 * `cache_path` can be a directory, or a callable that [returns a path](src/cachew/tests/test_cachew.py#L424) and depends on function's arguments.
-    
+
    By default, `settings.DEFAULT_CACHEW_DIR` is used.
-    
+
 * `depends_on` is a function which determines whether your inputs have changed, and the cache needs to be invalidated.
-    
+
    By default it just uses string representation of the arguments, you can also specify a custom callable.
-    
+
    For instance, it can be used to [discard cache](src/cachew/tests/test_cachew.py#L119) if the input file was modified.
-    
+
 * `cls` is the type that would be serialized.
 
    By default, it is inferred from return type annotations, but can be specified explicitly if you don't control the code you want to cache.

README.md

@@ -20,6 +20,8 @@
 # resolve_package_path is called from _pytest.pathlib.import_path
 # takes a full abs path to the test file and needs to return the path to the 'root' package on the filesystem
 resolve_pkg_path_orig = _pytest.pathlib.resolve_package_path
+
+
 def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
     result = path  # search from the test file upwards
     for parent in result.parents:
@@ -30,6 +32,8 @@ def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
         if path.name == 'conftest.py':
             return resolve_pkg_path_orig(path)
     raise RuntimeError("Couldn't determine path for ", path)
+
+
 _pytest.pathlib.resolve_package_path = resolve_package_path
 
 
@@ -38,10 +42,14 @@ def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
 # so we need to point it at the absolute path properly
 # not sure what are the consequences.. maybe it wouldn't be able to run against installed packages? not sure..
 search_pypath_orig = _pytest.main.search_pypath
+
+
 def search_pypath(module_name: str) -> str:
     mpath = root_dir / module_name.replace('.', os.sep)
     if not mpath.is_dir():
         mpath = mpath.with_suffix('.py')
         assert mpath.exists(), mpath  # just in case
     return str(mpath)
+
+
 _pytest.main.search_pypath = search_pypath