ExamplePydanticClass

class examples.samples.ExamplePydanticClass(/, **data: Any)

Bases: pydantic.BaseModel

An example Pydantic class.

Parameters:

valuefloat

A required parameter.

value_with_default1float, optional

A simple optional parameter with a default value of 3.14.

value_with_default2float, optional

A simple optional parameter using Field for the default value and description. Default is 3.14.

value_with_constraintsfloat, optional

An optional parameter with constraints using Field for the default value, description and constraints. Default is 10.0, with constraints: 0.0 <= value <= 100.0.

Examples

>>> example = ExamplePydanticClass(value=42)
>>> example.value
42
>>> example.value_with_default1
3.14
>>> example.value_with_default2
3.14
>>> example.value_with_constraints
10.0

Overview

Attributes

value	A required parameter.
value_with_default1	A simple optional parameter with a default value.
value_with_default2	A simple optional parameter using field for default value and description.
value_with_constraints	A optional parameter with constraints using field for default value, description and constraints.

Import detail

from examples.samples import ExamplePydanticClass

Attribute detail

ExamplePydanticClass.value: float

A required parameter.

ExamplePydanticClass.value_with_default1: float = 3.14

A simple optional parameter with a default value.

ExamplePydanticClass.value_with_default2: float = None

A simple optional parameter using field for default value and description.

ExamplePydanticClass.value_with_constraints: float = None

A optional parameter with constraints using field for default value, description and constraints.