{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/13"}],"enrichment":{"capability":"Provides a Python decorator to mark functions, methods, and classes as deprecated, emitting warnings to users and optionally modifying docstrings for Sphinx documentation.","skillfed_tags":["api-lifecycle","documentation-integration"],"use_cases":["Signal to users that a function or method will be removed in a future version, with a custom reason and target version.","Automatically inject deprecation warnings into Sphinx-generated API documentation without manual docstring edits.","Deprecate specific keyword arguments in a function while keeping the function itself active.","Emit warnings when a class is instantiated to guide users toward a replacement class.","Track and communicate API changes across library versions in a standardized, Python-native way."],"what_it_does":"deprecat is a lightweight decorator library for marking Python functions, methods, and classes as deprecated. When a user calls a deprecated target, the decorator emits a standard DeprecationWarning with a custom reason and version number, helping library maintainers signal API changes without breaking existing code.\n\nThe package includes a Sphinx integration that automatically injects deprecation notices into docstrings, making the deprecation visible in generated documentation. It supports deprecating individual keyword arguments as well, allowing fine-grained control over which parts of an API are being phased out. The single runtime dependency is wrapt, and installation is straightforward.","worth_installing":"Yes, if you are maintaining a library and need a simple, zero-configuration way to emit deprecation warnings. The package is stable, has no vulnerabilities, and requires only one lightweight dependency. Maintenance is dormant, but the decorator pattern itself is stable and unlikely to need updates. Not recommended if you need active support or expect frequent maintenance."},"id":"deprecat","links":{"html":"https://skillfed.io/packages/deprecat","md":"https://skillfed.io/packages/deprecat.md","pypi":"https://pypi.org/project/deprecat/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2024-07-24","license_spdx":null,"license_treatment":"permissive","name":"deprecat","python_support":"supports_current","summary":"Python @deprecat decorator to deprecate old python classes, functions or methods."},"popularity":{"monthly_downloads":350821,"position":7327,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"2.1.3"}