Skip to main content

deprecation-radar

See every deprecation your code depends on, grouped by library, before the upgrade breaks it.

pytest already shows deprecation warnings: as a long list at the end of every run, repeated once per test, mixed with warnings from inside your dependencies. Everyone learns to scroll past it. Then Pydantic 3 or Python 3.16 comes out and the list turns into errors.

deprecation-radar is a pytest plugin that turns that list into a report you can act on. Here it is on a small FastAPI app written the way many 2023 tutorials wrote it (examples/demo-app):

$ pytest
..                                                                       [100%]
============================== deprecation-radar ===============================
pydantic 2.14.1: 5 deprecations, removal in 3.0
  PydanticDeprecatedSince20: Support for class-based `config` is deprecated, use ConfigDict instead. Deprecated in Pydantic V2.0 to be removed in V3.0. ...
    app.py:20 in User
  PydanticDeprecatedSince20: The `dict` method is deprecated; use `model_dump` instead. Deprecated in Pydantic V2.0 to be removed in V3.0. ...
    app.py:36 in get_user
  PydanticDeprecatedSince20: The `json` method is deprecated; use `model_dump_json` instead. Deprecated in Pydantic V2.0 to be removed in V3.0. ...
    test_app.py:12 in test_user_json
  PydanticDeprecatedSince20: The `parse_obj` method is deprecated; use `model_validate` instead. Deprecated in Pydantic V2.0 to be removed in V3.0. ...
    app.py:35 in get_user
  UserWarning: Valid config keys have changed in V2: * 'orm_mode' has been renamed to 'from_attributes'
    inside pydantic: pydantic/_internal/_config.py:408
fastapi 0.162.0: 1 deprecation
  DeprecationWarning: on_event is deprecated, use lifespan event handlers instead. ...
    app.py:28 in <module>
    inside fastapi: fastapi/applications.py:4723
Python 3.12 standard library: 1 deprecation
  DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. ...
    app.py:30 in startup
SQLAlchemy 2.1.6: 1 deprecation
  MovedIn20Warning: The ``declarative_base()`` function is now available as sqlalchemy.orm.declarative_base(). (deprecated since: 2.0) ...
    app.py:10 in <module>
starlette 1.10.0: 1 deprecation, used only inside other packages
  StarletteDeprecationWarning: Using `httpx` with `starlette.testclient` is deprecated; install `httpx2` instead.
    inside fastapi: fastapi/testclient.py:1
deprecation-radar: 9 deprecations from 5 sources, used at 7 places in your code.
2 passed, 10 warnings in 2.03s

For each deprecation you get:

  • the library that deprecated it and the version you have installed,
  • the version that removes it, when the message says so, with those libraries listed first,
  • the lines of your code that use it, with the function they're in and how often they fired,
  • deprecations inside your dependencies, kept apart, because the fix there is upgrading the dependency, not changing your code.

Install

pip install pytest-deprecation-radar     # or: uv add --dev pytest-deprecation-radar

pytest loads the plugin on its own. The next pytest run prints the report.

What counts as a deprecation

  • DeprecationWarning, PendingDeprecationWarning and FutureWarning, and their subclasses (Pydantic's PydanticDeprecatedSince20, SQLAlchemy's MovedIn20Warning, Django's RemovedInDjango60Warning).
  • Warnings whose class is named like a deprecation even when it isn't a subclass of one. Starlette's and FastAPI's deprecation warnings subclass UserWarning on purpose, because Python hides DeprecationWarning by default.
  • Any warning whose message says "deprecated", "has been renamed" or "will be removed".

Warnings you've silenced with filterwarnings = ignore::... stay silenced.

Stop new deprecations getting in

A report alone doesn't stop the list growing. Record what your code uses today, then let only new uses fail the run:

pytest --deprecation-radar-update-baseline   # writes .deprecation-radar-baseline.json; commit it
pytest                                       # now a new deprecated call fails the run
pydantic 2.14.1: 5 deprecations, removal in 3.0
  PydanticDeprecatedSince20: The `json` method is deprecated; use `model_dump_json` instead. ...
    NEW app.py:40 in export
    test_app.py:12 in test_user_json
...
deprecation-radar: 9 deprecations from 5 sources, used at 8 places in your code; 1 new use fails the run.

Only uses in your code can fail the run. Deprecations inside your dependencies are reported but never fail it, since the fix there is upgrading the dependency.

Baseline entries are keyed by file, function, warning class and message, not line number, so editing code above a call doesn't make an old use look new. Links are left out of the message, because Pydantic's link to a page with the installed version in it (errors.pydantic.dev/2.14/...), and a minor upgrade would otherwise make every entry look new. When an entry stops showing up, the report says so, and the next --deprecation-radar-update-baseline after a full run drops it.

Configure

In pytest.ini, or [tool.pytest.ini_options] in pyproject.toml:

[pytest]
# When deprecations in your code fail the run:
#   new   (default) only uses not in the baseline file, and only when there is one
#   any   every use, baseline or not
#   never report only
deprecation_radar_fail = new
# Sources to leave out of the report and the gate.
deprecation_radar_ignore = pytest
# Where the baseline lives, relative to the rootdir.
deprecation_radar_baseline = .deprecation-radar-baseline.json

Turn it off for one run with pytest -p no:deprecation_radar.

GitHub Actions

Nothing to set up. When GITHUB_ACTIONS=true, uses in your code also show up as notes on the pull request diff: an error for a use that fails the run, a warning for every use when there's no baseline yet, and nothing for uses already in the baseline.

JSON report

pytest --deprecation-radar-json=deprecations.json

Every deprecation with its source, versions, every site, and the tests that triggered it. Useful for tracking the count over time, or for an upgrade ticket. The path is relative to where you run pytest.

Limits

  • It sees what your tests run. Code with no tests isn't checked.
  • A library decides which line a warning points at (stacklevel). When it points inside the library, the report says so (inside pydantic: ...) instead of guessing at your line.
  • Which library deprecated something is worked out from the warning's class, the names in its message, and the file that raised it. When none of those say, the report files it under "Unknown source".

How it's checked

Besides its own tests, CI runs the plugin on examples/demo-app against pinned real versions of FastAPI, Pydantic, SQLAlchemy and Starlette, and checks that every deprecation is credited to the right package and line.

License

MIT

Metadata

Release files for pytest-deprecation-radar 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytest-deprecation-radar 0.1.0
File Size Uploaded Provenance Actions
pytest_deprecation_radar-0.1.0.tar.gz 27.4 kB Without provenance Details for pytest_deprecation_radar-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pytest-deprecation-radar 0.1.0
File Interpreter ABI Platform Actions
pytest_deprecation_radar-0.1.0-py3-none-any.whl Python 3 none any Details for pytest_deprecation_radar-0.1.0-py3-none-any.whl

Total release size: 42.6 kB

Release files / pytest_deprecation_radar-0.1.0.tar.gz

Download URL pytest_deprecation_radar-0.1.0.tar.gz
Size 27.4 kB
Tags Source
SHA-256 checksum
How to use checksums
2eae6cadf930e7e51670a920adc7b9862733263b0c64dcde784d5cd74b2f1265
BLAKE2b-256 checksum
How to use checksums
03ffbb3a158386e3ab59fda9ab17f2d62c5772a47d1892e7102d5cf7e2d43b95
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pytest_deprecation_radar-0.1.0-py3-none-any.whl

Download URL pytest_deprecation_radar-0.1.0-py3-none-any.whl
Size 15.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
986dceee12be34bc62e26444b800d72a70d8297d8673c31189c3948b53711094
BLAKE2b-256 checksum
How to use checksums
7e471928d76e49fa709109951a9d8f138fa7aacff323452fa253e61b04839e78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for pytest-deprecation-radar 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page