Models#

pydantic model ConfiguredBaseModel#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

class ReftypeOptions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#
ref = 'ref'#
reference = 'reference'#
object = 'object'#
region = 'region'#
class QuantityEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#
ASTERISK = '*'#
QUESTION_MARK = '?'#
PLUS_SIGN = '+'#
zero_or_many = 'zero_or_many'#
one_or_many = 'one_or_many'#
zero_or_one = 'zero_or_one'#
class FlatDtype(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#
float = 'float'#
float32 = 'float32'#
double = 'double'#
float64 = 'float64'#
long = 'long'#
int64 = 'int64'#
int = 'int'#
int32 = 'int32'#
int16 = 'int16'#
short = 'short'#
int8 = 'int8'#
uint = 'uint'#
uint32 = 'uint32'#
uint16 = 'uint16'#
uint8 = 'uint8'#
uint64 = 'uint64'#
numeric = 'numeric'#
text = 'text'#
utf = 'utf'#
utf8 = 'utf8'#
utf_8 = 'utf-8'#
ascii = 'ascii'#
bool = 'bool'#
isodatetime = 'isodatetime'#
pydantic model Namespace#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field author: List[str] | str [Optional]#

List of strings with the names of the authors of the namespace.

field contact: List[str] | str [Optional]#

List of strings with the contact information for the authors. Ordering of the contacts should match the ordering of the authors.

field date: datetime | None = None#

Date that a namespace was last modified or released

field doc: str [Required]#

Description of corresponding object.

field full_name: str | None = None#

Optional string with extended full name for the namespace.

field name: str [Required]#
field schema_: List[Schema] | None [Optional] (alias 'schema')#

List of the schema to be included in this namespace.

field version: str [Required]#
pydantic model Namespaces#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field namespaces: List[Namespace] | None [Optional]#
pydantic model Schema#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field doc: str | None = None#
field namespace: str | None = None#

describes a named reference to another namespace. In contrast to source, this is a reference by name to a known namespace (i.e., the namespace is resolved during the build and must point to an already existing namespace). This mechanism is used to allow, e.g., extension of a core namespace (here the NWB core namespace) without requiring hard paths to the files describing the core namespace. Either source or namespace must be specified, but not both.

field neurodata_types: List[Dataset | Group] | None [Optional]#

an optional list of strings indicating which data types should be included from the given specification source or namespace. The default is null indicating that all data types should be included.

field source: str | None = None#

describes the name of the YAML (or JSON) file with the schema specification. The schema files should be located in the same folder as the namespace file.

field title: str | None = None#

a descriptive title for a file for documentation purposes.

pydantic model Group#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field attributes: List[Attribute] | None [Optional]#
field datasets: List[Dataset] | None [Optional]#
field default_name: str | None = None#
field doc: str [Required]#

Description of corresponding object.

field groups: List[Group] | None [Optional]#
field linkable: bool | None = None#
field name: str | None = None#
field neurodata_type_def: str | None = None#

Used alongside neurodata_type_inc to indicate inheritance, naming, and mixins

field neurodata_type_inc: str | None = None#

Used alongside neurodata_type_def to indicate inheritance, naming, and mixins

field quantity: QuantityEnum | int | None = 1#
pydantic model Groups#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field groups: List[Group] | None [Optional]#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field doc: str [Required]#

Description of corresponding object.

field name: str | None = None#
field quantity: QuantityEnum | int | None = 1#
field target_type: str [Required]#

Describes the neurodata_type of the target that the reference points to

pydantic model Datasets#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field datasets: List[Dataset] | None [Optional]#
pydantic model ReferenceDtype#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field reftype: ReftypeOptions | None = None#

describes the kind of reference

field target_type: str [Required]#

Describes the neurodata_type of the target that the reference points to

pydantic model CompoundDtype#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field doc: str [Required]#

Description of corresponding object.

field dtype: FlatDtype | ReferenceDtype [Required]#
field name: str [Required]#
pydantic model DtypeMixin#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field dtype: List[CompoundDtype] | FlatDtype | ReferenceDtype | None [Optional]#
pydantic model Attribute#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field default_value: Any | None = None#

Optional default value for variable-valued attributes.

field dims: List[Any | str] | None [Optional]#
field doc: str [Required]#

Description of corresponding object.

field dtype: List[CompoundDtype] | FlatDtype | ReferenceDtype | None [Optional]#
field name: str [Required]#
field required: bool | None = True#

Optional boolean key describing whether the attribute is required. Default value is True.

field shape: List[Any | int | str] | None [Optional]#
field value: Any | None = None#

Optional constant, fixed value for the attribute.

pydantic model Dataset#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Config:

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • arbitrary_types_allowed: bool = True

  • use_enum_values: bool = True

Fields:
field attributes: List[Attribute] | None [Optional]#
field default_name: str | None = None#
field default_value: Any | None = None#

Optional default value for variable-valued attributes.

field dims: List[Any | str] | None [Optional]#
field doc: str [Required]#

Description of corresponding object.

field dtype: List[CompoundDtype] | FlatDtype | ReferenceDtype | None [Optional]#
field linkable: bool | None = None#
field name: str | None = None#
field neurodata_type_def: str | None = None#

Used alongside neurodata_type_inc to indicate inheritance, naming, and mixins

field neurodata_type_inc: str | None = None#

Used alongside neurodata_type_def to indicate inheritance, naming, and mixins

field quantity: QuantityEnum | int | None = 1#
field shape: List[Any | int | str] | None [Optional]#
field value: Any | None = None#

Optional constant, fixed value for the attribute.