fiftyone.core.odm.utils

Utilities for documents.

Copyright 2017-2022, Voxel51, Inc.

voxel51.com

Classes:

DocumentRegistry()

A registry of fiftyone.core.odm.document.MongoEngineBaseDocument classes found when importing data from the database.

Exceptions:

DocumentRegistryError

Error raised when an unknown document class is encountered.

Functions:

deserialize_value(value)	Deserializes the given value.
get_field_kwargs(field)	Constructs the field keyword arguments dictionary for the given field.
get_implied_field_kwargs(value[, dynamic])	Infers the field keyword arguments dictionary for a field that can hold the given value.
serialize_value(value[, extended])	Serializes the given value.
validate_field_name(field_name[, …])	Verifies that the given field name is valid.
validate_fields_match(name, field, …)	Validates that the types of the given fields match.

fiftyone.core.odm.utils.serialize_value(value, extended=False)

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

fiftyone.core.odm.utils.deserialize_value(value)

Deserializes the given value.

Parameters

value – the serialized value

Returns

the value

fiftyone.core.odm.utils.validate_field_name(field_name, media_type=None, is_frame_field=False)

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

fiftyone.core.odm.utils.get_field_kwargs(field)

Constructs the field keyword arguments dictionary for the given field.

Parameters

field – a fiftyone.core.fields.Field

Returns

a field specification dict

fiftyone.core.odm.utils.get_implied_field_kwargs(value, dynamic=False)

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

fiftyone.core.odm.utils.validate_fields_match(name, field, existing_field)

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

class fiftyone.core.odm.utils.DocumentRegistry

Bases: object

A registry of fiftyone.core.odm.document.MongoEngineBaseDocument classes found when importing data from the database.

exception fiftyone.core.odm.utils.DocumentRegistryError

Bases: Exception

Error raised when an unknown document class is encountered.

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.