allensdk.brain_observatory.behavior.behavior_project_cache.project_metadata_writer.schemas module¶

class allensdk.brain_observatory.behavior.behavior_project_cache.project_metadata_writer.schemas.BaseMetadataWriterInputSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: ArgSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.behavior.behavior_project_cache.project_metadata_writer.schemas.BehaviorOphysMetadataInputSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: BaseMetadataWriterInputSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

validate_paths(data, **kwargs)[source]¶

class allensdk.brain_observatory.behavior.behavior_project_cache.project_metadata_writer.schemas.DataReleaseToolsInputSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: ArgSchema

This schema will be used as the output schema for data_release.metadata_writer modules. It is actually a subset of the input schema for the informatics_data_release_tools (the output of the metadata writers is meant to be the input of the data_release_tool)

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.behavior.behavior_project_cache.project_metadata_writer.schemas.PipelineMetadataSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: DefaultSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶