fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument

class documentation

class DynamicEmbeddedDocument(DynamicMixin, BaseEmbeddedDocument, mongoengine.DynamicEmbeddedDocument): (source)

Constructor: DynamicEmbeddedDocument(*args, **kwargs)

View In Hierarchy

Base class for dynamic documents that are embedded within other documents and therefore aren't stored in their own collection in the database.

Dynamic documents can have arbitrary fields added to them.

Method __hash__ Undocumented
Method __init__ Undocumented
Method __setattr__ Undocumented
Class Variable meta Undocumented
Static Method _extract_attribute_from_exception Undocumented
Method _get_field Undocumented
Method _raise_reserved_attribute_exception Undocumented

Inherited from DynamicMixin:

Method to_mongo Undocumented
Class Method _from_son Undocumented

Inherited from MongoEngineBaseDocument (via DynamicMixin, BaseEmbeddedDocument):

Class Method from_dict Loads the document from a BSON/JSON dictionary.
Method __deepcopy__ Undocumented
Method __delattr__ Undocumented
Method __delitem__ Undocumented
Method clear_field Clears the field from the document.
Method field_to_mongo Undocumented
Method field_to_python Undocumented
Method get_field Gets the field of the document.
Method has_field Determines whether the document has a field of the given name.
Method set_field Sets the value of a field of the document.
Method to_dict Serializes this document to a BSON/JSON dictionary.
Property field_names An ordered tuple of the public fields of this document.
Method _get_field_names Returns an ordered tuple of field names of this document.
Method _get_repr_fields Returns an ordered tuple of field names that should be included in the repr of the document.
Method _to_db_fields Undocumented
Instance Variable _fields_ordered Undocumented

Inherited from SerializableDocument (via DynamicMixin, BaseEmbeddedDocument, MongoEngineBaseDocument):

Class Method from_json Loads the document from a JSON string.
Method __eq__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method copy Returns a deep copy of the document.
Method fancy_repr Generates a customizable string representation of the document.
Method iter_fields Returns an iterator over the (name, value) pairs of the public fields of the document.
Method merge Merges the contents of the given document into this document.
Method to_json Serializes the document to a JSON string.
def __hash__(self): (source)

Undocumented

def __init__(self, *args, **kwargs): (source)

Undocumented

def __setattr__(self, name, value): (source)

Undocumented

meta: dict[str, bool] = (source)

Undocumented

@staticmethod
def _extract_attribute_from_exception(e): (source)

Undocumented

def _get_field(self, field_name, allow_missing=False): (source)
overrides fiftyone.core.odm.document.MongoEngineBaseDocument._get_field

Undocumented

def _raise_reserved_attribute_exception(self, e): (source)

Undocumented