Add documentation for reducing duplicate field types#2896
Conversation
|
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 48 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdded documentation for type alias deduplication feature, including guidance on using Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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. Comment |
🤖 Generated by GitHub Actions
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
tests/data/jsonschema/reduce_duplicate_field_types.jsonis excluded by!tests/data/**/*.jsonand included by none
📒 Files selected for processing (4)
docs/cli-reference/typing-customization.mddocs/model-reuse.mdtests/data/expected/main/jsonschema/reduce_duplicate_field_types.pytests/main/jsonschema/test_main_jsonschema.py
🧰 Additional context used
🧬 Code graph analysis (1)
tests/main/jsonschema/test_main_jsonschema.py (2)
tests/test_main_kr.py (1)
output_file(44-46)tests/main/conftest.py (2)
output_file(98-100)run_main_and_assert(244-408)
🪛 LanguageTool
docs/model-reuse.md
[style] ~322-~322: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... Type safety - All fields share the exact same type ### When to Use This Pattern Thi...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🪛 markdownlint-cli2 (0.18.1)
docs/cli-reference/typing-customization.md
4201-4201: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
4201-4201: Strong style
Expected: underscore; Actual: asterisk
(MD050, strong-style)
docs/model-reuse.md
300-300: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (16)
- GitHub Check: py312-black24 on Ubuntu
- GitHub Check: 3.14 on macOS
- GitHub Check: py312-black22 on Ubuntu
- GitHub Check: 3.10 on macOS
- GitHub Check: 3.10 on Ubuntu
- GitHub Check: py312-isort7 on Ubuntu
- GitHub Check: 3.10 on Windows
- GitHub Check: 3.11 on macOS
- GitHub Check: 3.14 on Windows
- GitHub Check: 3.12 on macOS
- GitHub Check: 3.11 on Windows
- GitHub Check: 3.13 on macOS
- GitHub Check: 3.12 on Windows
- GitHub Check: 3.13 on Windows
- GitHub Check: benchmarks
- GitHub Check: Analyze (python)
🔇 Additional comments (10)
docs/cli-reference/typing-customization.md (1)
4201-4201: LGTM! Cross-reference improves documentation navigation.The "See also" reference to Model Reuse and Deduplication helps users discover related functionality for the
--use-type-aliasoption.docs/model-reuse.md (4)
1-1: LGTM! Metadata and cross-references properly updated.The related CLI options comment, quick overview table entry, and See Also reference for
--use-type-aliasare all correctly added to support the new documentation section.Also applies to: 15-15, 339-339
247-261: Clear problem statement with effective example.The section introduces the duplicate field types problem well, with a concrete code example showing the redundancy that
--use-type-aliasaddresses.
263-298: Excellent step-by-step solution guide.The JSON schema example and CLI command clearly demonstrate how to use
$defswith$refand the--use-type-aliasflag to achieve type deduplication.
317-332: Comprehensive benefits and usage guidance.The benefits clearly explain the value proposition, and the "When to Use This Pattern" section provides practical guidance for applying the feature.
tests/data/expected/main/jsonschema/reduce_duplicate_field_types.py (4)
1-10: LGTM! Standard generated file structure.The file header, future annotations import, and type imports are all correct for demonstrating the
--use-type-aliasfeature with Pydantic models.
12-23: Excellent demonstration of TypeAlias with Field constraints.The
PlaceNametype alias correctly usesTypeAliasTypewithAnnotatedto encapsulate the field type, constraints, description, examples, and title in a single reusable definition.
26-33: Perfect example of type alias reuse across models.Both
ClassAandClassBcorrectly reference the sharedPlaceNametype alias, eliminating the duplication that would occur with inlineAnnotated[str, Field(...)]definitions in each class.
36-36: LGTM! Union type alias for model variants.The
Modeltype alias correctly combinesClassA | ClassBas a union, demonstrating another use case for type aliases in the generated code.tests/main/jsonschema/test_main_jsonschema.py (1)
7545-7559: New E2E test for--use-type-aliaslooks correct and consistentThe test wiring (schema path, expected file,
input_file_type="jsonschema", andextra_argsforpydantic_v2.BaseModel+--use-type-alias) matches existing patterns in this module and cleanly exercises the deduplication scenario described in the docstring. No changes needed from my side.
CodSpeed Performance ReportMerging #2896 will not alter performanceComparing
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2896 +/- ##
=======================================
Coverage 99.37% 99.37%
=======================================
Files 92 92
Lines 16196 16198 +2
Branches 1915 1915
=======================================
+ Hits 16095 16097 +2
Misses 52 52
Partials 49 49
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Breaking Change AnalysisResult: No breaking changes detected Reasoning: This PR only adds documentation and tests for an existing feature ( This analysis was performed by Claude Code Action |
|
🎉 Released in 0.52.0 This PR is now available in the latest release. See the release notes for details. |
2 participants
Related to: #2155
Summary by CodeRabbit
Release Notes
New Features
--use-type-aliasCLI option to reduce duplicate field types by sharing type definitions across multiple classes.Documentation
--use-type-aliasoption.✏️ Tip: You can customize this high-level summary in your review settings.