[BUG]: Use stdlib override when possible #5555
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
Fixes #5554
This PR uses
typing.override
in favor of theoverrides
dependency when possible. As of Python 3.12, the standard library offerstyping.override
to perform a static check on overridden methods.Motivation
Currently,
overrides
is incompatible with Python 3.14. As a result, any package that attempts to importoverrides
using Python 3.14+ will raise anAttributeError
. An issue has been raised and a pull request has been submitted to the GitHub repo for theoverrides
project. But the maintainer has been unresponsive.To ensure readiness for Python 3.14, this package (and any other package directly depending on
overrides
) should consider usingtyping.override
instead.Impact
The standard library added
typing.override
as of 3.12. As a result, this change will affect only users of Python 3.12+. Previous versions will continue to rely onoverrides
. Notably, the standard library implementation is slightly different than that ofoverrides
. A thorough discussion of those differences is shown in PEP 698, and it is also summarized nicely by the maintainer ofoverrides
here.There are 2 main ways that switching from
overrides
totyping.override
will have an impact on developers of this repo.typing.override
does not implement any runtime checking. Instead, it provides information to type checkers.EnforceOverrides
.overrides
incompatibilityTest plan
After applying these changes, I'm able to import the modules locally in Python 3.14.0rc2 without errors. I don't have a plan to write tests. Open to suggestions
Migration plan
I've updated the
pyproject.toml
to use a PEP508 compliant dependency specifier so thatoverrides
need not be installed for users of newer Python versions.Observability plan
I don't have a plan at this time. Open to suggestions.
Documentation Changes
As far as I can tell, the change to the decorators doesn't have a user-visible impact, and therefore shouldn't necessitate docstring or documentation updates