Port deprecations from `0.27.0.post` [rebase & merge] by Borda · Pull Request #2214 · roboflow/supervision

Borda · 2026-04-14T13:43:58Z

This pull request introduces several improvements and refactors across the codebase, focusing on modernizing deprecation handling, improving type safety, and enhancing annotation and image utility functions. The most significant changes include replacing the internal deprecation mechanism with the pydeprecate library, updating function signatures for better flexibility and type safety, and clarifying deprecation warnings for users. Below are the most important changes grouped by theme:

Deprecation Handling Modernization:

Replaced the custom deprecated decorator with the pydeprecate library throughout the codebase, updating all relevant imports and usages to standardize deprecation warnings and future removals. (src/supervision/utils/conversion.py, src/supervision/metrics/detection.py, src/supervision/utils/image.py, src/supervision/detection/core.py, src/supervision/detection/vlm.py, src/supervision/metrics/detection.py) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]
Deprecated the LMM enum and related functions, adding explicit warnings and docstrings to guide users to use the VLM enum instead. (src/supervision/detection/vlm.py, src/supervision/detection/core.py) [1] [2] [3] [4] [5]

Annotator and Type Safety Improvements:

Updated the BaseAnnotator.annotate method signature to accept arbitrary arguments and use Any for broader compatibility, and adjusted downstream usage accordingly. (src/supervision/annotators/base.py, src/supervision/annotators/core.py) [1] [2]
Improved type safety in annotation and image conversion utilities by using TypeVar, cast, and more precise return types, including for decorator wrappers. (src/supervision/utils/conversion.py, src/supervision/annotators/core.py) [1] [2] [3] [4] [5] [6]

Image Utility Enhancements:

Added assertions for input types in image manipulation functions (e.g., scale_image, resize_image, tint_image) to prevent misuse and clarify expected types. (src/supervision/utils/image.py) [1] [2] [3]
Refactored imports and internal logic in src/supervision/utils/image.py for improved clarity, maintainability, and to use new utility functions. (src/supervision/utils/image.py)

Dependency Management:

Added pydeprecate as a required dependency in pyproject.toml to support the new deprecation mechanism.

Miscellaneous:

Removed unused imports and updated function logic for clarity and to avoid deprecated usage, particularly in detection core modules. (src/supervision/detection/core.py)

These changes collectively modernize the codebase, improve user guidance for deprecated features, and enhance code robustness and maintainability.

…irecting to `supervision.key_points`. (cherry picked from commit 99e772c)

…cies (cherry picked from commit 219161f)

…ersion utilities (cherry picked from commit c976151)

(cherry picked from commit 224c756)

…sion (cherry picked from commit e36fbe0)

(cherry picked from commit 0ba57b2) (cherry picked from commit ae6aa36)

…across modules (cherry picked from commit 7f3dcae)

…multiple modules (cherry picked from commit bc521bc)

(cherry picked from commit 650ca0a)

(cherry picked from commit fd4845a)

…eprecated` with `warnings.warn` (cherry picked from commit 27e5fa3)

codecov · 2026-04-14T17:48:55Z

Codecov Report

❌ Patch coverage is 40.11299% with 106 lines in your changes missing coverage. Please review.
✅ Project coverage is 77%. Comparing base (565cd91) to head (9fab5f2).
⚠️ Report is 18 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop   #2214    +/-   ##
========================================
- Coverage       78%     77%    -2%     
========================================
  Files           63      66     +3     
  Lines         7979    8115   +136     
========================================
- Hits          6257    6232    -25     
- Misses        1722    1883   +161

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR ports and standardizes deprecations across Supervision by introducing pydeprecate-based deprecation decorators, refining some annotator/type-handling utilities, and adding/adjusting deprecation shims for renamed APIs.

Changes:

Adds pydeprecate as a dependency and replaces the repo’s removed custom deprecated decorator with deprecate.deprecated across updated modules.
Introduces deprecation shims/aliases for renamed keypoint validators and for the legacy from_lmm/LMM pathway.
Extends utils.image with a (deprecated) create_tiles implementation and refactors/expands image utility internals.

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
uv.lock	Locks `pydeprecate` and includes it in dependency resolution.
pyproject.toml	Adds `pydeprecate>=0.4,<0.5` to core dependencies.
supervision/keypoint/init.py	Adds deprecated import shim for `supervision.keypoint` → `supervision.key_points` (but currently outside `src/`).
supervision/keypoint/core.py	Deprecated shim re-exporting `KeyPoints` from new module.
supervision/keypoint/annotators.py	Deprecated shim re-exporting keypoint annotators from new module.
src/supervision/utils/internal.py	Removes the legacy custom `deprecated` decorator implementation.
src/supervision/validators/init.py	Adds deprecated aliases for renamed keypoint validator functions using `deprecate`.
src/supervision/utils/conversion.py	Improves typing of decorator helpers and adds deprecated aliases for older decorator names.
src/supervision/utils/image.py	Adds new tiling utilities (`create_tiles` + helpers), updates imports, and adjusts deprecations/assertions.
src/supervision/metrics/detection.py	Switches to `deprecate.deprecated` for `MeanAveragePrecision` and adds a workaround for wrapped staticmethods.
src/supervision/detection/vlm.py	Deprecates `LMM` enum usage via warnings and docstring directives.
src/supervision/detection/core.py	Removes decorator-based deprecation for `from_lmm` and replaces with runtime warning + mapping to `from_vlm`.
src/supervision/annotators/base.py	Broadens `BaseAnnotator.annotate` signature to accept arbitrary args/kwargs and loosens typing to `Any`.
src/supervision/annotators/core.py	Adjusts annotator signatures/defaults and adds casts to satisfy updated typing expectations.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

- Replace FutureWarning with warn_deprecated (SupervisionWarnings) in Detections.from_lmm to respect SUPERVISON_DEPRECATION_WARNING env var - Align removal version from 0.30.0 to 0.31.0 for consistency with all other deprecations introduced in this PR [resolve #3] Review comment by @copilot (PR #2214): "Deprecation warning says from_lmm will be removed in supervision-0.30.0..." [resolve #4] Review comment by @copilot (PR #2214): "Emitting deprecation warnings with the standard FutureWarning here byp..." --- Co-authored-by: Claude Code <noreply@anthropic.com>

Replace FutureWarning with warn_deprecated so the LMM deprecation respects the SUPERVISON_DEPRECATION_WARNING env var filter, consistent with other deprecations across the library. [resolve #4] Review comment by @copilot (PR #2214): "Same as Detections.from_lmm: this uses the standard FutureWarning..." --- Co-authored-by: Claude Code <noreply@anthropic.com>

Decorated functions now preserve __name__, __doc__, and __wrapped__ metadata, fixing introspection and documentation generation for all annotators using ensure_cv2/pil_image_for_* decorators. [resolve #9] Review comment by @copilot (PR #2214): "The decorator wrappers in this file no longer use functools.wraps..." --- Co-authored-by: Claude Code <noreply@anthropic.com>

- Move supervision/keypoint/ → src/supervision/keypoint/ so shims are included in built wheels (project uses src layout) - Replace raw DeprecationWarning with warn_deprecated (SupervisionWarnings) in all three shim files for consistent warning behaviour - Fix wrong import path (supervision.utils.deprecation → .internal) and remove unsupported stacklevel arg from warn_deprecated call [resolve #7] Review comment by @copilot (PR #2214): "This warning uses the standard DeprecationWarning..." [resolve #8] Review comment by @copilot (PR #2214): "These deprecation shim modules are added under the top-level supervision/..." --- Co-authored-by: Claude Code <noreply@anthropic.com>

- Replace FutureWarning with warn_deprecated (SupervisionWarnings) in Detections.from_lmm to respect SUPERVISON_DEPRECATION_WARNING env var - Align removal version from 0.30.0 to 0.31.0 for consistency with all other deprecations introduced in this PR [resolve #3] Review comment by @copilot (PR #2214): "Deprecation warning says from_lmm will be removed in supervision-0.30.0..." [resolve #4] Review comment by @copilot (PR #2214): "Emitting deprecation warnings with the standard FutureWarning here byp..." --- Co-authored-by: Claude Code <noreply@anthropic.com>

Replace FutureWarning with warn_deprecated so the LMM deprecation respects the SUPERVISON_DEPRECATION_WARNING env var filter, consistent with other deprecations across the library. [resolve #4] Review comment by @copilot (PR #2214): "Same as Detections.from_lmm: this uses the standard FutureWarning..." --- Co-authored-by: Claude Code <noreply@anthropic.com>

Decorated functions now preserve __name__, __doc__, and __wrapped__ metadata, fixing introspection and documentation generation for all annotators using ensure_cv2/pil_image_for_* decorators. [resolve #9] Review comment by @copilot (PR #2214): "The decorator wrappers in this file no longer use functools.wraps..." --- Co-authored-by: Claude Code <noreply@anthropic.com>

Borda added 12 commits April 14, 2026 15:24

Introduce deprecation warnings for supervision.keypoint module, red…

acbe57d

…irecting to `supervision.key_points`. (cherry picked from commit 99e772c)

Add deprecation warnings for annotation utilities and update dependen…

b22cf17

…cies (cherry picked from commit 219161f)

Add deprecation warning for ensure_cv2_image_for_processing in conv…

b96b458

…ersion utilities (cherry picked from commit c976151)

Add deprecation warning for create_tiles in image utilities

bc4dc75

(cherry picked from commit 224c756)

Add deprecation warnings for keypoint validation utilities in supervi…

ad7a41f

…sion (cherry picked from commit e36fbe0)

Update deprecation annotations and refactor deprecated utility usage

7cbaefe

(cherry picked from commit 0ba57b2) (cherry picked from commit ae6aa36)

Refactor imports for consistency and update deprecated utility usage …

9b0c4bb

…across modules (cherry picked from commit 7f3dcae)

Update deprecation annotations to extend remove_in versions across …

eef86ba

…multiple modules (cherry picked from commit bc521bc)

Revive create_tiles implementation and all related functions

91247af

(cherry picked from commit 650ca0a)

adjust deprecation version for from_lmm

5cee6ea

(cherry picked from commit fd4845a)

Refactor deprecation handling for LMM and from_lmm, replacing `@d…

7660329

…eprecated` with `warnings.warn` (cherry picked from commit 27e5fa3)

fix: resolve typing regressions in image utilities

1c0d1f7

Borda force-pushed the port/deprecations branch from ad782a8 to 1c0d1f7 Compare April 14, 2026 15:47

add pydeprecate dependency and update lockfile

857fc8b

Borda force-pushed the port/deprecations branch from dc1631d to 857fc8b Compare April 14, 2026 18:02

Borda changed the title ~~Port/deprecations [wip]~~ Port deprecations from 0.27.pot [rebase & merge] Apr 14, 2026

Borda changed the title ~~Port deprecations from 0.27.pot [rebase & merge]~~ Port deprecations from 0.27.0.post [rebase & merge] Apr 14, 2026

Borda marked this pull request as ready for review April 14, 2026 19:11

Borda requested a review from SkalskiP as a code owner April 14, 2026 19:11

Copilot AI review requested due to automatic review settings April 14, 2026 19:11

Copilot started reviewing on behalf of Borda April 14, 2026 19:12 View session

Copilot AI reviewed Apr 14, 2026

View reviewed changes

Borda and others added 5 commits April 15, 2026 13:37

Apply suggestions from code review

32ea3c5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Borda merged commit f28874c into develop Apr 15, 2026
27 checks passed

Borda deleted the port/deprecations branch April 15, 2026 18:59

Borda mentioned this pull request Apr 17, 2026

releasing 0.28.0 #2220

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port deprecations from `0.27.0.post` [rebase & merge]#2214

Port deprecations from `0.27.0.post` [rebase & merge]#2214
Borda merged 18 commits into
developfrom
port/deprecations

Borda commented Apr 14, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Apr 14, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Borda commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Borda commented Apr 14, 2026 •

edited

Loading

codecov Bot commented Apr 14, 2026 •

edited

Loading