scistag.filestag.bundle.BundleInfo

class BundleInfo(**data)

Bases: BaseModel

Defines the bundle information

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

Raises ValidationError if the input data cannot be parsed to form a valid model.

Methods

construct	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
copy	Duplicate a model, optionally choose which fields to include, exclude and change.
dict	Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
from_orm	rtype Model
json	Generate a JSON representation of the model, include and exclude arguments as per dict().
parse_file	rtype Model
parse_obj	rtype Model
parse_raw	rtype Model
schema	rtype DictStrAny
schema_json	rtype unicode
update_forward_refs	Try to update ForwardRefs on fields based on this Model, globalns and localns.
validate	rtype Model

Attributes

__abstractmethods__
__annotations__
__class_vars__
__custom_root_type__
__dict__
__doc__
__exclude_fields__
__fields__
__fields_set__
__hash__
__include_fields__
__module__
__post_root_validators__
__pre_root_validators__
__private_attributes__
__schema_cache__
__signature__
__slots__
__validators__
_abc_impl
source_type	The list of keys in their original order
keys	The source type
adv_elements	The advanced elements and their descriptor
simple_elements	The simple elements which can make use of direct key value storage
version	The protocol version
recursive	Defines if the elements of the first level e.g.

__setattr__(name, value)

Implement setattr(self, name, value).

classmethod construct(_fields_set=None, **values)

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Return type

Model

copy(*, include=None, exclude=None, update=None, deep=False)

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

• include (Union[AbstractSetIntStr, MappingIntStrAny, None]) – fields to include in new model

• exclude (Union[AbstractSetIntStr, MappingIntStrAny, None]) – fields to exclude from new model, as with values this takes precedence over include

• update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

• deep (bool) – set to True to make a deep copy of the model

Return type

Model

Returns

new model instance

dict(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Return type

DictStrAny

json(*, include=None, exclude=None, by_alias=False, skip_defaults=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=None, models_as_dict=True, **dumps_kwargs)

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Return type

unicode

classmethod update_forward_refs(**localns)

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Return type

None

adv_elements: dict[str, scistag.filestag.bundle.BundleElementInfo]

The advanced elements and their descriptor

keys: list[str]

The source type

recursive

Defines if the elements of the first level e.g. dictionaries and lists may contain further, bundled advanced types such as np.arrays.

simple_elements: dict[str, Any]

The simple elements which can make use of direct key value storage

source_type: Literal['dict', 'tuple', 'list']

The list of keys in their original order

version: int

The protocol version