Skip to content

schema

Camptocamp.org schema for hut data.

Classes:

Attributes:

Attributes

logger module-attribute 

logger = getLogger(__name__)

Classes

CamptocampLocale

Camptocamp locale data.

Attributes:

Attributes

version class-attribute instance-attribute 
version: int | None = None
lang instance-attribute 
lang: str
title instance-attribute 
title: str
summary class-attribute instance-attribute 
summary: str | None = None
description class-attribute instance-attribute 
description: str | None = None
access class-attribute instance-attribute 
access: str | None = None
access_period class-attribute instance-attribute 
access_period: str | None = None

CamptocampGeometry

Camptocamp geometry data.

Attributes:

Attributes

version instance-attribute 
version: int
geom instance-attribute 
geom: str

CamptocampArea

Camptocamp area data.

Attributes:

Attributes

document_id instance-attribute 
document_id: int
version instance-attribute 
version: int
locales instance-attribute 
locales: list[CamptocampLocale]
area_type instance-attribute 
area_type: str
available_langs class-attribute instance-attribute 
available_langs: list[str] | None = None
protected class-attribute instance-attribute 
protected: bool = False
type class-attribute instance-attribute 
type: str = 'a'

CamptocampDocument

Camptocamp document/hut data model.

Methods:

  • get_id –

    Get the document ID as string.

  • get_name –

    Get the name from the first locale.

  • get_location –

    Extract location from geometry.

  • get_locale –

    Get locale for specific language.

  • get_image_ids –

    Get image document ids from the associated images.

Attributes:

Attributes

model_config class-attribute instance-attribute 
model_config = ConfigDict(
    from_attributes=True,
    extra="allow",
    populate_by_name=True,
)
document_id instance-attribute 
document_id: int
version instance-attribute 
version: int
locales instance-attribute 
locales: list[CamptocampLocale]
geometry instance-attribute 
geometry: CamptocampGeometry
quality class-attribute instance-attribute 
quality: str | None = None
waypoint_type class-attribute instance-attribute 
waypoint_type: str | None = None
elevation class-attribute instance-attribute 
elevation: int | None = None
available_langs class-attribute instance-attribute 
available_langs: list[str] | None = None
areas class-attribute instance-attribute 
areas: list[CamptocampArea] = Field(default_factory=list)
protected class-attribute instance-attribute 
protected: bool = False
type class-attribute instance-attribute 
type: str | None = 'w'
capacity class-attribute instance-attribute 
capacity: int | None = None
capacity_staffed class-attribute instance-attribute 
capacity_staffed: int | None = None
phone class-attribute instance-attribute 
phone: str | None = None
phone_custodian class-attribute instance-attribute 
phone_custodian: str | None = None
url class-attribute instance-attribute 
url: str | None = None
custodian class-attribute instance-attribute 
custodian: str | None = None
custodianship class-attribute instance-attribute 
custodianship: str | None = None
matress_unstaffed class-attribute instance-attribute 
matress_unstaffed: bool | None = None
blanket_unstaffed class-attribute instance-attribute 
blanket_unstaffed: bool | None = None
gas_unstaffed class-attribute instance-attribute 
gas_unstaffed: bool | None = None
heating_unstaffed class-attribute instance-attribute 
heating_unstaffed: bool | None = None
associations class-attribute instance-attribute 
associations: dict[str, Any] | None = None

Functions

get_id 
get_id() -> str

Get the document ID as string.

get_name 
get_name() -> str

Get the name from the first locale.

get_location 
get_location() -> LocationEleSchema

Extract location from geometry.

get_locale 
get_locale(lang: str) -> CamptocampLocale | None

Get locale for specific language.

get_image_ids 
get_image_ids() -> list[int]

Get image document ids from the associated images.

CamptocampProperties

Properties saved together with the source data.

Attributes:

Attributes

quality class-attribute instance-attribute 
quality: str = Field(
    ..., description="Quality indicator from camptocamp"
)
waypoint_type class-attribute instance-attribute 
waypoint_type: str = Field(
    default="hut",
    description="Waypoint type from camptocamp",
)

CamptocampHutSource

Data from camptocamp.org database.

Methods:

  • __str__ –
  • show –

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

Attributes:

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."
)
version class-attribute instance-attribute 
version: int = Field(
    default=0,
    description="Version of the service when this entry was created.",
)
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.

source_name class-attribute instance-attribute 
source_name: str = 'camptocamp'

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.

CamptocampApiResponse

Response from camptocamp API.

Attributes:

Attributes

documents instance-attribute 
documents: list[CamptocampDocument]
total class-attribute instance-attribute 
total: int | None = None

CamptocampHut0Convert

Convert Camptocamp data to HutSchema.

Classes:

Methods:

Attributes:

Attributes

source_data class-attribute instance-attribute 
source_data: TSourceData = Field(..., exclude=True)
include_photos class-attribute instance-attribute 
include_photos: bool = True
slug property 
slug: str
location property 
location: LocationEleSchema
country_code property 
country_code: str | None
comment property 
comment: str
is_active property 
is_active: bool
is_bookable property 
is_bookable: bool

Whether availability can be fetched for this hut through the source service's online booking system.

Booking services override this (e.g. only huts with a booking structure); huts of sources without online booking are never bookable.

extras property 
extras: dict[str, Any]
name property 
name: TranslationSchema

Get name with translations.

source_name property 
source_name: str
description property 
description: TranslationSchema

Get description with translations.

author property 
author: AuthorSchema | None

Get author information.

source property 
source: SourceSchema | None

Get source information.

license property 
license: LicenseSchema | None

Get license information.

notes property 
notes: list[TranslationSchema]

Get notes including access and period information.

owner property 
owner: OwnerSchema | None

Get owner information.

photos property 
photos: list[PhotoSchema]

Get photos associated with this hut from camptocamp.org.

url property 
url: str

Hut website if available (the camptocamp page link is in source).

capacity property 
capacity: CapacitySchema

Get capacity information.

Camptocamp's capacity is the unstaffed (winter room) number and capacity_staffed the staffed one: only huts with a staffed capacity have a second, smaller number for the closed season.

hut_type property 
hut_type: HutTypeSchema

Guess hut type based on waypoint_type and other info.

open_monthly property 
open_monthly: OpenMonthlySchema

Opening months parsed from the (free text) access period.

is_public property 
is_public: bool

Determine if hut is public.

contacts property 
contacts: list[ContactSchema]

Get contact information.

Classes

FieldNotImplementedError 
FieldNotImplementedError(
    obj: BaseHutConverterSchema, field: str
)

Field is not implemented.

Parameters:

Functions

Functions

get_hut 
get_hut() -> HutSchema

Convert to hut.

Returns:

Functions