mt_metadata.transfer_functions.io.emtfxml.metadata.citation

Classes

Citation

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.io.emtfxml.metadata.citation.Citation(**data)

Bases: mt_metadata.common.Citation

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

survey_d_o_i: Annotated[pydantic.HttpUrl | str | None, Field(default=None, description='doi number of the survey', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['###/###']})]
classmethod validate_survey_d_o_i(value)

Validate the survey DOI.

Parameters:

  • value (str | None) – The DOI value to validate.

  • info (ValidationInfo) – Additional validation information.

Returns:

The validated DOI or None if not provided.

Return type:

str | None

to_xml(string=False, required=True)
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE