[ty] Add support for `@total_ordering` by charliermarsh · Pull Request #22181 · astral-sh/ruff

charliermarsh · 2025-12-24T19:24:22Z

Summary

We have some suppressions in the pyx codebase related to this, so wanted to resolve.

charliermarsh · 2025-12-24T19:24:54Z

crates/ty_python_semantic/resources/mdtest/decorators/total_ordering.md

+```py
+from functools import total_ordering
+
+@total_ordering


I wonder if we should have a dedicated diagnostic for this?

Yeah, I think we should -- it seems like Pyright does.

astral-sh-bot · 2025-12-24T19:26:42Z

Diagnostic diff on typing conformance tests

No changes detected when running ty on typing conformance tests ✅

astral-sh-bot · 2025-12-24T19:27:16Z

`mypy_primer` results

Changes were detected when running on open source projects

mkosi (https://github.com/systemd/mkosi)
- mkosi/qemu.py:1062:9: error[unsupported-operator] Operator `>=` is not supported between two objects of type `GenericVersion`
- mkosi/qemu.py:1171:12: error[unsupported-operator] Operator `>=` is not supported between two objects of type `GenericVersion`
- Found 98 diagnostics
+ Found 96 diagnostics

pydantic (https://github.com/pydantic/pydantic)
- pydantic/fields.py:943:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`
+ pydantic/fields.py:943:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`
- pydantic/fields.py:983:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`
+ pydantic/fields.py:983:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`
- pydantic/fields.py:1026:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`
+ pydantic/fields.py:1026:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`
- pydantic/fields.py:1066:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`
+ pydantic/fields.py:1066:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`
- pydantic/fields.py:1109:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`
+ pydantic/fields.py:1109:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`
- pydantic/fields.py:1148:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`
+ pydantic/fields.py:1148:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`
- pydantic/fields.py:1188:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`
+ pydantic/fields.py:1188:5: error[invalid-parameter-default] Default value of type `PydanticUndefinedType` is not assignable to annotated parameter type `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`
- pydantic/fields.py:1567:13: error[invalid-argument-type] Argument is incorrect: Expected `dict[str, Divergent] | ((dict[str, Divergent], /) -> None) | None`, found `Top[dict[Unknown, Unknown]] | (((dict[str, Divergent], /) -> None) & ~Top[dict[Unknown, Unknown]]) | None`
+ pydantic/fields.py:1567:13: error[invalid-argument-type] Argument is incorrect: Expected `dict[str, int | float | str | ... omitted 3 union elements] | ((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) | None`, found `Top[dict[Unknown, Unknown]] | (((dict[str, int | float | str | ... omitted 3 union elements], /) -> None) & ~Top[dict[Unknown, Unknown]]) | None`

Tanjun (https://github.com/FasterSpeeding/Tanjun)
- tanjun/dependencies/data.py:347:12: error[invalid-return-type] Return type does not match returned value: expected `_T@cached_inject`, found `_T@cached_inject | Coroutine[Any, Any, _T@cached_inject | Coroutine[Any, Any, _T@cached_inject]]`
+ tanjun/dependencies/data.py:347:12: error[invalid-return-type] Return type does not match returned value: expected `_T@cached_inject`, found `Coroutine[Any, Any, _T@cached_inject | Coroutine[Any, Any, _T@cached_inject]] | _T@cached_inject`

cloud-init (https://github.com/canonical/cloud-init)
- tests/integration_tests/dropins/test_custom_modules.py:26:8: error[unsupported-operator] Operator `>=` is not supported between two objects of type `Release`
- tests/integration_tests/modules/test_disk_setup.py:263:12: error[unsupported-operator] Operator `<=` is not supported between two objects of type `Release`
- tests/integration_tests/net/test_dhcp.py:19:9: error[unsupported-operator] Operator `>=` is not supported between two objects of type `Release`
- tests/integration_tests/test_defaults.py:58:12: error[unsupported-operator] Operator `>=` is not supported between two objects of type `Release`
- Found 1187 diagnostics
+ Found 1183 diagnostics

prefect (https://github.com/PrefectHQ/prefect)
- src/integrations/prefect-dbt/prefect_dbt/core/settings.py:94:28: error[invalid-assignment] Object of type `T@resolve_block_document_references | dict[str, Any]` is not assignable to `dict[str, Any]`
+ src/integrations/prefect-dbt/prefect_dbt/core/settings.py:94:28: error[invalid-assignment] Object of type `T@resolve_block_document_references | dict[str, Any] | str | ... omitted 4 union elements` is not assignable to `dict[str, Any]`
- src/integrations/prefect-dbt/prefect_dbt/core/settings.py:99:28: error[invalid-assignment] Object of type `T@resolve_variables | dict[str, Any]` is not assignable to `dict[str, Any]`
+ src/integrations/prefect-dbt/prefect_dbt/core/settings.py:99:28: error[invalid-assignment] Object of type `T@resolve_variables | str | int | ... omitted 4 union elements` is not assignable to `dict[str, Any]`
- src/prefect/cli/deploy/_core.py:86:21: error[invalid-assignment] Object of type `T@resolve_block_document_references | dict[str, Any]` is not assignable to `dict[str, Any]`
+ src/prefect/cli/deploy/_core.py:86:21: error[invalid-assignment] Object of type `T@resolve_block_document_references | dict[str, Any] | str | ... omitted 4 union elements` is not assignable to `dict[str, Any]`
- src/prefect/cli/deploy/_core.py:87:21: error[invalid-assignment] Object of type `T@resolve_variables` is not assignable to `dict[str, Any]`
+ src/prefect/cli/deploy/_core.py:87:21: error[invalid-assignment] Object of type `T@resolve_variables | str | int | ... omitted 4 union elements` is not assignable to `dict[str, Any]`
- src/prefect/deployments/steps/core.py:137:38: error[invalid-argument-type] Argument is incorrect: Expected `T@resolve_variables`, found `T@resolve_block_document_references | dict[str, Any]`
+ src/prefect/deployments/steps/core.py:137:38: error[invalid-argument-type] Argument is incorrect: Expected `T@resolve_variables`, found `T@resolve_block_document_references | dict[str, Any] | str | ... omitted 4 union elements`
- src/prefect/utilities/templating.py:320:13: error[invalid-assignment] Invalid subscript assignment with key of type `object` and value of type `T@resolve_block_document_references | dict[str, Any]` on object of type `dict[str, Any]`
+ src/prefect/utilities/templating.py:320:13: error[invalid-assignment] Invalid subscript assignment with key of type `object` and value of type `T@resolve_block_document_references | dict[str, Any] | str | ... omitted 4 union elements` on object of type `dict[str, Any]`
- src/prefect/utilities/templating.py:323:16: error[invalid-return-type] Return type does not match returned value: expected `T@resolve_block_document_references | dict[str, Any]`, found `list[T@resolve_block_document_references | dict[str, Any] | Unknown]`
+ src/prefect/utilities/templating.py:323:16: error[invalid-return-type] Return type does not match returned value: expected `T@resolve_block_document_references | dict[str, Any]`, found `list[T@resolve_block_document_references | dict[str, Any] | str | ... omitted 5 union elements]`
- src/prefect/utilities/templating.py:437:16: error[invalid-return-type] Return type does not match returned value: expected `T@resolve_variables`, found `dict[object, T@resolve_variables | Unknown]`
+ src/prefect/utilities/templating.py:437:16: error[invalid-return-type] Return type does not match returned value: expected `T@resolve_variables`, found `dict[object, T@resolve_variables | str | int | ... omitted 5 union elements]`
- src/prefect/utilities/templating.py:442:16: error[invalid-return-type] Return type does not match returned value: expected `T@resolve_variables`, found `list[T@resolve_variables | Unknown]`
+ src/prefect/utilities/templating.py:442:16: error[invalid-return-type] Return type does not match returned value: expected `T@resolve_variables`, found `list[T@resolve_variables | str | int | ... omitted 5 union elements]`
- src/prefect/workers/base.py:232:13: error[invalid-argument-type] Argument is incorrect: Expected `T@resolve_variables`, found `T@resolve_block_document_references | dict[str, Any]`
+ src/prefect/workers/base.py:232:13: error[invalid-argument-type] Argument is incorrect: Expected `T@resolve_variables`, found `T@resolve_block_document_references | dict[str, Any] | str | ... omitted 4 union elements`
- src/prefect/workers/base.py:234:20: error[invalid-argument-type] Argument expression after ** must be a mapping type: Found `T@resolve_variables`
+ src/prefect/workers/base.py:234:20: error[invalid-argument-type] Argument expression after ** must be a mapping type: Found `T@resolve_variables | str | int | ... omitted 4 union elements`

scikit-build-core (https://github.com/scikit-build/scikit-build-core)
- src/scikit_build_core/build/wheel.py:98:20: error[no-matching-overload] No overload of bound method `__init__` matches arguments
- Found 48 diagnostics
+ Found 47 diagnostics

static-frame (https://github.com/static-frame/static-frame)
- static_frame/core/series.py:772:16: error[invalid-return-type] Return type does not match returned value: expected `InterGetItemILocReduces[Series[Any, Any], TVDtype@Series]`, found `InterGetItemILocReduces[Series[Any, Any] | TypeBlocks | Batch | ... omitted 6 union elements, generic[object]]`
+ static_frame/core/series.py:772:16: error[invalid-return-type] Return type does not match returned value: expected `InterGetItemILocReduces[Series[Any, Any], TVDtype@Series]`, found `InterGetItemILocReduces[Top[Index[Any]] | TypeBlocks | Top[Bus[Any]] | ... omitted 6 union elements, generic[object]]`
- static_frame/core/series.py:4072:16: error[invalid-return-type] Return type does not match returned value: expected `InterGetItemILocReduces[SeriesHE[Any, Any], TVDtype@SeriesHE]`, found `InterGetItemILocReduces[Bottom[Series[Any, Any]] | TypeBlocks | Batch | ... omitted 7 union elements, generic[object]]`
+ static_frame/core/series.py:4072:16: error[invalid-return-type] Return type does not match returned value: expected `InterGetItemILocReduces[SeriesHE[Any, Any], TVDtype@SeriesHE]`, found `InterGetItemILocReduces[Self@iloc | SeriesHE[Any, Any], generic[object]]`

pandas-stubs (https://github.com/pandas-dev/pandas-stubs)
- pandas-stubs/_typing.pyi:1232:16: warning[unused-ignore-comment] Unused blanket `type: ignore` directive
- Found 5156 diagnostics
+ Found 5155 diagnostics

rotki (https://github.com/rotki/rotki)
- rotkehlchen/chain/decoding/tools.py:97:13: error[invalid-argument-type] Argument to function `decode_transfer_direction` is incorrect: Expected `(A@BaseDecoderTools & BTCAddress) | (A@BaseDecoderTools & ChecksumAddress) | (A@BaseDecoderTools & SubstrateAddress) | (A@BaseDecoderTools & SolanaAddress)`, found `A@BaseDecoderTools`
+ rotkehlchen/chain/decoding/tools.py:99:13: error[invalid-argument-type] Argument to function `decode_transfer_direction` is incorrect: Expected `Sequence[A@BaseDecoderTools]`, found `Unknown | tuple[BTCAddress, ...] | tuple[ChecksumAddress, ...] | tuple[SubstrateAddress, ...] | tuple[SolanaAddress, ...]`
- rotkehlchen/chain/decoding/tools.py:98:13: error[invalid-argument-type] Argument to function `decode_transfer_direction` is incorrect: Expected `(A@BaseDecoderTools & BTCAddress) | (A@BaseDecoderTools & ChecksumAddress) | (A@BaseDecoderTools & SubstrateAddress) | (A@BaseDecoderTools & SolanaAddress) | None`, found `A@BaseDecoderTools | None`
- rotkehlchen/chain/decoding/tools.py:99:13: error[invalid-argument-type] Argument to function `decode_transfer_direction` is incorrect: Expected `Sequence[(A@BaseDecoderTools & BTCAddress) | (A@BaseDecoderTools & ChecksumAddress) | (A@BaseDecoderTools & SubstrateAddress) | (A@BaseDecoderTools & SolanaAddress)]`, found `Unknown | tuple[BTCAddress, ...] | tuple[ChecksumAddress, ...] | tuple[SubstrateAddress, ...] | tuple[SolanaAddress, ...]`
- Found 2094 diagnostics
+ Found 2092 diagnostics

No memory usage changes detected ✅

charliermarsh · 2025-12-24T19:29:44Z

Keeping in draft while I add a new diagnostic.

charliermarsh · 2025-12-24T19:30:04Z

Although that could plausibly be its own PR.

charliermarsh · 2025-12-24T19:48:24Z

I implemented the diagnostic in a separate PR (since it's absence here doesn't cause any false positives or false negatives on the comparators, at least): #22183

AlexWaygood · 2025-12-24T20:01:24Z

in the ty codebase

guessing you mean pyx? :P

charliermarsh · 2025-12-24T20:04:04Z

Err… yes :)

AlexWaygood · 2025-12-24T20:04:21Z

I'm surprised there aren't more diagnostics going away in the ecosystem. I thought functools.total_ordering was pretty popular

crates/ty_python_semantic/src/types/function.rs

charliermarsh · 2025-12-24T20:34:42Z

I'm surprised it's not in the conformance tests!

astral-sh-bot · 2026-01-05T21:05:16Z

`ecosystem-analyzer` results

Lint rule	Added	Removed	Changed
`invalid-argument-type`	4	2	5
`unsupported-operator`	0	6	0
`invalid-assignment`	0	0	5
`invalid-return-type`	0	1	4
`possibly-missing-attribute`	3	0	1
`invalid-await`	2	0	0
`unresolved-attribute`	0	0	2
`unused-ignore-comment`	0	1	0
Total	9	10	17

Full report with detailed diff (timing results)

carljm

Looks great! A few test suggestions, nothing blocking. Thank you!!

crates/ty_python_semantic/resources/mdtest/decorators/total_ordering.md

crates/ty_python_semantic/src/types/infer/builder.rs

charliermarsh · 2026-01-06T03:24:36Z

Thank you!

crates/ty_python_semantic/resources/mdtest/decorators/total_ordering.md

charliermarsh added the ty Multi-file analysis & type inference label Dec 24, 2025

charliermarsh commented Dec 24, 2025

View reviewed changes

charliermarsh force-pushed the charlie/functools branch from 93f81bf to 52e7d6f Compare December 24, 2025 19:45

charliermarsh force-pushed the charlie/functools branch from 52e7d6f to 240fc44 Compare December 24, 2025 19:54

charliermarsh marked this pull request as ready for review December 24, 2025 19:59

charliermarsh requested review from AlexWaygood, MichaReiser, carljm, dcreager and sharkdp as code owners December 24, 2025 19:59

AlexWaygood reviewed Dec 24, 2025

View reviewed changes

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

charliermarsh requested a review from AlexWaygood December 24, 2025 20:45

charliermarsh added the ecosystem-analyzer label Jan 5, 2026

carljm approved these changes Jan 6, 2026

View reviewed changes

[ty] Add support for @total_ordering

1e742f4

charliermarsh force-pushed the charlie/functools branch from 15b9212 to f50ca7a Compare January 6, 2026 03:24

carljm reviewed Jan 6, 2026

View reviewed changes

crates/ty_python_semantic/resources/mdtest/decorators/total_ordering.md Outdated Show resolved Hide resolved

Apply review feedback

815e631

charliermarsh force-pushed the charlie/functools branch from f50ca7a to 815e631 Compare January 6, 2026 03:30

charliermarsh merged commit 28fa021 into main Jan 6, 2026
48 checks passed

charliermarsh deleted the charlie/functools branch January 6, 2026 03:47

behrmann mentioned this pull request Jan 10, 2026

total_ordering generated methods should derive their signature from the user-provided comparison method astral-sh/ty#2435

Closed

Conversation

charliermarsh commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

charliermarsh Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

charliermarsh Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

charliermarsh Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

astral-sh-bot bot commented Dec 24, 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!

astral-sh-bot bot commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

mypy_primer results

Uh oh!

charliermarsh commented Dec 24, 2025

Uh oh!

charliermarsh commented Dec 24, 2025

Uh oh!

charliermarsh commented Dec 24, 2025

Uh oh!

AlexWaygood commented Dec 24, 2025

Uh oh!

charliermarsh commented Dec 24, 2025

Uh oh!

AlexWaygood commented Dec 24, 2025

Uh oh!

Uh oh!

charliermarsh commented Dec 24, 2025

Uh oh!

astral-sh-bot bot commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ecosystem-analyzer results

Uh oh!

carljm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

charliermarsh commented Jan 6, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

charliermarsh commented Dec 24, 2025 •

edited

Loading

astral-sh-bot bot commented Dec 24, 2025 •

edited

Loading

astral-sh-bot bot commented Dec 24, 2025 •

edited

Loading

`mypy_primer` results

astral-sh-bot bot commented Jan 5, 2026 •

edited

Loading

`ecosystem-analyzer` results