Skip to content
Back to top
View this page

# DefinitionsInspector

class dsviper.DefinitionsInspector

  Bases: `object`

  DefinitionsInspector(definitions). A class used to retrieve registered concepts, clubs, enumerations, structures and attachments from TypeName.

  attachment_identifiers() → set[str]

    Return the set of identifiers for all attachments.

  check_attachment(identifier: str) → Attachment

    Return the attachment or raise.

  check_club(type_name: TypeName) → TypeClub

    Return the club or raise.

  check_concept(type_name: TypeName) → TypeConcept

    Return the concept or raise.

  check_enumeration(type_name: TypeName) → TypeEnumeration

    Return the enum or raise.

  check_structure(type_name: TypeName) → TypeStructure

    Return a struct or raise.

  club_type_names() → set[TypeName]

    Return the set of TypeName for all clubs.

  concept_type_names() → set[TypeName]

    Return the set of TypeName for all concepts.

  enumeration_type_names() → set[TypeName]

    Return the set of TypeName for all enums.

  name_spaces() → set[NameSpace]

    Return the set of NameSpace for all TypNames.

  query_attachment(identifier: str) → Attachment | None

    Return the attachment or None.

  query_club(type_name: TypeName) → TypeClub | None

    Return the club or None.

  query_concept(type_name: TypeName) → TypeConcept | None

    Return the concept or None.

  query_enumeration(type_name: TypeName) → TypeEnumeration | None

    Return the enum or None.

  query_structure(type_name: TypeName) → TypeStructure | None

    Return a struct or None.

  representation(type_name: TypeName) → str

    Return the shortest representation of the TypeName.

  structure_type_names() → set[TypeName]

    Return the set of TypeName for all structs.