Refactor generate() and Parser to use config directly by koxudaxi · Pull Request #2878 · koxudaxi/datamodel-code-generator

koxudaxi · 2025-12-30T21:31:30Z

Summary by CodeRabbit

Refactor
- Restructured internal configuration system to enhance code organization and maintainability.
- Improved parser architecture with enhanced type safety and structural flexibility for future extensibility.

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

coderabbitai · 2025-12-30T21:31:40Z

Warning

Rate limit exceeded

@koxudaxi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 22 minutes and 8 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 180595a and 8a4e90d.

📒 Files selected for processing (14)

.pre-commit-config.yaml
pyproject.toml
src/datamodel_code_generator/__init__.py
src/datamodel_code_generator/_types/__init__.py
src/datamodel_code_generator/_types/graphql_parser_config_dict.py
src/datamodel_code_generator/_types/jsonschema_parser_config_dict.py
src/datamodel_code_generator/_types/openapi_parser_config_dict.py
src/datamodel_code_generator/config.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
tests/main/test_main_general.py
tox.ini

📝 Walkthrough

Walkthrough

The PR refactors configuration handling across the codebase. The main module now routes all option access through GenerateConfig objects instead of local variables. The Parser base class becomes generic with a ParserConfigT type variable, introduces a _create_default_config classmethod, and updates init to accept generic config types. Derived parsers inherit with concrete types.

Changes

Cohort / File(s)	Summary
Configuration routing refactor `src/datamodel_code_generator/__init__.py`	Replaced 50+ direct local variable reads (output, target_python_version, encoding, feature flags) with config.* access patterns. Updated payload construction for OpenAPI/GraphQL/JSONSchema parsers, header generation logic, file I/O operations, and DataclassArguments construction to consume from GenerateConfig object throughout multiple call sites.
Generic Parser base class `src/datamodel_code_generator/parser/base.py`	Made Parser generic with ParserConfigT type variable bound to ParserConfig. Added _create_default_config classmethod for unified config construction. Updated init signature from `config: ParserConfig \| None` to `config: ParserConfigT \| None` and refactored initialization flow to populate internal state from resolved config object. Added Generic, TypeVar imports and type annotations.
Parser subclass generic inheritance `src/datamodel_code_generator/parser/graphql.py`, `src/datamodel_code_generator/parser/jsonschema.py`	Updated class signatures to inherit from Parser["ParserConfig"] instead of non-generic Parser base. No functional logic changes.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Simplify Parser.__init__ signature using Unpack[ParserConfigDict] #2877: Modifies Parser.init to accept config-driven signature with Unpack[ParserConfigDict]; the main PR further generalizes Parser to ParserConfigT and introduces _create_default_config classmethod for more flexible configuration handling.
Simplify generate() function signature using Unpack[GenerateConfigDict] #2874: Updates parser base and derived parser classes; both PRs modify Parser class signatures and initialization patterns, with this PR making Parser generic and changing config handling while the related PR adjusts parameter type aliases.

Suggested labels

breaking-change-analyzed, breaking-change

Poem

🐰 Configuration now flows through GenConfig's gentle stream,
Parser becomes generic—a type-safe dream!
No more scattered variables across the land,
One config object guides each parsing hand. ✨

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 accurately summarizes the main changes: refactoring the generate() function and Parser class to rely on config objects instead of scattered parameters.
Docstring Coverage	✅ Passed	Docstring coverage is 83.33% 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 · 2025-12-30T21:32:15Z

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

codspeed-hq · 2025-12-30T21:34:29Z

CodSpeed Performance Report

Merging #2878 will not alter performance

_{Comparing refactor/use-config-directly (8a4e90d) with main (0c5d538)}

⚠️

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. ↩

codecov · 2025-12-30T21:34:53Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.38%. Comparing base (0c5d538) to head (8a4e90d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2878      +/-   ##
==========================================
- Coverage   99.39%   99.38%   -0.01%     
==========================================
  Files          91       91              
  Lines       15820    15648     -172     
  Branches     1845     1849       +4     
==========================================
- Hits        15724    15552     -172     
  Misses         50       50              
  Partials       46       46

Flag	Coverage Δ
unittests	`99.38% <100.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/datamodel_code_generator/__init__.py (1)

616-639: Consistent use of config.encoding for file operations.

All file read operations correctly use config.encoding for consistent character encoding handling.

Regarding the static analysis hint at line 619: the # noqa: PLC0415 directive for the import io statement appears intentional for lazy imports. If PLC0415 is not enabled in your Ruff configuration, you could remove the directive.
src/datamodel_code_generator/parser/base.py (2)
704-706: Remove unused noqa directives.

The # noqa: PLC0415 directives are unnecessary as this rule is not enabled in the project's linter configuration. As per the static analysis hints, these can be safely removed.
🔎 Proposed fix
-        from datamodel_code_generator import types as types_module  # noqa: PLC0415
-        from datamodel_code_generator.config import ParserConfig  # noqa: PLC0415
-        from datamodel_code_generator.model import base as model_base  # noqa: PLC0415
+        from datamodel_code_generator import types as types_module
+        from datamodel_code_generator.config import ParserConfig
+        from datamodel_code_generator.model import base as model_base
728-728: Remove unused noqa directive.

The # noqa: PLR0912, PLR0915 directive is flagged as unused. The refactoring may have simplified the function enough that these complexity rules no longer trigger.
🔎 Proposed fix
-    def __init__(  # noqa: PLR0912, PLR0915
+    def __init__(

📜 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 0c5d538 and 180595a.

📒 Files selected for processing (4)

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

🧰 Additional context used

🧬 Code graph analysis (1)

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

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

Parser (691-3127)

🪛 Ruff (0.14.10)

src/datamodel_code_generator/__init__.py

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