[ty] infer `name` and `value` for enum members by thejchap · Pull Request #20311 · astral-sh/ruff

thejchap · 2025-09-09T02:49:46Z

summary

this pr implements the following attributes for Enum members:
- name
- _name_
- value
- _value_
adds a TODO test for my_enum_class_instance.name
only implements if the instance is a subclass of Enum re: this comment and existing test

pointers

test plan

mdtests
triaged conformance diffs here: https://diffswarm.dev/d-01k531ag4nee3xmdeq4f3j66pb
triaged mypy primer diffs here for django-stubs: https://diffswarm.dev/d-01k5331n13k9yx8tvnxnkeawp3
- added a TODO test for overriding .value
discord diff seems reasonable

github-actions · 2025-09-10T01:45:48Z

Diagnostic diff on typing conformance tests

Changes were detected when running ty on typing conformance tests

--- old-output.txt	2025-09-17 07:23:56.516264569 +0000
+++ new-output.txt	2025-09-17 07:23:59.584286258 +0000
@@ -316,16 +316,9 @@
 enums_behaviors.py:32:1: error[type-assertion-failure] Argument does not have asserted type `Literal[Color.BLUE]`
 enums_behaviors.py:44:21: error[subclass-of-final-class] Class `ExtendedShape` cannot inherit from final class `Shape`
 enums_expansion.py:52:9: error[type-assertion-failure] Argument does not have asserted type `CustomFlags`
-enums_member_names.py:21:1: error[type-assertion-failure] Argument does not have asserted type `Literal["RED"]`
-enums_member_names.py:22:1: error[type-assertion-failure] Argument does not have asserted type `Literal["RED"]`
-enums_member_names.py:26:5: error[type-assertion-failure] Argument does not have asserted type `Literal["RED", "BLUE"]`
 enums_member_names.py:30:5: error[type-assertion-failure] Argument does not have asserted type `Literal["RED", "BLUE", "GREEN"]`
-enums_member_values.py:21:1: error[type-assertion-failure] Argument does not have asserted type `Literal[1]`
-enums_member_values.py:22:1: error[type-assertion-failure] Argument does not have asserted type `Literal[1]`
-enums_member_values.py:26:5: error[type-assertion-failure] Argument does not have asserted type `Literal[1, 3]`
 enums_member_values.py:30:5: error[type-assertion-failure] Argument does not have asserted type `Literal[1, 2, 3]`
 enums_member_values.py:54:1: error[type-assertion-failure] Argument does not have asserted type `Literal[1]`
-enums_member_values.py:68:1: error[type-assertion-failure] Argument does not have asserted type `Literal[1]`
 enums_member_values.py:96:1: error[type-assertion-failure] Argument does not have asserted type `int`
 enums_members.py:128:21: info[revealed-type] Revealed type: `Unknown | Literal[2]`
 enums_members.py:129:9: error[type-assertion-failure] Argument does not have asserted type `Unknown`
@@ -869,5 +862,5 @@
 typeddicts_usage.py:28:1: error[missing-typed-dict-key] Missing required key 'name' in TypedDict `Movie` constructor
 typeddicts_usage.py:28:18: error[invalid-key] Invalid key access on TypedDict `Movie`: Unknown key "title"
 typeddicts_usage.py:40:24: error[invalid-type-form] The special form `typing.TypedDict` is not allowed in type expressions. Did you mean to use a concrete TypedDict or `collections.abc.Mapping[str, object]` instead?
-Found 870 diagnostics
+Found 863 diagnostics
 WARN A fatal error occurred while checking some files. Not all project files were analyzed. See the diagnostics list above for details.

github-actions · 2025-09-10T01:48:06Z

`mypy_primer` results

Changes were detected when running on open source projects

django-stubs (https://github.com/typeddjango/django-stubs)
- tests/assert_type/db/models/_enums.py:20:1: error[type-assertion-failure] Argument does not have asserted type `Literal["NORTH"]`
- tests/assert_type/db/models/test_enums.py:144:1: error[type-assertion-failure] Argument does not have asserted type `Literal["CLUB"]`
- tests/assert_type/db/models/test_enums.py:155:1: error[type-assertion-failure] Argument does not have asserted type `Literal["SENIOR"]`
- tests/assert_type/db/models/test_enums.py:167:1: error[type-assertion-failure] Argument does not have asserted type `Literal["CAR"]`
- tests/assert_type/db/models/test_enums.py:181:1: error[type-assertion-failure] Argument does not have asserted type `Literal["MALE"]`
- tests/assert_type/db/models/test_enums.py:194:1: error[type-assertion-failure] Argument does not have asserted type `Literal["GOLD"]`
- tests/assert_type/db/models/test_enums.py:207:1: error[type-assertion-failure] Argument does not have asserted type `Literal["FS"]`
- tests/assert_type/db/models/test_enums.py:221:1: error[type-assertion-failure] Argument does not have asserted type `Literal["PI"]`
- tests/assert_type/db/models/test_enums.py:235:1: error[type-assertion-failure] Argument does not have asserted type `Literal["ABYSS"]`
+ tests/assert_type/db/models/test_enums.py:237:1: error[type-assertion-failure] Argument does not have asserted type `Any`
- tests/assert_type/db/models/test_enums.py:248:1: error[type-assertion-failure] Argument does not have asserted type `Literal["NORTH"]`
- tests/assert_type/db/models/test_enums.py:260:1: error[type-assertion-failure] Argument does not have asserted type `Literal["NORTH"]`
- Found 476 diagnostics
+ Found 466 diagnostics

discord.py (https://github.com/Rapptz/discord.py)
- discord/audit_logs.py:550:56: error[invalid-argument-type] Argument to bound method `from_data` is incorrect: Expected `int`, found `None | Unknown | (Unknown & ~None) | Literal[-1]`
+ discord/audit_logs.py:550:56: error[invalid-argument-type] Argument to bound method `from_data` is incorrect: Expected `int`, found `None | Unknown | (Unknown & ~None) | Literal[3, 4, 1, 5, -1]`
- discord/audit_logs.py:551:55: error[invalid-argument-type] Argument to bound method `from_data` is incorrect: Expected `int`, found `None | Unknown | (Unknown & ~None) | Literal[-1]`
+ discord/audit_logs.py:551:55: error[invalid-argument-type] Argument to bound method `from_data` is incorrect: Expected `int`, found `None | Unknown | (Unknown & ~None) | Literal[3, 4, 1, 5, -1]`

No memory usage changes detected ✅

thejchap · 2025-09-12T00:50:59Z

@sharkdp could use some feedback on approach for _value_/value before i get further in

i am thinking to add a value_ty field to EnumLiteralType that stores this value, which i think would require giving EnumMetadata the 'db lifetime

anything im missing there or other recommendations?

sharkdp · 2025-09-12T07:26:43Z

i am thinking to add a value_ty field to EnumLiteralType that stores this value

I would rather expect that we add the value Type for enum members to members on EnumMetadata? Maybe by turning it to a Name => Type HashMap? Is that what you meant?

which i think would require giving EnumMetadata the 'db lifetime

Yes, it looks like that would require adding a lifetime parameter to EnumMetadata.

anything im missing there

I don't think so

codspeed-hq · 2025-09-13T03:14:51Z

CodSpeed Instrumentation Performance Report

Merging #20311 will not alter performance

_{Comparing thejchap:thejchap/enum-members (78528f6) with main (d121a76)}

Summary

✅ 43 untouched

crates/ty_python_semantic/src/types/enums.rs

github-actions · 2025-09-13T13:00:56Z

`ruff-ecosystem` results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

crates/ty_python_semantic/resources/mdtest/enums.md

github-actions · 2025-09-15T08:47:49Z

`ecosystem-analyzer` results

Lint rule	Added	Removed	Changed
`type-assertion-failure`	1	11	0
`invalid-argument-type`	0	0	2
Total	1	11	2

sharkdp

Thank you very much. This looks great.

crates/ty_python_semantic/resources/mdtest/enums.md

crates/ty_python_semantic/src/types.rs

crates/ty_python_semantic/src/types/builder.rs

crates/ty_python_semantic/src/types/enums.rs

astral-sh/ty#876

sharkdp

Thank you!

Glad we could get rid of the performance regression.

AlexWaygood added the ty Multi-file analysis & type inference label Sep 9, 2025

thejchap force-pushed the thejchap/enum-members branch from 4606136 to 64c8a66 Compare September 10, 2025 01:42

thejchap force-pushed the thejchap/enum-members branch from 64c8a66 to da7ed1f Compare September 13, 2025 03:03

thejchap force-pushed the thejchap/enum-members branch 2 times, most recently from 5c75f79 to 1c247f9 Compare September 13, 2025 12:33

thejchap commented Sep 13, 2025

View reviewed changes

crates/ty_python_semantic/src/types/enums.rs Outdated Show resolved Hide resolved

thejchap force-pushed the thejchap/enum-members branch 2 times, most recently from 64830e6 to 809a225 Compare September 13, 2025 12:48

thejchap changed the title ~~[ty] infer type for enum members~~ [ty] infer name and value for enum members Sep 13, 2025

thejchap force-pushed the thejchap/enum-members branch 4 times, most recently from c34449e to a3af30d Compare September 14, 2025 03:21

thejchap marked this pull request as ready for review September 14, 2025 03:30

thejchap requested review from AlexWaygood, carljm, dcreager and sharkdp as code owners September 14, 2025 03:30

thejchap commented Sep 14, 2025

View reviewed changes

crates/ty_python_semantic/resources/mdtest/enums.md Show resolved Hide resolved

sharkdp added the ecosystem-analyzer label Sep 15, 2025

sharkdp reviewed Sep 15, 2025

View reviewed changes

thejchap force-pushed the thejchap/enum-members branch 2 times, most recently from 0370e59 to 0df220f Compare September 16, 2025 18:20

carljm removed their request for review September 16, 2025 18:37

[ty] infer type for enum members

63fd2f4

astral-sh/ty#876

thejchap force-pushed the thejchap/enum-members branch from 0df220f to 63fd2f4 Compare September 16, 2025 20:09

dcreager removed their request for review September 17, 2025 01:27

Move tests out of members/non-members section

78528f6

sharkdp approved these changes Sep 17, 2025

View reviewed changes

sharkdp merged commit 9f0b942 into astral-sh:main Sep 17, 2025
38 checks passed

Comments

Conversation

thejchap commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

summary

pointers

test plan

Uh oh!

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

Uh oh!

Diagnostic diff on typing conformance tests

Uh oh!

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

Uh oh!

mypy_primer results

Uh oh!

thejchap commented Sep 12, 2025

Uh oh!

sharkdp commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codspeed-hq bot commented Sep 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Instrumentation Performance Report

Merging #20311 will not alter performance

Summary

Uh oh!

Uh oh!

github-actions bot commented Sep 13, 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!

github-actions bot commented Sep 15, 2025

ecosystem-analyzer results

Uh oh!

sharkdp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sharkdp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

thejchap commented Sep 9, 2025 •

edited

Loading

github-actions bot commented Sep 10, 2025 •

edited

Loading

github-actions bot commented Sep 10, 2025 •

edited

Loading

`mypy_primer` results

sharkdp commented Sep 12, 2025 •

edited

Loading

codspeed-hq bot commented Sep 13, 2025 •

edited

Loading

github-actions bot commented Sep 13, 2025 •

edited

Loading

`ruff-ecosystem` results

`ecosystem-analyzer` results