fiftyone.core.odm.mixins¶

Mixins and helpers for sample backing documents.

Copyright 2017-2020, Voxel51, Inc.
voxel51.com

Classes

`DatasetMixin`	Mixin for concrete `fiftyone.core.odm.document.SampleDocument` subtypes that are backed by a dataset.
`NoDatasetMixin`	Mixin for `fiftyone.core.odm.document.SampleDocument` subtypes that are not backed by a dataset.

Functions

`default_sample_fields`(cls[, …])	The default fields present on all `SampleDocument` objects.
`get_implied_field_kwargs`(value, **kwargs)
`no_delete_default_field`(func)	Wrapper for `SampleDocument.delete_field()` that prevents deleting default fields of `SampleDocument`.
`no_rename_default_field`(func)	Wrapper for `SampleDocument.rename_field()` that prevents renaming default fields of `SampleDocument`.

fiftyone.core.odm.mixins.default_sample_fields(cls, include_private=False, include_id=False)¶

The default fields present on all SampleDocument objects.

Parameters

cls – the SampleDocument class
include_private (False) – whether to include fields that start with _
include_id (False) – whether to include the id field

Returns

a tuple of field names

fiftyone.core.odm.mixins.no_rename_default_field(func)¶

Wrapper for SampleDocument.rename_field() that prevents renaming default fields of SampleDocument.

This is a decorator because the subclasses implement this as either an instance or class method.

fiftyone.core.odm.mixins.no_delete_default_field(func)¶

Wrapper for SampleDocument.delete_field() that prevents deleting default fields of SampleDocument.

This is a decorator because the subclasses implement this as either an instance or class method.

class fiftyone.core.odm.mixins.DatasetMixin¶

Bases: object

Mixin for concrete fiftyone.core.odm.document.SampleDocument subtypes that are backed by a dataset.

property collection_name¶

property field_names¶

classmethod get_field_schema(ftype=None, embedded_doc_type=None, include_private=False)¶

Returns a schema dictionary describing the fields of this sample.

If the sample belongs to a dataset, the schema will apply to all samples in the dataset.

Parameters

ftype (None) – an optional field type to which to restrict the returned schema. Must be a subclass of fiftyone.core.fields.Field
embedded_doc_type (None) – an optional embedded document type to which to restrict the returned schema. Must be a subclass of fiftyone.core.odm.BaseEmbeddedDocument
include_private (False) – whether to include fields that start with _ in the returned schema

Returns

a dictionary mapping field names to field types

has_field(field_name)¶

get_field(field_name)¶

classmethod add_field(field_name, ftype, embedded_doc_type=None, subfield=None, save=True, **kwargs)¶

Adds a new field to the sample.

Parameters

field_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. Used only when ftype is an embedded fiftyone.core.fields.EmbeddedDocumentField
subfield (None) – the type of the contained field. Used only when ftype is a fiftyone.core.fields.ListField or fiftyone.core.fields.DictField

classmethod add_implied_field(field_name, value, **kwargs)¶

Adds the field to the sample, inferring the field type from the provided value.

Parameters

field_name – the field name
value – the field value

set_field(field_name, value, create=False)¶

clear_field(field_name)¶

classmethod rename_field(field_name, new_field_name, is_frame_field=False)¶

Renames the field of the sample(s).

If the sample is in a dataset, the field will be renamed on all samples in the dataset.

Parameters

field_name – the field name
new_field_name – the new field name
is_frame_field (False) – whether this is a frame-level field

Raises

AttributeError – if the field does not exist

classmethod rename_embedded_field(field_name, new_field_name)¶

Renames the embedded field of the sample(s).

If the sample is in a dataset, the embedded field will be renamed on all samples in the dataset.

Parameters

field_name – the “embedded.field.name”
new_field_name – the “new.embedded.field.name”

Raises

AttributeError – if the field does not exist

classmethod delete_field(field_name, is_frame_field=False, update_schema=False)¶

Deletes the field from the sample(s).

If the sample is in a dataset, the field will be removed from all samples in the dataset.

Parameters

field_name – the field name
is_frame_field (False) – whether this is a frame-level field
update_schema (False) – whether to remove the field from the dataset schema

Raises

AttributeError – if the field does not exist

classmethod delete_embedded_field(field_name)¶

Deletes the embedded field from the sample(s).

If the sample is in a dataset, the embedded field will be removed from all samples in the dataset.

Parameters: field_name – the “embedded.field.name”

class fiftyone.core.odm.mixins.NoDatasetMixin¶

Bases: object

Mixin for fiftyone.core.odm.document.SampleDocument subtypes that are not backed by a dataset.

property id¶

property field_names¶

has_field(field_name)¶

get_field(field_name)¶

set_field(field_name, value, create=False)¶

clear_field(field_name)¶

to_dict(extended=False)¶

classmethod from_dict(d, extended=False)¶

save()¶

Saves the sample to the database.

Because the sample does not belong to a dataset, this method does nothing.

reload()¶

Reloads the sample from the database.

Because the sample does not belong to a dataset, this method does nothing.

delete()¶

Deletes the sample from the database.

Because the sample does not belong to a dataset, this method does nothing.

fiftyone.core.odm.mixins.get_implied_field_kwargs(value, **kwargs)¶