Skip to content
Back to top
View this page

# TypeStructureDescriptor

class dsviper.TypeStructureDescriptor(name, *, documentation=None)

  Bases: `object`

  A class used to describe the fields of a struct.

  add_field(field_name: str, type_or_value: _DefaultValues, documentation: str | None = None) → None

    Add a field where the type is specified or deducted from the value.

  description() → str

    Return the description.

  documentation() → str

    Return the documentation.

  fields() → list[TypeStructureField]

    Return the list of fields.

  name() → str

    Return the name.