fiftyone.core.odm.utils

module documentation

(source)

Utilities for documents.

Class	`DocumentRegistry`	A registry of `fiftyone.core.odm.document.MongoEngineBaseDocument` classes found when importing data from the database.
Exception	`DocumentRegistryError`	Error raised when an unknown document class is encountered.
Function	`create_field`	Creates the field defined by the given specification.
Function	`create_implied_field`	Creates the field for the given value.
Function	`deserialize_value`	Deserializes the given value.
Function	`get_field_kwargs`	Constructs the field keyword arguments dictionary for the given field.
Function	`get_implied_field_kwargs`	Infers the field keyword arguments dictionary for a field that can hold the given value.
Function	`load_dataset`	Loads the dataset from the database by its unique id or name. Throws an error if neither id nor name is provided.
Function	`serialize_value`	Serializes the given value.
Function	`validate_field_name`	Verifies that the given field name is valid.
Function	`validate_fields_match`	Validates that the types of the given fields match.
Variable	`fol`	Undocumented
Variable	`food`	Undocumented
Variable	`fooe`	Undocumented
Function	`_finalize_embedded_doc_fields`	Undocumented
Function	`_get_field_kwargs`	Undocumented
Function	`_get_field_type`	Undocumented
Function	`_get_list_subfield_type`	Undocumented
Function	`_merge_embedded_doc_fields`	Undocumented
Function	`_parse_embedded_doc_fields`	Undocumented
Function	`_parse_embedded_doc_list_fields`	Undocumented
Function	`_parse_field_str`	Undocumented
Variable	`_document_registry`	Undocumented

def create_field(name, ftype, embedded_doc_type=None, subfield=None, fields=None, db_field=None, description=None, info=None, read_only=False, created_at=None, **kwargs): (source) ¶

Creates the field defined by the given specification.

Note

This method is used exclusively to create user-defined (non-default) fields. Any parameters accepted here must be stored on fiftyone.core.odm.dataset.SampleFieldDocument or else datasets will "lose" any additional decorations when they are loaded from the database.

Parameters
name	the field name
ftype	the field type to create. Must be a subclass of `fiftyone.core.fields.Field`
embedded_doc_type:`None`	the `fiftyone.core.odm.BaseEmbeddedDocument` type of the field. Only applicable when `ftype` is `fiftyone.core.fields.EmbeddedDocumentField`
subfield:`None`	the `fiftyone.core.fields.Field` type of the contained field. Only applicable when `ftype` is `fiftyone.core.fields.ListField` or `fiftyone.core.fields.DictField`
fields:`None`	a list of `fiftyone.core.fields.Field` instances defining embedded document attributes. Only applicable when `ftype` is `fiftyone.core.fields.EmbeddedDocumentField`
db_field:`None`	the database field to store this field in. By default, `name` is used
description:`None`	an optional description
info:`None`	an optional info dict
read_only:`False`	whether the field should be read-only
created_at:`None`	the datetime the field was created
**kwargs	Undocumented
Returns
a `fiftyone.core.fields.Field`

def create_implied_field(path, value, dynamic=False): (source) ¶

Creates the field for the given value.

Parameters
path	the field name or path
value	a value
dynamic:`False`	whether to declare dynamic embedded document fields
Returns
a `fiftyone.core.fields.Field`

def deserialize_value(value): (source) ¶

Deserializes the given value.

Parameters
value	the serialized value
Returns
the value

def get_field_kwargs(field): (source) ¶

Constructs the field keyword arguments dictionary for the given field.

Parameters
field	a `fiftyone.core.fields.Field` or `str(field)` representation of one
Returns
a field specification dict

def get_implied_field_kwargs(value, dynamic=False): (source) ¶

Infers the field keyword arguments dictionary for a field that can hold the given value.

Parameters
value	a value
dynamic:`False`	whether to declare dynamic embedded document fields
Returns
a field specification dict

def load_dataset(id=None, name=None): (source) ¶

Loads the dataset from the database by its unique id or name. Throws an error if neither id nor name is provided.

Parameters
id:`None`	the unique id of the dataset
name:`None`	the name of the dataset
Returns
a `fiftyone.core.dataset.Dataset`

def serialize_value(value, extended=False): (source) ¶

Serializes the given value.

Parameters
value	the value
extended:`False`	whether to serialize extended JSON constructs such as ObjectIDs, Binary, etc. into JSON format
Returns
the serialized value

def validate_field_name(field_name, media_type=None, is_frame_field=False): (source) ¶

Verifies that the given field name is valid.

Parameters
field_name	the field name
media_type:`None`	the media type of the sample, if known
is_frame_field:`False`	whether this is a frame-level field
Raises
`ValueError`	if the field name is invalid

def validate_fields_match(name, field, existing_field): (source) ¶

Validates that the types of the given fields match.

Embedded document fields are not validated, if applicable.

Parameters
name	the field name or `embedded.field.name`
field	a `fiftyone.core.fields.Field`
existing_field	the reference `fiftyone.core.fields.Field`
Raises
`ValueError`	if the fields do not match

fol = (source) ¶

Undocumented

food = (source) ¶

Undocumented

fooe = (source) ¶

Undocumented

def _finalize_embedded_doc_fields(fields_dict): (source) ¶

Undocumented

def _get_field_kwargs(value, field, dynamic): (source) ¶

Undocumented

def _get_field_type(value): (source) ¶

Undocumented

def _get_list_subfield_type(values): (source) ¶

Undocumented

def _merge_embedded_doc_fields(fields_dict, fields): (source) ¶

Undocumented

def _parse_embedded_doc_fields(doc, dynamic): (source) ¶

Undocumented

def _parse_embedded_doc_list_fields(values, dynamic): (source) ¶

Undocumented

def _parse_field_str(field_str): (source) ¶

Undocumented

_document_registry = (source) ¶

Undocumented