Model Customization¶
Choose model class shape, naming, reuse, and root-model behavior.
Options are grouped from shared CLI metadata and link back to their generated reference sections.
Groups¶
| Group | Options | Description |
|---|---|---|
| Model Naming | 12 | Class names, suffixes, prefixes, and duplicate-name behavior. |
| Model Reuse | 4 | Schema deduplication and shared generated modules. |
| Model Shape | 7 | Output model family and compatibility targets. |
| Root Model | 12 | Root model creation, collapse, and alias behavior. |
Model Naming¶
Class names, suffixes, prefixes, and duplicate-name behavior.
| Option | Description |
|---|---|
--allow-leading-underscore-class-name |
Allow an explicitly specified root class name to start with an underscore. |
--class-name |
Override the auto-generated class name with a custom name. |
--class-name-affix-scope |
Control which classes receive the prefix/suffix. |
--class-name-prefix |
Add a prefix to all generated class names. |
--class-name-suffix |
Add a suffix to all generated class names. |
--duplicate-name-suffix |
Customize suffix for duplicate model names. |
--model-name-map |
Rename generated model classes from a JSON mapping. |
--name-converted-payloads-by-message |
Name a converted payload that names no type of its own after its message. |
--naming-strategy |
Choose how models are named and how duplicate model names are told apart. |
--parent-scoped-naming |
Namespace models by their parent scope to avoid naming conflicts. |
--singularize-last-word-of-item-names |
Name the item model of an array by singularizing only the last word of its name. |
--use-duplicate-name-suffix-for-every-collision |
Give the --duplicate-name-suffix suffix to every model renamed in its module. |
Model Reuse¶
Schema deduplication and shared generated modules.
| Option | Description |
|---|---|
--collapse-reuse-models |
Collapse duplicate models by replacing references instead of inheritance. |
--reuse-model |
Reuse identical model definitions instead of generating duplicates. |
--reuse-scope |
Scope for model reuse detection (root or tree). |
--shared-module-name |
Customize the name of the shared module for deduplicated models. |
Model Shape¶
Output model family and compatibility targets.
| Option | Description |
|---|---|
--base-class |
Specify a custom base class for generated models. |
--base-class-map |
Specify different base classes for specific models via JSON mapping. |
--merge-message-trait-headers |
Give an AsyncAPI message the headers of all its traits, merged in order, and the... |
--output-model-type |
Select the output model type (Pydantic v2, Pydantic v2 dataclass, dataclasses, T... |
--target-pydantic-version |
Target Pydantic version for generated code compatibility. |
--target-python-version |
Target Python version for generated code syntax and imports. |
--use-generic-base-class |
Generate a shared base class with model configuration to avoid repetition (DRY). |
Root Model¶
Root model creation, collapse, and alias behavior.
| Option | Description |
|---|---|
--collapse-constrained-root-models-as-annotated |
Inline a constrained string root model into a union or a container as `Annotated... |
--collapse-root-models |
Inline root model definitions instead of creating separate wrapper classes. |
--collapse-root-models-name-strategy |
Select which name to keep when collapsing root models with object references. |
--collapse-shared-parent-wrappers |
Collapse a parent-strategy wrapper in every model that references it. |
--keep-constrained-root-models-in-every-container |
Keep constrained root models named in every container of a holder. |
--keep-enum-literal-aliases |
Keep a named enum written as a Literal type alias named under collapse. |
--keep-reference-null-on-collapsed-root-models |
Keep the null of a root model that admits null where --collapse-root-models in... |
--keep-self-referencing-array-items |
Keep the items of an array whose items name the array itself. |
--keep-shared-members-on-collapsed-root-models |
Keep each member of a root type that collapse inlined at several sites at every ... |
--remove-unused-models-beside-type-overrides |
Remove the unused models from a module that a model-level --type-overrides key... |
--skip-root-model |
Skip generation of root model when schema contains nested definitions. |
--use-root-model-sequence-interface |
Make non-null sequence-like Pydantic v2 RootModel classes implement collections.... |