bulklink 0.2.0__tar.gz

bulklink-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bulklink Contributors
+
+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.

bulklink-0.2.0/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: bulklink
+Version: 0.2.0
+Summary: Predictable bulkhead isolation and bounded concurrency for Python asyncio.
+Author: Bulklink Contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/igors93/bulklink
+Project-URL: Repository, https://github.com/igors93/bulklink
+Project-URL: Documentation, https://github.com/igors93/bulklink/tree/main/docs
+Project-URL: Issues, https://github.com/igors93/bulklink/issues
+Project-URL: Changelog, https://github.com/igors93/bulklink/blob/main/CHANGELOG.md
+Keywords: asyncio,bulkhead,concurrency,backpressure,resilience,load-shedding
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.11; extra == "dev"
+Requires-Dist: mypy>=1.15; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+# Bulklink
+
+**Simple admission control. Strong isolation. Predictable behavior under load.**
+
+Bulklink is a small, typed, zero-dependency library for bulkhead isolation and
+bounded concurrency in Python `asyncio` applications.
+
+Current package version: **0.2.0**. The documented `0.2.x` public contract is stable.
+
+</div>
+
+## What problem does it solve?
+
+Without admission control, one slow dependency can attract hundreds of concurrent
+operations, consume connections and memory, and damage unrelated parts of an
+application.
+
+Bulklink creates independent compartments:
+
+```python
+from bulklink import AsyncBulkhead
+
+payments = AsyncBulkhead(
+    label="payments",
+    parallelism=10,
+    waiting_room=50,
+    wait_limit=2.0,
+)
+
+reports = AsyncBulkhead(
+    label="reports",
+    parallelism=2,
+    waiting_room=5,
+)
+```
+
+Slow reports can use at most two execution slots. They cannot consume the ten slots
+reserved for payments.
+
+## Quick start
+
+```python
+async def send_payment(order: object) -> object:
+    async with payments.slot():
+        return await payment_api.send(order)
+```
+
+Or:
+
+```python
+result = await payments.execute(payment_api.send, order)
+```
+
+Reject instead of waiting when immediate capacity is required:
+
+```python
+result = await payments.execute_now(payment_api.send, order)
+```
+
+Use a shorter limit for one call without extending the bulkhead default:
+
+```python
+result = await payments.execute_within(0.25, payment_api.send, order)
+```
+
+Or decorate an async function:
+
+```python
+@payments
+async def send_payment(order: object) -> object:
+    return await payment_api.send(order)
+```
+
+## Behavior
+
+For each bulkhead:
+
+1. up to `parallelism` operations may execute;
+2. up to `waiting_room` operations may wait in FIFO order;
+3. an operation is rejected immediately when both areas are full;
+4. a waiting operation is rejected when `wait_limit` expires;
+5. exceptions and task cancellation release capacity safely;
+6. `close()` rejects queued and future operations without interrupting active work;
+7. `wait_closed()` waits until all active operations have released their slots;
+8. `resize()` changes capacity without cancelling active work or bypassing FIFO order.
+
+## Graceful shutdown
+
+```python
+await payments.close_and_wait()
+```
+
+`close_and_wait()` stops new admission, rejects queued work, and waits for operations
+already running to finish. Cancelling the caller does not cancel protected operations.
+
+
+## Observe state transitions
+
+```python
+from bulklink import BulkheadEvent
+
+
+def record_event(event: BulkheadEvent) -> None:
+    print(event.kind.value, event.in_flight, event.waiting)
+
+
+payments.add_event_handler(record_event)
+```
+
+Handlers are synchronous, run outside the coordinator lock, and receive immutable
+metadata only. They never receive operation arguments, results, or exceptions. Handler
+failures are reported through the event loop exception handler without changing
+bulkhead state.
+
+## Diagnose capacity pressure
+
+```python
+report = await payments.capacity_report()
+
+print(report.summary)
+for finding in report.findings:
+    print(finding.severity.value, finding.message)
+```
+
+The report combines the current snapshot with cumulative admission history. It is
+immutable, conservative with small samples, and never changes the bulkhead
+configuration.
+
+## Change capacity safely
+
+```python
+await payments.resize(20)
+```
+
+Increasing capacity admits queued operations in FIFO order. Reducing capacity never
+cancels active work; existing operations drain naturally before admission resumes at
+the new limit.
+
+## Manage named bulkheads together
+
+```python
+from bulklink import BulkheadRegistry
+
+registry = BulkheadRegistry()
+payments = registry.create("payments", parallelism=10, waiting_room=20)
+reports = registry.create("reports", parallelism=2)
+
+await registry.close_and_wait()
+```
+
+The registry is optional. It enforces unique names, returns immutable ordered snapshots,
+and coordinates shutdown without replacing direct `AsyncBulkhead` usage.
+
+## Designed to coexist with Relinker
+
+Bulklink and Relinker solve different stages:
+
+- **Bulklink** decides whether one operation may start;
+- **Relinker** decides whether a failed operation should be attempted again.
+
+Bulklink deliberately uses `AsyncBulkhead`, `execute()`, `slot()`, and `status()`,
+rather than Relinker's policy, retry, result, budget, `run_async()`, and `snapshot()`
+terminology.
+
+See [Using Bulklink with Relinker](docs/guides/with-relinker.md).
+
+## Non-goals
+
+Bulklink does not provide retries, backoff, jitter, circuit breakers, HTTP-specific
+behavior, requests-per-second limits, or distributed coordination.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+./scripts/ci.sh
+```
+
+## Documentation
+
+- [Documentation index](docs/README.md)
+- [Getting started](docs/guides/getting-started.md)
+- [Using Bulklink with Relinker](docs/guides/with-relinker.md)
+- [Production checklist](docs/guides/production-checklist.md)
+- [Capacity diagnostics](docs/concepts/capacity-diagnostics.md)
+- [Dynamic capacity](docs/concepts/dynamic-capacity.md)
+- [Named bulkhead registry](docs/concepts/registry.md)
+- [Architecture](docs/maintainers/architecture.md)
+
+## License
+
+MIT.
+
+## Validation and benchmarks
+
+The release candidate is checked on Python 3.10 through 3.14 on Linux, with additional
+Windows and macOS validation. The suite includes deterministic race tests, generated
+model-oriented sequences, adversarial stress, executable examples, clean-wheel
+installation, and consumer-facing typing checks.
+
+Run the complete local verification on Linux or macOS:
+
+```bash
+./scripts/ci.sh
+```
+
+Record a local performance baseline without enforcing unstable timing thresholds:
+
+```bash
+python -m benchmarks.run --output benchmark-results.json
+```

bulklink-0.2.0/README.md

@@ -0,0 +1,213 @@
+<div align="center">
+
+# Bulklink
+
+**Simple admission control. Strong isolation. Predictable behavior under load.**
+
+Bulklink is a small, typed, zero-dependency library for bulkhead isolation and
+bounded concurrency in Python `asyncio` applications.
+
+Current package version: **0.2.0**. The documented `0.2.x` public contract is stable.
+
+</div>
+
+## What problem does it solve?
+
+Without admission control, one slow dependency can attract hundreds of concurrent
+operations, consume connections and memory, and damage unrelated parts of an
+application.
+
+Bulklink creates independent compartments:
+
+```python
+from bulklink import AsyncBulkhead
+
+payments = AsyncBulkhead(
+    label="payments",
+    parallelism=10,
+    waiting_room=50,
+    wait_limit=2.0,
+)
+
+reports = AsyncBulkhead(
+    label="reports",
+    parallelism=2,
+    waiting_room=5,
+)
+```
+
+Slow reports can use at most two execution slots. They cannot consume the ten slots
+reserved for payments.
+
+## Quick start
+
+```python
+async def send_payment(order: object) -> object:
+    async with payments.slot():
+        return await payment_api.send(order)
+```
+
+Or:
+
+```python
+result = await payments.execute(payment_api.send, order)
+```
+
+Reject instead of waiting when immediate capacity is required:
+
+```python
+result = await payments.execute_now(payment_api.send, order)
+```
+
+Use a shorter limit for one call without extending the bulkhead default:
+
+```python
+result = await payments.execute_within(0.25, payment_api.send, order)
+```
+
+Or decorate an async function:
+
+```python
+@payments
+async def send_payment(order: object) -> object:
+    return await payment_api.send(order)
+```
+
+## Behavior
+
+For each bulkhead:
+
+1. up to `parallelism` operations may execute;
+2. up to `waiting_room` operations may wait in FIFO order;
+3. an operation is rejected immediately when both areas are full;
+4. a waiting operation is rejected when `wait_limit` expires;
+5. exceptions and task cancellation release capacity safely;
+6. `close()` rejects queued and future operations without interrupting active work;
+7. `wait_closed()` waits until all active operations have released their slots;
+8. `resize()` changes capacity without cancelling active work or bypassing FIFO order.
+
+## Graceful shutdown
+
+```python
+await payments.close_and_wait()
+```
+
+`close_and_wait()` stops new admission, rejects queued work, and waits for operations
+already running to finish. Cancelling the caller does not cancel protected operations.
+
+
+## Observe state transitions
+
+```python
+from bulklink import BulkheadEvent
+
+
+def record_event(event: BulkheadEvent) -> None:
+    print(event.kind.value, event.in_flight, event.waiting)
+
+
+payments.add_event_handler(record_event)
+```
+
+Handlers are synchronous, run outside the coordinator lock, and receive immutable
+metadata only. They never receive operation arguments, results, or exceptions. Handler
+failures are reported through the event loop exception handler without changing
+bulkhead state.
+
+## Diagnose capacity pressure
+
+```python
+report = await payments.capacity_report()
+
+print(report.summary)
+for finding in report.findings:
+    print(finding.severity.value, finding.message)
+```
+
+The report combines the current snapshot with cumulative admission history. It is
+immutable, conservative with small samples, and never changes the bulkhead
+configuration.
+
+## Change capacity safely
+
+```python
+await payments.resize(20)
+```
+
+Increasing capacity admits queued operations in FIFO order. Reducing capacity never
+cancels active work; existing operations drain naturally before admission resumes at
+the new limit.
+
+## Manage named bulkheads together
+
+```python
+from bulklink import BulkheadRegistry
+
+registry = BulkheadRegistry()
+payments = registry.create("payments", parallelism=10, waiting_room=20)
+reports = registry.create("reports", parallelism=2)
+
+await registry.close_and_wait()
+```
+
+The registry is optional. It enforces unique names, returns immutable ordered snapshots,
+and coordinates shutdown without replacing direct `AsyncBulkhead` usage.
+
+## Designed to coexist with Relinker
+
+Bulklink and Relinker solve different stages:
+
+- **Bulklink** decides whether one operation may start;
+- **Relinker** decides whether a failed operation should be attempted again.
+
+Bulklink deliberately uses `AsyncBulkhead`, `execute()`, `slot()`, and `status()`,
+rather than Relinker's policy, retry, result, budget, `run_async()`, and `snapshot()`
+terminology.
+
+See [Using Bulklink with Relinker](docs/guides/with-relinker.md).
+
+## Non-goals
+
+Bulklink does not provide retries, backoff, jitter, circuit breakers, HTTP-specific
+behavior, requests-per-second limits, or distributed coordination.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+./scripts/ci.sh
+```
+
+## Documentation
+
+- [Documentation index](docs/README.md)
+- [Getting started](docs/guides/getting-started.md)
+- [Using Bulklink with Relinker](docs/guides/with-relinker.md)
+- [Production checklist](docs/guides/production-checklist.md)
+- [Capacity diagnostics](docs/concepts/capacity-diagnostics.md)
+- [Dynamic capacity](docs/concepts/dynamic-capacity.md)
+- [Named bulkhead registry](docs/concepts/registry.md)
+- [Architecture](docs/maintainers/architecture.md)
+
+## License
+
+MIT.
+
+## Validation and benchmarks
+
+The release candidate is checked on Python 3.10 through 3.14 on Linux, with additional
+Windows and macOS validation. The suite includes deterministic race tests, generated
+model-oriented sequences, adversarial stress, executable examples, clean-wheel
+installation, and consumer-facing typing checks.
+
+Run the complete local verification on Linux or macOS:
+
+```bash
+./scripts/ci.sh
+```
+
+Record a local performance baseline without enforcing unstable timing thresholds:
+
+```bash
+python -m benchmarks.run --output benchmark-results.json
+```

bulklink-0.2.0/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bulklink"
+version = "0.2.0"
+description = "Predictable bulkhead isolation and bounded concurrency for Python asyncio."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Bulklink Contributors" }]
+keywords = ["asyncio", "bulkhead", "concurrency", "backpressure", "resilience", "load-shedding"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Typing :: Typed",
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2",
+  "pytest>=8.0",
+  "pytest-asyncio>=0.24",
+  "pytest-cov>=5.0",
+  "ruff>=0.11",
+  "mypy>=1.15",
+]
+
+[project.urls]
+Homepage = "https://github.com/igors93/bulklink"
+Repository = "https://github.com/igors93/bulklink"
+Documentation = "https://github.com/igors93/bulklink/tree/main/docs"
+Issues = "https://github.com/igors93/bulklink/issues"
+Changelog = "https://github.com/igors93/bulklink/blob/main/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+bulklink = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+asyncio_mode = "auto"
+addopts = ["--import-mode=importlib"]
+markers = [
+  "stress: deterministic adversarial concurrency tests",
+  "model: generated model-oriented state transition tests",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP", "SIM"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+mypy_path = "src"
+
+[tool.coverage.run]
+branch = true
+source = ["bulklink"]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true
+skip_covered = false

bulklink-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bulklink-0.2.0/src/bulklink/__init__.py

@@ -0,0 +1,43 @@
+"""Stable Bulklink public API."""
+
+from bulklink.bulkhead import AsyncBulkhead
+from bulklink.capacity import (
+    CapacityFinding,
+    CapacityFindingCode,
+    CapacityReport,
+    CapacitySeverity,
+)
+from bulklink.errors import (
+    BulkheadClosedError,
+    BulkheadQueueTimeoutError,
+    BulkheadSaturatedError,
+    BulklinkError,
+)
+from bulklink.events import BulkheadEvent, BulkheadEventHandler, BulkheadEventKind
+from bulklink.registry import (
+    BulkheadRegistry,
+    BulkheadRegistryFailure,
+    BulkheadRegistryOperationError,
+)
+from bulklink.status import BulkheadStatus
+
+__all__ = [
+    "AsyncBulkhead",
+    "CapacityFinding",
+    "CapacityFindingCode",
+    "CapacityReport",
+    "CapacitySeverity",
+    "BulkheadClosedError",
+    "BulkheadEvent",
+    "BulkheadEventHandler",
+    "BulkheadEventKind",
+    "BulkheadQueueTimeoutError",
+    "BulkheadRegistry",
+    "BulkheadRegistryFailure",
+    "BulkheadRegistryOperationError",
+    "BulkheadSaturatedError",
+    "BulkheadStatus",
+    "BulklinkError",
+]
+
+__version__ = "0.2.0"

bulklink-0.2.0/src/bulklink/_internal/__init__.py

@@ -0,0 +1,4 @@
+"""Private Bulklink implementation details.
+
+Nothing in this package is part of the stable public API.
+"""

bulklink-0.2.0/src/bulklink/_internal/cancellation.py

@@ -0,0 +1,34 @@
+"""Helpers for completing critical cleanup during task cancellation."""
+
+from __future__ import annotations
+
+import asyncio
+from collections.abc import Coroutine
+from typing import Any, TypeVar
+
+T = TypeVar("T")
+
+
+async def complete_cleanup(action: Coroutine[Any, Any, T]) -> T:
+    """Finish one cleanup coroutine despite repeated cancellation requests.
+
+    Cancellation is remembered and propagated only after the cleanup task has
+    finished. An exception raised by the cleanup itself takes precedence because
+    it indicates that internal state may not have been restored.
+    """
+    cleanup_task = asyncio.create_task(action)
+    cancellation: asyncio.CancelledError | None = None
+
+    while not cleanup_task.done():
+        try:
+            await asyncio.shield(cleanup_task)
+        except asyncio.CancelledError as error:
+            if cancellation is None:
+                cancellation = error
+
+    result = cleanup_task.result()
+
+    if cancellation is not None:
+        raise cancellation
+
+    return result