schema

Classes:

• OSMTags –

  Open street map tags.

• OSMTagsOptional –

  Open street map tags, all optional.

• OsmHutSchema –

  Open street map schema.

• OsmProperties –
• OsmHutSource –
• OsmHut0Convert –

Attributes:

• logger –

Attributes

logger module-attribute

logger = getLogger(__name__)

Classes

OSMTags

Open street map tags.

Attributes:

• tourism (Literal['alpine_hut', 'wilderness_hut']) –
• wikidata (str | None) –
• name (str) –
• operator (str | None) –
• email (str | None) –
• contact_email (str | None) –
• phone (str | None) –
• contact_phone (str | None) –
• website (str | None) –
• contact_website (str | None) –
• note (str | None) –
• bed (str | None) –
• beds (str | None) –
• capacity (str | None) –
• access (str | None) –
• fireplace (str | None) –
• wall (str | None) –
• amenity (str | None) –
• shelter_type (str | None) –
• winter_room (str | None) –
• reservation (str | None) –
• ele (Elevation | None) –

Attributes

tourism instance-attribute

tourism: Literal['alpine_hut', 'wilderness_hut']

wikidata class-attribute instance-attribute

wikidata: str | None = None

name instance-attribute

name: str

operator class-attribute instance-attribute

operator: str | None = None

email class-attribute instance-attribute

email: str | None = None

contact_email class-attribute instance-attribute

contact_email: str | None = Field(
    None, alias="contact:field"
)

phone class-attribute instance-attribute

phone: str | None = None

contact_phone class-attribute instance-attribute

contact_phone: str | None = Field(
    None, alias="contact:phone"
)

website class-attribute instance-attribute

website: str | None = None

contact_website class-attribute instance-attribute

contact_website: str | None = Field(
    None, alias="contact:website"
)

note class-attribute instance-attribute

note: str | None = None

bed class-attribute instance-attribute

bed: str | None = None

beds class-attribute instance-attribute

beds: str | None = None

capacity class-attribute instance-attribute

capacity: str | None = None

access class-attribute instance-attribute

access: str | None = None

fireplace class-attribute instance-attribute

fireplace: str | None = None

wall class-attribute instance-attribute

wall: str | None = None

amenity class-attribute instance-attribute

amenity: str | None = None

shelter_type class-attribute instance-attribute

shelter_type: str | None = None

winter_room class-attribute instance-attribute

winter_room: str | None = None

reservation class-attribute instance-attribute

reservation: str | None = None

ele class-attribute instance-attribute

ele: Elevation | None = None

OSMTagsOptional

Open street map tags, all optional.

Attributes:

• wikidata (str | None) –
• operator (str | None) –
• email (str | None) –
• contact_email (str | None) –
• phone (str | None) –
• contact_phone (str | None) –
• website (str | None) –
• contact_website (str | None) –
• note (str | None) –
• bed (str | None) –
• beds (str | None) –
• capacity (str | None) –
• access (str | None) –
• fireplace (str | None) –
• wall (str | None) –
• amenity (str | None) –
• shelter_type (str | None) –
• winter_room (str | None) –
• reservation (str | None) –
• tourism (str | None) –
• name (str | None) –
• ele (float | str | None) –

Attributes

wikidata class-attribute instance-attribute

wikidata: str | None = None

operator class-attribute instance-attribute

operator: str | None = None

email class-attribute instance-attribute

email: str | None = None

contact_email class-attribute instance-attribute

contact_email: str | None = Field(
    None, alias="contact:field"
)

phone class-attribute instance-attribute

phone: str | None = None

contact_phone class-attribute instance-attribute

contact_phone: str | None = Field(
    None, alias="contact:phone"
)

website class-attribute instance-attribute

website: str | None = None

contact_website class-attribute instance-attribute

contact_website: str | None = Field(
    None, alias="contact:website"
)

note class-attribute instance-attribute

note: str | None = None

bed class-attribute instance-attribute

bed: str | None = None

beds class-attribute instance-attribute

beds: str | None = None

capacity class-attribute instance-attribute

capacity: str | None = None

access class-attribute instance-attribute

access: str | None = None

fireplace class-attribute instance-attribute

fireplace: str | None = None

wall class-attribute instance-attribute

wall: str | None = None

amenity class-attribute instance-attribute

amenity: str | None = None

shelter_type class-attribute instance-attribute

shelter_type: str | None = None

winter_room class-attribute instance-attribute

winter_room: str | None = None

reservation class-attribute instance-attribute

reservation: str | None = None

tourism class-attribute instance-attribute

tourism: str | None = None

name class-attribute instance-attribute

name: str | None = None

ele class-attribute instance-attribute

ele: float | str | None = None

OsmHutSchema

Open street map schema.

Methods:

• get_id –

  Get open street map id.

• get_name –

  Get open street map hut name.

• get_location –

  Get open street map location.

Attributes:

• model_config –
• osm_type (Literal['node', 'way', 'area'] | None) –
• osm_id (int) –
• lat (Latitude | None) –
• lon (Longitude | None) –
• center_lat (Latitude | None) –
• center_lon (Longitude | None) –
• tags (OSMTags) –

Attributes

model_config class-attribute instance-attribute

model_config = ConfigDict(
    from_attributes=True, extra="allow"
)

osm_type class-attribute instance-attribute

osm_type: Literal['node', 'way', 'area'] | None = None

osm_id class-attribute instance-attribute

osm_id: int = Field(..., alias='id')

lat class-attribute instance-attribute

lat: Latitude | None = None

lon class-attribute instance-attribute

lon: Longitude | None = None

center_lat class-attribute instance-attribute

center_lat: Latitude | None = None

center_lon class-attribute instance-attribute

center_lon: Longitude | None = None

tags instance-attribute

tags: OSMTags

Functions

get_id

get_id() -> str

Get open street map id.

get_name

get_name() -> str

Get open street map hut name.

get_location

get_location() -> LocationEleSchema

Get open street map location.

OsmProperties

Attributes:

• osm_type (Literal['node', 'way', 'area']) –

Attributes

osm_type class-attribute instance-attribute

osm_type: Literal["node", "way", "area"] = Field(
    ..., description="osm object type: node, way, or area"
)

OsmHutSource

Methods:

• __str__ –
• show –

  Returns a formatted string with the hut information which can be printed.

Attributes:

• model_config –
• name (str) –
• location (LocationEleSchema | None) –
• source_id (str) –
• source_data (TSourceData_co | None) –
• source_properties (TProperties_co | None) –
• created (datetime) –
• source_properties_schema (dict) –

  Returns JSON schema for the 'source_properties' fields.

• version (int) –
• source_name (str) –

Attributes

model_config class-attribute instance-attribute

model_config = ConfigDict(coerce_numbers_to_str=True)

name class-attribute instance-attribute

name: str = Field(..., description='Original hut name.')

location class-attribute instance-attribute

location: LocationEleSchema | None = Field(
    None, description="Location of the hut."
)

source_id class-attribute instance-attribute

source_id: str = Field(
    ..., description="Originial source id of the hut."
)

source_data class-attribute instance-attribute

source_data: TSourceData_co | None = Field(
    None, description="Source data for this hut."
)

source_properties class-attribute instance-attribute

source_properties: TProperties_co | None = Field(
    None, description="Additinal source data properties."
)

created class-attribute instance-attribute

created: datetime = Field(
    default_factory=now,
    description="Version of the service when this entry was created.",
)

source_properties_schema property

source_properties_schema: dict

Returns JSON schema for the 'source_properties' fields.

Returns:

• dict –

  JSON schema.

version class-attribute instance-attribute

version: int = 0

source_name class-attribute instance-attribute

source_name: str = 'osm'

Functions

__str__

__str__() -> str

show

show(
    source_id: bool = True,
    location: bool = True,
    elevation: bool = True,
    source_name: bool = True,
    version: bool = False,
    created: bool = False,
) -> str

Returns a formatted string with the hut information which can be printed.

Parameters:

• source_id

  (bool, default: True ) –

  Show source ID.

• location

  (bool, default: True ) –

  Show location.

• elevation

  (bool, default: True ) –

  Show elevation.

• source_name

  (bool, default: True ) –

  Show source name.

• version

  (bool, default: False ) –

  Show verions.

• created

  (bool, default: False ) –

  Show created date.

Returns:

• str –

  Formatted string.

OsmHut0Convert

Classes:

• FieldNotImplementedError –

  Field is not implemented.

Methods:

• get_hut –

  Convert to hut.

Attributes:

• source_data (TSourceData) –
• slug (str) –
• source (SourceSchema | None) –
• author (AuthorSchema | None) –
• location (LocationEleSchema) –
• notes (list[TranslationSchema]) –
• country_code (str | None) –
• open_monthly (OpenMonthlySchema) –
• include_photos (bool) –
• name (TranslationSchema) –
• source_name (str) –
• description (TranslationSchema) –
• owner (OwnerSchema | None) –
• url (str) –
• contacts (list[ContactSchema]) –
• comment (str) –
• capacity (CapacitySchema) –
• hut_type (HutTypeSchema) –
• wikidata_entity (None) –
• photos (list[PhotoSchema]) –

  Not supported for osm data, use wikidata isntead which are based on the osm data.

• is_active (bool) –
• is_public (bool) –
• extras (dict[str, Any]) –

Attributes

source_data class-attribute instance-attribute

source_data: TSourceData = Field(..., exclude=True)

slug property

slug: str

source property

source: SourceSchema | None

author property

author: AuthorSchema | None

location property

location: LocationEleSchema

notes property

notes: list[TranslationSchema]

country_code property

country_code: str | None

open_monthly property

open_monthly: OpenMonthlySchema

include_photos class-attribute instance-attribute

include_photos: bool = False

name property

name: TranslationSchema

source_name property

source_name: str

description property

description: TranslationSchema

owner property

owner: OwnerSchema | None

url property

url: str

contacts property

contacts: list[ContactSchema]

comment property

comment: str

capacity property

capacity: CapacitySchema

hut_type property

hut_type: HutTypeSchema

wikidata_entity property

wikidata_entity: None

photos property

photos: list[PhotoSchema]

Not supported for osm data, use wikidata isntead which are based on the osm data.

is_active property

is_active: bool

is_public property

is_public: bool

extras property

extras: dict[str, Any]

Classes

FieldNotImplementedError

FieldNotImplementedError(
    obj: BaseHutConverterSchema, field: str
)

Field is not implemented.

Parameters:

• obj

  (BaseHutConverterSchema) –

  Current object.

• field

  (str) –

  Field which is not implementd.

Functions

Functions

get_hut

get_hut() -> HutSchema

Convert to hut.

Returns:

• HutSchema –

  Converted hut.

Functions