Skip to content

search_model

Pydantic model for YAML files

StrEnum #

Bases: str, Enum

String Enum

Source code in camply/containers/search_model.py 
22
23
24
25
class StrEnum(str, Enum):
    """
    String Enum
    """

YamlSearchFile #

Bases: CamplyModel

Campsite Search Data Model

Source code in camply/containers/search_model.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class YamlSearchFile(CamplyModel):
    """
    Campsite Search Data Model
    """

    provider: ProviderEnum = Field(
        description="Campsite provider", default="RecreationDotGov"
    )
    recreation_area: ArrayOrSingle = None
    campgrounds: ArrayOrSingle = None
    campsites: ArrayOrSingle = None
    start_date: Union[datetime.date, List[datetime.date]]
    end_date: Union[datetime.date, List[datetime.date]]
    days: Optional[List[str]] = None
    weekends: bool = False
    nights: int = 1
    continuous: bool = True
    polling_interval: int = SearchConfig.RECOMMENDED_POLLING_INTERVAL
    notifications: ArrayOrSingleStr = "silent"
    search_forever: bool = False
    search_once: bool = False
    notify_first_try: bool = False
    equipment: ArrayOrSingleEquipment = None
    offline_search: bool = False
    offline_search_path: Optional[str] = None

    @validator("provider", pre=True)
    def validate_provider(cls, value):
        """
        Validate provider
        """
        lowercase_enum_dict = {
            key.lower(): key for key in ProviderEnum.__members__.keys()
        }
        if value.lower() in lowercase_enum_dict.keys():
            return lowercase_enum_dict[value.lower()]
        else:
            return value

    @validator("equipment", pre=True)
    def validate_equipment(cls, value) -> ArrayOrSingleEquipment:
        """
        Validate equipment
        """
        equipment_tuple_length = 2
        if (
            isinstance(value, list)
            and len(value) == equipment_tuple_length
            and isinstance(value[0], str)
        ):
            return [tuple(value)]
        else:
            return value

validate_equipment(value) #

Validate equipment

Source code in camply/containers/search_model.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
@validator("equipment", pre=True)
def validate_equipment(cls, value) -> ArrayOrSingleEquipment:
    """
    Validate equipment
    """
    equipment_tuple_length = 2
    if (
        isinstance(value, list)
        and len(value) == equipment_tuple_length
        and isinstance(value[0], str)
    ):
        return [tuple(value)]
    else:
        return value

validate_provider(value) #

Validate provider

Source code in camply/containers/search_model.py 
60
61
62
63
64
65
66
67
68
69
70
71
@validator("provider", pre=True)
def validate_provider(cls, value):
    """
    Validate provider
    """
    lowercase_enum_dict = {
        key.lower(): key for key in ProviderEnum.__members__.keys()
    }
    if value.lower() in lowercase_enum_dict.keys():
        return lowercase_enum_dict[value.lower()]
    else:
        return value