Skip to content
Back to top
View this page

# TypeEnumeration

class dsviper.TypeEnumeration

  Bases: `object`

  A class used to represent an enum type.

  Note: Not directly instantiable.

  cases() → list[TypeEnumerationCase]

    Return the list of cases.

  static cast(type: Type) → TypeEnumeration

    Return a type enum or raise.

  check(name: str) → TypeEnumerationCase

    Return the case or raise.

  description(*, namespace: NameSpace | None = None) → str

    Return the description.

  documentation() → str

    Return the documentation.

  query(name: str) → TypeEnumerationCase | None

    Return the case or None.

  representation(*, namespace: NameSpace | None = None) → str

    Return the representation.

  runtime_id() → ValueUUId

    Return the uuid assigned by the runtime.

  type_code() → str

    Return the type code.

  type_name() → TypeName

    Return a TypeName.