Skip to content

item

pokelance.ext.item ⚓︎

Item(client) ⚓︎

Bases: BaseExtension

Extension for item related endpoints.

Attributes:

Name Type Description
cache Item

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_item(name) async ⚓︎

Fetches an item from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item.

 required

Returns:

Type Description
Item

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

Raises:

Type Description
ResourceNotFound

The name or id of the item is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     item = await client.item.fetch_item("potion")
...     print(item.id)
...     await client.close()
>>> asyncio.run(main())
17
Source code in pokelance/ext/item.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_item(self, name: t.Union[str, int]) -> ItemModel:
    """Fetches an item from the API.

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

    Returns
    -------
    ItemModel
        The item if it exists in the API, else raises ResourceNotFound.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     item = await client.item.fetch_item("potion")
    ...     print(item.id)
    ...     await client.close()
    >>> asyncio.run(main())
    17
    """
    route = Endpoint.get_item(name)
    self._validate_resource(self.cache.item, name, route)
    data = await self._client.request(route)
    return self.cache.item.setdefault(route, ItemModel.from_payload(data))

fetch_item_attribute(name) async ⚓︎

Fetches an item attribute from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item attribute.

 required

Returns:

Type Description
ItemAttribute

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

Raises:

Type Description
ResourceNotFound

The name or id of the item attribute is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     item_attribute = await client.item.fetch_item_attribute("holdable")
...     print(item_attribute.id)
...     await client.close()
>>> asyncio.run(main())
5
Source code in pokelance/ext/item.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_item_attribute(self, name: t.Union[str, int]) -> ItemAttribute:
    """Fetches an item attribute from the API.

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

    Returns
    -------
    ItemAttribute
        The item attribute if it exists in the API, else raises ResourceNotFound.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     item_attribute = await client.item.fetch_item_attribute("holdable")
    ...     print(item_attribute.id)
    ...     await client.close()
    >>> asyncio.run(main())
    5
    """
    route = Endpoint.get_item_attribute(name)
    self._validate_resource(self.cache.item_attribute, name, route)
    data = await self._client.request(route)
    return self.cache.item_attribute.setdefault(route, ItemAttribute.from_payload(data))

fetch_item_category(name) async ⚓︎

Fetches an item category from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item category.

 required

Returns:

Type Description
ItemCategory

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

Raises:

Type Description
ResourceNotFound

The name or id of the item category is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     item_category = await client.item.fetch_item_category(1)
...     print(item_category.name)
...     await client.close()
>>> asyncio.run(main())
stat-boosts
Source code in pokelance/ext/item.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_item_category(self, name: t.Union[str, int]) -> ItemCategory:
    """Fetches an item category from the API.

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

    Returns
    -------
    ItemCategory
        The item category if it exists in the API, else raises ResourceNotFound.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     item_category = await client.item.fetch_item_category(1)
    ...     print(item_category.name)
    ...     await client.close()
    >>> asyncio.run(main())
    stat-boosts
    """
    route = Endpoint.get_item_category(name)
    self._validate_resource(self.cache.item_category, name, route)
    data = await self._client.request(route)
    return self.cache.item_category.setdefault(route, ItemCategory.from_payload(data))

fetch_item_fling_effect(name) async ⚓︎

Fetches an item fling effect from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item fling effect.

 required

Returns:

Type Description
ItemFlingEffect

The item fling effect if it exists in the API, else raises ResourceNotFound.

Raises:

Type Description
ResourceNotFound

The name or id of the item fling effect is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     item_fling_effect = await client.item.fetch_item_fling_effect(1)
...     print(item_fling_effect.name)
...     await client.close()
>>> asyncio.run(main())
badly-poison
Source code in pokelance/ext/item.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_item_fling_effect(self, name: t.Union[str, int]) -> ItemFlingEffect:
    """Fetches an item fling effect from the API.

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

    Returns
    -------
    ItemFlingEffect
        The item fling effect if it exists in the API, else raises ResourceNotFound.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     item_fling_effect = await client.item.fetch_item_fling_effect(1)
    ...     print(item_fling_effect.name)
    ...     await client.close()
    >>> asyncio.run(main())
    badly-poison
    """
    route = Endpoint.get_item_fling_effect(name)
    self._validate_resource(self.cache.item_fling_effect, name, route)
    data = await self._client.request(route)
    return self.cache.item_fling_effect.setdefault(route, ItemFlingEffect.from_payload(data))

fetch_item_pocket(name) async ⚓︎

Fetches an item pocket from the API.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item pocket.

 required

Returns:

Type Description
ItemPocket

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

Raises:

Type Description
ResourceNotFound

The name or id of the item pocket is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     item_pocket = await client.item.fetch_item_pocket(1)
...     print(item_pocket.name)
...     await client.close()
>>> asyncio.run(main())
misc
Source code in pokelance/ext/item.py
Python
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
async def fetch_item_pocket(self, name: t.Union[str, int]) -> ItemPocket:
    """Fetches an item pocket from the API.

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

    Returns
    -------
    ItemPocket
        The item pocket if it exists in the API, else raises ResourceNotFound.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     item_pocket = await client.item.fetch_item_pocket(1)
    ...     print(item_pocket.name)
    ...     await client.close()
    >>> asyncio.run(main())
    misc
    """
    route = Endpoint.get_item_pocket(name)
    self._validate_resource(self.cache.item_pocket, name, route)
    data = await self._client.request(route)
    return self.cache.item_pocket.setdefault(route, ItemPocket.from_payload(data))

get_item(name) ⚓︎

Gets an item from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item.

 required

Returns:

Type Description
Optional[Item]

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

Raises:

Type Description
ResourceNotFound

The name or id of the item is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> item = client.item.get_item("potion")
>>> item.id
17
Source code in pokelance/ext/item.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_item(self, name: t.Union[str, int]) -> t.Optional[ItemModel]:
    """Gets an item from the cache.

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

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

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> item = client.item.get_item("potion")
    >>> item.id
    17
    """
    route = Endpoint.get_item(name)
    self._validate_resource(self.cache.item, name, route)
    return self.cache.item.get(route, None)

get_item_attribute(name) ⚓︎

Gets an item attribute from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item attribute.

 required

Returns:

Type Description
Optional[ItemAttribute]

The item attribute if it exists in the cache, else None.

Raises:

Type Description
ResourceNotFound

The name or id of the item attribute is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> item_attribute = client.item.get_item_attribute("holdable")
>>> item_attribute.id
5
Source code in pokelance/ext/item.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_item_attribute(self, name: t.Union[str, int]) -> t.Optional[ItemAttribute]:
    """Gets an item attribute from the cache.

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

    Returns
    -------
    typing.Optional[pokelance.models.ItemAttribute]
        The item attribute if it exists in the cache, else None.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> item_attribute = client.item.get_item_attribute("holdable")
    >>> item_attribute.id
    5
    """
    route = Endpoint.get_item_attribute(name)
    self._validate_resource(self.cache.item_attribute, name, route)
    return self.cache.item_attribute.get(route, None)

get_item_category(name) ⚓︎

Gets an item category from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item category.

 required

Returns:

Type Description
Optional[ItemCategory]

The item category if it exists in the cache, else None.

Raises:

Type Description
ResourceNotFound

The name or id of the item category is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> item_category = client.item.get_item_category(1)
>>> item_category.name
'stat-boosts'
Source code in pokelance/ext/item.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_item_category(self, name: t.Union[str, int]) -> t.Optional[ItemCategory]:
    """Gets an item category from the cache.

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

    Returns
    -------
    typing.Optional[pokelance.models.ItemCategory]
        The item category if it exists in the cache, else None.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> item_category = client.item.get_item_category(1)
    >>> item_category.name
    'stat-boosts'
    """
    route = Endpoint.get_item_category(name)
    self._validate_resource(self.cache.item_category, name, route)
    return self.cache.item_category.get(route, None)

get_item_fling_effect(name) ⚓︎

Gets an item fling effect from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item fling effect.

 required

Returns:

Type Description
Optional[ItemFlingEffect]

The item fling effect if it exists in the cache, else None.

Raises:

Type Description
ResourceNotFound

The name or id of the item fling effect is invalid.

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> item_fling_effect = client.item.get_item_fling_effect(1)
>>> item_fling_effect.name
'badly-poison'
Source code in pokelance/ext/item.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_item_fling_effect(self, name: t.Union[str, int]) -> t.Optional[ItemFlingEffect]:
    """Gets an item fling effect from the cache.

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

    Returns
    -------
    typing.Optional[pokelance.models.ItemFlingEffect]
        The item fling effect if it exists in the cache, else None.

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

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> item_fling_effect = client.item.get_item_fling_effect(1)
    >>> item_fling_effect.name
    'badly-poison'
    """
    route = Endpoint.get_item_fling_effect(name)
    self._validate_resource(self.cache.item_fling_effect, name, route)
    return self.cache.item_fling_effect.get(route, None)

get_item_pocket(name) ⚓︎

Gets an item pocket from the cache.

Parameters:

Name Type Description Default
name Union[str, int]

The name or id of the item pocket.

 required

Returns:

Type Description
Optional[ItemPocket]

The item pocket 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()
>>> item_pocket = client.item.get_item_pocket(1)
>>> item_pocket.name
'misc'
Source code in pokelance/ext/item.py
Python
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
def get_item_pocket(self, name: t.Union[str, int]) -> t.Optional[ItemPocket]:
    """Gets an item pocket from the cache.

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

    Returns
    -------
    typing.Optional[pokelance.models.ItemPocket]
        The item pocket 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()
    >>> item_pocket = client.item.get_item_pocket(1)
    >>> item_pocket.name
    'misc'
    """
    route = Endpoint.get_item_pocket(name)
    self._validate_resource(self.cache.item_pocket, name, route)
    return self.cache.item_pocket.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."

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 item cog.

Source code in pokelance/ext/item.py
Python
368
369
370
def setup(lance: "PokeLance") -> None:
    """Sets up the item cog."""
    lance.add_extension("item", Item(lance.http))