engin 0.2.0__tar.gz → 0.2.1__tar.gz

{engin-0.2.0 → engin-0.2.1}/PKG-INFO

@@ -1,21 +1,20 @@
 Metadata-Version: 2.4
 Name: engin
-Version: 0.2.0
+Version: 0.2.1
 Summary: A dependency-injection powered application framework
-Project-URL: Homepage, https://github.com/invokermain/engin
-Project-URL: Documentation, https://engin.readthedocs.io/en/latest/
-Project-URL: Repository, https://github.com/invokermain/engin.git
-Project-URL: Changelog, https://github.com/invokermain/engin/blob/main/CHANGELOG.md
+Keywords: Dependency Injection,Application Framework
 License-Expression: MIT
-License-File: LICENSE
-Keywords: Application Framework,Dependency Injection
-Requires-Python: >=3.10
 Requires-Dist: anyio>=4
 Requires-Dist: exceptiongroup>=1
 Requires-Dist: typing-extensions>=4
+Requires-Dist: typer>=0.15 ; extra == 'cli'
+Requires-Dist: tomli>=2.0 ; python_full_version < '3.11' and extra == 'cli'
+Requires-Python: >=3.10
+Project-URL: Changelog, https://github.com/invokermain/engin/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://engin.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/invokermain/engin
+Project-URL: Repository, https://github.com/invokermain/engin.git
 Provides-Extra: cli
-Requires-Dist: tomli>=2.0; (python_version < '3.11') and extra == 'cli'
-Requires-Dist: typer>=0.15; extra == 'cli'
 Description-Content-Type: text/markdown
 
 # Engin 🏎️
@@ -30,8 +29,8 @@ Description-Content-Type: text/markdown
 
 ---
 
-Engin is a lightweight application framework powered by dependency injection, it helps
-you build and maintain large monoliths and many microservices.
+Engin is a lightweight application framework powered by dependency injection. It helps
+you build and maintain everything from large monoliths to hundreds of microservices.
 
 
 ## Features

{engin-0.2.0 → engin-0.2.1}/README.md

@@ -10,8 +10,8 @@
 
 ---
 
-Engin is a lightweight application framework powered by dependency injection, it helps
-you build and maintain large monoliths and many microservices.
+Engin is a lightweight application framework powered by dependency injection. It helps
+you build and maintain everything from large monoliths to hundreds of microservices.
 
 
 ## Features

{engin-0.2.0 → engin-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "engin"
-version = "0.2.0"
+version = "0.2.1"
 description = "A dependency-injection powered application framework"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -56,8 +56,8 @@ docs = [
 default-groups = ["dev", "docs"]
 
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["uv_build"]
+build-backend = "uv_build"
 
 
 [tool.ruff]

{engin-0.2.0 → engin-0.2.1}/src/engin/_block.py

@@ -10,6 +10,8 @@ from engin.exceptions import InvalidBlockError
 if TYPE_CHECKING:
     from engin._engin import Engin
 
+_BUILTIN_CLASS_FUNCTIONS = ("__annotate_func__",)
+
 
 def provide(
     func_: Func | None = None, *, scope: str | None = None, override: bool = False
@@ -84,6 +86,8 @@ class Block:
     @classmethod
     def _method_options(cls) -> Iterable[Provide | Invoke]:
         for name, method in inspect.getmembers(cls, inspect.isfunction):
+            if name in _BUILTIN_CLASS_FUNCTIONS:
+                continue
             if option := getattr(method, "_opt", None):
                 if not isinstance(option, Provide | Invoke):
                     raise InvalidBlockError(

engin-0.2.0/.github/workflows/benchmark.yaml

@@ -1,41 +0,0 @@
-name: Benchmark Main
-
-on:
-  push:
-
-env:
-  UV_FROZEN: "1"
-
-jobs:
-  benchmark-main:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-        with:
-          enable-cache: true
-          cache-dependency-glob: "uv.lock"
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version-file: "pyproject.toml"
-
-      - name: Install the project
-        run: uv sync --dev
-
-      - name: Run benchmark
-        run: |
-          uv run pytest tests --benchmark-only --benchmark-json bench.json
-
-      - name: Store benchmark result
-        uses: benchmark-action/github-action-benchmark@v1
-        if: contains('refs/heads/main', github.ref)
-        with:
-          tool: 'pytest'
-          output-file-path: bench.json
-          github-token: ${{ secrets.PAT }}
-          auto-push: true

engin-0.2.0/.github/workflows/check.yaml

@@ -1,51 +0,0 @@
-name: Check
-
-on:
-  push:
-
-env:
-  UV_FROZEN: "1"
-
-jobs:
-  check:
-    name: python
-
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
-
-    runs-on: ${{ matrix.os }}
-
-    permissions:
-      id-token: write
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-        with:
-          enable-cache: true
-          cache-dependency-glob: "uv.lock"
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install the project
-        run: uv sync --all-extras --dev
-
-      - name: Quality
-        run: uv run poe check
-
-      - name: Test
-        run: uv run poe ci-test
-
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          flags: ${{ matrix.os }},py${{ matrix.python-version }}
-          name: codecov-${{ matrix.os }}-py${{ matrix.python-version }}

engin-0.2.0/.github/workflows/publish.yaml

@@ -1,34 +0,0 @@
-name: Publish
-
-on:
-  workflow_dispatch:
-  release:
-    types: [created]
-
-jobs:
-  publish-to-pypi:
-    name: python
-    runs-on: ubuntu-latest
-
-    permissions:
-      id-token: write
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-        with:
-          enable-cache: true
-          cache-dependency-glob: "uv.lock"
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version-file: "pyproject.toml"
-
-      - name: Build the Project
-        run: uv build
-
-      - name: Publish
-        run: uv publish

engin-0.2.0/.gitignore

@@ -1,167 +0,0 @@
-# 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/
-
-# Python local version specifier
-.python-version
-
-# 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/
-
-scrap/**

engin-0.2.0/.readthedocs.yaml

@@ -1,25 +0,0 @@
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the OS, Python version, and other tools you might need
-build:
-  os: ubuntu-24.04
-  tools:
-    python: "3.13"
-  jobs:
-    create_environment:
-       - asdf plugin add uv
-       - asdf install uv latest
-       - asdf global uv latest
-       - uv venv
-    install:
-       - uv sync --group docs
-    build:
-       html:
-          - NO_COLOR=1 uv run mkdocs build -f mkdocs.yaml --strict --site-dir $READTHEDOCS_OUTPUT/html
-
-mkdocs:
-  configuration: mkdocs.yaml

engin-0.2.0/CHANGELOG.md

@@ -1,283 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.2.0] - 2025-09-15
-
-### Added
-
-- `Supervisor` now has a shutdown hook option for supervised tasks.
-
-### Changed
-
-- `Provide` now raises a helpful error message when it is called with a static value
-  suggesting to use `Supply` instead.
-- Tests are now ran against all support Python versions and operating systems.
-- Improved signal handling code for Windows OS and added handler for SIGBREAK.
-
-### Fixed
-
-- Replaced Python 3.10 unsupported `typing` imports with imports from `typing_extensions`.
-
-
-## [0.1.0] - 2025-08-16
-
-### Added
-
-- `Supervisor` class which can safely supervise long running tasks.
-- A new cli option `engin check` that validates whether you have any missing providers. 
-- Support for specifying `default-instance` in your `pyproject.toml` under `[tool.engin]`
-  which is used as a default value for the `app` parameter when using the cli.
-- A new exception class: `TypeNotProvidedError`.
-
-### Changed
-
-- If a Provider is missing during Assembly, the Assembler now raises `TypeNotProvidedError`
-  instead of a `LookupError`.
-- `engin graph` has improved visualisations and options.
-- `engin check` does not list all available providers anymore.
-
-
-## [0.0.20] - 2025-06-18
-
-### Changed
-
-- Improved string representation of Provide & Supply to make error messages more helpful.
-
-### Fixed
-
-- Engin now correctly supports postponed evaluation of annotations, e.g. `x: "MyType"` in
-  a factory function.
-
-
-## [0.0.19] - 2025-04-27
-
-### Added
-
-- A new exception: `InvalidBlockError`.
-
-### Changed
-
-- Improved performance of Provide & Assembler by a factor of >2x (in certain scenarios).
-- Renamed the `ext` subpackage to `extensions`.
-- Errors are now imported from `engin.exceptions.*` instead of `engin.*`
-- Blocks will now raise an `InvalidBlockError` if the block has methods which are not
-  decorated with `@provide` & `@invoke`.
-
-### Fixed
-
-- `Assembler.add` incorrect cache invalidation logic.
-
-
-## [0.0.18] - 2025-04-25
-
-### Added
-
-- A new cli option `engin inspect` that can be used to inspect providers, e.g.
-  `engin inspect examples.simple.main:engin --module httpx`
-
-
-## [0.0.17] - 2025-04-20
-
-### Added
-
-- `Provide` now has the `as_type` parameter that `Supply` had previously.
-
-### Changed
-
-- Renamed `parameter_types` property on dependencies to `parameter_type_ids` to be more
-  explicit.
-
-
-## [0.0.16] - 2025-04-16
-
-### Added
-
-- Preliminary support for scoped providers. Scoped providers are only accessible when
-  the assembler is in the matching scope, and the built output is only cached until the
-  assembler leaves the matching scope. This can be used for example to have request scoped
-  providers in a Web Server.
-
-### Changed
-
-- Minor improvements to the work-in-progress dependency grapher.
-
-
-## [0.0.15] - 2025-03-25
-
-### Changed
-
-- `Provide` & `Supply` will now raise an error if overriding an existing provider from the
-  same package. This is to prevent accidental overrides. Users can explicitly allow
-  overrides by specifying the `override` parameter when defining the provider
-  `Provide(..., override=True)` or `@provide(override=True)`.
-- Lifecycle startup tasks will now timeout after 15 seconds and raise an error.
-- Assembler's `get` method has been renamed to `build`.
-- Supply's `type_hint` parameter has been renamed to `as_type`.
-
-### Fixed
-
-- `Assembler` would occasionally fail to call all multiproviders due to inconsistent
-  ordering.
-
-
-## [0.0.14] - 2025-03-23
-
-### Added
-
-- `LifecycleHook` class to help build simple lifecycles with a start and stop call.
-
-### Changed
-
-- `engin-graph` has been replaced by `engin graph`.
-- Engin now uses `typer` for an improved cli experience. Note the package now has an extra `cli` which must be installed to use the cli.
-- `Assembler.add(...)` does not error when adding already registered providers.
-- Use a more performant algorithm for inspecting frame stack.
-
-### Fixed
-
-- `ASGIEngin` now properly surfaces startup errors.
-- `Engin.run()` doing a double shutdown.
-
-
-## [0.0.13] - 2025-03-22
-
-### Changed
-
-- `Provide` now supports union types.
-
-
-## [0.0.12] - 2025-03-03
-
-### Added
-
-- `Assembler` has a new method `add(provider: Provide) -> None` which allows adding a
-  provider to the Assembler post initialisation.
-
-### Changed
-
-- `Provide` now raises a `ValueError` if the factory function is circular, i.e. one of its
-  parameters is the same as its return type as the behaviour of this is undefined.
-- The ASGI utility method `engin_to_lifespan` has been improved so that it works "out of
-  the box" for more use cases now.
-
-
-## [0.0.11] - 2025-03-02
-
-### Added
-
-- Dependency types now have two new attributes `source_module` & `source_package`.
-
-### Changed
-
-- `engin-graph` now highlights external dependencies.
-
-
-## [0.0.10] - 2025-02-27
-
-### Added
-
-- A utility function for ASGI extension `engin_to_lifespan` enabling users to easily
-  integrate Engin into an existing ASGI application.
-- Further documentation work, including a FastAPI guide.
-
-### Fixed
-
-- The warning for missing multiproviders is only logged once for each given type now.
-
-
-## [0.0.9] - 2025-02-22
-
-### Added
-
-- Dependency class now has a new attribute: `func_name`.
-
-### Changed
-
-- Improved `engin-graph` output.
-- The `module` attribute of dependencies has been renamed to `origin`
-
-### Fixed
-
-- Options provided under the `options` on a Block now have the `block_name` set.
-
-
-## [0.0.8] - 2025-02-22
-
-### Added
-
-- A package script, `engin-graph` for visualising the dependency graph.
-
-
-## [0.0.7] - 2025-02-20
-
-### Changed
-
-- TypeId retains Annotations allowing them to be used to discriminate otherwise identical
-  types.
-
-
-## [0.0.6] - 2025-02-19
-
-### Fixed
-
-- Engin now respects intended multiproviders behaviour instead of treating them as normal
-  providers and overwriting existing multiproviders for that type.
-- `Engin.shutdown()` does not block if shutdown is called before startup, or after aborted
-  startup.
-
-
-## [0.0.5] - 2025-01-29
-
-### Added
-
-- Docstrings for every public class, method and function.
-
-### Changed
-
-- AssemblyError has been renamed to ProviderError.
-- Lifecycle now supports synchronous Context Managers.
-
-
-## [0.0.4] - 2025-01-27
-
-### Changed
-
-- Invocations, startups tasks and shutdown tasks are now all run sequentially.
-- Improved error handling, if an Invocation errors, or a Lifecycle startup tasks errors
-  then the Engin will exit. Whilst errors in shutdown tasks are logged and ignored. 
-- Improved error messaging when Invocations or Lifecycle tasks error.
-- Removed non-public methods from the Lifecycle class, and renamed `register_context` to
-  `append`.
-
-
-## [0.0.3] - 2025-01-15
-
-### Added
-
-- Blocks can now provide options via the `options` class variable. This allows packaged
-  Blocks to easily expose Providers and Invocations as normal functions whilst allowing
-  them to be part of a Block as well. This makes usage of the Block optional which makes
-  it more flexible for end users.
-- Added missing type hints and enabled mypy strict mode.
-
-### Fixed
-
-- Engin now performs Lifecycle shutdown.
-
-
-## [0.0.2] - 2025-01-10
-
-### Added
-
-- The `ext` sub-package is now explicitly exported in the package `__init__.py`
-
-
-## [0.0.1] - 2024-12-12
-
-### Added
-
-- Initial release