[`ruff`] Added `cls.dict.get('annotations')` check (`RUF063`) #18233

dericcrago · 2025-05-20T21:25:21Z

Added cls.__dict__.get('__annotations__') check for Python 3.10+ and Python < 3.10 with typing-extensions enabled.

Summary

Added cls.__dict__.get('__annotations__') check for Python 3.10+ and Python < 3.10 with typing-extensions enabled.

Test Plan

cargo test

AlexWaygood · 2025-05-20T21:32:00Z

looks like you need to regenerate the JSON schema -- running cargo dev generate-all and committing the changes should fix it!

github-actions · 2025-05-20T21:44:32Z

`ruff-ecosystem` results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

crates/ruff_linter/src/rules/ruff/rules/class_dict_annotations.rs

dericcrago · 2025-05-21T14:11:27Z

Thank you for the review @JelleZijlstra! I will work on these changes.

JelleZijlstra

Looks good, thanks!

The error message might be a bit long with mentioning all the different get_annotations() functions.

JelleZijlstra · 2025-05-23T02:47:39Z

crates/ruff_linter/src/rules/ruff/rules/class_dict_annotations.rs

+    #[derive_message_formats]
+    fn message(&self) -> String {
+        "Use `typing_extensions.get_annotations` (Python < 3.10 with \
+        `typing_extensions` enabled), `inspect.get_annotations` \


"enabled" is an odd word choice, is that used elsewhere in Ruff? I'd use "installed" (this also occurs a few other times in the file).

Thanks for taking another look @JelleZijlstra!

You're right, the original error message was a bit lengthy. I've trimmed about 25 characters off, but I'm happy to iterate on this further if you have other suggestions for conciseness.

Regarding "enabled" vs. "installed"; thanks for pointing that out. I think some distinction and mixed use might be necessary. For example, I think that:

the module typing-extensions should be installed

the ruff setting typing-extensions should be enabled

Does this distinction for using 'enabled' in the context of the ruff setting seem reasonable to you? I'm open to suggestions if you still feel like "installed" makes more sense or if a different term would be clearer here.

I've pushed the above changes for review.

Oh I see, didn't realize that was a reference to a Ruff setting.

That's understandable, the code was a bit ambiguous regarding the typing-extensions module vs setting. I'm hopeful that the changes in the last commit make that distinction clearer. Please let me know if it's still not quite hitting the mark! Thanks for sticking with me @JelleZijlstra!

MichaReiser · 2025-05-23T14:23:01Z

@dylwil3 could you review this PR (as the author of the issue and it being Python 3.14 related?)

ntBre

Thanks, this is looking great overall! I just have a few stylistic nits/suggestions.

crates/ruff_linter/resources/test/fixtures/ruff/RUF061.py

crates/ruff_linter/src/rules/ruff/rules/class_dict_annotations.rs

crates/ruff_linter/src/codes.rs

crates/ruff_linter/src/rules/ruff/rules/class_dict_annotations.rs

ntBre

Thanks, this looks great! Just a couple of small nits, the merge conflicts, and possibly extending the rule to __dict__["__annotations__"] as you said (and renaming). This is otherwise good to go!

crates/ruff_linter/src/rules/ruff/rules/class_dict_annotations.rs

Python < 3.10 with `typing_extensions` enabled.

…enabled

Co-authored-by: Brent Westbrook <[email protected]>

…e());'

…ons setting

This commit renames the rule from `AnnotationsFromClassDict` to `AccessAnnotationsFromClassDict` to better reflect its expanded scope. The rule has been extended to detect direct subscript access (e.g., `foo.__dict__["__annotations__"]`), in addition to the existing check for `foo.__dict__.get("__annotations__")` method calls. This change provides more comprehensive detection of this discouraged access pattern.

ntBre

This is great, thank you!

* main: (21 commits) [`flake8-logging`] Avoid false positive for `exc_info=True` outside `logger.exception` (`LOG014`) (#18737) [`flake8-pie`] Small docs fix to `PIE794` (#18829) [`pylint`] Ignore __init__.py files in (PLC0414) (#18400) Avoid generating diagnostics with per-file ignores (#18801) [`flake8-simplify`] Fix false negatives for shadowed bindings (`SIM910`, `SIM911`) (#18794) [ty] Fix panics when pulling types for `ClassVar` or `Final` parameterized with >1 argument (#18824) [`pylint`] add fix safety section (`PLR1714`) (#18415) [Perflint] Small docs improvement to `PERF401` (#18786) [`pylint`] Avoid flattening nested `min`/`max` when outer call has single argument (`PLW3301`) (#16885) [`ruff`] Added `cls.__dict__.get('__annotations__')` check (`RUF063`) (#18233) [ty] Use `HashTable` in `PlaceTable` (#18819) docs: Correct collections-named-tuple example to use PascalCase assignment (#16884) [ty] ecosystem-analyzer workflow (#18719) [ty] Add support for `@staticmethod`s (#18809) unnecessary_dict_kwargs doc - a note on type checking benefits (#18666) [`flake8-pytest-style`] Mark autofix for `PT001` and `PT023` as unsafe if there's comments in the decorator (#18792) [ty] Surface matched overload diagnostic directly (#18452) [ty] Report when a dataclass contains more than one `KW_ONLY` field (#18731) [`flake8-pie`] Add fix safety section to `PIE794` (#18802) [`pycodestyle`] Add fix safety section to `W291` and `W293` (#18800) ...

AlexWaygood added the rule Implementing or modifying a lint rule label May 20, 2025

dericcrago force-pushed the 17853-cls-dict-annotations branch from 34602f5 to 8669fd7 Compare May 20, 2025 21:37

JelleZijlstra reviewed May 21, 2025

View reviewed changes

JelleZijlstra reviewed May 23, 2025

View reviewed changes

MichaReiser requested a review from dylwil3 May 23, 2025 14:22

MichaReiser added the python314 Related to Python 3.14 label May 23, 2025

ntBre self-requested a review May 30, 2025 16:09

ntBre reviewed Jun 4, 2025

View reviewed changes

ntBre mentioned this pull request Jun 5, 2025

[New rule] Octal literal for chmod mode bits #18464

Closed

dericcrago force-pushed the 17853-cls-dict-annotations branch 2 times, most recently from 8bfef8e to b5a45a8 Compare June 8, 2025 20:18

ntBre approved these changes Jun 18, 2025

View reviewed changes

crates/ruff_linter/src/rules/ruff/rules/class_dict_annotations.rs Outdated Show resolved Hide resolved

crates/ruff_linter/src/rules/ruff/rules/class_dict_annotations.rs Outdated Show resolved Hide resolved

dericcrago and others added 12 commits June 19, 2025 02:26

Added cls.__dict__.get('__annotations__') check for Python 3.10+ and

ff7d452

Python < 3.10 with `typing_extensions` enabled.

implemented PR review suggestions

c7a5215

Trimmed message (slightly)

cdf1139

Fixed usage of typing-extensions: module is installed & setting is …

6364a5b

…enabled

implemented PR review suggestions

598eb97

Co-authored-by: Brent Westbrook <[email protected]>

renumbered to RUF063

04840b3

updated to 'checker.report_diagnostic(ClassDictAnnotations, call.rang…

3972231

…e());'

updated suggestion message based on python version and typing-extensi…

0b5c64f

…ons setting

remove unnecessary block

bb5894e

improve message formatting

b11802e

rename to 'AnnotationsFromClassDict'

00cfbd8

dericcrago force-pushed the 17853-cls-dict-annotations branch from b5a45a8 to c31b5d6 Compare June 19, 2025 06:39

MichaReiser requested a review from ntBre June 19, 2025 14:30

MichaReiser added 2 commits June 19, 2025 16:32

Merge branch 'main' into 17853-cls-dict-annotations

6def89e

Merge branch 'main' into 17853-cls-dict-annotations

48a5000

ntBre approved these changes Jun 20, 2025

View reviewed changes

ntBre changed the title ~~Added cls.__dict__.get('__annotations__') check~~ [ruff] Added cls.__dict__.get('__annotations__') check (RUF063) Jun 20, 2025

ntBre merged commit e66f182 into astral-sh:main Jun 20, 2025
35 checks passed

dericcrago deleted the 17853-cls-dict-annotations branch June 20, 2025 13:39

BrewTestBot mentioned this pull request Jun 26, 2025

ruff 0.12.1 Homebrew/homebrew-core#228300

Merged

[ruff] Added cls.__dict__.get('__annotations__') check (RUF063) #18233

[ruff] Added cls.__dict__.get('__annotations__') check (RUF063) #18233

Uh oh!

Conversation

dericcrago commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

AlexWaygood commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ruff-ecosystem results

Linter (stable)

Linter (preview)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dericcrago commented May 21, 2025

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

JelleZijlstra May 23, 2025

Choose a reason for hiding this comment

Uh oh!

dericcrago May 23, 2025

Choose a reason for hiding this comment

Uh oh!

JelleZijlstra May 23, 2025

Choose a reason for hiding this comment

Uh oh!

dericcrago May 23, 2025

Choose a reason for hiding this comment

Uh oh!

MichaReiser commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ntBre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ntBre left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ntBre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

[`ruff`] Added `cls.dict.get('annotations')` check (`RUF063`) #18233

[`ruff`] Added `cls.dict.get('annotations')` check (`RUF063`) #18233

dericcrago commented May 20, 2025 •

edited

Loading

AlexWaygood commented May 20, 2025 •

edited

Loading

github-actions bot commented May 20, 2025 •

edited

Loading

`ruff-ecosystem` results

MichaReiser commented May 23, 2025 •

edited

Loading

ntBre left a comment •

edited

Loading