Field options

In some cases creating a new class just for one little thing could be excessive. Moreover, you may need to deal with third party classes that you are not allowed to change. You can use dataclasses.field function to configure some serialization aspects through its metadata parameter. Next section describes all supported options to use in metadata mapping.

💡 Tip If you don't want to remember the names of the options you can use field_options helper function:

from dataclasses import dataclass, field
from mashumaro import field_options

@dataclass
class A:
   x: int = field(metadata=field_options(...))

Warning

If you need to save a reference to from_* or to_* method, you should do it after the method is compiled. To be safe, you can always use lambda function:

from_dict = lambda x: MyModel.from_dict(x)
to_dict = lambda x: x.to_dict()

Warning

No syntax highlighting anymore:

print("hello world")

Syntax hilighting works if the title was removed

print("hello world")

With spaces as line breaks

Note
This is a note

Note\

This is a note

Warning
This is a warning

Note
This is a note

Warning
This is a warning

Note

Highlights information that users should take into account, even when skimming.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Warning

This library is currently in pre-release stage and may have backward incompatible changes prior to version 1.0. Please use caution when using this library in production environments and be sure to thoroughly test any updates before upgrading to a new version.