class documentation

class DictField(mongoengine.fields.DictField, Field): (source)

Known subclasses: fiftyone.core.fields.MaskTargetsField

Constructor: DictField(field, description, info, read_only, ...)

View In Hierarchy

A dictionary field that wraps a standard Python dictionary.

If this field is not set, its default value is {}.

Parameters
fieldan optional Field instance describing the type of the values in the dict
descriptionan optional description
infoan optional info dict
read_onlywhether the field is read-only
created_atthe datetime the field was created
Method __init__ Undocumented
Method __str__ Undocumented
Method validate Undocumented
Method _set_dataset Undocumented
Instance Variable _created_at Undocumented
Instance Variable _description Undocumented
Instance Variable _info Undocumented
Instance Variable _read_only Undocumented

Inherited from Field:

Method copy Returns a copy of the field.
Method description.setter Undocumented
Method info.setter Undocumented
Method read_only.setter Undocumented
Method save Saves any edits to this field's description and info attributes.
Property path The fully-qualified path of this field in the dataset's schema, or None if the field is not associated with a dataset.
Method _set_created_at Undocumented
Instance Variable __dataset Undocumented
Instance Variable __path Undocumented
Property _dataset The fiftyone.core.dataset.Dataset that this field belongs to, or None if the field is not associated with a dataset.
def __init__(self, field=None, description=None, info=None, read_only=False, created_at=None, **kwargs): (source)
def __str__(self): (source)

Undocumented

def validate(self, value): (source)

Undocumented

def _set_dataset(self, dataset, path): (source)