Metadata-Version: 2.4
Name: pico-resilience
Version: 0.1.0
Summary: Resilience AOP for the Pico ecosystem: @retryable, @circuit_breaker and @timeout method interceptors.
Author-email: David Perez Cabrera <dperezcabrera@gmail.com>
License: MIT License
        
        Copyright (c) 2025 David Pérez Cabrera
        
        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.
        
Project-URL: Homepage, https://github.com/dperezcabrera/pico-resilience
Project-URL: Documentation, https://dperezcabrera.github.io/pico-resilience/
Project-URL: Repository, https://github.com/dperezcabrera/pico-resilience
Project-URL: Changelog, https://github.com/dperezcabrera/pico-resilience/blob/main/CHANGELOG.md
Project-URL: Issue Tracker, https://github.com/dperezcabrera/pico-resilience/issues
Keywords: resilience,retry,circuit breaker,timeout,aop,ioc,spring boot
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pico-ioc>=2.2.0
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: pytest-cov>=5; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

# 📦 pico-resilience

[![PyPI](https://img.shields.io/pypi/v/pico-resilience.svg)](https://pypi.org/project/pico-resilience/)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/dperezcabrera/pico-resilience)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![CI (tox matrix)](https://github.com/dperezcabrera/pico-resilience/actions/workflows/ci.yml/badge.svg)
[![codecov](https://codecov.io/gh/dperezcabrera/pico-resilience/branch/main/graph/badge.svg)](https://codecov.io/gh/dperezcabrera/pico-resilience)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dperezcabrera_pico-resilience&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dperezcabrera_pico-resilience)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=dperezcabrera_pico-resilience&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=dperezcabrera_pico-resilience)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=dperezcabrera_pico-resilience&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=dperezcabrera_pico-resilience)
[![PyPI Downloads](https://img.shields.io/pypi/dm/pico-resilience)](https://pypi.org/project/pico-resilience/)
[![Docs](https://img.shields.io/badge/Docs-pico--resilience-blue?style=flat&logo=readthedocs&logoColor=white)](https://dperezcabrera.github.io/pico-resilience/)
[![Interactive Lab](https://img.shields.io/badge/Learn-online-green?style=flat&logo=python&logoColor=white)](https://dperezcabrera.github.io/pico-learn/)

Spring-style **resilience annotations** for the [Pico](https://github.com/dperezcabrera/pico-ioc) ecosystem, built on pico-ioc method interception and auto-discovered by [pico-boot](https://github.com/dperezcabrera/pico-boot). Zero-config.

| Decorator | Policy |
|---|---|
| `@retryable(max_attempts, backoff_seconds, retry_on)` | Exponential-backoff retry (sync + async) |
| `@circuit_breaker(failure_threshold, reset_timeout_seconds)` | Per-method circuit: closed → open → half-open |
| `@timeout(seconds)` | Async time budget via `asyncio.timeout` |

## Install

```bash
pip install pico-resilience
```

## Use

```python
from pico_ioc import component
from pico_resilience import retryable, circuit_breaker, timeout

@component
class PaymentGateway:
    @retryable(max_attempts=3, backoff_seconds=0.2, retry_on=(ConnectionError,))
    @circuit_breaker(failure_threshold=5, reset_timeout_seconds=30)
    def charge(self, order): ...

    @timeout(2.0)
    async def query_partner(self, q): ...
```

Failures raise `RetryExhaustedError` / `CircuitOpenError` / `TimeoutError` with the method name. `resilience.enabled: false` in `application.yaml` bypasses every policy (handy in tests).

Chain rule: put `@retryable` **at the top** when combining decorators (it runs innermost); `@circuit_breaker`/`@cacheable` below it then wrap the whole retry loop — the circuit counts exhausted retries and the cache stores the final result. `@timeout` rejects sync methods at import time: a thread cannot be cancelled, and a timeout that lies is worse than none.

## Documentation

Full docs at **[dperezcabrera.github.io/pico-resilience](https://dperezcabrera.github.io/pico-resilience/)**.

## License

MIT
