mt_metadata.common.geographic_location ====================================== .. py:module:: mt_metadata.common.geographic_location Classes ------- .. autoapisummary:: mt_metadata.common.geographic_location.GeographicLocation Module Contents --------------- .. py:class:: GeographicLocation(**data) Bases: :py:obj:`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. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: 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 .. py:attribute:: country :type: Annotated[str | list[str] | None, Field(default=None, description='Country of the geographic location, should be spelled out in full. Can be a list of countries.', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': 'United States of America'})] .. py:attribute:: state :type: Annotated[str | list[str] | None, Field(default=None, description='State or province of the geographic location, should be spelled out in full. Can be a list of states or provinces.', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': '[Colorado, Utah]'})] .. py:attribute:: county :type: Annotated[str | list[str] | None, Field(default=None, description='County of the geographic location, should be spelled out in full. Can be a list of counties.', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': '[Douglass, Fayet]'})] .. py:attribute:: township :type: Annotated[str | list[str] | None, Field(default=None, description='Township or city name or code.', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': '090'})] .. py:attribute:: section :type: Annotated[str | list[str] | None, Field(default=None, description='Section name or code.', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': '012'})] .. py:attribute:: quarter :type: Annotated[str | list[str] | None, Field(default=None, description='Quarter section code.', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': '400'})] .. py:attribute:: parcel :type: Annotated[str | list[str] | None, Field(default=None, description='Land parcel ID.', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': '46b29a'})]