Skip to content

RootModel

RootModel class and type definitions.

RootModel 

RootModel(
    __pydantic_self__, root=PydanticUndefined, **data
)

Bases: BaseModel, typing.Generic[RootModelRootType]

Usage Documentation

RootModel and custom root types

A Pydantic BaseModel for the root object of the model.

Attributes:

Name Type Description
root RootModelRootType

The root object of the model.
__pydantic_root_model__

Whether the model is a RootModel.
__pydantic_private__

Private fields in the model.
__pydantic_extra__

Extra fields in the model.
Source code in pydantic/root_model.py 
55
56
57
58
59
60
61
62
63
def __init__(__pydantic_self__, root: RootModelRootType = PydanticUndefined, **data) -> None:  # type: ignore
    __tracebackhide__ = True
    if data:
        if root is not PydanticUndefined:
            raise ValueError(
                '"RootModel.__init__" accepts either a single positional argument or arbitrary keyword arguments'
            )
        root = data  # type: ignore
    __pydantic_self__.__pydantic_validator__.validate_python(root, self_instance=__pydantic_self__)

model_construct classmethod 

model_construct(root, _fields_set=None)

Create a new model using the provided root object and update fields set.

Parameters:

Name Type Description Default
root RootModelRootType

The root object of the model.

 required
_fields_set set[str] | None

The set of fields to be updated.

 None

Returns:

Type Description
Model

The new model.

Raises:

Type Description
NotImplemented

If the model is not a subclass of RootModel.
Source code in pydantic/root_model.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
@classmethod
def model_construct(cls: type[Model], root: RootModelRootType, _fields_set: set[str] | None = None) -> Model:
    """Create a new model using the provided root object and update fields set.

    Args:
        root: The root object of the model.
        _fields_set: The set of fields to be updated.

    Returns:
        The new model.

    Raises:
        NotImplemented: If the model is not a subclass of `RootModel`.
    """
    return super().model_construct(root=root, _fields_set=_fields_set)

model_dump 

model_dump(
    *,
    mode="python",
    include=None,
    exclude=None,
    by_alias=False,
    exclude_unset=False,
    exclude_defaults=False,
    exclude_none=False,
    round_trip=False,
    warnings=True
)

This method is included just to get a more accurate return type for type checkers. It is included in this if TYPE_CHECKING: block since no override is actually necessary.

See the documentation of BaseModel.model_dump for more details about the arguments.

Source code in pydantic/root_model.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def model_dump(
    self,
    *,
    mode: Literal['json', 'python'] | str = 'python',
    include: Any = None,
    exclude: Any = None,
    by_alias: bool = False,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False,
    round_trip: bool = False,
    warnings: bool = True,
) -> RootModelRootType:
    """This method is included just to get a more accurate return type for type checkers.
    It is included in this `if TYPE_CHECKING:` block since no override is actually necessary.

    See the documentation of `BaseModel.model_dump` for more details about the arguments.
    """
    ...