pokelance.ext.move ⚓︎

Move(client) ⚓︎

Bases: BaseExtension

Extension for move related endpoints.

Attributes:
  • cache (Move) –

    The cache for this extension.

Initializes the extension.

Parameters:
  • client (HttpClient) –

    The client to use for requests.
Returns:
Source code in pokelance/ext/_base.py
Python
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def __init__(self, client: "HttpClient") -> None:
    """Initializes the extension.

    Parameters
    ----------
    client: pokelance.http.HttpClient
        The client to use for requests.

    Returns
    -------
    pokelance.ext.BaseExtension
        The extension.
    """
    self._client = client
    self._cache = self._client.cache
    self.cache = getattr(self._cache, self.__class__.__name__.lower())

fetch_move(name) async ⚓︎

Fetches a move from the API.

Parameters:
Returns:
  • Move –

    The move if it exists in the API, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     move = await client.move.fetch_move(1)
...     print(move.name)
...     await client.close()
>>> asyncio.run(main())
pound
Source code in pokelance/ext/move.py
Python
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
87
88
89
90
91
92
93
94
95
96
async def fetch_move(self, name: t.Union[str, int]) -> MoveModel:
    """Fetches a move from the API.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move.

    Returns
    -------
    MoveModel
        The move if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move does not exist in the API.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     move = await client.move.fetch_move(1)
    ...     print(move.name)
    ...     await client.close()
    >>> asyncio.run(main())
    pound
    """
    route = Endpoint.get_move(name)
    self._validate_resource(self.cache.move, name, route)
    data = await self._client.request(route)
    return self.cache.move.setdefault(route, MoveModel.from_payload(data))

fetch_move_ailment(name) async ⚓︎

Fetches a move ailment from the API.

Parameters:
  • name (Union[str, int]) –

    The id of the move ailment.
Returns:
  • MoveAilment –

    The move ailment if it exists in the API, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     ailment = await client.move.fetch_move_ailment(1)
...     print(ailment.name)
...     await client.close()
>>> asyncio.run(main())
paralysis
Source code in pokelance/ext/move.py
Python
129
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
async def fetch_move_ailment(self, name: t.Union[str, int]) -> MoveAilment:
    """Fetches a move ailment from the API.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move ailment.

    Returns
    -------
    MoveAilment
        The move ailment if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move ailment does not exist in the API.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     ailment = await client.move.fetch_move_ailment(1)
    ...     print(ailment.name)
    ...     await client.close()
    >>> asyncio.run(main())
    paralysis
    """
    route = Endpoint.get_move_ailment(name)
    self._validate_resource(self.cache.move_ailment, name, route)
    data = await self._client.request(route)
    return self.cache.move_ailment.setdefault(route, MoveAilment.from_payload(data))

fetch_move_battle_style(name) async ⚓︎

Fetches a move battle style from the API.

Parameters:
  • name (Union[str, int]) –

    The id of the move battle style.
Returns:
  • MoveBattleStyle –

    The move battle style if it exists in the API, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     style = await client.move.fetch_move_battle_style(1)
...     print(style.name)
...     await client.close()
>>> asyncio.run(main())
attack
Source code in pokelance/ext/move.py
Python
196
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
async def fetch_move_battle_style(self, name: t.Union[str, int]) -> MoveBattleStyle:
    """Fetches a move battle style from the API.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move battle style.

    Returns
    -------
    MoveBattleStyle
        The move battle style if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move battle style does not exist in the API.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     style = await client.move.fetch_move_battle_style(1)
    ...     print(style.name)
    ...     await client.close()
    >>> asyncio.run(main())
    attack
    """
    route = Endpoint.get_move_battle_style(name)
    self._validate_resource(self.cache.move_battle_style, name, route)
    data = await self._client.request(route)
    return self.cache.move_battle_style.setdefault(route, MoveBattleStyle.from_payload(data))

fetch_move_category(name) async ⚓︎

Fetches a move category from the API.

Parameters:
  • name (Union[str, int]) –

    The id of the move category.
Returns:
  • MoveCategory –

    The move category if it exists in the API, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     category = await client.move.fetch_move_category(1)
...     print(category.name)
...     await client.close()
>>> asyncio.run(main())
ailment
Source code in pokelance/ext/move.py
Python
263
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
async def fetch_move_category(self, name: t.Union[str, int]) -> MoveCategory:
    """Fetches a move category from the API.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move category.

    Returns
    -------
    MoveCategory
        The move category if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move category does not exist in the API.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     category = await client.move.fetch_move_category(1)
    ...     print(category.name)
    ...     await client.close()
    >>> asyncio.run(main())
    ailment
    """
    route = Endpoint.get_move_category(name)
    self._validate_resource(self.cache.move_category, name, route)
    data = await self._client.request(route)
    return self.cache.move_category.setdefault(route, MoveCategory.from_payload(data))

fetch_move_damage_class(name) async ⚓︎

Fetches a move damage class from the API.

Parameters:
  • name (Union[str, int]) –

    The id of the move damage class.
Returns:
  • MoveDamageClass –

    The move damage class if it exists in the API, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     damage_class = await client.move.fetch_move_damage_class(1)
...     print(damage_class.name)
...     await client.close()
>>> asyncio.run(main())
status
Source code in pokelance/ext/move.py
Python
330
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
async def fetch_move_damage_class(self, name: t.Union[str, int]) -> MoveDamageClass:
    """Fetches a move damage class from the API.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move damage class.

    Returns
    -------
    MoveDamageClass
        The move damage class if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move damage class does not exist in the API.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     damage_class = await client.move.fetch_move_damage_class(1)
    ...     print(damage_class.name)
    ...     await client.close()
    >>> asyncio.run(main())
    status
    """
    route = Endpoint.get_move_damage_class(name)
    self._validate_resource(self.cache.move_damage_class, name, route)
    data = await self._client.request(route)
    return self.cache.move_damage_class.setdefault(route, MoveDamageClass.from_payload(data))

fetch_move_learn_method(name) async ⚓︎

Fetches a move learn method from the API.

Parameters:
  • name (Union[str, int]) –

    The id of the move learn method.
Returns:
  • MoveLearnMethod –

    The move learn method if it exists in the API, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     learn_method = await client.move.fetch_move_learn_method(1)
...     print(learn_method.name)
...     await client.close()
>>> asyncio.run(main())
level-up
Source code in pokelance/ext/move.py
Python
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
async def fetch_move_learn_method(self, name: t.Union[str, int]) -> MoveLearnMethod:
    """Fetches a move learn method from the API.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move learn method.

    Returns
    -------
    MoveLearnMethod
        The move learn method if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move learn method does not exist in the API.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     learn_method = await client.move.fetch_move_learn_method(1)
    ...     print(learn_method.name)
    ...     await client.close()
    >>> asyncio.run(main())
    level-up
    """
    route = Endpoint.get_move_learn_method(name)
    self._validate_resource(self.cache.move_learn_method, name, route)
    data = await self._client.request(route)
    return self.cache.move_learn_method.setdefault(route, MoveLearnMethod.from_payload(data))

fetch_move_target(name) async ⚓︎

Fetches a move target from the API.

Parameters:
  • name (Union[str, int]) –

    The id of the move target.
Returns:
  • MoveTarget –

    The move target if it exists in the API, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     target = await client.move.fetch_move_target(1)
...     print(target.name)
...     await client.close()
>>> asyncio.run(main())
specific-pokemon
Source code in pokelance/ext/move.py
Python
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
async def fetch_move_target(self, name: t.Union[str, int]) -> MoveTarget:
    """Fetches a move target from the API.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move target.

    Returns
    -------
    MoveTarget
        The move target if it exists in the API, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move target does not exist in the API.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     target = await client.move.fetch_move_target(1)
    ...     print(target.name)
    ...     await client.close()
    >>> asyncio.run(main())
    specific-pokemon
    """
    route = Endpoint.get_move_target(name)
    self._validate_resource(self.cache.move_target, name, route)
    data = await self._client.request(route)
    return self.cache.move_target.setdefault(route, MoveTarget.from_payload(data))

get_message(case, data) staticmethod ⚓︎

Gets the error message for a resource not found error.

Parameters:
  • case (str) –

    The case to use for the error message.

  • data (Set[str]) –

    The data to use for the error message.
Returns:
  • str –

    The error message.
Source code in pokelance/ext/_base.py
Python
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
@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_move(name) ⚓︎

Gets a move from the cache.

Parameters:
Returns:
  • Optional[Move] –

    The move if it exists in the cache, else None.
Raises:

Examples:

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

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move.

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

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move does not exist in the cache.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> move = client.move.get_move(1)
    >>> move.name
    'pound'
    """
    route = Endpoint.get_move(name)
    self._validate_resource(self.cache.move, name, route)
    return self.cache.move.get(route, None)

get_move_ailment(name) ⚓︎

Gets a move ailment from the cache.

Parameters:
  • name (Union[str, int]) –

    The id of the move ailment.
Returns:
Raises:

Examples:

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

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move ailment.

    Returns
    -------
    typing.Optional[pokelance.models.MoveAilment]
        The move ailment if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move ailment does not exist in the cache.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> ailment = client.move.get_move_ailment(1)
    >>> ailment.name
    'paralysis'
    """
    route = Endpoint.get_move_ailment(name)
    self._validate_resource(self.cache.move_ailment, name, route)
    return self.cache.move_ailment.get(route, None)

get_move_battle_style(name) ⚓︎

Gets a move battle style from the cache.

Parameters:
  • name (Union[str, int]) –

    The id of the move battle style.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> style = client.move.get_move_battle_style(1)
>>> style.name
'attack'
Source code in pokelance/ext/move.py
Python
165
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
def get_move_battle_style(self, name: t.Union[str, int]) -> t.Optional[MoveBattleStyle]:
    """Gets a move battle style from the cache.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move battle style.

    Returns
    -------
    typing.Optional[pokelance.models.MoveBattleStyle]
        The move battle style if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move battle style does not exist in the cache.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> style = client.move.get_move_battle_style(1)
    >>> style.name
    'attack'
    """
    route = Endpoint.get_move_battle_style(name)
    self._validate_resource(self.cache.move_battle_style, name, route)
    return self.cache.move_battle_style.get(route, None)

get_move_category(name) ⚓︎

Gets a move category from the cache.

Parameters:
  • name (Union[str, int]) –

    The id of the move category.
Returns:
Raises:

Examples:

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

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move category.

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

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move category does not exist in the cache.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> category = client.move.get_move_category(1)
    >>> category.name
    'ailment'
    """
    route = Endpoint.get_move_category(name)
    self._validate_resource(self.cache.move_category, name, route)
    return self.cache.move_category.get(route, None)

get_move_damage_class(name) ⚓︎

Gets a move damage class from the cache.

Parameters:
  • name (Union[str, int]) –

    The id of the move damage class.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> damage_class = client.move.get_move_damage_class(1)
>>> damage_class.name
'status'
Source code in pokelance/ext/move.py
Python
299
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
def get_move_damage_class(self, name: t.Union[str, int]) -> t.Optional[MoveDamageClass]:
    """Gets a move damage class from the cache.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move damage class.

    Returns
    -------
    typing.Optional[pokelance.models.MoveDamageClass]
        The move damage class if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move damage class does not exist in the cache.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> damage_class = client.move.get_move_damage_class(1)
    >>> damage_class.name
    'status'
    """
    route = Endpoint.get_move_damage_class(name)
    self._validate_resource(self.cache.move_damage_class, name, route)
    return self.cache.move_damage_class.get(route, None)

get_move_learn_method(name) ⚓︎

Gets a move learn method from the cache.

Parameters:
  • name (Union[str, int]) –

    The id of the move learn method.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> learn_method = client.move.get_move_learn_method(1)
>>> learn_method.name
'level-up'
Source code in pokelance/ext/move.py
Python
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
def get_move_learn_method(self, name: t.Union[str, int]) -> t.Optional[MoveLearnMethod]:
    """Gets a move learn method from the cache.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move learn method.

    Returns
    -------
    typing.Optional[pokelance.models.MoveLearnMethod]
        The move learn method if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move learn method does not exist in the cache.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> learn_method = client.move.get_move_learn_method(1)
    >>> learn_method.name
    'level-up'
    """
    route = Endpoint.get_move_learn_method(name)
    self._validate_resource(self.cache.move_learn_method, name, route)
    return self.cache.move_learn_method.get(route, None)

get_move_target(name) ⚓︎

Gets a move target from the cache.

Parameters:
  • name (Union[str, int]) –

    The id of the move target.
Returns:
  • Optional[MoveTarget] –

    The move target if it exists in the cache, else None.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> target = client.move.get_move_target(1)
>>> target.name
'specific-pokemon'
Source code in pokelance/ext/move.py
Python
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
def get_move_target(self, name: t.Union[str, int]) -> t.Optional[MoveTarget]:
    """Gets a move target from the cache.

    Parameters
    ----------
    name: t.Union[str, int]
        The id of the move target.

    Returns
    -------
    typing.Optional[pokelance.models.MoveTarget]
        The move target if it exists in the cache, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the move target does not exist in the cache.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> target = client.move.get_move_target(1)
    >>> target.name
    'specific-pokemon'
    """
    route = Endpoint.get_move_target(name)
    self._validate_resource(self.cache.move_target, name, route)
    return self.cache.move_target.get(route, None)

setup() async ⚓︎

Sets up the extension.

Source code in pokelance/ext/_base.py
Python
 95
 96
 97
 98
 99
100
101
102
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 move cog.

Source code in pokelance/ext/move.py
Python
501
502
503
def setup(lance: "PokeLance") -> None:
    """Sets up the move cog."""
    lance.add_extension("move", Move(lance.http))