bulkman 1.0.3__py3-none-any.whl

bulkman/__init__.py

@@ -0,0 +1,35 @@
+"""
+Bulkman - Bulkhead Pattern Implementation with Trio
+
+A robust implementation of the Bulkhead pattern for isolating resources
+and preventing cascading failures in distributed systems.
+Built on Trio for structured concurrency and resilient_circuit for circuit breaking.
+"""
+
+from bulkman.config import BulkheadConfig, ExecutionResult
+from bulkman.core import Bulkhead, BulkheadManager
+from bulkman.exceptions import (
+    BulkheadCircuitOpenError,
+    BulkheadError,
+    BulkheadFullError,
+    BulkheadIsolationError,
+    BulkheadTimeoutError,
+)
+from bulkman.state import BulkheadState
+from bulkman.sync_bridge import BulkheadSync
+
+__version__ = "1.0.3"
+
+__all__ = [
+    "Bulkhead",
+    "BulkheadSync",
+    "BulkheadConfig",
+    "BulkheadManager",
+    "BulkheadState",
+    "BulkheadError",
+    "BulkheadCircuitOpenError",
+    "BulkheadFullError",
+    "BulkheadIsolationError",
+    "BulkheadTimeoutError",
+    "ExecutionResult",
+]

bulkman/config.py

@@ -0,0 +1,63 @@
+"""Configuration for bulkhead pattern."""
+
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass
+class BulkheadConfig:
+    """Configuration for a bulkhead.
+
+    Isolation Strategy:
+    ====================
+    Circuit breaker state isolation is controlled by (resource_key, namespace):
+
+    - **resource_key**: Set to bulkhead `name`. Different names = always isolated.
+    - **namespace**: Set at storage level. Same namespace = shared state space.
+
+    Examples:
+    ---------
+    1. Different bulkheads in same app:
+       - Use different `name` for each bulkhead
+       - Use same storage (same namespace)
+       - Result: Isolated by resource_key
+
+    2. Same bulkhead across app instances (persistence):
+       - Use same `name` for the bulkhead
+       - Use same storage (same namespace)
+       - Result: Share circuit breaker state (INTENDED)
+
+    3. Different environments:
+       - Use storage with different namespace for each environment
+       - Result: Fully isolated prod/staging/dev
+
+    For distributed systems:
+    ------------------------
+    - Create storage with `create_storage(namespace="production")`
+    - All instances of the same app share the same namespace
+    - Different bulkheads (different names) are isolated within that namespace
+    - Different environments use different namespaces
+    """
+
+    name: str
+    max_concurrent_calls: int = 10
+    max_queue_size: int = 100
+    timeout_seconds: float | None = None
+    failure_threshold: int = 5
+    success_threshold: int = 3
+    isolation_duration: float = 30.0  # seconds
+    circuit_breaker_enabled: bool = True
+    health_check_interval: float = 5.0
+
+
+@dataclass
+class ExecutionResult:
+    """Result of a function execution through bulkhead."""
+
+    success: bool
+    result: Any
+    error: Exception | None
+    execution_time: float
+    bulkhead_name: str
+    queued_time: float = 0.0
+    execution_id: str = ""

bulkman/core.py

@@ -0,0 +1,395 @@
+"""Core bulkhead pattern implementation using Trio."""
+
+import inspect
+import logging
+import uuid
+from contextlib import asynccontextmanager
+from datetime import timedelta
+from fractions import Fraction
+from functools import wraps
+from typing import Any, Callable, TypeVar
+
+import trio
+from resilient_circuit import CircuitProtectorPolicy, CircuitState
+from resilient_circuit.exceptions import ProtectedCallError
+from resilient_circuit.storage import CircuitBreakerStorage
+
+from bulkman.config import BulkheadConfig, ExecutionResult
+from bulkman.exceptions import (
+    BulkheadCircuitOpenError,
+    BulkheadError,
+    BulkheadTimeoutError,
+)
+from bulkman.state import BulkheadState
+
+logger = logging.getLogger("bulkman")
+
+T = TypeVar("T")
+
+
+class Bulkhead:
+    """
+    Implements the bulkhead pattern to isolate function executions
+    and prevent cascading failures using Trio for concurrency.
+    """
+
+    def __init__(
+        self,
+        config: BulkheadConfig,
+        circuit_storage: CircuitBreakerStorage | None = None,
+    ):
+        self.config = config
+        self.name = config.name
+
+        # Execution control using Trio primitives
+        self._semaphore = trio.Semaphore(config.max_concurrent_calls)
+        self._send_channel: trio.MemorySendChannel | None = None
+        self._receive_channel: trio.MemoryReceiveChannel | None = None
+        self._task_nursery: trio.Nursery | None = None
+
+        # Circuit breaker integration
+        self._circuit_breaker: CircuitProtectorPolicy | None = None
+        if config.circuit_breaker_enabled:
+            # Namespace is controlled by the storage, not the config
+            # Each bulkhead is identified by (resource_key, namespace)
+            # - resource_key = config.name (unique per bulkhead)
+            # - namespace = from storage (shared by app/environment)
+            self._circuit_breaker = CircuitProtectorPolicy(
+                resource_key=config.name,
+                storage=circuit_storage,  # Namespace comes from storage
+                cooldown=timedelta(seconds=config.isolation_duration),
+                failure_limit=Fraction(config.failure_threshold, config.failure_threshold),
+                success_limit=Fraction(config.success_threshold, config.success_threshold),
+                on_status_change=self._on_circuit_status_change,
+            )
+
+        # Statistics
+        self._total_executions = 0
+        self._successful_executions = 0
+        self._failed_executions = 0
+        self._rejected_executions = 0
+        self._active_tasks = 0
+        self._stats_lock = trio.Lock()
+
+        # Running state
+        self._running = False
+        self._cancel_scope: trio.CancelScope | None = None
+
+        logger.info(
+            f"Bulkhead '{self.name}' initialized with {config.max_concurrent_calls} "
+            f"concurrent calls and queue size {config.max_queue_size}"
+        )
+
+    def _on_circuit_status_change(
+        self,
+        policy: CircuitProtectorPolicy,
+        old_status: CircuitState,
+        new_status: CircuitState,
+    ) -> None:
+        """Callback for circuit breaker status changes."""
+        logger.info(
+            f"Bulkhead '{self.name}' circuit breaker changed: {old_status.value} -> {new_status.value}"
+        )
+
+    async def _check_circuit(self) -> None:
+        """Check if circuit breaker allows execution."""
+        if self._circuit_breaker:
+            # Let circuit breaker validate (it will auto-transition from OPEN to HALF_OPEN after cooldown)
+            try:
+                # Run the validation in a thread since it's synchronous
+                await trio.to_thread.run_sync(self._circuit_breaker._status.validate_execution)
+            except ProtectedCallError:
+                async with self._stats_lock:
+                    self._rejected_executions += 1
+                raise BulkheadCircuitOpenError(
+                    f"Bulkhead '{self.name}' circuit is open - requests are blocked"
+                )
+
+    async def execute(
+        self,
+        func: Callable[..., T],
+        *args: Any,
+        **kwargs: Any,
+    ) -> ExecutionResult:
+        """
+        Execute a function through the bulkhead with isolation.
+
+        Args:
+            func: The function to execute (can be sync or async)
+            *args: Function arguments
+            **kwargs: Function keyword arguments
+
+        Returns:
+            ExecutionResult containing the result or error
+
+        Raises:
+            BulkheadCircuitOpenError: If circuit breaker is open
+            BulkheadFullError: If the bulkhead is at capacity
+            BulkheadTimeoutError: If operation times out
+        """
+        # Check circuit breaker
+        await self._check_circuit()
+
+        submission_time = trio.current_time()
+        execution_id = str(uuid.uuid4())
+
+        # Create timeout scope if needed
+        timeout = self.config.timeout_seconds if self.config.timeout_seconds else float('inf')
+
+        with trio.move_on_after(timeout) as cancel_scope:
+            async with self._semaphore:
+                # Update stats
+                async with self._stats_lock:
+                    self._total_executions += 1
+                    self._active_tasks += 1
+
+                start_time = trio.current_time()
+                queued_time = start_time - submission_time
+
+                try:
+                    # Execute the function
+                    if inspect.iscoroutinefunction(func):
+                        result = await func(*args, **kwargs)
+                    else:
+                        # trio.to_thread.run_sync doesn't support **kwargs, so wrap in lambda
+                        if kwargs:
+                            result = await trio.to_thread.run_sync(lambda: func(*args, **kwargs))
+                        else:
+                            result = await trio.to_thread.run_sync(func, *args)
+
+                    execution_time = trio.current_time() - start_time
+
+                    # Record success
+                    if self._circuit_breaker:
+                        try:
+                            self._circuit_breaker._status.mark_success()
+                            self._circuit_breaker._save_state()
+                        except Exception as e:
+                            logger.warning(f"Failed to mark circuit success: {e}")
+
+                    async with self._stats_lock:
+                        self._successful_executions += 1
+                        self._active_tasks -= 1
+
+                    return ExecutionResult(
+                        success=True,
+                        result=result,
+                        error=None,
+                        execution_time=execution_time,
+                        bulkhead_name=self.name,
+                        queued_time=queued_time,
+                        execution_id=execution_id,
+                    )
+
+                except Exception as e:
+                    execution_time = trio.current_time() - start_time
+
+                    # Record failure
+                    if self._circuit_breaker:
+                        try:
+                            self._circuit_breaker._status.mark_failure()
+                            self._circuit_breaker._save_state()
+                        except Exception as circuit_err:
+                            logger.warning(f"Failed to mark circuit failure: {circuit_err}")
+
+                    async with self._stats_lock:
+                        self._failed_executions += 1
+                        self._active_tasks -= 1
+
+                    # Wrap exception if needed
+                    if not isinstance(e, BulkheadError):
+                        wrapped_error = BulkheadError(f"Execution failed: {e}")
+                        wrapped_error.__cause__ = e
+                        error = wrapped_error
+                    else:
+                        error = e
+
+                    return ExecutionResult(
+                        success=False,
+                        result=None,
+                        error=error,
+                        execution_time=execution_time,
+                        bulkhead_name=self.name,
+                        queued_time=queued_time,
+                        execution_id=execution_id,
+                    )
+
+        # Check if we timed out
+        if cancel_scope.cancelled_caught:
+            async with self._stats_lock:
+                self._rejected_executions += 1
+                if self._active_tasks > 0:
+                    self._active_tasks -= 1
+            raise BulkheadTimeoutError(
+                f"Bulkhead '{self.name}' operation timed out after {self.config.timeout_seconds} seconds"
+            )
+
+    @asynccontextmanager
+    async def context(self):
+        """
+        Context manager for bulkhead operations.
+
+        Example:
+            async with bulkhead.context():
+                result = await bulkhead.execute(my_function, arg1, arg2)
+        """
+        yield self
+
+    async def get_state(self) -> BulkheadState:
+        """Get the current state of the bulkhead."""
+        if self._circuit_breaker:
+            circuit_status = self._circuit_breaker.status
+            if circuit_status == CircuitState.CLOSED:
+                return BulkheadState.HEALTHY
+            elif circuit_status == CircuitState.HALF_OPEN:
+                return BulkheadState.DEGRADED
+            elif circuit_status == CircuitState.OPEN:
+                return BulkheadState.ISOLATED
+        return BulkheadState.HEALTHY
+
+    async def get_stats(self) -> dict[str, Any]:
+        """Get statistics for the bulkhead."""
+        async with self._stats_lock:
+            stats = {
+                "name": self.name,
+                "state": (await self.get_state()).value,
+                "total_executions": self._total_executions,
+                "successful_executions": self._successful_executions,
+                "failed_executions": self._failed_executions,
+                "rejected_executions": self._rejected_executions,
+                "active_tasks": self._active_tasks,
+                "max_concurrent_calls": self.config.max_concurrent_calls,
+                "max_queue_size": self.config.max_queue_size,
+            }
+
+            # Add circuit breaker info if enabled
+            if self._circuit_breaker:
+                stats["circuit_breaker_enabled"] = True
+                stats["circuit_status"] = self._circuit_breaker.status.value
+
+            return stats
+
+    async def reset_stats(self) -> None:
+        """Reset bulkhead statistics."""
+        async with self._stats_lock:
+            self._total_executions = 0
+            self._successful_executions = 0
+            self._failed_executions = 0
+            self._rejected_executions = 0
+
+    async def is_healthy(self) -> bool:
+        """Check if bulkhead is healthy."""
+        state = await self.get_state()
+        return state in (BulkheadState.HEALTHY, BulkheadState.DEGRADED)
+
+
+class BulkheadManager:
+    """
+    Manages multiple bulkheads for different system components.
+
+    Args:
+        circuit_storage: Optional PostgreSQL storage for circuit breaker persistence.
+                        All bulkheads created by this manager will share this storage.
+                        The namespace is set at storage creation time.
+
+    Example:
+        # Production environment
+        storage = create_storage(namespace="production")
+        manager = BulkheadManager(circuit_storage=storage)
+
+        # All bulkheads share the "production" namespace
+        # but are isolated by their names
+    """
+
+    def __init__(
+        self,
+        circuit_storage: CircuitBreakerStorage | None = None,
+    ):
+        self._bulkheads: dict[str, Bulkhead] = {}
+        self._lock = trio.Lock()
+        self._circuit_storage = circuit_storage
+
+    async def create_bulkhead(self, config: BulkheadConfig) -> Bulkhead:
+        """Create and register a new bulkhead."""
+        async with self._lock:
+            if config.name in self._bulkheads:
+                raise ValueError(f"Bulkhead with name '{config.name}' already exists")
+
+            bulkhead = Bulkhead(config, circuit_storage=self._circuit_storage)
+            self._bulkheads[config.name] = bulkhead
+            return bulkhead
+
+    async def get_bulkhead(self, name: str) -> Bulkhead | None:
+        """Get a bulkhead by name."""
+        async with self._lock:
+            return self._bulkheads.get(name)
+
+    async def get_or_create_bulkhead(self, config: BulkheadConfig) -> Bulkhead:
+        """Get existing bulkhead or create new one."""
+        async with self._lock:
+            if config.name in self._bulkheads:
+                return self._bulkheads[config.name]
+
+            # Create bulkhead directly without acquiring lock again
+            bulkhead = Bulkhead(config, circuit_storage=self._circuit_storage)
+            self._bulkheads[config.name] = bulkhead
+            return bulkhead
+
+    async def execute_in_bulkhead(
+        self,
+        bulkhead_name: str,
+        func: Callable[..., T],
+        *args: Any,
+        **kwargs: Any,
+    ) -> ExecutionResult:
+        """Execute a function in a specific bulkhead."""
+        bulkhead = await self.get_bulkhead(bulkhead_name)
+        if not bulkhead:
+            raise ValueError(f"Bulkhead '{bulkhead_name}' not found")
+        return await bulkhead.execute(func, *args, **kwargs)
+
+    async def get_all_stats(self) -> dict[str, dict[str, Any]]:
+        """Get statistics for all bulkheads."""
+        async with self._lock:
+            stats = {}
+            for name, bulkhead in self._bulkheads.items():
+                stats[name] = await bulkhead.get_stats()
+            return stats
+
+    async def get_health_status(self) -> dict[str, bool]:
+        """Get health status for all bulkheads."""
+        async with self._lock:
+            status = {}
+            for name, bulkhead in self._bulkheads.items():
+                status[name] = await bulkhead.is_healthy()
+            return status
+
+    @asynccontextmanager
+    async def context(self):
+        """Context manager for bulkhead manager."""
+        yield self
+
+
+def with_bulkhead(
+    bulkhead: Bulkhead,
+) -> Callable[[Callable[..., T]], Callable[..., T]]:
+    """
+    Decorator to execute an async function through a bulkhead.
+
+    Example:
+        @with_bulkhead(my_bulkhead)
+        async def query_database(query):
+            return await db.execute(query)
+    """
+
+    def decorator(func: Callable[..., T]) -> Callable[..., T]:
+        @wraps(func)
+        async def wrapper(*args: Any, **kwargs: Any) -> T:
+            result = await bulkhead.execute(func, *args, **kwargs)
+            if not result.success:
+                raise result.error or BulkheadError("Execution failed")
+            return result.result
+
+        return wrapper
+
+    return decorator

bulkman/exceptions.py

@@ -0,0 +1,21 @@
+"""Exception definitions for bulkhead pattern."""
+
+
+class BulkheadError(Exception):
+    """Base exception for all bulkhead-related errors."""
+
+
+class BulkheadIsolationError(BulkheadError):
+    """Exception raised when bulkhead is isolated."""
+
+
+class BulkheadTimeoutError(BulkheadError):
+    """Exception raised when bulkhead operation times out."""
+
+
+class BulkheadFullError(BulkheadError):
+    """Exception raised when bulkhead queue is full."""
+
+
+class BulkheadCircuitOpenError(BulkheadError):
+    """Exception raised when bulkhead circuit is open."""

bulkman/state.py

@@ -0,0 +1,12 @@
+"""State definitions for bulkhead pattern."""
+
+from enum import Enum
+
+
+class BulkheadState(Enum):
+    """Enum representing the state of a bulkhead."""
+
+    HEALTHY = "healthy"
+    DEGRADED = "degraded"
+    ISOLATED = "isolated"
+    FAILED = "failed"

bulkman/sync_bridge.py

@@ -0,0 +1,181 @@
+"""
+Synchronous bridge for Bulkman to enable threading-based usage.
+
+This module provides a synchronous wrapper around Bulkman's async API,
+allowing it to be used in threading-based code (like Highway's orchestrator).
+"""
+
+import atexit
+import concurrent.futures
+import logging
+import threading
+from typing import Any, Callable
+
+import trio
+from resilient_circuit.storage import CircuitBreakerStorage
+
+from bulkman.config import BulkheadConfig, ExecutionResult
+from bulkman.core import Bulkhead
+from bulkman.exceptions import BulkheadError
+
+logger = logging.getLogger("bulkman.sync")
+
+
+class TrioThread:
+    """Manages a background thread running a Trio event loop."""
+
+    def __init__(self):
+        self._portal: trio.lowlevel.TrioToken | None = None
+        self._thread: threading.Thread | None = None
+        self._started = threading.Event()
+        self._stopping = threading.Event()
+        self._lock = threading.Lock()
+
+    def start(self) -> None:
+        """Start the Trio thread if not already running."""
+        with self._lock:
+            if self._thread is not None:
+                return  # Already running
+
+            def trio_thread_main():
+                async def trio_main():
+                    # Store portal for cross-thread calls
+                    self._portal = trio.lowlevel.current_trio_token()
+                    self._started.set()
+
+                    # Keep trio running until stopped
+                    with trio.CancelScope() as cancel_scope:
+                        self._cancel_scope = cancel_scope
+                        await trio.sleep_forever()
+
+                try:
+                    trio.run(trio_main)
+                except Exception as e:
+                    logger.error(f"Trio thread crashed: {e}")
+
+            self._thread = threading.Thread(target=trio_thread_main, daemon=True, name="TrioRunner")
+            self._thread.start()
+            self._started.wait(timeout=5.0)
+            if not self._portal:
+                raise RuntimeError("Failed to start Trio thread")
+
+            logger.info("Trio runner thread started")
+
+    def stop(self) -> None:
+        """Stop the Trio thread."""
+        with self._lock:
+            if self._thread is None:
+                return
+
+            self._stopping.set()
+            if hasattr(self, "_cancel_scope"):
+                self._cancel_scope.cancel()
+
+            self._thread.join(timeout=5.0)
+            self._thread = None
+            self._portal = None
+            logger.info("Trio runner thread stopped")
+
+    def run_sync(self, async_fn: Callable, *args: Any) -> Any:
+        """Run an async function from a sync context."""
+        if not self._portal:
+            raise RuntimeError("Trio thread not started")
+
+        return trio.from_thread.run(async_fn, *args, trio_token=self._portal)
+
+
+# Global Trio thread instance
+_trio_thread: TrioThread | None = None
+_trio_lock = threading.Lock()
+
+
+def _get_trio_thread() -> TrioThread:
+    """Get or create the global Trio thread."""
+    global _trio_thread
+    with _trio_lock:
+        if _trio_thread is None:
+            _trio_thread = TrioThread()
+            _trio_thread.start()
+            atexit.register(_trio_thread.stop)
+        return _trio_thread
+
+
+class BulkheadSync:
+    """
+    Synchronous wrapper for Bulkman's async Bulkhead.
+
+    Provides threading-based API compatible with concurrent.futures.
+    """
+
+    def __init__(
+        self,
+        config: BulkheadConfig,
+        circuit_storage: CircuitBreakerStorage | None = None,
+    ):
+        self.config = config
+        self.name = config.name
+        self._trio_thread = _get_trio_thread()
+        self._bulkhead: Bulkhead | None = None
+        self._executor = concurrent.futures.ThreadPoolExecutor(
+            max_workers=config.max_concurrent_calls,
+            thread_name_prefix=f"Bulkhead-{config.name}",
+        )
+
+        # Create async bulkhead in Trio thread
+        async def create_bulkhead():
+            self._bulkhead = Bulkhead(config, circuit_storage)
+
+        self._trio_thread.run_sync(create_bulkhead)
+        logger.info(f"BulkheadSync '{self.name}' initialized")
+
+    def execute(
+        self,
+        func: Callable[..., Any],
+        *args: Any,
+        **kwargs: Any,
+    ) -> concurrent.futures.Future[ExecutionResult]:
+        """
+        Execute a function through the bulkhead.
+
+        Returns:
+            concurrent.futures.Future containing ExecutionResult
+        """
+        future: concurrent.futures.Future[ExecutionResult] = concurrent.futures.Future()
+
+        def run_in_executor():
+            """Run the function via Trio bulkhead and set result."""
+            try:
+                # Execute via async bulkhead from sync context
+                async def async_wrapper():
+                    return await self._bulkhead.execute(func, *args, **kwargs)
+
+                execution_result = self._trio_thread.run_sync(async_wrapper)
+                future.set_result(execution_result)
+
+            except Exception as e:
+                # Wrap in ExecutionResult for consistency
+                if not isinstance(e, BulkheadError):
+                    e = BulkheadError(f"Bulkhead execution failed: {e}")
+                future.set_exception(e)
+
+        # Submit to thread pool
+        self._executor.submit(run_in_executor)
+        return future
+
+    def get_stats(self) -> dict[str, Any]:
+        """Get bulkhead statistics."""
+        async def async_get_stats():
+            return await self._bulkhead.get_stats()
+
+        return self._trio_thread.run_sync(async_get_stats)
+
+    def shutdown(self, wait: bool = True, timeout: float = 5.0) -> None:
+        """Shutdown the bulkhead."""
+        async def async_shutdown():
+            if self._bulkhead:
+                await self._bulkhead.shutdown()
+
+        try:
+            self._trio_thread.run_sync(async_shutdown)
+        finally:
+            self._executor.shutdown(wait=wait, timeout=timeout)

bulkman-1.0.3.dist-info/METADATA

@@ -0,0 +1,367 @@
+Metadata-Version: 2.4
+Name: bulkman
+Version: 1.0.3
+Summary: Bulkhead pattern implementation with Trio for structured concurrency and resilient circuit breaking
+Author-email: Farshid Ashouri <farsheed.ashouri@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rodmena-limited/bulkman
+Project-URL: Repository, https://github.com/rodmena-limited/bulkman
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: System :: Networking
+Classifier: Framework :: Trio
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: trio>=0.22.0
+Requires-Dist: resilient-circuit[postgres]>=0.4.1
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-trio>=0.8.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# Bulkman
+
+**Bulkman** is a robust implementation of the **Bulkhead Pattern** for Python, built on [Trio](https://trio.readthedocs.io/) for structured concurrency and [resilient-circuit](https://github.com/rodmena-limited/resilient-circuit) for circuit breaking.
+
+The bulkhead pattern isolates resources and prevents cascading failures in distributed systems by limiting concurrent access to critical resources.
+
+## Features
+
+- **Structured Concurrency**: Built on Trio for proper async/await support
+- **Circuit Breaker Integration**: Uses `resilient-circuit` with PostgreSQL support for distributed systems
+- **Resource Isolation**: Limit concurrent executions to prevent resource exhaustion
+- **Automatic Failure Detection**: Circuit breaker opens automatically after threshold failures
+- **Comprehensive Metrics**: Track executions, failures, queue sizes, and circuit states
+- **Type Safe**: Full type hints for better IDE support
+- **Well Tested**: 92%+ test coverage
+
+## Installation
+
+```bash
+pip install bulkman
+```
+
+For development with all dependencies:
+```bash
+pip install bulkman[dev]
+```
+
+## Quick Start
+
+```python
+import trio
+from bulkman import Bulkhead, BulkheadConfig
+
+async def main():
+    # Create a bulkhead with configuration
+    config = BulkheadConfig(
+        name="api_calls",
+        max_concurrent_calls=5,
+        timeout_seconds=10.0,
+        circuit_breaker_enabled=True,
+    )
+    bulkhead = Bulkhead(config)
+
+    # Execute a function through the bulkhead
+    result = await bulkhead.execute(my_function, arg1, arg2)
+
+    if result.success:
+        print(f"Result: {result.result}")
+    else:
+        print(f"Error: {result.error}")
+
+trio.run(main)
+```
+
+## Basic Usage
+
+### Simple Function Execution
+
+```python
+import trio
+from bulkman import Bulkhead, BulkheadConfig
+
+async def fetch_data(url: str) -> dict:
+    # Your async function
+    await trio.sleep(0.1)
+    return {"data": "example"}
+
+async def main():
+    config = BulkheadConfig(name="api", max_concurrent_calls=3)
+    bulkhead = Bulkhead(config)
+
+    result = await bulkhead.execute(fetch_data, "https://api.example.com")
+    print(result.result)
+
+trio.run(main)
+```
+
+### Using Decorators
+
+```python
+from bulkman import Bulkhead, BulkheadConfig
+from bulkman.core import with_bulkhead
+
+config = BulkheadConfig(name="database", max_concurrent_calls=10)
+bulkhead = Bulkhead(config)
+
+@with_bulkhead(bulkhead)
+async def query_database(query: str):
+    # Your database query
+    return await db.execute(query)
+
+# The decorator automatically wraps execution
+result = await query_database("SELECT * FROM users")
+```
+
+### Managing Multiple Bulkheads
+
+```python
+import trio
+from bulkman import BulkheadManager, BulkheadConfig
+
+async def main():
+    manager = BulkheadManager()
+
+    # Create multiple bulkheads for different resources
+    await manager.create_bulkhead(
+        BulkheadConfig(name="database", max_concurrent_calls=20)
+    )
+    await manager.create_bulkhead(
+        BulkheadConfig(name="external_api", max_concurrent_calls=5)
+    )
+
+    # Execute in specific bulkhead
+    result = await manager.execute_in_bulkhead(
+        "database",
+        lambda: db.query("SELECT * FROM users")
+    )
+
+    # Get health status of all bulkheads
+    health = await manager.get_health_status()
+    print(health)  # {'database': True, 'external_api': True}
+
+trio.run(main)
+```
+
+## Configuration
+
+### BulkheadConfig Options
+
+```python
+from bulkman import BulkheadConfig
+
+config = BulkheadConfig(
+    name="my_bulkhead",              # Unique name for the bulkhead
+    max_concurrent_calls=10,         # Max concurrent executions
+    max_queue_size=100,              # Max queued tasks (currently for reference)
+    timeout_seconds=30.0,            # Execution timeout in seconds
+    failure_threshold=5,             # Failures before circuit opens
+    success_threshold=3,             # Successes to close circuit
+    isolation_duration=30.0,         # Seconds circuit stays open
+    circuit_breaker_enabled=True,    # Enable/disable circuit breaker
+    health_check_interval=5.0,       # Health check interval (for reference)
+)
+```
+
+## Circuit Breaker Integration
+
+Bulkman integrates with `resilient-circuit` for sophisticated circuit breaking:
+
+```python
+from bulkman import Bulkhead, BulkheadConfig
+from resilient_circuit.storage import create_storage
+
+# Use PostgreSQL for distributed circuit breaker state
+storage = create_storage(namespace="my_app")
+
+config = BulkheadConfig(
+    name="external_service",
+    failure_threshold=3,
+    isolation_duration=60.0,
+)
+
+bulkhead = Bulkhead(config, circuit_storage=storage)
+```
+
+The circuit breaker has three states:
+- **CLOSED** (Healthy): Normal operation
+- **OPEN** (Isolated): Blocking requests after failures
+- **HALF_OPEN** (Degraded): Testing if service recovered
+
+## Monitoring and Metrics
+
+### Get Statistics
+
+```python
+stats = await bulkhead.get_stats()
+print(stats)
+# {
+#     'name': 'api',
+#     'state': 'healthy',
+#     'total_executions': 150,
+#     'successful_executions': 145,
+#     'failed_executions': 5,
+#     'rejected_executions': 0,
+#     'active_tasks': 3,
+#     'max_concurrent_calls': 10,
+#     'max_queue_size': 100,
+#     'circuit_breaker_enabled': True,
+#     'circuit_status': 'CLOSED'
+# }
+```
+
+### Check Health
+
+```python
+is_healthy = await bulkhead.is_healthy()
+state = await bulkhead.get_state()  # BulkheadState enum
+```
+
+### Reset Statistics
+
+```python
+await bulkhead.reset_stats()
+```
+
+## Advanced Usage
+
+### Context Manager
+
+```python
+async with bulkhead.context():
+    result1 = await bulkhead.execute(func1)
+    result2 = await bulkhead.execute(func2)
+```
+
+### Handling Sync and Async Functions
+
+Bulkman automatically detects and handles both sync and async functions:
+
+```python
+# Async function
+async def async_operation():
+    await trio.sleep(1)
+    return "async result"
+
+# Sync function
+def sync_operation():
+    import time
+    time.sleep(1)
+    return "sync result"
+
+# Both work seamlessly
+result1 = await bulkhead.execute(async_operation)
+result2 = await bulkhead.execute(sync_operation)
+```
+
+### Concurrent Execution
+
+```python
+import trio
+from bulkman import Bulkhead, BulkheadConfig
+
+async def main():
+    config = BulkheadConfig(name="workers", max_concurrent_calls=5)
+    bulkhead = Bulkhead(config)
+
+    async def worker(task_id: int):
+        result = await bulkhead.execute(process_task, task_id)
+        return result
+
+    # Run many tasks concurrently, bulkhead limits concurrency
+    async with trio.open_nursery() as nursery:
+        for i in range(100):
+            nursery.start_soon(worker, i)
+
+trio.run(main)
+```
+
+## Error Handling
+
+Bulkman provides specific exceptions for different failure scenarios:
+
+```python
+from bulkman.exceptions import (
+    BulkheadError,
+    BulkheadCircuitOpenError,
+    BulkheadTimeoutError,
+    BulkheadFullError,
+)
+
+try:
+    result = await bulkhead.execute(my_function)
+    if not result.success:
+        print(f"Execution failed: {result.error}")
+except BulkheadCircuitOpenError:
+    print("Circuit breaker is open")
+except BulkheadTimeoutError:
+    print("Operation timed out")
+except BulkheadFullError:
+    print("Bulkhead is at capacity")
+```
+
+## Testing
+
+Run the test suite:
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests with coverage
+pytest tests/ --cov=bulkman --cov-report=term-missing
+
+# Run specific test file
+pytest tests/test_bulkhead.py -v
+```
+
+## Architecture
+
+Bulkman uses:
+- **Trio Semaphores** for concurrency control
+- **Trio Locks** for thread-safe statistics
+- **resilient-circuit** for circuit breaking logic
+- **Structured concurrency** for clean resource management
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the Apache Software License 2.0 - see the LICENSE file for details.
+
+## Credits
+
+- Built with [Trio](https://trio.readthedocs.io/) for structured concurrency
+- Circuit breaker powered by [resilient-circuit](https://github.com/rodmena-limited/resilient-circuit)
+- Inspired by Michael Nygard's "Release It!" and Martin Fowler's circuit breaker pattern
+
+## Related Patterns
+
+- **Circuit Breaker**: Prevents cascading failures (integrated via `resilient-circuit`)
+- **Rate Limiting**: Controls request rate (complementary pattern)
+- **Retry**: Automatically retries failed operations (can be combined)
+- **Timeout**: Prevents indefinite waits (built-in via `timeout_seconds`)
+
+## Links
+
+- **PyPI**: [https://pypi.org/project/bulkman/](https://pypi.org/project/bulkman/)
+- **Trio Documentation**: [https://trio.readthedocs.io/](https://trio.readthedocs.io/)
+- **resilient-circuit**: [https://github.com/rodmena-limited/resilient-circuit](https://github.com/rodmena-limited/resilient-circuit)

bulkman-1.0.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+bulkman/__init__.py,sha256=y_CjO_eCNnivIKiuQujCUnTojB9fXlf3v2pJYU4kVf8,932
+bulkman/config.py,sha256=tShtVUxohSe-FHjR-mYeb5jnHXYPX5Yr71b8yAg7zJY,1917
+bulkman/core.py,sha256=ni1EF5RJ_F31KF-PPKbD0ftuDwsu5BwRME1sAgkoVdM,14777
+bulkman/exceptions.py,sha256=zTMaFWFcBW2mJUx19e5MjzA8lfRr8EhNvTTO7iyjpNA,555
+bulkman/state.py,sha256=xAxnyp92vfSWig-rH1bno1SbU_2CAJIkY1Jy-ozOX9U,250
+bulkman/sync_bridge.py,sha256=ruPwdfS8b_CAYRPgnqZyPdey0DxQONJnDz2v-Qs39ZA,5942
+bulkman-1.0.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+bulkman-1.0.3.dist-info/METADATA,sha256=ov_r1XO4FFQ17zv6JL3NoKzs3tdY2ClcsDT095xKnZc,10306
+bulkman-1.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bulkman-1.0.3.dist-info/top_level.txt,sha256=P7oXMEeU9XTK2CREQ0agi1mSVGK537gRzCYDJ7Qkmh8,8
+bulkman-1.0.3.dist-info/RECORD,,

bulkman-1.0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bulkman-1.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

bulkman-1.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+bulkman