alternative 0.1.0__tar.gz

alternative-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v1
+
+      - name: Install dependencies
+        run: |
+          uv sync --dev
+          uv tool install ruff
+          uv tool install pyrefly
+          uv tool install mypy
+
+      - name: Ruff format check
+        run: uv run --dev ruff format --check --diff .
+        continue-on-error: true
+
+      - name: Type check
+        run: |
+          uv run --dev pyrefly check .
+          uv run --dev mypy .
+        continue-on-error: true
+
+      - name: Run tests
+        run: |
+          # Some GitHub-hosted runners export PYTEST_DISABLE_PLUGIN_AUTOLOAD=1.
+          # Unset it so pytest can discover pytest-cov and pytest-benchmark via entry points,
+          # which are required by the addopts configured in pyproject.toml.
+          unset PYTEST_DISABLE_PLUGIN_AUTOLOAD
+          uv run --dev pytest -vv --cov=alternative --cov-report=xml --junitxml=test-results.xml
+
+      - name: Upload coverage to Codecov
+        if: always() && env.CODECOV_TOKEN != ''
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ env.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          fail_ci_if_error: true
+
+      - name: Upload test results to Codecov
+        if: always() && env.CODECOV_TOKEN != ''
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ env.CODECOV_TOKEN }}
+          files: ./test-results.xml
+          report_type: test_results
+          fail_ci_if_error: true
+

alternative-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/alternative
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build
+      # the publishing uses PyPI's trusted publishing, so configured on pypi instead of using secrets
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

alternative-0.1.0/.gitignore

@@ -0,0 +1,194 @@
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

alternative-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

alternative-0.1.0/AGENTS.md

@@ -0,0 +1,5 @@
+The repository defines testing via GitHub actions. When contributing:
+
+* Run the same steps locally that the workflow performs. This includes running `uv run --dev pytest`, `uv run --dev ruff format --check .`, `pyrefly check .`, and `mypy .`.
+* Ensure code is formatted with `ruff format` before committing.
+* Name tests and functions in `snake_case` and give them triple-quoted docstrings similar to the current codebase.

alternative-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: alternative
+Version: 0.1.0
+Summary: A library to help with the management of alternative implementations of functions
+Author-email: Oliver Bristow <evilumbrella+github@gmail.com>
+Requires-Python: >=3.12
+Requires-Dist: pytest>=8.3.5
+Description-Content-Type: text/markdown
+
+[![PyPi Package](https://badge.fury.io/py/alternative.svg)](https://pypi.org/project/alternative/) [![Build Status](https://github.com/Code0x58/alternative/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Code0x58/alternative/actions/workflows/ci.yml) [![Coverage Report](https://codecov.io/gh/Code0x58/alternative/branch/master/graph/badge.svg)](https://codecov.io/gh/Code0x58/alternative)
+
+This is a library to help with the management of alternative implementations of functions, as you may have when
+optimising.
+
+```python
+import alternative
+
+
+@alternative.reference
+def constant_number():
+    return 1
+
+
+@constant_number.add(default=True)
+def alternative_constant_number():
+    return 2
+
+
+@constant_number.add
+def unused_alternative_constant_number():
+    return 3
+
+
+# the reference implementation is substituted with the default implementation - if no default was specified, the reference would have been used
+assert constant_number() == 2
+# alternative implementations still act like themselves
+assert unused_alternative_constant_number() == 3
+
+# TODO: mash in measure + benchmark + equality tests from examples
+```
+
+The library tries to avoid unpleasant surprises that may come from import orders or maintenance issues:
+ * the implementation that is used cannot be changed once it has been used
+ * implementations cannot be added once they have been inspected: reduces the changes of tests only covering a subset of 
+
+Running with `ALTERNATIVE_DEBUG=1` as an environment variable will result in the library recording which lines were
+responsible for critical state changes like the point that a default implementation was selected or the implementations
+were inspected. These are then used in error messages which can be used to resolve stateful issues.
+
+For how this can tie in with equivalence checks and benchmarking in pytest, see the examples directory.

alternative-0.1.0/README.md

@@ -0,0 +1,41 @@
+[![PyPi Package](https://badge.fury.io/py/alternative.svg)](https://pypi.org/project/alternative/) [![Build Status](https://github.com/Code0x58/alternative/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Code0x58/alternative/actions/workflows/ci.yml) [![Coverage Report](https://codecov.io/gh/Code0x58/alternative/branch/master/graph/badge.svg)](https://codecov.io/gh/Code0x58/alternative)
+
+This is a library to help with the management of alternative implementations of functions, as you may have when
+optimising.
+
+```python
+import alternative
+
+
+@alternative.reference
+def constant_number():
+    return 1
+
+
+@constant_number.add(default=True)
+def alternative_constant_number():
+    return 2
+
+
+@constant_number.add
+def unused_alternative_constant_number():
+    return 3
+
+
+# the reference implementation is substituted with the default implementation - if no default was specified, the reference would have been used
+assert constant_number() == 2
+# alternative implementations still act like themselves
+assert unused_alternative_constant_number() == 3
+
+# TODO: mash in measure + benchmark + equality tests from examples
+```
+
+The library tries to avoid unpleasant surprises that may come from import orders or maintenance issues:
+ * the implementation that is used cannot be changed once it has been used
+ * implementations cannot be added once they have been inspected: reduces the changes of tests only covering a subset of 
+
+Running with `ALTERNATIVE_DEBUG=1` as an environment variable will result in the library recording which lines were
+responsible for critical state changes like the point that a default implementation was selected or the implementations
+were inspected. These are then used in error messages which can be used to resolve stateful issues.
+
+For how this can tie in with equivalence checks and benchmarking in pytest, see the examples directory.