Skip to content

location

pokelance.ext.location ⚓︎

Location(client) ⚓︎

Bases: BaseExtension

Extension for location related endpoints.

Attributes:

Name Type Description
cache Location

The cache for this extension.

Initializes the extension.

Parameters:

Name Type Description Default
client HttpClient

The client to use for requests.

 required
Source code in pokelance/ext/_base.py
Python
36
37
38
39
40
41
42
43
44
45
46
def __init__(self, client: "HttpClient") -> None:
    """Initializes the extension.

    Parameters
    ----------
    client: pokelance.http.HttpClient
        The client to use for requests.
    """
    self._client = client
    self._cache = self._client.cache
    self.cache = getattr(self._cache, self.__class__.__name__.lower())

fetch_location(name) async ⚓︎

Fetches a location from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the location.

 required

Returns:

Type Description
Location

The location if it exists in the API, else raises ResourceNotFound.

Raises:

Type Description
ResourceNotFound

The name or id of the location is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     location = await client.location.fetch_location(1)
...     print(location.name)
...     await client.close()
>>> asyncio.run(main())
canalave-city
Source code in pokelance/ext/location.py
Python
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
async def fetch_location(self, name: t.Union[str, int]) -> LocationModel:
    """Fetches a location from the API.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the location.

    Returns
    -------
    LocationModel
        The location if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the location is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     location = await client.location.fetch_location(1)
    ...     print(location.name)
    ...     await client.close()
    >>> asyncio.run(main())
    canalave-city
    """
    route = Endpoint.get_location(name)
    self._validate_resource(self.cache.location, name, route)
    data = await self._client.request(route)
    return self.cache.location.setdefault(route, LocationModel.from_payload(data))

fetch_location_area(name) async ⚓︎

Fetches a location area from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the location area.

 required

Returns:

Type Description
LocationArea

The location area if it exists in the API, else raises ResourceNotFound.

Raises:

Type Description
ResourceNotFound

The name or id of the location area is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     location_area = await client.location.fetch_location_area(1)
...     print(location_area.name)
...     await client.close()
>>> asyncio.run(main())
canalave-city-area
Source code in pokelance/ext/location.py
Python
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
async def fetch_location_area(self, name: t.Union[str, int]) -> LocationArea:
    """Fetches a location area from the API.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the location area.

    Returns
    -------
    LocationArea
        The location area if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the location area is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     location_area = await client.location.fetch_location_area(1)
    ...     print(location_area.name)
    ...     await client.close()
    >>> asyncio.run(main())
    canalave-city-area
    """
    route = Endpoint.get_location_area(name)
    self._validate_resource(self.cache.location_area, name, route)
    data = await self._client.request(route)
    return self.cache.location_area.setdefault(route, LocationArea.from_payload(data))

fetch_pal_park_area(name) async ⚓︎

Fetches a pal park area from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the pal park area.

 required

Returns:

Type Description
PalParkArea

The pal park area if it exists in the API, else raises ResourceNotFound.

Raises:

Type Description
ResourceNotFound

The name or id of the pal park area is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     pal_park_area = await client.location.fetch_pal_park_area(1)
...     print(pal_park_area.name)
...     await client.close()
>>> asyncio.run(main())
forest
Source code in pokelance/ext/location.py
Python
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
async def fetch_pal_park_area(self, name: t.Union[str, int]) -> PalParkArea:
    """Fetches a pal park area from the API.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the pal park area.

    Returns
    -------
    PalParkArea
        The pal park area if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the pal park area is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     pal_park_area = await client.location.fetch_pal_park_area(1)
    ...     print(pal_park_area.name)
    ...     await client.close()
    >>> asyncio.run(main())
    forest
    """
    route = Endpoint.get_pal_park_area(name)
    self._validate_resource(self.cache.pal_park_area, name, route)
    data = await self._client.request(route)
    return self.cache.pal_park_area.setdefault(route, PalParkArea.from_payload(data))

fetch_region(name) async ⚓︎

Fetches a region from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the region.

 required

Returns:

Type Description
Region

The region if it exists in the API, else raises ResourceNotFound.

Raises:

Type Description
ResourceNotFound

The name or id of the region is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     region = await client.location.fetch_region(1)
...     print(region.name)
...     await client.close()
>>> asyncio.run(main())
kanto
Source code in pokelance/ext/location.py
Python
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
async def fetch_region(self, name: t.Union[str, int]) -> Region:
    """Fetches a region from the API.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the region.

    Returns
    -------
    Region
        The region if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the region is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     region = await client.location.fetch_region(1)
    ...     print(region.name)
    ...     await client.close()
    >>> asyncio.run(main())
    kanto
    """
    route = Endpoint.get_region(name)
    self._validate_resource(self.cache.region, name, route)
    data = await self._client.request(route)
    return self.cache.region.setdefault(route, Region.from_payload(data))

get_location(name) ⚓︎

Gets a location from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the location.

 required

Returns:

Type Description
Optional[Location]

The location if it exists in the cache, else None.

Raises:

Type Description
ResourceNotFound

The name or id of the item pocket is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> location = client.location.get_location(1)
>>> location.name
'canalave-city'
Source code in pokelance/ext/location.py
Python
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
def get_location(self, name: t.Union[str, int]) -> t.Optional[LocationModel]:
    """Gets a location from the cache.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the location.

    Returns
    -------
    typing.Optional[pokelance.models.Location]
        The location if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the item pocket is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> location = client.location.get_location(1)
    >>> location.name
    'canalave-city'
    """
    route = Endpoint.get_location(name)
    self._validate_resource(self.cache.location, name, route)
    return self.cache.location.get(route, None)

get_location_area(name) ⚓︎

Gets a location area from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the location area.

 required

Returns:

Type Description
Optional[LocationArea]

The location area if it exists in the cache, else None.

Raises:

Type Description
ResourceNotFound

The name or id of the location area is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> location_area = client.location.get_location_area(1)
>>> location_area.name
'canalave-city-area'
Source code in pokelance/ext/location.py
Python
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_location_area(self, name: t.Union[str, int]) -> t.Optional[LocationArea]:
    """Gets a location area from the cache.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the location area.

    Returns
    -------
    typing.Optional[pokelance.models.LocationArea]
        The location area if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the location area is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> location_area = client.location.get_location_area(1)
    >>> location_area.name
    'canalave-city-area'
    """
    route = Endpoint.get_location_area(name)
    self._validate_resource(self.cache.location_area, name, route)
    return self.cache.location_area.get(route, None)

get_message(case, data) staticmethod ⚓︎

Gets the error message for a resource not found error.

Parameters:

Name Type Description Default
case str

The case to use for the error message.

 required
data Set[str]

The data to use for the error message.

 required

Returns:

Type Description
str

The error message.
Source code in pokelance/ext/_base.py
Python
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@staticmethod
def get_message(case: str, data: t.Set[str]) -> str:
    """Gets the error message for a resource not found error.

    Parameters
    ----------
    case: str
        The case to use for the error message.
    data: typing.Set[str]
        The data to use for the error message.

    Returns
    -------
    str
        The error message.
    """
    matches = get_close_matches(case, data, n=10, cutoff=0.5)
    if matches:
        return f"Resource not found. Did you mean {', '.join(matches)}?"
    return "Resource not found."

get_pal_park_area(name) ⚓︎

Gets a pal park area from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the pal park area.

 required

Returns:

Type Description
Optional[PalParkArea]

The pal park area if it exists in the cache, else None.

Raises:

Type Description
ResourceNotFound

The name or id of the pal park area is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pal_park_area = client.location.get_pal_park_area(1)
>>> pal_park_area.name
'forest'
Source code in pokelance/ext/location.py
Python
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
def get_pal_park_area(self, name: t.Union[str, int]) -> t.Optional[PalParkArea]:
    """Gets a pal park area from the cache.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the pal park area.

    Returns
    -------
    typing.Optional[pokelance.models.PalParkArea]
        The pal park area if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the pal park area is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pal_park_area = client.location.get_pal_park_area(1)
    >>> pal_park_area.name
    'forest'
    """
    route = Endpoint.get_pal_park_area(name)
    self._validate_resource(self.cache.pal_park_area, name, route)
    return self.cache.pal_park_area.get(route, None)

get_region(name) ⚓︎

Gets a region from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the region.

 required

Returns:

Type Description
Optional[Region]

The region if it exists in the cache, else None.

Raises:

Type Description
ResourceNotFound

The name or id of the region is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> region = client.location.get_region(1)
>>> region.name
'kanto'
Source code in pokelance/ext/location.py
Python
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
def get_region(self, name: t.Union[str, int]) -> t.Optional[Region]:
    """Gets a region from the cache.

    Parameters
    ----------
    name: typing.Union[str, int]
        The name or id of the region.

    Returns
    -------
    typing.Optional[pokelance.models.Region]
        The region if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        The name or id of the region is invalid.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> region = client.location.get_region(1)
    >>> region.name
    'kanto'
    """
    route = Endpoint.get_region(name)
    self._validate_resource(self.cache.region, name, route)
    return self.cache.region.get(route, None)

setup() async ⚓︎

Sets up the extension.

Source code in pokelance/ext/_base.py
Python
90
91
92
93
94
95
96
97
async def setup(self) -> None:
    """Sets up the extension."""
    for item in dir(self):
        if item.startswith("fetch_"):
            data = await self._client.request(
                t.cast(t.Callable[[], "Route"], getattr(Endpoint, f"get_{item[6:]}_endpoints"))()
            )
            self._cache.load_documents(str(self.__class__.__name__), item[6:], data["results"])

setup(lance) ⚓︎

Sets up the location cog.

Source code in pokelance/ext/location.py
Python
301
302
303
def setup(lance: "PokeLance") -> None:
    """Sets up the location cog."""
    lance.add_extension("location", Location(lance.http))