# datamodel-code-generator
This code generator creates [pydantic v1 and v2](https://docs.pydantic.dev/) model, [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html) and [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict) from an openapi file and others.
[](https://github.com/koxudaxi/datamodel-code-generator/actions?query=workflow%3ATest)
[](https://pypi.python.org/pypi/datamodel-code-generator)
[](https://anaconda.org/conda-forge/datamodel-code-generator)
[](https://pepy.tech/project/datamodel-code-generator)
[](https://pypi.python.org/pypi/datamodel-code-generator)
[](https://codecov.io/gh/koxudaxi/datamodel-code-generator)
[](https://github.com/psf/black)
## Help
See [documentation](https://koxudaxi.github.io/datamodel-code-generator) for more details.
## Sponsors
[](https://github.com/JetBrainsOfficial)
## Quick Installation
To install `datamodel-code-generator`:
```bash
$ pip install datamodel-code-generator
```
## Simple Usage
You can generate models from a local file.
```bash
$ datamodel-codegen --input api.yaml --output model.py
```
<details>
<summary>api.yaml</summary>
```yaml
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://petstore.swagger.io/v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations
passthroughBehavior: when_no_templates
httpMethod: POST
type: aws_proxy
post:
summary: Create a pet
operationId: createPets
tags:
- pets
responses:
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations
passthroughBehavior: when_no_templates
httpMethod: POST
type: aws_proxy
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations
passthroughBehavior: when_no_templates
httpMethod: POST
type: aws_proxy
components:
schemas:
Pet:
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
apis:
type: array
items:
type: object
properties:
apiKey:
type: string
description: To be used as a dataset parameter value
apiVersionNumber:
type: string
description: To be used as a version parameter value
apiUrl:
type: string
format: uri
description: "The URL describing the dataset's fields"
apiDocumentationUrl:
type: string
format: uri
description: A URL to the API console for each API
```
</details>
<details>
<summary>model.py</summary>
```python
# generated by datamodel-codegen:
# filename: api.yaml
# timestamp: 2020-06-02T05:28:24+00:00
from __future__ import annotations
from typing import List, Optional
from pydantic import AnyUrl, BaseModel, Field
class Pet(BaseModel):
id: int
name: str
tag: Optional[str] = None
class Pets(BaseModel):
__root__: List[Pet]
class Error(BaseModel):
code: int
message: str
class Api(BaseModel):
apiKey: Optional[str] = Field(
None, description='To be used as a dataset parameter value'
)
apiVersionNumber: Optional[str] = Field(
None, description='To be used as a version parameter value'
)
apiUrl: Optional[AnyUrl] = Field(
None, description="The URL describing the dataset's fields"
)
apiDocumentationUrl: Optional[AnyUrl] = Field(
None, description='A URL to the API console for each API'
)
class Apis(BaseModel):
__root__: List[Api]
```
</details>
## Projects that use datamodel-code-generator
These OSS projects use datamodel-code-generator to generate many models. See the following linked projects for real world examples and inspiration.
- [Netflix/consoleme](https://github.com/Netflix/consoleme)
- *[How do I generate models from the Swagger specification?](https://github.com/Netflix/consoleme/blob/master/docs/gitbook/faq.md#how-do-i-generate-models-from-the-swagger-specification)*
- [DataDog/integrations-core](https://github.com/DataDog/integrations-core)
- *[Config models](https://github.com/DataDog/integrations-core/blob/master/docs/developer/meta/config-models.md)*
- [awslabs/aws-lambda-powertools-python](https://github.com/awslabs/aws-lambda-powertools-python)
- *Recommended for [advanced-use-cases](https://awslabs.github.io/aws-lambda-powertools-python/2.6.0/utilities/parser/#advanced-use-cases) in the official documentation*
- [open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata)
- [Makefile](https://github.com/open-metadata/OpenMetadata/blob/main/Makefile)
- [airbytehq/airbyte](https://github.com/airbytehq/airbyte)
- *[code-generator/Dockerfile](https://github.com/airbytehq/airbyte/blob/master/tools/code-generator/Dockerfile)*
- [IBM/compliance-trestle](https://github.com/IBM/compliance-trestle)
- *[Building the models from the OSCAL schemas.](https://github.com/IBM/compliance-trestle/blob/develop/docs/contributing/website.md#building-the-models-from-the-oscal-schemas)*
- [SeldonIO/MLServer](https://github.com/SeldonIO/MLServer)
- *[generate-types.sh](https://github.com/SeldonIO/MLServer/blob/master/hack/generate-types.sh)*
## Supported input types
- OpenAPI 3 (YAML/JSON, [OpenAPI Data Type](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#data-types))
- JSON Schema ([JSON Schema Core](http://json-schema.org/draft/2019-09/json-schema-validation.html)/[JSON Schema Validation](http://json-schema.org/draft/2019-09/json-schema-validation.html))
- JSON/YAML/CSV Data (it will be converted to JSON Schema)
- Python dictionary (it will be converted to JSON Schema)
## Supported output types
- [pydantic](https://docs.pydantic.dev/1.10/).BaseModel
- [pydantic_v2](https://docs.pydantic.dev/2.0/).BaseModel
- [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html)
- [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict)
## Installation
To install `datamodel-code-generator`:
```bash
$ pip install datamodel-code-generator
```
### `http` extra option
If you want to resolve `$ref` for remote files then you should specify `http` extra option.
```bash
$ pip install datamodel-code-generator[http]
```
### Docker Image
The docker image is in [Docker Hub](https://hub.docker.com/r/koxudaxi/datamodel-code-generator)
```bash
$ docker pull koxudaxi/datamodel-code-generator
```
## Advanced Uses
You can genearte models from a URL.
```bash
$ datamodel-codegen --url https://<INPUT FILE URL> --output model.py
```
This method needs the [http extra option](#http-extra-option)
## All Command Options
The `datamodel-codegen` command:
```bash
usage: datamodel-codegen [-h] [--input INPUT] [--url URL]
[--http-headers HTTP_HEADER [HTTP_HEADER ...]]
[--http-ignore-tls]
[--input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}]
[--output-model-type {pydantic.BaseModel,pydantic_v2.BaseModel,dataclasses.dataclass,typing.TypedDict}]
[--openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]]
[--output OUTPUT] [--base-class BASE_CLASS]
[--field-constraints] [--use-annotated]
[--use-non-positive-negative-number-constrained-types]
[--field-extra-keys FIELD_EXTRA_KEYS [FIELD_EXTRA_KEYS ...]]
[--field-include-all-keys]
[--field-extra-keys-without-x-prefix FIELD_EXTRA_KEYS_WITHOUT_X_PREFIX [FIELD_EXTRA_KEYS_WITHOUT_X_PREFIX ...]]
[--snake-case-field]
[--original-field-name-delimiter ORIGINAL_FIELD_NAME_DELIMITER]
[--strip-default-none]
[--disable-appending-item-suffix]
[--allow-population-by-field-name]
[--allow-extra-fields] [--enable-faux-immutability]
[--use-default] [--force-optional]
[--strict-nullable]
[--strict-types {str,bytes,int,float,bool} [{str,bytes,int,float,bool} ...]]
[--disable-timestamp] [--use-standard-collections]
[--use-generic-container-types]
[--use-union-operator] [--use-schema-description]
[--use-field-description] [--use-default-kwarg]
[--reuse-model] [--keep-model-order]
[--collapse-root-models]
[--enum-field-as-literal {all,one}] [--use-one-literal-as-default]
[--set-default-enum-member]
[--empty-enum-field-name EMPTY_ENUM_FIELD_NAME]
[--capitalise-enum-members]
[--special-field-name-prefix SPECIAL_FIELD_NAME_PREFIX]
[--remove-special-field-name-prefix]
[--use-subclass-enum] [--class-name CLASS_NAME]
[--use-title-as-name] [--use-operation-id-as-name]
[--use-unique-items-as-set]
[--custom-template-dir CUSTOM_TEMPLATE_DIR]
[--extra-template-data EXTRA_TEMPLATE_DATA]
[--aliases ALIASES]
[--target-python-version {3.6,3.7,3.8,3.9,3.10,3.11}]
[--wrap-string-literal] [--validation]
[--use-double-quotes] [--encoding ENCODING] [--debug]
[--disable-warnings] [--version]
options:
-h, --help show this help message and exit
--input INPUT Input file/directory (default: stdin)
--url URL Input file URL. `--input` is ignored when `--url` is
used
--http-headers HTTP_HEADER [HTTP_HEADER ...]
Set headers in HTTP requests to the remote host.
(example: "Authorization: Basic dXNlcjpwYXNz")
--http-ignore-tls Disable verification of the remote host's TLS
certificate
--input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}
Input file type (default: auto)
--output-model-type {pydantic.BaseModel,pydantic_v2.BaseModel,dataclasses.dataclass,typing.TypedDict}
Output model type (default: pydantic.BaseModel)
--openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]
Scopes of OpenAPI model generation (default: schemas)
--output OUTPUT Output file (default: stdout)
--base-class BASE_CLASS
Base Class (default: pydantic.BaseModel)
--field-constraints Use field constraints and not con* annotations
--use-annotated Use typing.Annotated for Field(). Also, `--field-
constraints` option will be enabled.
--use-non-positive-negative-number-constrained-types
Use the Non{Positive,Negative}{FloatInt} types instead
of the corresponding con* constrained types.
--field-extra-keys FIELD_EXTRA_KEYS [FIELD_EXTRA_KEYS ...]
Add extra keys to field parameters
--field-include-all-keys
Add all keys to field parameters
--field-extra-keys-without-x-prefix
Add extra keys with `x-` prefix to field parameters.
The extra keys are stripped of the `x-` prefix.
--snake-case-field Change camel-case field name to snake-case
--original-field-name-delimiter ORIGINAL_FIELD_NAME_DELIMITER
Set delimiter to convert to snake case. This option
only can be used with --snake-case-field (default: `_`
)
--strip-default-none Strip default None on fields
--disable-appending-item-suffix
Disable appending `Item` suffix to model name in an
array
--allow-population-by-field-name
Allow population by field name
--allow-extra-fields Allow to pass extra fields, if this flag is not
passed, extra fields are forbidden.
--enable-faux-immutability
Enable faux immutability
--use-default Use default value even if a field is required
--force-optional Force optional for required fields
--strict-nullable Treat default field as a non-nullable field (Only
OpenAPI)
--strict-types {str,bytes,int,float,bool} [{str,bytes,int,float,bool} ...]
Use strict types
--disable-timestamp Disable timestamp on file headers
--use-standard-collections
Use standard collections for type hinting (list, dict)
--use-generic-container-types
Use generic container types for type hinting
(typing.Sequence, typing.Mapping). If `--use-standard-
collections` option is set, then import from
collections.abc instead of typing
--use-union-operator Use | operator for Union type (PEP 604).
--use-schema-description
Use schema description to populate class docstring
--use-field-description
Use schema description to populate field docstring
--use-default-kwarg Use `default=` instead of a positional argument for
Fields that have default values.
--reuse-model Re-use models on the field when a module has the model
with the same content
--keep-model-order Keep generated models' order
--collapse-root-models
Models generated with a root-type field will be
mergedinto the models using that root-type model
--enum-field-as-literal {all,one}
Parse enum field as literal. all: all enum field type
are Literal. one: field type is Literal when an enum
has only one possible value
--use-one-literal-as-default
Use one literal as default value for one literal field
--set-default-enum-member
Set enum members as default values for enum field
--empty-enum-field-name EMPTY_ENUM_FIELD_NAME
Set field name when enum value is empty (default: `_`)
--capitalise-enum-members
Capitalize field names on enum
--special-field-name-prefix SPECIAL_FIELD_NAME_PREFIX
Set field name prefix when first character can't be
used as Python field name (default: `field`)
--remove-special-field-name-prefix
Remove field name prefix when first character can't be
used as Python field name
--use-subclass-enum Define Enum class as subclass with field type when
enum has type (int, float, bytes, str)
--class-name CLASS_NAME
Set class name of root model
--use-title-as-name use titles as class names of models
--use-unique-items-as-set
define field type as `set` when the field attribute
has `uniqueItems`
--custom-template-dir CUSTOM_TEMPLATE_DIR
Custom template directory
--extra-template-data EXTRA_TEMPLATE_DATA
Extra template data
--aliases ALIASES Alias mapping file
--target-python-version {3.6,3.7,3.8,3.9,3.10,3.11}
target python version (default: 3.7)
--wrap-string-literal
Wrap string literal by using black `experimental-
string-processing` option (require black 20.8b0 or
later)
--validation Enable validation (Only OpenAPI)
--use-double-quotes Model generated with double quotes. Single quotes or
your black config skip_string_normalization value will
be used without this option.
--encoding ENCODING The encoding of input and output (default: cp1252)
--debug show debug message
--disable-warnings disable warnings
--version show version
```
## Related projects
### fastapi-code-generator
This code generator creates [FastAPI](https://github.com/tiangolo/fastapi) app from an openapi file.
[https://github.com/koxudaxi/fastapi-code-generator](https://github.com/koxudaxi/fastapi-code-generator)
### pydantic-pycharm-plugin
[A JetBrains PyCharm plugin](https://plugins.jetbrains.com/plugin/12861-pydantic) for [`pydantic`](https://github.com/samuelcolvin/pydantic).
[https://github.com/koxudaxi/pydantic-pycharm-plugin](https://github.com/koxudaxi/pydantic-pycharm-plugin)
## PyPi
[https://pypi.org/project/datamodel-code-generator](https://pypi.org/project/datamodel-code-generator)
## License
datamodel-code-generator is released under the MIT License. http://www.opensource.org/licenses/mit-license
Raw data
{
"_id": null,
"home_page": "https://github.com/koxudaxi/datamodel-code-generator",
"name": "datamodel-code-generator-genson-wheel",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Koudai Aono",
"author_email": "koxudaxi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fe/3f/cdff4c24135ac2bc5a0d2589eb37be2152796cac2631c707271c2ff6cca4/datamodel_code_generator_genson_wheel-0.25.6.tar.gz",
"platform": null,
"description": "# datamodel-code-generator\n\nThis code generator creates [pydantic v1 and v2](https://docs.pydantic.dev/) model, [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html) and [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict) from an openapi file and others.\n\n[](https://github.com/koxudaxi/datamodel-code-generator/actions?query=workflow%3ATest)\n[](https://pypi.python.org/pypi/datamodel-code-generator)\n[](https://anaconda.org/conda-forge/datamodel-code-generator)\n[](https://pepy.tech/project/datamodel-code-generator)\n[](https://pypi.python.org/pypi/datamodel-code-generator)\n[](https://codecov.io/gh/koxudaxi/datamodel-code-generator)\n\n[](https://github.com/psf/black)\n\n\n## Help\nSee [documentation](https://koxudaxi.github.io/datamodel-code-generator) for more details.\n\n## Sponsors\n[](https://github.com/JetBrainsOfficial)\n\n## Quick Installation\n\nTo install `datamodel-code-generator`:\n```bash\n$ pip install datamodel-code-generator\n```\n\n## Simple Usage\nYou can generate models from a local file.\n```bash\n$ datamodel-codegen --input api.yaml --output model.py\n```\n\n<details>\n<summary>api.yaml</summary>\n\n```yaml\nopenapi: \"3.0.0\"\ninfo:\n version: 1.0.0\n title: Swagger Petstore\n license:\n name: MIT\nservers:\n - url: http://petstore.swagger.io/v1\npaths:\n /pets:\n get:\n summary: List all pets\n operationId: listPets\n tags:\n - pets\n parameters:\n - name: limit\n in: query\n description: How many items to return at one time (max 100)\n required: false\n schema:\n type: integer\n format: int32\n responses:\n '200':\n description: A paged array of pets\n headers:\n x-next:\n description: A link to the next page of responses\n schema:\n type: string\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Pets\"\n default:\n description: unexpected error\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Error\"\n x-amazon-apigateway-integration:\n uri:\n Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations\n passthroughBehavior: when_no_templates\n httpMethod: POST\n type: aws_proxy\n post:\n summary: Create a pet\n operationId: createPets\n tags:\n - pets\n responses:\n '201':\n description: Null response\n default:\n description: unexpected error\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Error\"\n x-amazon-apigateway-integration:\n uri:\n Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations\n passthroughBehavior: when_no_templates\n httpMethod: POST\n type: aws_proxy\n /pets/{petId}:\n get:\n summary: Info for a specific pet\n operationId: showPetById\n tags:\n - pets\n parameters:\n - name: petId\n in: path\n required: true\n description: The id of the pet to retrieve\n schema:\n type: string\n responses:\n '200':\n description: Expected response to a valid request\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Pets\"\n default:\n description: unexpected error\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Error\"\n x-amazon-apigateway-integration:\n uri:\n Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations\n passthroughBehavior: when_no_templates\n httpMethod: POST\n type: aws_proxy\ncomponents:\n schemas:\n Pet:\n required:\n - id\n - name\n properties:\n id:\n type: integer\n format: int64\n name:\n type: string\n tag:\n type: string\n Pets:\n type: array\n items:\n $ref: \"#/components/schemas/Pet\"\n Error:\n required:\n - code\n - message\n properties:\n code:\n type: integer\n format: int32\n message:\n type: string\n apis:\n type: array\n items:\n type: object\n properties:\n apiKey:\n type: string\n description: To be used as a dataset parameter value\n apiVersionNumber:\n type: string\n description: To be used as a version parameter value\n apiUrl:\n type: string\n format: uri\n description: \"The URL describing the dataset's fields\"\n apiDocumentationUrl:\n type: string\n format: uri\n description: A URL to the API console for each API\n```\n\n</details>\n\n<details>\n<summary>model.py</summary>\n\n```python\n# generated by datamodel-codegen:\n# filename: api.yaml\n# timestamp: 2020-06-02T05:28:24+00:00\n\nfrom __future__ import annotations\n\nfrom typing import List, Optional\n\nfrom pydantic import AnyUrl, BaseModel, Field\n\n\nclass Pet(BaseModel):\n id: int\n name: str\n tag: Optional[str] = None\n\n\nclass Pets(BaseModel):\n __root__: List[Pet]\n\n\nclass Error(BaseModel):\n code: int\n message: str\n\n\nclass Api(BaseModel):\n apiKey: Optional[str] = Field(\n None, description='To be used as a dataset parameter value'\n )\n apiVersionNumber: Optional[str] = Field(\n None, description='To be used as a version parameter value'\n )\n apiUrl: Optional[AnyUrl] = Field(\n None, description=\"The URL describing the dataset's fields\"\n )\n apiDocumentationUrl: Optional[AnyUrl] = Field(\n None, description='A URL to the API console for each API'\n )\n\n\nclass Apis(BaseModel):\n __root__: List[Api]\n```\n</details>\n\n## Projects that use datamodel-code-generator\nThese OSS projects use datamodel-code-generator to generate many models. See the following linked projects for real world examples and inspiration.\n- [Netflix/consoleme](https://github.com/Netflix/consoleme)\n - *[How do I generate models from the Swagger specification?](https://github.com/Netflix/consoleme/blob/master/docs/gitbook/faq.md#how-do-i-generate-models-from-the-swagger-specification)*\n- [DataDog/integrations-core](https://github.com/DataDog/integrations-core)\n - *[Config models](https://github.com/DataDog/integrations-core/blob/master/docs/developer/meta/config-models.md)*\n- [awslabs/aws-lambda-powertools-python](https://github.com/awslabs/aws-lambda-powertools-python)\n - *Recommended for [advanced-use-cases](https://awslabs.github.io/aws-lambda-powertools-python/2.6.0/utilities/parser/#advanced-use-cases) in the official documentation*\n- [open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata)\n - [Makefile](https://github.com/open-metadata/OpenMetadata/blob/main/Makefile)\n- [airbytehq/airbyte](https://github.com/airbytehq/airbyte)\n - *[code-generator/Dockerfile](https://github.com/airbytehq/airbyte/blob/master/tools/code-generator/Dockerfile)*\n- [IBM/compliance-trestle](https://github.com/IBM/compliance-trestle)\n - *[Building the models from the OSCAL schemas.](https://github.com/IBM/compliance-trestle/blob/develop/docs/contributing/website.md#building-the-models-from-the-oscal-schemas)*\n- [SeldonIO/MLServer](https://github.com/SeldonIO/MLServer)\n - *[generate-types.sh](https://github.com/SeldonIO/MLServer/blob/master/hack/generate-types.sh)*\n## Supported input types\n- OpenAPI 3 (YAML/JSON, [OpenAPI Data Type](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#data-types))\n- JSON Schema ([JSON Schema Core](http://json-schema.org/draft/2019-09/json-schema-validation.html)/[JSON Schema Validation](http://json-schema.org/draft/2019-09/json-schema-validation.html))\n- JSON/YAML/CSV Data (it will be converted to JSON Schema)\n- Python dictionary (it will be converted to JSON Schema)\n\n## Supported output types\n- [pydantic](https://docs.pydantic.dev/1.10/).BaseModel\n- [pydantic_v2](https://docs.pydantic.dev/2.0/).BaseModel\n- [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html)\n- [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict)\n\n## Installation\n\nTo install `datamodel-code-generator`:\n```bash\n$ pip install datamodel-code-generator\n```\n\n### `http` extra option\nIf you want to resolve `$ref` for remote files then you should specify `http` extra option.\n```bash\n$ pip install datamodel-code-generator[http]\n```\n\n### Docker Image\nThe docker image is in [Docker Hub](https://hub.docker.com/r/koxudaxi/datamodel-code-generator)\n```bash\n$ docker pull koxudaxi/datamodel-code-generator\n```\n\n## Advanced Uses\nYou can genearte models from a URL.\n```bash\n$ datamodel-codegen --url https://<INPUT FILE URL> --output model.py\n```\nThis method needs the [http extra option](#http-extra-option)\n\n\n## All Command Options\n\nThe `datamodel-codegen` command:\n```bash\nusage: datamodel-codegen [-h] [--input INPUT] [--url URL]\n [--http-headers HTTP_HEADER [HTTP_HEADER ...]]\n [--http-ignore-tls]\n [--input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}]\n [--output-model-type {pydantic.BaseModel,pydantic_v2.BaseModel,dataclasses.dataclass,typing.TypedDict}]\n [--openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]]\n [--output OUTPUT] [--base-class BASE_CLASS]\n [--field-constraints] [--use-annotated]\n [--use-non-positive-negative-number-constrained-types]\n [--field-extra-keys FIELD_EXTRA_KEYS [FIELD_EXTRA_KEYS ...]]\n [--field-include-all-keys]\n [--field-extra-keys-without-x-prefix FIELD_EXTRA_KEYS_WITHOUT_X_PREFIX [FIELD_EXTRA_KEYS_WITHOUT_X_PREFIX ...]] \n [--snake-case-field]\n [--original-field-name-delimiter ORIGINAL_FIELD_NAME_DELIMITER]\n [--strip-default-none]\n [--disable-appending-item-suffix]\n [--allow-population-by-field-name]\n [--allow-extra-fields] [--enable-faux-immutability]\n [--use-default] [--force-optional]\n [--strict-nullable]\n [--strict-types {str,bytes,int,float,bool} [{str,bytes,int,float,bool} ...]]\n [--disable-timestamp] [--use-standard-collections]\n [--use-generic-container-types]\n [--use-union-operator] [--use-schema-description]\n [--use-field-description] [--use-default-kwarg]\n [--reuse-model] [--keep-model-order]\n [--collapse-root-models]\n [--enum-field-as-literal {all,one}] [--use-one-literal-as-default]\n [--set-default-enum-member]\n [--empty-enum-field-name EMPTY_ENUM_FIELD_NAME]\n [--capitalise-enum-members]\n [--special-field-name-prefix SPECIAL_FIELD_NAME_PREFIX]\n [--remove-special-field-name-prefix]\n [--use-subclass-enum] [--class-name CLASS_NAME]\n [--use-title-as-name] [--use-operation-id-as-name]\n [--use-unique-items-as-set]\n [--custom-template-dir CUSTOM_TEMPLATE_DIR]\n [--extra-template-data EXTRA_TEMPLATE_DATA]\n [--aliases ALIASES]\n [--target-python-version {3.6,3.7,3.8,3.9,3.10,3.11}]\n [--wrap-string-literal] [--validation]\n [--use-double-quotes] [--encoding ENCODING] [--debug]\n [--disable-warnings] [--version]\n\noptions:\n -h, --help show this help message and exit\n --input INPUT Input file/directory (default: stdin)\n --url URL Input file URL. `--input` is ignored when `--url` is\n used\n --http-headers HTTP_HEADER [HTTP_HEADER ...]\n Set headers in HTTP requests to the remote host.\n (example: \"Authorization: Basic dXNlcjpwYXNz\")\n --http-ignore-tls Disable verification of the remote host's TLS\n certificate\n --input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}\n Input file type (default: auto)\n --output-model-type {pydantic.BaseModel,pydantic_v2.BaseModel,dataclasses.dataclass,typing.TypedDict}\n Output model type (default: pydantic.BaseModel)\n --openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]\n Scopes of OpenAPI model generation (default: schemas)\n --output OUTPUT Output file (default: stdout)\n --base-class BASE_CLASS\n Base Class (default: pydantic.BaseModel)\n --field-constraints Use field constraints and not con* annotations\n --use-annotated Use typing.Annotated for Field(). Also, `--field-\n constraints` option will be enabled.\n --use-non-positive-negative-number-constrained-types\n Use the Non{Positive,Negative}{FloatInt} types instead\n of the corresponding con* constrained types.\n --field-extra-keys FIELD_EXTRA_KEYS [FIELD_EXTRA_KEYS ...]\n Add extra keys to field parameters\n --field-include-all-keys\n Add all keys to field parameters\n --field-extra-keys-without-x-prefix\n Add extra keys with `x-` prefix to field parameters.\n The extra keys are stripped of the `x-` prefix.\n --snake-case-field Change camel-case field name to snake-case\n --original-field-name-delimiter ORIGINAL_FIELD_NAME_DELIMITER\n Set delimiter to convert to snake case. This option\n only can be used with --snake-case-field (default: `_`\n )\n --strip-default-none Strip default None on fields\n --disable-appending-item-suffix\n Disable appending `Item` suffix to model name in an\n array\n --allow-population-by-field-name\n Allow population by field name\n --allow-extra-fields Allow to pass extra fields, if this flag is not\n passed, extra fields are forbidden.\n --enable-faux-immutability\n Enable faux immutability\n --use-default Use default value even if a field is required\n --force-optional Force optional for required fields\n --strict-nullable Treat default field as a non-nullable field (Only\n OpenAPI)\n --strict-types {str,bytes,int,float,bool} [{str,bytes,int,float,bool} ...]\n Use strict types\n --disable-timestamp Disable timestamp on file headers\n --use-standard-collections\n Use standard collections for type hinting (list, dict)\n --use-generic-container-types\n Use generic container types for type hinting\n (typing.Sequence, typing.Mapping). If `--use-standard-\n collections` option is set, then import from\n collections.abc instead of typing\n --use-union-operator Use | operator for Union type (PEP 604).\n --use-schema-description\n Use schema description to populate class docstring\n --use-field-description\n Use schema description to populate field docstring\n --use-default-kwarg Use `default=` instead of a positional argument for\n Fields that have default values.\n --reuse-model Re-use models on the field when a module has the model\n with the same content\n --keep-model-order Keep generated models' order\n --collapse-root-models\n Models generated with a root-type field will be\n mergedinto the models using that root-type model\n --enum-field-as-literal {all,one}\n Parse enum field as literal. all: all enum field type\n are Literal. one: field type is Literal when an enum\n has only one possible value\n --use-one-literal-as-default\n Use one literal as default value for one literal field\n --set-default-enum-member\n Set enum members as default values for enum field\n --empty-enum-field-name EMPTY_ENUM_FIELD_NAME\n Set field name when enum value is empty (default: `_`)\n --capitalise-enum-members\n Capitalize field names on enum\n --special-field-name-prefix SPECIAL_FIELD_NAME_PREFIX\n Set field name prefix when first character can't be\n used as Python field name (default: `field`)\n --remove-special-field-name-prefix\n Remove field name prefix when first character can't be\n used as Python field name\n --use-subclass-enum Define Enum class as subclass with field type when\n enum has type (int, float, bytes, str)\n --class-name CLASS_NAME\n Set class name of root model\n --use-title-as-name use titles as class names of models\n --use-unique-items-as-set\n define field type as `set` when the field attribute\n has `uniqueItems`\n --custom-template-dir CUSTOM_TEMPLATE_DIR\n Custom template directory\n --extra-template-data EXTRA_TEMPLATE_DATA\n Extra template data\n --aliases ALIASES Alias mapping file\n --target-python-version {3.6,3.7,3.8,3.9,3.10,3.11}\n target python version (default: 3.7)\n --wrap-string-literal\n Wrap string literal by using black `experimental-\n string-processing` option (require black 20.8b0 or\n later)\n --validation Enable validation (Only OpenAPI)\n --use-double-quotes Model generated with double quotes. Single quotes or\n your black config skip_string_normalization value will\n be used without this option.\n --encoding ENCODING The encoding of input and output (default: cp1252)\n --debug show debug message\n --disable-warnings disable warnings\n --version show version\n```\n\n## Related projects\n### fastapi-code-generator\nThis code generator creates [FastAPI](https://github.com/tiangolo/fastapi) app from an openapi file.\n\n[https://github.com/koxudaxi/fastapi-code-generator](https://github.com/koxudaxi/fastapi-code-generator)\n\n### pydantic-pycharm-plugin\n[A JetBrains PyCharm plugin](https://plugins.jetbrains.com/plugin/12861-pydantic) for [`pydantic`](https://github.com/samuelcolvin/pydantic).\n\n[https://github.com/koxudaxi/pydantic-pycharm-plugin](https://github.com/koxudaxi/pydantic-pycharm-plugin)\n\n## PyPi\n\n[https://pypi.org/project/datamodel-code-generator](https://pypi.org/project/datamodel-code-generator)\n\n## License\n\ndatamodel-code-generator is released under the MIT License. http://www.opensource.org/licenses/mit-license\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Datamodel Code Generator",
"version": "0.25.6",
"project_urls": {
"Homepage": "https://github.com/koxudaxi/datamodel-code-generator",
"Repository": "https://github.com/koxudaxi/datamodel-code-generator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91c93814295b1c65d5003e85cab434e5914888dd18a64accb9f840de52e25b5e",
"md5": "b55503df51c57cc94f429b2d50720f38",
"sha256": "6ed2dc74290b21048e34190ba24eb47d33470cb63ceb654852af5b652533f6ad"
},
"downloads": -1,
"filename": "datamodel_code_generator_genson_wheel-0.25.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b55503df51c57cc94f429b2d50720f38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 89441,
"upload_time": "2024-05-12T02:26:22",
"upload_time_iso_8601": "2024-05-12T02:26:22.311446Z",
"url": "https://files.pythonhosted.org/packages/91/c9/3814295b1c65d5003e85cab434e5914888dd18a64accb9f840de52e25b5e/datamodel_code_generator_genson_wheel-0.25.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe3fcdff4c24135ac2bc5a0d2589eb37be2152796cac2631c707271c2ff6cca4",
"md5": "bb337fcfd425461abd1f75776e484cd5",
"sha256": "7ce8f26c7865dabb9f207a938f685b8253bfadb89d852fab7c63dec883e0f1bb"
},
"downloads": -1,
"filename": "datamodel_code_generator_genson_wheel-0.25.6.tar.gz",
"has_sig": false,
"md5_digest": "bb337fcfd425461abd1f75776e484cd5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 69355,
"upload_time": "2024-05-12T02:26:24",
"upload_time_iso_8601": "2024-05-12T02:26:24.538252Z",
"url": "https://files.pythonhosted.org/packages/fe/3f/cdff4c24135ac2bc5a0d2589eb37be2152796cac2631c707271c2ff6cca4/datamodel_code_generator_genson_wheel-0.25.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-12 02:26:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "koxudaxi",
"github_project": "datamodel-code-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "datamodel-code-generator-genson-wheel"
}
JSON
