BaseConfig.model_dump#

BaseConfig.model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)#

Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Args:
mode: The mode in which to_python should run.

If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.

include: A set of fields to include in the output. exclude: A set of fields to exclude from the output. context: Additional context to pass to the serializer. by_alias: Whether to use the field’s alias in the dictionary key if defined. exclude_unset: Whether to exclude fields that have not been explicitly set. exclude_defaults: Whether to exclude fields that are set to their default value. exclude_none: Whether to exclude fields that have a value of None. round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. warnings: How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,

“error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].

serialize_as_any: Whether to serialize fields with duck-typing serialization behavior.

Returns:

A dictionary representation of the model.

Parameters:

  • mode (Literal['json', 'python'] | str)

  • include (Set[int] | Set[str] | Mapping[int, Set[int] | Set[str] | Mapping[int, IncEx | Literal[True]] | ~typing.Mapping[str, IncEx | ~typing.Literal[True]] | ~typing.Literal[True]] | ~typing.Mapping[str, ~typing.Set[int] | ~typing.Set[str] | ~typing.Mapping[int, IncEx | ~typing.Literal[True]] | ~typing.Mapping[str, IncEx | ~typing.Literal[True]] | ~typing.Literal[True]] | None)

  • exclude (Set[int] | Set[str] | Mapping[int, Set[int] | Set[str] | Mapping[int, IncEx | Literal[True]] | ~typing.Mapping[str, IncEx | ~typing.Literal[True]] | ~typing.Literal[True]] | ~typing.Mapping[str, ~typing.Set[int] | ~typing.Set[str] | ~typing.Mapping[int, IncEx | ~typing.Literal[True]] | ~typing.Mapping[str, IncEx | ~typing.Literal[True]] | ~typing.Literal[True]] | None)

  • context (Any | None)

  • by_alias (bool)

  • exclude_unset (bool)

  • exclude_defaults (bool)

  • exclude_none (bool)

  • round_trip (bool)

  • warnings (bool | Literal['none', 'warn', 'error'])

  • serialize_as_any (bool)

Return type:

dict[str, Any]