Option to give custom types

[gk12277]

Hi, is there an option to give custom types?

I want the models to be created in this way.

from random_file import UserType

class User(BaseModel):
    user_type: Optional[UserType] = Field(None)

For the import string I have added it in custom template.

I am using jsonschema for generation. Is there a way to specify types like UserType in this case.

"$schema": http://json-schema.org/draft-07/schema#
type: object
properties:
  User:
    type: object
    properties:
      user_type:
        type:

[balukrishnans]

Hi,

There is a similar use case for me. I need to give a function as the default value (the importing part is a similar case here). I am also using jsonschema for generating the models.

For example

foo.py

class Foo:
    def bar(self):
        # code here

models.py

from foo import Foo

class Baz(BaseModel):
    bar = Foo.bar

Is there any way to achieve this?

[koxudaxi]

@gk12277
We need to add a CLI option to support custom types.
I think we should give a custom type or custom format.
Did you have an idea?

@balukrishnans
Your situation is more complex.
I guess we can pass custom type by adding a new CLI option. But, you set Foo.bar. it is not Foo 🤔
You may need to create a custom template with jinja2.
There is an option.
--custom-template-dir

And, this is the default template.
https://github.com/koxudaxi/datamodel-code-generator/blob/master/datamodel_code_generator/model/template/pydantic/BaseModel.jinja2

[koxudaxi]

@gk12277

Does the type: string given along with customTypePath have a particular meaning or is it just given as a type is needed.

I think JsonSchema is not related to implementation.
And, we should cut implementation information as soon as possible.

I would use the schema to define the external interface.
For example, Other apps send data as string, And pydantic model parse string as custom-type.

object is not bad. pydnatic model tries to parse object as custom-type.

Format will be useful to interpret the creation of certain type of objects.

I don't know the part.
Did you tell me a concrete use case?

[gk12277]

I think JsonSchema is not related to implementation.
And, we should cut implementation information as soon as possible.

But from the the library perspective, isn't it related to implementation since a developer would use this library to create pydantic models from jsonschema

Did you tell me a concrete use case?

Format to ensure compatibility with python data structures if format is not used then it will behave as usual.

For customTypes as you had said using customTypePath key seems good. Format can be used later on for some complex usecases probably.

[koxudaxi]

@gk12277
I'm sorry for my late reply.
OK, I will start implementing the feature.
The first step is to support customTypePath.

[gk12277]

Hey @koxudaxi any estimated time around which this feature will be released. So that I can plan accordingly.
Thank you 😃

[koxudaxi]

@gk12277
I've been busy recently. 🤦
I will try it tomorrow.

[koxudaxi]

@gk12277
I have released a new version 0.11.6
Input

datamodel-code-generator/tests/data/jsonschema/custom_type_path.json

Lines 4 to 9 in 1d5790e

	"type": "object",
	"properties": {
	"firstName": {
	"type": "string",
	"description": "The person's first name.",
	"customTypePath": "custom.TitleString"

Output

datamodel-code-generator/tests/data/expected/main/main_jsonschema_custom_type_path/output.py

Lines 17 to 23 in 1d5790e

	class Person(BaseModel):
	class Config:
	arbitrary_types_allowed = True
	firstName: Optional[TitleString] = Field(
	None, description="The person's first name."
	)

I must add a document for customTypePath 😅
#436

[gk12277]

Thank you 😃
Tested it working great 👍

[m-a-choquette]

Thanks @gk12277 for and @koxudaxi , this is useful and I will likely use it.

@koxudaxi if the source format is OpenAPI, do you know If there's a vision/plan for this use case ? (or some alternative I may have missed)

Adding the customTypePath to a property seems to actually produce the intended output.
However OpenAPI complains about the additional property.

Not sure if that could be case for an x-... extension property.

[koxudaxi]

@m-a-choquette
I have not thought about OpenAPI 😅

Not sure if that could be case for an x-... extension property.

That's looks good If the validator doesn't say a warning.

[gk12277]

@m-a-choquette @koxudaxi for Latest OpenApi Specification 3.1 this should work fine since it follows Jsonschema.
But for the versions before that will have to use x- prefix. So most validators before 3.1 would throw error for customTypePath but would fine with x-cusotmTypePath.