datamodel-code-generator API reference

218 public APIs from datamodel-code-generator (koxudaxi/datamodel-code-generator) — 101 classes, 58 functions, 59 methods. Signatures extracted by static analysis of the actual source.

Repository: koxudaxi/datamodel-code-generator

Kind	Count
Classes	101
Functions	58
Methods	59

API list

classsrc.datamodel_code_generator.Error

Base exception for datamodel-code-generator errors.

classsrc.datamodel_code_generator.__main__.Config

Configuration model for code generation.

methodsrc.datamodel_code_generator.__main__.Config.get(item:str) -> Any

Get attribute value by name.

methodsrc.datamodel_code_generator.__main__.Config.get_fields() -> dict[str, Any]

Get model fields.

methodsrc.datamodel_code_generator.__main__.Config.merge_args(args:Namespace) -> None

Merge command-line arguments into config.

methodsrc.datamodel_code_generator.__main__.Config.validate_additional_imports(values:dict[str, Any]) -> dict[str, Any]

Validate and split additional imports.

methodsrc.datamodel_code_generator.__main__.Config.validate_alias_generator() -> Self

Validate alias generator compatibility.

methodsrc.datamodel_code_generator.__main__.Config.validate_custom_formatters(values:dict[str, Any]) -> dict[str, Any]

Validate and split custom formatters.

methodsrc.datamodel_code_generator.__main__.Config.validate_http_headers(value:Any) -> list[tuple[str, str]] | None

Validate HTTP headers.

methodsrc.datamodel_code_generator.__main__.Config.validate_http_query_parameters(value:Any) -> list[tuple[str, str]] | None

Validate HTTP query parameters.

methodsrc.datamodel_code_generator.__main__.Config.validate_path(value:Any) -> Path | None

Validate and resolve path.

methodsrc.datamodel_code_generator.__main__.Config.validate_root() -> Self

Validate root model configuration.

methodsrc.datamodel_code_generator.__main__.Config.validate_schema_validator_base_class_name(v:str | None) -> str | None

Validate schema validator base class name.

methodsrc.datamodel_code_generator.__main__.Config.validate_url(value:Any) -> ParseResult | None

Validate and parse URL.

classsrc.datamodel_code_generator.__main__.Exit

Exit reasons.

funcsrc.datamodel_code_generator.__main__.sig_int_handler(_:int, __:Any) -> None

Handle SIGINT signal gracefully.

classsrc.datamodel_code_generator._format_types.DateClassType

Output date class type options.

classsrc.datamodel_code_generator._format_types.DatetimeClassType

Output datetime class type options.

classsrc.datamodel_code_generator._format_types.Formatter

Available code formatters for generated output.

methodsrc.datamodel_code_generator._format_types.PythonVersion.has_strenum() -> bool

Check if Python version supports StrEnum.

classsrc.datamodel_code_generator._internal_utils.Child

Protocol for objects with a parent reference.

methodsrc.datamodel_code_generator._internal_utils.Child.parent() -> Any | None

Get the parent object reference.

classsrc.datamodel_code_generator._python_type_annotation.PythonTypeName

One unqualified Python name.

classsrc.datamodel_code_generator._python_type_annotation.PythonTypeUnion

A union rendered with the ``|`` spelling.

classsrc.datamodel_code_generator.base_config.BaseGenerateConfig

Shared generation configuration fields.

funcsrc.datamodel_code_generator.cached_path_exists(path:Path) -> bool

Check if a path exists with LRU caching.

funcsrc.datamodel_code_generator.chdir(path:Path | None) -> Iterator[None]

Change working directory and return to previous on exit.

classsrc.datamodel_code_generator.cli_options.CLIOptionMeta

Shared metadata for a CLI option.

classsrc.datamodel_code_generator.cli_options.OptionGroup

Optional subgroups within CLI option topics.

funcsrc.datamodel_code_generator.cli_options.get_all_canonical_options() -> frozenset[str]

Get all canonical options from argparse.

funcsrc.datamodel_code_generator.cli_options.get_canonical_option(option:str) -> str

Normalize an option alias to its canonical form.

funcsrc.datamodel_code_generator.cli_options.get_option_meta(option:str) -> CLIOptionMeta | None

Get documentation metadata for an option.

classsrc.datamodel_code_generator.config.AvroParserConfig

Configuration model for AvroParser.__init__().

classsrc.datamodel_code_generator.config.GenerateConfig

Configuration model for generate().

classsrc.datamodel_code_generator.config.ParseConfig

Configuration model for Parser.parse().

classsrc.datamodel_code_generator.config.ParserConfig

Configuration model for Parser.__init__().

classsrc.datamodel_code_generator.deprecations.Deprecation

Structured metadata for a deprecation entry.

funcsrc.datamodel_code_generator.deprecations.deprecation_message(deprecation_id:DeprecationId) -> str

Return the user-facing message for a deprecation.

funcsrc.datamodel_code_generator.deprecations.get_deprecation(deprecation_id:DeprecationId) -> Deprecation

Return a registered deprecation by id.

funcsrc.datamodel_code_generator.deprecations.render_deprecations(format_:DeprecationFormat) -> str

Render deprecations in the requested format.

funcsrc.datamodel_code_generator.deprecations.render_deprecations_json() -> str

Render all deprecations as JSON.

funcsrc.datamodel_code_generator.deprecations.render_deprecations_markdown(*include_header:bool=True) -> str

Render all deprecations as Markdown.

func

src.datamodel_code_generator.deprecations.warn_deprecated(deprecation_id:DeprecationId, *stacklevel:int=2, *details:str | None=None) -> None

Emit a warning from the central registry.

funcsrc.datamodel_code_generator.dynamic.clear_dynamic_models_cache() -> int

Clear the dynamic models cache.

funcsrc.datamodel_code_generator.enable_debug_message() -> None

Enable debug tracing with pysnooper.

classsrc.datamodel_code_generator.enums.AliasGenerator

Supported Pydantic v2 alias generator helpers.

classsrc.datamodel_code_generator.enums.AllExportsScope

Scope for __all__ exports in __init__.py.

classsrc.datamodel_code_generator.enums.AllOfMergeMode

Mode for field merging in allOf schemas.

classsrc.datamodel_code_generator.enums.AsyncAPIVersion

AsyncAPI specification versions.

classsrc.datamodel_code_generator.enums.ClassNameAffixScope

Scope for applying class name prefix/suffix.

classsrc.datamodel_code_generator.enums.DataModelType

Supported output data model types.

classsrc.datamodel_code_generator.enums.DataclassArguments

Arguments for @dataclass decorator.

classsrc.datamodel_code_generator.enums.ExtraFields

Generated model behavior for unknown input fields.

classsrc.datamodel_code_generator.enums.GraphQLScope

Scopes for GraphQL model generation.

classsrc.datamodel_code_generator.enums.HTTPBackend

HTTP client backend selection policy.

classsrc.datamodel_code_generator.enums.InputFileType

Supported input file types for schema parsing.

classsrc.datamodel_code_generator.enums.JsonSchemaVersion

JSON Schema draft versions.

classsrc.datamodel_code_generator.enums.OpenAPIScope

Scopes for OpenAPI model generation.

classsrc.datamodel_code_generator.enums.OpenAPIVersion

OpenAPI specification versions.

classsrc.datamodel_code_generator.enums.ProtobufVersion

Protocol Buffers schema syntax versions.

classsrc.datamodel_code_generator.enums.ReuseScope

Scope for model reuse deduplication.

classsrc.datamodel_code_generator.enums.SchemaValidatorType

Schema-derived runtime validator backend.

classsrc.datamodel_code_generator.enums.StrictTypes

Strict type options for generated models.

classsrc.datamodel_code_generator.enums.TargetPydanticVersion

Target Pydantic version for generated code.

classsrc.datamodel_code_generator.enums.UnionMode

Union discriminator mode for Pydantic v2.

classsrc.datamodel_code_generator.enums.VersionMode

Schema version validation mode.

classsrc.datamodel_code_generator.enums.XMLSchemaVersion

XML Schema specification versions.

funcsrc.datamodel_code_generator.experimental.render_experimental_features_markdown(*include_header:bool=True) -> str

Render all experimental features as Markdown.

classsrc.datamodel_code_generator.format.CustomCodeFormatter

Base class for custom code formatters.

methodsrc.datamodel_code_generator.format.CustomCodeFormatter.apply(code:str) -> str

Apply formatting to code.

funcsrc.datamodel_code_generator.get_first_file(path:Path) -> Path

Find and return the first file in a path (file or directory).

funcsrc.datamodel_code_generator.get_version() -> str

Return the version embedded by the build backend.

funcsrc.datamodel_code_generator.http.join_url(url:str, ref:str='.', *http_backend:HTTPBackend=HTTPBackend.AUTO) -> str

Join a base URL with a relative reference.

classsrc.datamodel_code_generator.imports.Import

Represents a single Python import statement.

methodsrc.datamodel_code_generator.imports.Import.is_future() -> bool

Check if this is a __future__ import.

funcsrc.datamodel_code_generator.infer_input_type(text:str) -> InputFileType

Automatically detect the input file type from text content.

classsrc.datamodel_code_generator.input_model.Error

Error raised during input model loading.

funcsrc.datamodel_code_generator.is_asyncapi(data:Mapping[str, Any]) -> bool

Check if the data dict is an AsyncAPI specification.

funcsrc.datamodel_code_generator.is_openapi(data:Mapping[str, Any]) -> bool

Check if the data dict is an OpenAPI specification.

funcsrc.datamodel_code_generator.is_schema(data:dict) -> bool

Check if the data dict is a JSON Schema.

classsrc.datamodel_code_generator.json_config.DefaultValuesConfig

Default value override mapping.

classsrc.datamodel_code_generator.json_config.DuplicateNameSuffixConfig

Duplicate-name suffix mapping.

classsrc.datamodel_code_generator.json_config.ExtraTemplateDataConfig

Extra template data mapping.

classsrc.datamodel_code_generator.json_config.JsonConfigSpecs

Registry of JSON configuration specs.

funcsrc.datamodel_code_generator.load_data(text:str) -> dict[str, YamlValue]

Load text as JSON or YAML based on content.

funcsrc.datamodel_code_generator.load_data_from_path(path:Path, encoding:str) -> dict[str, YamlValue]

Load file as JSON or YAML based on file extension.

funcsrc.datamodel_code_generator.load_yaml(stream:str | TextIO) -> YamlValue

Load YAML content using ryaml (if available) or PyYAML.

funcsrc.datamodel_code_generator.load_yaml_dict(stream:str | TextIO) -> dict[str, YamlValue]

Load YAML and return as dict.

funcsrc.datamodel_code_generator.load_yaml_dict_from_path(path:Path, encoding:str) -> dict[str, YamlValue]

Load YAML and return as dict from a file path.

classsrc.datamodel_code_generator.model.base.BaseClassDataType

DataType subclass for base class references.

classsrc.datamodel_code_generator.model.base.DataModel

Abstract base class for all data model types.

methodsrc.datamodel_code_generator.model.base.DataModel.class_name() -> str

Get the class name without module path.

methodsrc.datamodel_code_generator.model.base.DataModel.is_alias() -> bool

Whether is a type alias (i.e.

methodsrc.datamodel_code_generator.model.base.DataModel.module_name() -> str

Get the full module name for this model.

methodsrc.datamodel_code_generator.model.base.DataModel.name() -> str

Get the full name of this model.

methodsrc.datamodel_code_generator.model.base.DataModel.nullable() -> bool

Check if this model is nullable.

methodsrc.datamodel_code_generator.model.base.DataModel.path() -> str

Get the full reference path for this model.

methodsrc.datamodel_code_generator.model.base.DataModel.render(*class_name:str | None=None) -> str

Render the model to a string using the template.

methodsrc.datamodel_code_generator.model.base.DataModel.set_base_class() -> None

Set up the base class(es) for this model.

methodsrc.datamodel_code_generator.model.base.DataModel.set_reference_path(new_path:str) -> None

Set reference path and clear cached path property.

classsrc.datamodel_code_generator.model.dataclass.DataClass

DataModel implementation for Python dataclasses.

classsrc.datamodel_code_generator.model.dataclass.DataModelField

Field implementation for dataclass models.

methodsrc.datamodel_code_generator.model.dataclass.DataModelField.field() -> str | None

For backwards compatibility.

classsrc.datamodel_code_generator.model.dataclass.DataTypeManager

Type manager for dataclass models.

classsrc.datamodel_code_generator.model.enum.Enum

DataModel implementation for Python enumerations.

methodsrc.datamodel_code_generator.model.enum.Enum.get_data_type(types:Types, **kwargs:Any) -> DataType

Get data type for enum (not implemented).

methodsrc.datamodel_code_generator.model.enum.Enum.get_member(field:DataModelFieldBase) -> Member

Create a Member instance for the given field.

methodsrc.datamodel_code_generator.model.enum.Enum.imports() -> tuple[Import, ...]

Get imports excluding Any.

classsrc.datamodel_code_generator.model.enum.IntEnum

Integer enumeration type.

classsrc.datamodel_code_generator.model.enum.Member

Represents an enum member with its parent enum and field.

classsrc.datamodel_code_generator.model.enum.StrEnum

String enumeration type.

funcsrc.datamodel_code_generator.model.enum.get_raw_enum_member_value(default:Any) -> Any

Return one semantic value from structured or legacy rendered defaults.

classsrc.datamodel_code_generator.model.msgspec.Constraints

Constraint model for msgspec fields.

methodsrc.datamodel_code_generator.model.msgspec.DataModelField.field() -> str | None

For backwards compatibility.

methodsrc.datamodel_code_generator.model.msgspec.DataModelField.process_const() -> None

Process const field constraint.

classsrc.datamodel_code_generator.model.msgspec.DataTypeManager

Type manager for msgspec Struct models.

classsrc.datamodel_code_generator.model.msgspec.Struct

DataModel implementation for msgspec.Struct.

methodsrc.datamodel_code_generator.model.msgspec.Struct.add_base_class_kwarg(name:str, value:str) -> None

Add keyword argument to base class constructor.

funcsrc.datamodel_code_generator.model.msgspec.get_field_default_info(field:DataModelFieldBase) -> tuple[bool, bool]

Return msgspec constructor-default semantics.

classsrc.datamodel_code_generator.model.pydantic_base.DataModelField

Field implementation for Pydantic models.

methodsrc.datamodel_code_generator.model.pydantic_base.DataModelField.field() -> str | None

For backwards compatibility.

methodsrc.datamodel_code_generator.model.pydantic_base.DataModelField.is_class_var() -> bool

Check if this field is a ClassVar.

methodsrc.datamodel_code_generator.model.pydantic_base.DataModelField.method() -> str | None

Get the validation method name.

methodsrc.datamodel_code_generator.model.pydantic_base.DataModelField.validator() -> str | None

Get the validator name.

classsrc.datamodel_code_generator.model.pydantic_v2.ConfigDict

Pydantic v2 model_config options.

methodsrc.datamodel_code_generator.model.pydantic_v2.ConfigDict.dict(**kwargs:Any) -> dict[str, Any]

Return dict for templates.

classsrc.datamodel_code_generator.model.pydantic_v2.root_model.RootModel

DataModel for Pydantic v2 RootModel.

classsrc.datamodel_code_generator.model.type_alias.TypeAliasBase

Base class for all type alias implementations.

classsrc.datamodel_code_generator.model.typed_dict.DataModelField

Field implementation for TypedDict models.

methodsrc.datamodel_code_generator.model.typed_dict.DataModelField.key() -> str

Get escaped field key for TypedDict.

classsrc.datamodel_code_generator.model.typed_dict.TypedDict

DataModel implementation for Python TypedDict.

methodsrc.datamodel_code_generator.model.typed_dict.TypedDict.render(*class_name:str | None=None) -> str

Render TypedDict class with appropriate syntax.

classsrc.datamodel_code_generator.model.types.DataTypeManager

Base type manager for model modules.

method

src.datamodel_code_generator.model.types.DataTypeManager.get_data_type(types:Types, *field_constraints:bool=False, **_:Any) -> DataType

Get data type for schema type.

classsrc.datamodel_code_generator.model_metadata.ModelMetadata

JSON payload emitted by --emit-model-metadata.

funcsrc.datamodel_code_generator.model_metadata.dump_model_metadata(metadata:ModelMetadata | None) -> str

Serialize model metadata as pretty JSON.

classsrc.datamodel_code_generator.parser.LiteralType

Options for handling enum fields as literals.

funcsrc.datamodel_code_generator.parser._scc.find_circular_sccs(graph:ModuleGraph) -> SCCList

Find SCCs that represent circular dependencies.

funcsrc.datamodel_code_generator.parser._xmlschema_detection.is_xml_schema_text(text:str) -> bool

Return whether text is an XML Schema document.

classsrc.datamodel_code_generator.parser.asyncapi.AsyncAPIContext

Resolver context for an AsyncAPI document.

classsrc.datamodel_code_generator.parser.asyncapi.AsyncAPIParser

Parser for AsyncAPI 2.x and 3.x documents.

classsrc.datamodel_code_generator.parser.base.ParseConfig

Configuration for the parse operation.

classsrc.datamodel_code_generator.parser.base.Parser

Abstract base class for schema parsers.

methodsrc.datamodel_code_generator.parser.base.Parser.data_type() -> type[DataType]

Get the DataType class from the type manager.

methodsrc.datamodel_code_generator.parser.base.Parser.get_url_path_parts(url:ParseResult) -> list[str]

Split URL into scheme/host and path components.

methodsrc.datamodel_code_generator.parser.base.Parser.parse_raw() -> None

Parse the raw schema source.

classsrc.datamodel_code_generator.parser.base.Source

Schema source file with path and content.

methodsrc.datamodel_code_generator.parser.base.Source.from_dict(data:dict[str, YamlValue]) -> Source

Create a Source from a dict.

funcsrc.datamodel_code_generator.parser.base.dump_templates(templates:list[DataModel]) -> str

Join model templates into a single code string.

funcsrc.datamodel_code_generator.parser.base.get_module_directory(module:tuple[str, ...]) -> tuple[str, ...]

Get the directory portion of a module tuple.

func

src.datamodel_code_generator.parser.base.relative(current_module:str, reference:str, *reference_is_module:bool=False, *current_is_init:bool=False) -> tuple[str, str]

Find relative module path.

funcsrc.datamodel_code_generator.parser.base.title_to_class_name(title:str) -> str

Convert a schema title to a valid Python class name.

classsrc.datamodel_code_generator.parser.graphql.GraphQLParser

Parser for GraphQL schema files.

method

src.datamodel_code_generator.parser.graphql.GraphQLParser.parse_enum_as_enum_class(enum_object:graphql.GraphQLEnumType) -> None

Parse enum values as an Enum class.

method

src.datamodel_code_generator.parser.graphql.GraphQLParser.parse_enum_as_literal(enum_object:graphql.GraphQLEnumType) -> None

Parse enum values as a Literal type.

func

src.datamodel_code_generator.parser.graphql.build_graphql_schema(schema_str:str, *source:str | None=None) -> graphql.GraphQLSchema

Build a graphql schema from a string.

classsrc.datamodel_code_generator.parser.mcp.MCPTool

Validated MCP tool definition.

classsrc.datamodel_code_generator.parser.openapi.ComponentsObject

Represent an OpenAPI components object.

classsrc.datamodel_code_generator.parser.openapi.ExampleObject

Represent an OpenAPI example object.

classsrc.datamodel_code_generator.parser.openapi.HeaderObject

Represent an OpenAPI header object.

classsrc.datamodel_code_generator.parser.openapi.MediaObject

Represent an OpenAPI media type object.

classsrc.datamodel_code_generator.parser.openapi.Operation

Represent an OpenAPI operation object.

classsrc.datamodel_code_generator.parser.openapi.ParameterLocation

Represent OpenAPI parameter locations.

classsrc.datamodel_code_generator.parser.openapi.ParameterObject

Represent an OpenAPI parameter object.

classsrc.datamodel_code_generator.parser.openapi.ReferenceObject

Represent an OpenAPI reference object ($ref).

classsrc.datamodel_code_generator.parser.openapi.RequestBodyObject

Represent an OpenAPI request body object.

classsrc.datamodel_code_generator.parser.openapi.ResponseObject

Represent an OpenAPI response object.

classsrc.datamodel_code_generator.parser.schema_version.FeatureMetadata

Metadata for schema feature documentation.

classsrc.datamodel_code_generator.parser.schema_version.JsonSchemaFeatures

Feature flags for JSON Schema versions.

classsrc.datamodel_code_generator.parser.schema_version.OpenAPISchemaFeatures

Feature flags for OpenAPI versions.

funcsrc.datamodel_code_generator.parser.schema_version.detect_openapi_version(data:dict[str, Any]) -> OpenAPIVersion

Detect OpenAPI version from openapi field.

funcsrc.datamodel_code_generator.parser.schema_version.get_data_formats(*is_openapi:bool=False) -> DataFormatMapping

Get merged data formats based on schema type.

funcsrc.datamodel_code_generator.parser.xmlschema.is_xml_schema_text(text:str) -> bool

Return whether text is an XML Schema document.

classsrc.datamodel_code_generator.preset.PresetContext

Context required to resolve a preset.

classsrc.datamodel_code_generator.preset.PresetError

Raised when a preset cannot be resolved.

classsrc.datamodel_code_generator.preset.PresetInfo

Public preset metadata used by CLI docs.

classsrc.datamodel_code_generator.preset.PresetName

Available immutable preset names.

classsrc.datamodel_code_generator.preset.PresetOptionGroup

Documented option group for a preset.

funcsrc.datamodel_code_generator.preset.get_latest_preset_name() -> str

Return the latest public preset name.

funcsrc.datamodel_code_generator.preset.get_preset_infos() -> tuple[PresetInfo, ...]

Return public preset metadata.

funcsrc.datamodel_code_generator.preset.get_preset_names() -> tuple[str, ...]

Return all public preset names.

funcsrc.datamodel_code_generator.preset.preset_info_as_dict(info:PresetInfo) -> _PresetInfoDict

Serialize a preset info entry to primitive values.

funcsrc.datamodel_code_generator.preset.render_presets(format_:PresetFormat) -> str

Render presets in the requested format.

funcsrc.datamodel_code_generator.preset.render_presets_json() -> str

Render preset metadata as JSON.

funcsrc.datamodel_code_generator.preset.render_presets_markdown() -> str

Render the preset reference page.

func

src.datamodel_code_generator.prompt.generate_prompt(args:Namespace, help_text:str, parser:ArgumentParser | None=None) -> str

Generate LLM consultation prompt.

classsrc.datamodel_code_generator.reference.ModelType

Type of model for field name resolution strategy.

classsrc.datamodel_code_generator.reference.Reference

Represents a reference to a model in the schema.

methodsrc.datamodel_code_generator.reference.Reference.iter_data_model_children() -> Iterator[Any]

Yield all DataModel children.

methodsrc.datamodel_code_generator.reference.Reference.short_name() -> str

Return the last component of the dotted name.

funcsrc.datamodel_code_generator.reference.get_relative_path(base_path:PurePath, target_path:PurePath) -> PurePath

Calculate relative path from base to target.

funcsrc.datamodel_code_generator.reference.get_singular_name(name:str, suffix:str=SINGULAR_NAME_SUFFIX) -> str

Convert a plural name to singular form.

methodsrc.datamodel_code_generator.types.DataType.imports() -> Iterator[Import]

Yield imports required by this DataType.

methodsrc.datamodel_code_generator.types.DataType.remove_reference() -> None

Remove the reference from this DataType.

methodsrc.datamodel_code_generator.types.DataType.replace_reference(reference:Reference | None) -> None

Replace this DataType's reference with a new one.

methodsrc.datamodel_code_generator.types.DataTypeManager.copy_data_type(data_type:DataType) -> DataType

Copy a type-map prototype for caller-owned mutation.

methodsrc.datamodel_code_generator.types.DataTypeManager.get_data_type(types:Types, **kwargs:Any) -> DataType

Map a Types enum value to a DataType.

classsrc.datamodel_code_generator.types.Modular

Protocol for objects with a module name property.

methodsrc.datamodel_code_generator.types.Modular.module_name() -> str

Return the module name.

classsrc.datamodel_code_generator.types.Nullable

Protocol for objects with a nullable property.

methodsrc.datamodel_code_generator.types.Nullable.nullable() -> bool

Return whether the type is nullable.

classsrc.datamodel_code_generator.types.Types

Standard type identifiers for schema type mapping.

funcsrc.datamodel_code_generator.types.chain_as_tuple(*iterables:Iterable[T]) -> tuple[T, ...]

Chain multiple iterables and return as a tuple.

funcsrc.datamodel_code_generator.types.get_optional_type(type_:str, use_union_operator:bool) -> str

Wrap a type string in Optional or add | None suffix.

funcsrc.datamodel_code_generator.types.is_data_model_field(obj:object) -> TypeIs[DataModelFieldBase]

Check if an object structurally owns a DataType.

funcsrc.datamodel_code_generator.types.normalize_integer_constraints(constraints:dict[str, Any]) -> dict[str, Any]

Return integer-safe pydantic constraints.

funcsrc.datamodel_code_generator.util.camel_to_snake(string:str) -> str

Convert camelCase or PascalCase to snake_case.

funcsrc.datamodel_code_generator.util.get_safe_loader() -> type

Get customized SafeLoader lazily.

funcsrc.datamodel_code_generator.util.load_toml(path:Path) -> dict[str, Any]

Load and parse a TOML file.

funcsrc.datamodel_code_generator.util.warn_yaml_deprecated_bool_values(text:str) -> None

Warn for YAML 1.1-style boolean scalars when ryaml is used.

classsrc.datamodel_code_generator.validators.ModelValidators

Validators configuration for a single model.

classsrc.datamodel_code_generator.validators.ValidatorDefinition

Definition of a single validator.

methodsrc.datamodel_code_generator.validators.ValidatorDefinition.validate_field(value:str | None) -> str | None

Validate a single field name.

methodsrc.datamodel_code_generator.validators.ValidatorDefinition.validate_fields(value:list[str] | None) -> list[str] | None

Validate multiple field names.

methodsrc.datamodel_code_generator.validators.ValidatorDefinition.validate_function(value:str) -> str

Validate the imported validator function path.

methodsrc.datamodel_code_generator.validators.ValidatorDefinition.validate_mode(value:Any) -> Any

Validate the Pydantic field_validator mode.

classsrc.datamodel_code_generator.validators.ValidatorMode

Validator mode for Pydantic v2 field_validator.

classsrc.datamodel_code_generator.validators.ValidatorsConfig

Root model for validators configuration.

About this data

These signatures were extracted from the public source of koxudaxi/datamodel-code-generator using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries