Migrate from pyright to ty type checker by koxudaxi · Pull Request #2928 · koxudaxi/datamodel-code-generator

koxudaxi · 2026-01-05T16:48:00Z

Summary by CodeRabbit

Chores
- Updated development tooling and internal configuration for project maintenance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-05T16:48:14Z

Warning

Rate limit exceeded

@koxudaxi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 52 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 0d090d5 and 9cd72a3.

📒 Files selected for processing (4)

src/datamodel_code_generator/format.py
src/datamodel_code_generator/input_model.py
src/datamodel_code_generator/parser/graphql.py
src/datamodel_code_generator/parser/jsonschema.py

📝 Walkthrough

Walkthrough

This pull request migrates the project's type checking tool from Pyright to Ty. The changes include updating the dependency declaration in pyproject.toml, replacing Pyright-specific type-ignore directives with generic ty: ignore comments throughout the codebase, and updating the type-checking command in tox.ini.

Changes

Cohort / File(s)	Summary
Configuration & Build `pyproject.toml`, `tox.ini`	Replaced Pyright dependency with `ty>=0.0.8`; updated `[tool.pyright]` configuration block with new `[tool.ty.*]` configuration sections for src, environment, and rules; changed type-checking command from `pyright src` to `ty check src`
Parser Modules `src/datamodel_code_generator/__init__.py`, `src/datamodel_code_generator/parser/base.py`, `src/datamodel_code_generator/parser/graphql.py`, `src/datamodel_code_generator/parser/jsonschema.py`, `src/datamodel_code_generator/parser/openapi.py`	Updated type-ignore comments from Pyright-specific directives to generic `ty: ignore` annotations on parser instantiations, config creation, and resolver/field handling
Pydantic Model Modules `src/datamodel_code_generator/model/base.py`, `src/datamodel_code_generator/model/pydantic/__init__.py`, `src/datamodel_code_generator/model/pydantic/base_model.py`, `src/datamodel_code_generator/model/pydantic/types.py`, `src/datamodel_code_generator/model/pydantic_v2/base_model.py`, `src/datamodel_code_generator/model/pydantic_v2/dataclass.py`, `src/datamodel_code_generator/model/msgspec.py`	Replaced Pyright-specific ignore comments (e.g., `reportAssignmentType`, `reportIncompatibleVariableOverride`) with generic `ty: ignore` annotations on ConfigDict usage, field validators, and model configuration declarations
Utility & Core Modules `src/datamodel_code_generator/__main__.py`, `src/datamodel_code_generator/format.py`, `src/datamodel_code_generator/http.py`, `src/datamodel_code_generator/input_model.py`, `src/datamodel_code_generator/types.py`, `src/datamodel_code_generator/util.py`, `src/datamodel_code_generator/pydantic_patch.py`, `src/datamodel_code_generator/reference.py`, `src/datamodel_code_generator/watch.py`	Updated type-ignore directives from Pyright-specific comments to generic `ty: ignore` across validators, return statements, config assignments, and function call annotations

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested labels

safe-to-fix

Suggested reviewers

ilovelinux

Poem

🐰 A rabbit hops through code so bright,
From Pyright's gaze to Ty's keen sight!
Each # ty: ignore placed with care,
Type-checking tools beyond compare,
The migration's done—hooray, hooray! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and directly describes the main change: migrating the project from pyright to ty type checker, which is reflected across all modified files.
Docstring Coverage	✅ Passed	Docstring coverage is 84.78% which is sufficient. The required threshold is 80.00%.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-01-05T16:48:44Z

📚 Docs Preview: https://pr-2928.datamodel-code-generator.pages.dev

codspeed-hq · 2026-01-05T16:50:58Z

CodSpeed Performance Report

Merging #2928 will not alter performance

_{Comparing migrate-pyright-to-ty (9cd72a3) with main (5acb178)}

⚠️

Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

Summary

✅ 11 untouched
⏩ 98 skipped¹

98 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

coderabbitai

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

src/datamodel_code_generator/util.py (1)
185-201: Clean up unused noqa on validator import

Ruff flags the # noqa: PLC0415 on the validator import as unused (rule not enabled), so it can be dropped without changing behavior. The adjacent # ty: ignore on the return lines is fine for the Pydantic v1/v2 shim.

[static_analysis_hint]
Suggested diff to remove unused # noqa
-        from pydantic import validator  # noqa: PLC0415  # pragma: no cover
+        from pydantic import validator  # pragma: no cover
src/datamodel_code_generator/parser/openapi.py (1)
309-323: Discriminator field augmentation and response typing: behavior OK; drop unused PLW2901 noqa

Using properties.get(field_obj.original_name) with # ty: ignore and then guarding via isinstance(field, JsonSchemaObject) is safe and leaves runtime unchanged.

Similarly, data_types[status_code][content_type] = data_type # ty: ignore only suppresses a key-type check on the defaultdict.

Ruff also reports # noqa: PLW2901 here as unused; you can simplify the line to keep only the Ty suppression:

[static_analysis_hint]
Suggested diff for PLW2901 # noqa cleanup
-                field_obj = self.data_model_field_type(**{  # noqa: PLW2901  # ty: ignore
+                field_obj = self.data_model_field_type(**{  # ty: ignore
Also applies to: 480-484

🧹 Nitpick comments (5)

src/datamodel_code_generator/watch.py (1)
16-16: Address the unused noqa directive.

The static analysis tool correctly identifies that the noqa: PLC0415 directive is no longer needed (Ruff reports it as unused). Consider removing it.
🔎 Proposed fix
-        import watchfiles  # noqa: PLC0415  # ty: ignore
+        import watchfiles  # ty: ignore
src/datamodel_code_generator/reference.py (1)
1234-1240: Optional: tighten get_singular_name to avoid ty ignores

You can remove the # ty: ignore markers here by explicitly narrowing the return type from inflect:
Proposed refactor for get_singular_name
 @lru_cache
 def get_singular_name(name: str, suffix: str = SINGULAR_NAME_SUFFIX) -> str:
     """Convert a plural name to singular form."""
-    singular_name = _get_inflect_engine().singular_noun(cast("inflect.Word", name))  # ty: ignore
-    if singular_name is False:
-        singular_name = f"{name}{suffix}"
-    return singular_name  # ty: ignore
+    singular = _get_inflect_engine().singular_noun(cast("inflect.Word", name))
+    if singular is False:
+        return f"{name}{suffix}"
+    return cast(str, singular)
src/datamodel_code_generator/parser/openapi.py (1)

209-213: Config-derived attributes with ty-ignores are fine, but could later be tightened

Reading openapi_scopes, include_path_parameters, use_status_code_in_response_name, and openapi_include_paths from self.config with # ty: ignore is consistent with how Parser.config is used elsewhere, and doesn’t affect behavior. If you ever want to drop these ignores, a small runtime assertion (assert self.config is not None) or a narrowed attribute type on Parser.config would be enough.
src/datamodel_code_generator/__init__.py (1)
758-758: Clean up unused noqa directive.

Ruff correctly identifies an unused noqa directive on line 758. The comment # noqa: PLC0415 can be removed as the rule is not currently enabled.
🔎 Proposed fix
-        from datamodel_code_generator.parser.jsonschema import JsonSchemaParser  # noqa: PLC0415
+        from datamodel_code_generator.parser.jsonschema import JsonSchemaParser
src/datamodel_code_generator/__main__.py (1)
265-456: Clean up unused noqa directives.

Ruff identifies several unused # noqa: N805 directives on the following lines:

Line 265

Line 273

Line 429

Line 436

Line 456

These can be safely removed as the N805 rule is not currently enabled.
🔎 Proposed fix
-    @model_validator(mode="before")  # ty: ignore
-    def validate_additional_imports(cls, values: dict[str, Any]) -> dict[str, Any]:  # noqa: N805
+    @model_validator(mode="before")  # ty: ignore
+    def validate_additional_imports(cls, values: dict[str, Any]) -> dict[str, Any]:
Apply similar changes to lines 273, 429, 436, and 456.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5acb178 and 0d090d5.

⛔ Files ignored due to path filters (1)

uv.lock is excluded by !**/*.lock, !**/*.lock and included by none

📒 Files selected for processing (23)

pyproject.toml
src/datamodel_code_generator/__init__.py
src/datamodel_code_generator/__main__.py
src/datamodel_code_generator/format.py
src/datamodel_code_generator/http.py
src/datamodel_code_generator/input_model.py
src/datamodel_code_generator/model/base.py
src/datamodel_code_generator/model/msgspec.py
src/datamodel_code_generator/model/pydantic/__init__.py
src/datamodel_code_generator/model/pydantic/base_model.py
src/datamodel_code_generator/model/pydantic/types.py
src/datamodel_code_generator/model/pydantic_v2/base_model.py
src/datamodel_code_generator/model/pydantic_v2/dataclass.py
src/datamodel_code_generator/parser/base.py
src/datamodel_code_generator/parser/graphql.py
src/datamodel_code_generator/parser/jsonschema.py
src/datamodel_code_generator/parser/openapi.py
src/datamodel_code_generator/pydantic_patch.py
src/datamodel_code_generator/reference.py
src/datamodel_code_generator/types.py
src/datamodel_code_generator/util.py
src/datamodel_code_generator/watch.py
tox.ini

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2026-01-02T08:25:19.839Z

Learnt from: koxudaxi
Repo: koxudaxi/datamodel-code-generator PR: 2890
File: tests/data/expected/main/jsonschema/ref_nullable_with_constraint.py:14-15
Timestamp: 2026-01-02T08:25:19.839Z
Learning: The datamodel-code-generator currently generates RootModel subclasses with an explicit `root` field annotation (e.g., `class StringType(RootModel[str]): root: str`). This is existing behavior of the code generator and should not be flagged as an issue introduced by new changes.

Applied to files:

src/datamodel_code_generator/parser/base.py
src/datamodel_code_generator/model/pydantic/base_model.py
src/datamodel_code_generator/model/base.py
src/datamodel_code_generator/__init__.py
src/datamodel_code_generator/reference.py
src/datamodel_code_generator/model/pydantic/types.py
src/datamodel_code_generator/watch.py
src/datamodel_code_generator/format.py
src/datamodel_code_generator/model/pydantic_v2/dataclass.py
src/datamodel_code_generator/util.py
src/datamodel_code_generator/types.py
src/datamodel_code_generator/model/pydantic_v2/base_model.py
src/datamodel_code_generator/parser/openapi.py
src/datamodel_code_generator/__main__.py

📚 Learning: 2025-12-25T09:23:08.506Z

Learnt from: koxudaxi
Repo: koxudaxi/datamodel-code-generator PR: 2799
File: src/datamodel_code_generator/util.py:49-66
Timestamp: 2025-12-25T09:23:08.506Z
Learning: In datamodel-code-generator, the is_pydantic_v2() and is_pydantic_v2_11() functions in src/datamodel_code_generator/util.py intentionally use global variable caching (_is_v2, _is_v2_11) on top of lru_cache for performance optimization. This dual-layer caching eliminates function call overhead and cache lookup overhead for frequently-called version checks. The PLW0603 linter warnings should be suppressed with # noqa: PLW0603 as this is a deliberate design choice.

Applied to files:

src/datamodel_code_generator/model/base.py
src/datamodel_code_generator/reference.py
src/datamodel_code_generator/util.py
src/datamodel_code_generator/types.py
src/datamodel_code_generator/__main__.py

🧬 Code graph analysis (12)

src/datamodel_code_generator/model/pydantic/base_model.py (2)

src/datamodel_code_generator/util.py (1)

model_validate (302-306)

src/datamodel_code_generator/model/pydantic/__init__.py (1)

Config (26-47)

src/datamodel_code_generator/model/base.py (1)

src/datamodel_code_generator/model/pydantic_v2/__init__.py (1)

ConfigDict (29-55)

src/datamodel_code_generator/parser/jsonschema.py (2)

src/datamodel_code_generator/model/pydantic_v2/__init__.py (1)

ConfigDict (29-55)

src/datamodel_code_generator/config.py (1)

JSONSchemaParserConfig (350-351)

src/datamodel_code_generator/input_model.py (2)

src/datamodel_code_generator/model/base.py (1)

model_rebuild (201-208)

src/datamodel_code_generator/types.py (1)

model_rebuild (415-422)

src/datamodel_code_generator/reference.py (2)

src/datamodel_code_generator/util.py (4)

model_validator (125-130)

model_validator (134-140)

model_validator (144-148)

model_validator (151-182)

src/datamodel_code_generator/model/pydantic_v2/__init__.py (1)

ConfigDict (29-55)

src/datamodel_code_generator/model/msgspec.py (2)

src/datamodel_code_generator/types.py (2)

chain_as_tuple (186-193)

imports (620-674)

src/datamodel_code_generator/model/base.py (2)

imports (326-351)

imports (823-828)

src/datamodel_code_generator/model/pydantic_v2/dataclass.py (3)

src/datamodel_code_generator/model/msgspec.py (1)

Constraints (212-217)

src/datamodel_code_generator/model/pydantic/base_model.py (1)

Constraints (38-50)

src/datamodel_code_generator/model/pydantic_v2/base_model.py (1)

Constraints (56-74)

src/datamodel_code_generator/util.py (2)

src/datamodel_code_generator/reference.py (1)

_BaseModel (82-139)

src/datamodel_code_generator/__main__.py (1)

parse_obj (161-163)

src/datamodel_code_generator/types.py (1)

src/datamodel_code_generator/model/pydantic_v2/__init__.py (1)

ConfigDict (29-55)

src/datamodel_code_generator/model/pydantic_v2/base_model.py (4)

src/datamodel_code_generator/util.py (5)

model_validator (125-130)

model_validator (134-140)

model_validator (144-148)

model_validator (151-182)

model_validate (302-306)

src/datamodel_code_generator/model/msgspec.py (1)

Constraints (212-217)

src/datamodel_code_generator/model/pydantic/base_model.py (1)

Constraints (38-50)

src/datamodel_code_generator/model/pydantic_v2/__init__.py (1)

ConfigDict (29-55)

src/datamodel_code_generator/parser/openapi.py (5)

src/datamodel_code_generator/parser/base.py (1)

_create_default_config (699-727)

src/datamodel_code_generator/parser/jsonschema.py (1)

_create_default_config (659-683)

src/datamodel_code_generator/_types/parser_config_dicts.py (1)

OpenAPIParserConfigDict (173-177)

src/datamodel_code_generator/config.py (1)

OpenAPIParserConfig (354-360)

src/datamodel_code_generator/enums.py (1)

OpenAPIScope (70-78)

src/datamodel_code_generator/__main__.py (2)

src/datamodel_code_generator/model/pydantic_v2/__init__.py (1)

ConfigDict (29-55)

src/datamodel_code_generator/util.py (4)

model_validator (125-130)

model_validator (134-140)

model_validator (144-148)

model_validator (151-182)

🪛 Ruff (0.14.10)

src/datamodel_code_generator/__init__.py

758-758: Unused noqa directive (non-enabled: PLC0415)