griffe-warnings-deprecated

1.1.1 verified Mon Apr 27 auth: no python

Griffe extension that recognizes @warnings.deprecated decorator (PEP 702) and marks objects as deprecated. Current version 1.1.1, requires Python >=3.10. Compatible with mkdocstrings.

pip install griffe-warnings-deprecated

Common errors

error ModuleNotFoundError: No module named 'griffelib' ↓

cause Older projects depend on 'griffe' but v1.1.1 requires 'griffelib'.

fix

pip install griffelib or update environment to use griffelib.

error No module named 'griffe_warnings_deprecated' ↓

cause Package not installed.

fix

pip install griffe-warnings-deprecated

Warnings

gotcha The extension submodule is deprecated in 1.1.1; use top-level import directly. ↓

fix from griffe_warnings_deprecated import WarningsDeprecatedExtension instead of from griffe_warnings_deprecated.extension import ...

deprecated Dependency changed from 'griffe' to 'griffelib' in v1.1.1. Projects pinning griffe may conflict. ↓

fix Update your requirements to depend on griffelib instead of griffe, or remove direct griffe pin.

Imports

WarningsDeprecatedExtension

from griffe_warnings_deprecated import WarningsDeprecatedExtension

Quickstart

Load a package with the extension to detect deprecated objects.

import griffe
from griffe_warnings_deprecated import WarningsDeprecatedExtension

loader = griffe.load(
    packages=["mypackage"],
    extensions=[WarningsDeprecatedExtension()]
)