ExampleDataClass

class examples.samples.ExampleDataClass

An example dataclass.

Parameters:

valuefloat

A mandatory parameter.

value_with_defaultfloat, optional

An optional parameter with a default value of 3.14.

value_with_default_fieldfloat, optional

An optional parameter using field for the default value. Default is 3.14.

Examples

>>> example = ExampleDataClass(value=42)
>>> example.value
42
>>> example.value_with_default
3.14
>>> example.value_with_default_field
3.14

Overview

Attributes

value	A mandatory parameter.
value_with_default	An optional parameter with a default value.
value_with_default_field	An optional parameter using field for the default value.

Import detail

from examples.samples import ExampleDataClass

Attribute detail

ExampleDataClass.value: float

A mandatory parameter.

ExampleDataClass.value_with_default: float = 3.14

An optional parameter with a default value.

ExampleDataClass.value_with_default_field: float = 3.14

An optional parameter using field for the default value.