objbase 0.3.0__tar.gz

objbase-0.3.0/.github/dependabot.yml

@@ -0,0 +1,34 @@
+version: 2
+updates:
+  # Keeps the SHA-pinned actions (and their "# vX.Y.Z" comments) up to date.
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      actions:
+        patterns: ["*"] # one PR for all action updates instead of one per action
+    cooldown:
+      default-days: 7 # skip releases younger than a week, in case a compromised version gets pulled
+    commit-message:
+      prefix: ci
+
+  # Keeps uv.lock up to date, so CI tests against current releases.
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly
+    # The >= floors in pyproject.toml are deliberate minimum supported versions
+    # (tested by the "minimum dependency versions" CI job), so leave them alone and
+    # only update the lockfile when a new release already satisfies them.
+    versioning-strategy: increase-if-necessary
+    groups:
+      # Libraries the adapters integrate with; a new release can break an adapter.
+      backends:
+        patterns: ["redis", "pymongo", "pydantic"]
+      dev-tools:
+        patterns: ["*"]
+    cooldown:
+      default-days: 7
+    commit-message:
+      prefix: deps

objbase-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,130 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+  # Lets the release workflow run the full CI before publishing.
+  workflow_call:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint, format and type check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: uv sync --locked
+      - name: Ruff lint
+        run: uv run ruff check --output-format=github .
+      - name: Ruff format
+        if: ${{ !cancelled() }}
+        run: uv run ruff format --check --diff .
+      - name: Mypy (library, strict)
+        if: ${{ !cancelled() }}
+        run: uv run mypy
+      # Also check platform-specific branches (e.g. msvcrt file locking) as Windows would see them.
+      - name: Mypy (library, strict, Windows)
+        if: ${{ !cancelled() }}
+        run: uv run mypy --platform win32
+      # Tests and examples use the public API the way users do, so type checking
+      # them catches annotations that are correct internally but awkward to use.
+      - name: Mypy (tests and examples)
+        if: ${{ !cancelled() }}
+        run: uv run mypy --allow-untyped-defs --allow-incomplete-defs --allow-untyped-calls tests examples
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync --locked
+      # Redis and MongoDB tests use testcontainers; Docker is preinstalled on ubuntu runners.
+      - name: Run tests
+        run: uv run pytest -q
+
+  test-other-os:
+    name: Test (${{ matrix.os }}, no containers)
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: uv sync --locked
+      # Covers platform-specific code such as file locking (fcntl vs msvcrt). These
+      # runners can't run the Linux Redis/MongoDB containers, so those tests are excluded.
+      - name: Run tests
+        run: >-
+          uv run pytest -q -k "not redis and not mongodb"
+          --ignore=tests/test_redis_storage.py
+          --ignore=tests/test_async_redis_storage.py
+          --ignore=tests/test_mongodb_storage.py
+          --ignore=tests/test_async_mongodb_storage.py
+
+  test-minimum-deps:
+    name: Test (minimum dependency versions)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: "3.13"
+      - name: Install package with lowest allowed extras
+        run: |
+          uv venv
+          uv pip install --resolution lowest-direct -e ".[all]"
+          uv pip install pytest pytest-asyncio testcontainers
+          uv pip list | grep -iE "^(redis|pymongo|pydantic) "
+      - name: Run tests
+        run: .venv/bin/pytest -q
+
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+      - name: Build sdist and wheel
+        run: uv build --no-sources
+      - name: Check distribution metadata
+        run: uvx twine check --strict dist/*
+      - name: Check wheel contents
+        run: |
+          unzip -l dist/*.whl | tee wheel-contents.txt
+          grep -q "objbase/py.typed" wheel-contents.txt
+          grep -q "licenses/LICENSE" wheel-contents.txt

objbase-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,158 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+# Actions are pinned to commit SHAs (updated by Dependabot).
+permissions:
+  contents: read
+
+jobs:
+  check-version:
+    name: Check tag matches package version
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      prerelease: ${{ steps.version.outputs.prerelease }}
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: false # never build release artifacts from a cache
+      - name: Compare tag with pyproject.toml version
+        id: version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          version=$(uv version --short)
+          if [[ "${TAG}" != "v${version}" ]]; then
+            echo "::error::Tag ${TAG} does not match the package version ${version} in pyproject.toml (expected v${version})."
+            exit 1
+          fi
+          echo "version=${version}" >> "$GITHUB_OUTPUT"
+          # PEP 440 pre-releases (e.g. 1.0.0a1, 1.0.0b2, 1.0.0rc1, 1.0.0.dev1)
+          if [[ "${version}" =~ (a|b|rc|\.dev)[0-9]+$ ]]; then
+            echo "prerelease=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "prerelease=false" >> "$GITHUB_OUTPUT"
+          fi
+
+  ci:
+    name: CI
+    needs: check-version
+    uses: ./.github/workflows/ci.yml
+
+  build:
+    name: Build distributions
+    needs: [check-version, ci]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: false # never build release artifacts from a cache
+      - name: Build sdist and wheel
+        run: uv build --no-sources
+      - name: Check distribution metadata
+        run: uvx twine check --strict dist/*
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  github-release:
+    name: Create GitHub release
+    needs: [check-version, build]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+      - name: Create release with distributions attached
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.ref_name }}
+          PRERELEASE: ${{ needs.check-version.outputs.prerelease }}
+        run: |
+          flags=()
+          if [[ "${PRERELEASE}" == "true" ]]; then
+            flags+=(--prerelease)
+          fi
+          gh release create "${TAG}" dist/* \
+            --repo "${GITHUB_REPOSITORY}" \
+            --title "${TAG}" \
+            --generate-notes \
+            --verify-tag \
+            "${flags[@]}"
+
+  # A dry run on TestPyPI; if the upload or the install check fails, nothing is published to PyPI.
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs: [check-version, build]
+    runs-on: ubuntu-latest
+    # Trusted publishing, like PyPI below, but configured on test.pypi.org.
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/objbase/${{ needs.check-version.outputs.version }}/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          # TestPyPI rejects re-uploads, so re-running a release whose PyPI step failed would fail here.
+          skip-existing: true
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          enable-cache: false
+          # The minimum supported version (requires-python). Without it uv uses the runner's
+          # system Python, which may be too old to install the package.
+          python-version: "3.13"
+      - name: Install from TestPyPI
+        env:
+          VERSION: ${{ needs.check-version.outputs.version }}
+        # Only TestPyPI is used as the index, which works because the package has no
+        # required dependencies. New uploads can take a minute to appear, so retry.
+        run: |
+          for attempt in 1 2 3 4 5 6; do
+            if uv run --isolated --no-project --no-cache \
+                --index-url https://test.pypi.org/simple/ --with "objbase==${VERSION}" \
+                python -c "import importlib.metadata as m, objbase; assert m.version('objbase') == '${VERSION}'"; then
+              exit 0
+            fi
+            echo "objbase ${VERSION} not installable from TestPyPI yet (attempt ${attempt}), retrying in 20s ..."
+            sleep 20
+          done
+          echo "::error::objbase ${VERSION} could not be installed from TestPyPI."
+          exit 1
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [check-version, publish-testpypi]
+    runs-on: ubuntu-latest
+    # Trusted publishing: configure a publisher for this repository, workflow
+    # (release.yml) and environment on PyPI; no API token is needed.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/objbase/${{ needs.check-version.outputs.version }}/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

objbase-0.3.0/.gitignore

@@ -0,0 +1,169 @@
+.idea/
+
+# Data written by the examples
+data/
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+

objbase-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 fm-labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.