mt_metadata.transfer_functions.io.jfiles.metadata.birrp_block

Classes

BirrpBlock

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.io.jfiles.metadata.birrp_block.BirrpBlock(**data)

Bases: mt_metadata.base.MetadataBase

Base class for all metadata objects with Pydantic validation.

MetadataBase extends DotNotationBaseModel (which inherits from Pydantic’s BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:

list[str]

_fields

Private attribute caching field information

Type:

dict[str, Any]

Notes

• All field assignments are validated automatically via Pydantic

• None values are converted to appropriate defaults (empty string or 0.0)

• Supports nested attribute access via dot notation

• Thread-safe for read operations after initialization

filnam: Annotated[str, Field(default='', description='File name of data block', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['hx.dat']})]

nskip: Annotated[int, Field(default=None, description='number of points to skip', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['0']})]

nread: Annotated[int, Field(default=None, description='number of points to read', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['10000']})]

ncomp: Annotated[int, Field(default=0, description='number of components in file', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['4']})]

indices: Annotated[list[int] | int | str, Field(default_factory=list, description='index values to use', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['[1, 2]']})]

classmethod validate_indices(value)

Ensure indices is a list of integers or a single integer.