Skip to content
Back to top
View this page

# Attachment

class dsviper.Attachment

  Bases: `object`

  A class used to represent an attachment.

  Note: Not directly instantiable.

  create_document() → Value

    Return a new document.

  create_key(instance_id: ValueUUId | None = None) → ValueKey

    Return a new key.

  create_structure(initial_value: dict[str, _InputValues] | None = None) → ValueStructure

    Create a new structure and may initialize it or raise.

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

    Return the description.

  document_type() → Type

    Return the type of the document.

  documentation() → str

    Return the documentation.

  identifier() → str

    Return the identifier.

  key_type() → _AbstractionTypes

    Return the type of the key.

  key_type_name() → TypeName

    Return the key’s TypeName.

  keys_type() → TypeSet

    Return the type of the key.

  optional_document_type() → TypeOptional

    Return the type of the optional document.

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

    Return the representation.

  runtime_id() → ValueUUId

    Return the uuid assigned by the runtime.

  type_key() → TypeKey

    Return the type key<element_type>.

  type_name() → TypeName

    Return the TypeName.