deckhand.common.document module

class deckhand.common.document.DocumentDict[source]

Bases: dict

Wrapper for a document.

Implements convenient properties for nested, commonly accessed document keys. Property setters are only implemented for mutable data.

Useful for accessing nested dictionary keys without having to worry about exceptions getting thrown.

Note

As a rule of thumb, setters for any metadata properties should be avoided. Only implement or use for well-understood edge cases.

actions
data
classmethod from_list(documents)[source]

Convert an iterable of documents into instances of this class.

Parameters:documents (iterable) – Documents to wrap in this class.
has_barbican_ref
has_replacement
is_abstract
is_control
is_encrypted
is_replacement
labels
layer
layer_order
layeringDefinition
layering_definition
meta
metadata
name
parent_selector
classmethod redact(field)[source]
replaced_by
schema
storage_policy
substitutions
deckhand.common.document.document_dict_representer(dumper, data)[source]