pyminideprecator documentation

---

Source code docs:

• Modules
  • DeprecatedError
  • Version
  • deprecate()
  • get_current_version()
  • scoped_version()
  • set_current_version()
• pyminideprecator package
  • Submodules
  • pyminideprecator.config module
  • pyminideprecator.deprecator module
  • pyminideprecator.exc module
  • pyminideprecator.version module
  • Module contents

---

pyminideprecator

Professional deprecation management for modern Python projects.

---

pyminideprecator is a lightweight yet powerful decorator-based solution for managing code deprecation in Python libraries and applications. It provides a robust mechanism to mark deprecated code with automatic warnings that escalate to errors at specified version thresholds, supporting both semantic versioning and date-based versioning.

Key Features: - Zero-dependency implementation - Thread-safe and async-compatible - Automatic docstring integration - Semantic and date-based version comparison - Gradual deprecation with warning-to-error transition - Full async support for coroutines - 100% test coverage with mutation testing

Contents:

• Installation
• Core Concepts
  • Version Management System
  • Thread-Safe Context-aware Execution
  • Lifecycle Management
• Advanced Usage
  • Property Deprecation
  • Custom Warning Types
  • Early Error Enforcement
  • Context-Specific Version Overrides
• API Reference
  • Decorator
  • Version Management
  • Version Class
  • Exceptions
• Best Practices
  • 1. Always Provide Alternatives
  • 2. Use Gradual Enforcement
  • 3. Maintain Documentation Context
  • 4. Test Deprecation Lifecycle
  • 5. Consistent Versioning Schemes
• Examples
  • Multi-threaded Application
  • Large-Scale Refactoring

---

Indices and tables

• Index

• Module Index

• Search Page