griffe-warnings-deprecated

What it is and what it does

griffe-warnings-deprecated is a Griffe extension that recognizes the `@warnings.deprecated` decorator from PEP 702 and renders deprecation notices in generated API documentation. It integrates into Griffe's analysis pipeline to detect deprecated symbols and wrap them in admonitions (styled blocks) that highlight the deprecation status to users reading the docs.

The extension works in three contexts: as a command-line flag to `griffe dump`, as a programmatic loader in Python code, and as a plugin configuration in MkDocs + mkdocstrings. It exposes three configuration options—admonition kind, title, and label—to customize how deprecation notices appear. The single runtime dependency is griffelib, making installation and setup straightforward.

Use it for:

• Automatically surface deprecation warnings in API docs generated from Python source code with PEP 702 markers.
• Configure MkDocs documentation to highlight deprecated functions and classes with custom admonition styling.
• Programmatically load and analyze a Python package while detecting and rendering all deprecation notices.
• Add deprecation labels and notices to generated documentation without manual markup.
• Integrate deprecation visibility into CI/CD pipelines that generate docs from source.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Extends Griffe to recognize and render PEP 702 `@warnings.deprecated` markers in Python code documentation, surfacing deprecation notices during API analysis.

Yes, if you use Griffe or mkdocstrings to generate Python API documentation and want to automatically surface PEP 702 deprecations. Low install friction, active maintenance, no security issues, and permissive license make it a straightforward addition. Skip it if you don't use Griffe or don't rely on `@warnings.deprecated` markers in your codebase.

Install

griffe-warnings-deprecated on PyPI

pip install griffe-warnings-deprecated

uv add griffe-warnings-deprecated

poetry add griffe-warnings-deprecated

Installing griffe-warnings-deprecated

Before you install

Low friction: single pure-Python dependency on griffelib, distributed as a wheel. Actively maintained with recent commits; last release 175 days ago.

License in practice

ISC permissive license; no restrictions on commercial or proprietary use.

Quickstart

pip install griffe-warnings-deprecated

import griffe
griffe.load(
    "mypackage",
    extensions=griffe.load_extensions(
        [{"griffe_warnings_deprecated": {"kind": "danger"}}]
    )
)

Requires Python 3.10 or later; griffelib must be installed (pulled in automatically).

Verify before relying

• Whether the extension works with all Griffe versions or requires a specific minimum version of griffelib.
• Performance impact when processing large codebases with many deprecated items.
• Compatibility with other Griffe extensions that may also modify admonition rendering.

Package facts

Evidence: griffe_warnings_deprecated-1.1.1-py3-none-any.whl

Tags

More Software Development packages