griffe-warnings-deprecated
Griffe extension for `@warnings.deprecated` (PEP 702).
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; griffelib must be installed (pulled in automatically).
- Low friction: single pure-Python dependency on griffelib, distributed as a wheel.
- Actively maintained with recent commits; last release 175 days ago.
License · maintenance · safety
ISC (permissive) — ISC permissive license; no restrictions on commercial or proprietary use.
last release 2026-02-20 (175 days) · last repo commit 2026-02-21 · 3 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 168,576 downloads/mo, #10,443 on PyPI
Alternatives
Verify before relying
pip install griffe-warnings-deprecated
import griffe
griffe.load(
"mypackage",
extensions=griffe.load_extensions(
[{"griffe_warnings_deprecated": {"kind": "danger"}}]
)
)- 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.
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 on it.
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
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.
Requires Python 3.10 or later; griffelib must be installed (pulled in automatically).
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"}}]
)
)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
| License | ISC permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagegriffelib |
| Maintenance | Actively maintained 175 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 168,576 / month, #10,443 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaIntended Audience :: DevelopersProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Software DevelopmentTopic :: UtilitiesTyping :: Typed |
Evidence: griffe_warnings_deprecated-1.1.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “griffe extension deprecated”
- griffe-warnings-deprecatedExtends Griffe to recognize and render PEP 702 `@warnings.deprecated`…
- griffe-pydanticExtends Griffe to automatically extract and document Pydantic model…
- griffe-typingdocGriffe extension that enables inline documentation of function…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also griffe-typingdoc · griffe · griffe-pydantic · deprecat · zope.deprecation · griffe2md · pyDeprecate · deprecation · flake8-pep585 · Deprecated