Skip to content

containers

camply Data Storage Objects

AvailableCampsite #

Bases: CamplyModel

Campsite Storage

This container should be universal regardless of API Provider

Source code in camply/containers/data_containers.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
class AvailableCampsite(CamplyModel):
    """
    Campsite Storage

    This container should be universal regardless of API Provider
    """

    campsite_id: Union[int, str]
    booking_date: datetime.datetime
    booking_end_date: datetime.datetime
    booking_nights: int
    campsite_site_name: str
    campsite_loop_name: Optional[str]
    campsite_type: Optional[str]
    campsite_occupancy: Tuple[int, int]
    campsite_use_type: Optional[str]
    availability_status: str
    recreation_area: str
    recreation_area_id: Union[int, str]
    facility_name: str
    facility_id: Union[int, str]
    booking_url: str
    location: Optional[CampsiteLocation] = None

    permitted_equipment: Optional[List[RecDotGovEquipment]]
    campsite_attributes: Optional[List[RecDotGovAttribute]]

    __unhashable__ = {"permitted_equipment", "campsite_attributes", "location"}

AvailableResource #

Bases: CamplyModel

A resource that is available for booking

Source code in camply/containers/data_containers.py 
139
140
141
142
143
144
145
class AvailableResource(CamplyModel):
    """
    A resource that is available for booking
    """

    resource_id: int
    map_id: int

CampgroundFacility #

Bases: CamplyModel

Campground Facility Data Storage

Source code in camply/containers/data_containers.py 
114
115
116
117
118
119
120
121
122
123
124
class CampgroundFacility(CamplyModel):
    """
    Campground Facility Data Storage
    """

    facility_name: str
    recreation_area: str
    facility_id: Union[int, str]
    recreation_area_id: Union[int, str]
    map_id: Optional[int]
    coordinates: Optional[Tuple[float, float]]

CamplyModel #

Bases: BaseModel

Hashable Pydantic Model

Source code in camply/containers/base_container.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class CamplyModel(BaseModel):
    """
    Hashable Pydantic Model
    """

    __unhashable__: Set[str] = set()

    def __hash__(self):
        """
        Hash Method for Pydantic BaseModels
        """
        return hash(self.__class__) + hash(
            tuple(
                value
                for key, value in self.__dict__.items()
                if key not in self.__unhashable__
            )
        )

    def __eq__(self, other: Any) -> bool:
        """
        Exclude Unhashable Fields When Evaluating Equality
        """
        if isinstance(other, CamplyModel):
            return self.dict(exclude=self.__unhashable__) == other.dict(
                exclude=other.__unhashable__
            )
        else:
            return self.dict(exclude=self.__unhashable__) == other

    class Config:
        """
        Camply Wide Configuration
        """

        anystr_strip_whitespace = True

Config #

Camply Wide Configuration

Source code in camply/containers/base_container.py 
40
41
42
43
44
45
class Config:
    """
    Camply Wide Configuration
    """

    anystr_strip_whitespace = True

__eq__(other) #

Exclude Unhashable Fields When Evaluating Equality

Source code in camply/containers/base_container.py 
29
30
31
32
33
34
35
36
37
38
def __eq__(self, other: Any) -> bool:
    """
    Exclude Unhashable Fields When Evaluating Equality
    """
    if isinstance(other, CamplyModel):
        return self.dict(exclude=self.__unhashable__) == other.dict(
            exclude=other.__unhashable__
        )
    else:
        return self.dict(exclude=self.__unhashable__) == other

__hash__() #

Hash Method for Pydantic BaseModels

Source code in camply/containers/base_container.py 
17
18
19
20
21
22
23
24
25
26
27
def __hash__(self):
    """
    Hash Method for Pydantic BaseModels
    """
    return hash(self.__class__) + hash(
        tuple(
            value
            for key, value in self.__dict__.items()
            if key not in self.__unhashable__
        )
    )

RecreationArea #

Bases: CamplyModel

Recreation Area Data Storage

Source code in camply/containers/data_containers.py 
127
128
129
130
131
132
133
134
135
136
class RecreationArea(CamplyModel):
    """
    Recreation Area Data Storage
    """

    recreation_area: str
    recreation_area_id: Union[int, str]
    recreation_area_location: str
    coordinates: Optional[Tuple[float, float]]
    description: Optional[str]

SearchWindow #

Bases: CamplyModel

Search Window for Campsite Search

Source code in camply/containers/data_containers.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
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
class SearchWindow(CamplyModel):
    """
    Search Window for Campsite Search
    """

    @validator("start_date")
    @classmethod
    def start_date_must_be_in_future(cls, v):
        """
        Validate that start_date is in the future.

        Coerece start date to today's date when it is not in the future.
        """
        current_date = datetime.datetime.now().date()
        if v < current_date:
            return current_date

        return v

    @validator("end_date")
    @classmethod
    def end_date_must_be_in_future(cls, v):
        """
        Validate that end_date is in the future
        """
        current_date = datetime.datetime.now().date()
        if v < current_date:
            raise ValueError("must be in the future")

        return v

    start_date: datetime.date
    end_date: datetime.date

    def get_date_range(self) -> List[datetime.date]:
        """
        Generate a List of Dates Between two Dates

        Returns
        -------
        List[datetime.date]
        """
        return [
            self.start_date + datetime.timedelta(days=x)
            for x in range((self.end_date - self.start_date).days)
        ]

    def get_current_start_date(self) -> datetime.date:
        """
        Return a start date with the current day in mind
        """
        return max((datetime.datetime.now().date(), self.start_date))

end_date_must_be_in_future(v) classmethod #

Validate that end_date is in the future

Source code in camply/containers/data_containers.py 
40
41
42
43
44
45
46
47
48
49
50
@validator("end_date")
@classmethod
def end_date_must_be_in_future(cls, v):
    """
    Validate that end_date is in the future
    """
    current_date = datetime.datetime.now().date()
    if v < current_date:
        raise ValueError("must be in the future")

    return v

get_current_start_date() #

Return a start date with the current day in mind

Source code in camply/containers/data_containers.py 
68
69
70
71
72
def get_current_start_date(self) -> datetime.date:
    """
    Return a start date with the current day in mind
    """
    return max((datetime.datetime.now().date(), self.start_date))

get_date_range() #

Generate a List of Dates Between two Dates

Returns:

Type Description
List[date]
Source code in camply/containers/data_containers.py 
55
56
57
58
59
60
61
62
63
64
65
66
def get_date_range(self) -> List[datetime.date]:
    """
    Generate a List of Dates Between two Dates

    Returns
    -------
    List[datetime.date]
    """
    return [
        self.start_date + datetime.timedelta(days=x)
        for x in range((self.end_date - self.start_date).days)
    ]

start_date_must_be_in_future(v) classmethod #

Validate that start_date is in the future.

Coerece start date to today's date when it is not in the future.

Source code in camply/containers/data_containers.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
@validator("start_date")
@classmethod
def start_date_must_be_in_future(cls, v):
    """
    Validate that start_date is in the future.

    Coerece start date to today's date when it is not in the future.
    """
    current_date = datetime.datetime.now().date()
    if v < current_date:
        return current_date

    return v