mt_metadata.transfer_functions.io.emtfxml.metadata.field_notes

Created on Thu Mar 9 12:25:44 2023

@author: jpeacock

Classes

FieldNotes

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.io.emtfxml.metadata.field_notes.FieldNotes(**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

read_dict(input_dict)
to_xml(string=False, required=True)

Convert the FieldNotes instance to XML format.

Parameters:

  • string (bool, optional) – If True, return XML as a string, by default False

  • required (bool, optional) – If True, include all required fields, by default True

Returns:

The XML representation of the FieldNotes instance

Return type:

list[str | et.Element]