pokelance.ext.pokemon ⚓︎

Pokemon(client) ⚓︎

Bases: BaseExtension

Extension for pokemon related endpoints.

Attributes:
  • cache (Pokemon) –

    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())

all_pokemons: t.Optional[t.List[str]] property ⚓︎

Returns a list of all pokemon names.

Returns:
  • Optional[List[str]] –

    List of all pokemon names. None if not cached yet.

fetch_ability(name) async ⚓︎

Fetch an ability by name or id.

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

    The name or id of the ability.
Returns:
  • Ability –

    The ability if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     ability = await client.pokemon.fetch_ability("stench")
...     print(ability.id)
...     await client.close()
>>> asyncio.run(main())
1
Source code in pokelance/ext/pokemon.py
Python
 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
 98
 99
100
101
102
103
104
105
106
async def fetch_ability(self, name: t.Union[str, int]) -> Ability:
    """Fetch an ability by name or id.

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

    Returns
    -------
    Ability
        The ability if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the ability was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     ability = await client.pokemon.fetch_ability("stench")
    ...     print(ability.id)
    ...     await client.close()
    >>> asyncio.run(main())
    1
    """
    route = Endpoint.get_ability(name)
    self._validate_resource(self.cache.ability, name, route)
    data = await self._client.request(route)
    return self.cache.ability.setdefault(route, Ability.from_payload(data))

fetch_characteristic(id_) async ⚓︎

Fetch a characteristic by id.

Parameters:
  • id_ (int) –

    The id of the characteristic.
Returns:
  • Characteristic –

    The characteristic if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     characteristic = await client.pokemon.fetch_characteristic(1)
...     print(characteristic.gene_modulo)
...     await client.close()
>>> asyncio.run(main())
0
Source code in pokelance/ext/pokemon.py
Python
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
165
166
167
168
169
170
171
172
173
async def fetch_characteristic(self, id_: int) -> Characteristic:
    """Fetch a characteristic by id.

    Parameters
    ----------
    id_: int
        The id of the characteristic.

    Returns
    -------
    Characteristic
        The characteristic if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the characteristic was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     characteristic = await client.pokemon.fetch_characteristic(1)
    ...     print(characteristic.gene_modulo)
    ...     await client.close()
    >>> asyncio.run(main())
    0
    """
    route = Endpoint.get_characteristic(id_)
    self._validate_resource(self.cache.characteristic, id_, route)
    data = await self._client.request(route)
    return self.cache.characteristic.setdefault(route, Characteristic.from_payload(data))

fetch_egg_group(name) async ⚓︎

Fetch an egg group by name or id.

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

    The name or id of the egg group.
Returns:
  • EggGroup –

    The egg group if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...     egg_group = await client.pokemon.fetch_egg_group("monster")
...     print(egg_group.id)
...     await client.close()
>>> asyncio.run(main())
1
Source code in pokelance/ext/pokemon.py
Python
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
232
233
234
235
236
237
238
239
240
async def fetch_egg_group(self, name: t.Union[str, int]) -> EggGroup:
    """Fetch an egg group by name or id.

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

    Returns
    -------
    EggGroup
        The egg group if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the egg group was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...     egg_group = await client.pokemon.fetch_egg_group("monster")
    ...     print(egg_group.id)
    ...     await client.close()
    >>> asyncio.run(main())
    1
    """
    route = Endpoint.get_egg_group(name)
    self._validate_resource(self.cache.egg_group, name, route)
    data = await self._client.request(route)
    return self.cache.egg_group.setdefault(route, EggGroup.from_payload(data))

fetch_gender(name) async ⚓︎

Fetches a gender model by name or id.

Parameters:
Returns:
  • Gender –

    Gender model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    gender = await client.pokemon.fetch_gender(1)
...    print(gender.name)
...    await client.close()
>>> asyncio.run(main())
female
Source code in pokelance/ext/pokemon.py
Python
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
299
300
301
302
303
304
305
306
307
308
309
async def fetch_gender(self, name: t.Union[str, int]) -> Gender:
    """
    Fetches a gender model by name or id.

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

    Returns
    -------
    Gender
        Gender model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if gender was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    gender = await client.pokemon.fetch_gender(1)
    ...    print(gender.name)
    ...    await client.close()
    >>> asyncio.run(main())
    female
    """
    route = Endpoint.get_gender(name)
    self._validate_resource(self.cache.gender, name, route)
    data = await self._client.request(route)
    return self.cache.gender.setdefault(route, Gender.from_payload(data))

fetch_growth_rate(name) async ⚓︎

Fetches a growth rate model by name or id.

Parameters:
Returns:
  • GrowthRate –

    Growth rate model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    growth_rate = await client.pokemon.fetch_growth_rate(1)
...    print(growth_rate.name)
...    await client.close()
>>> asyncio.run(main())
slow
Source code in pokelance/ext/pokemon.py
Python
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
async def fetch_growth_rate(self, name: t.Union[str, int]) -> GrowthRate:
    """
    Fetches a growth rate model by name or id.

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

    Returns
    -------
    GrowthRate
        Growth rate model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if growth rate was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    growth_rate = await client.pokemon.fetch_growth_rate(1)
    ...    print(growth_rate.name)
    ...    await client.close()
    >>> asyncio.run(main())
    slow
    """
    route = Endpoint.get_growth_rate(name)
    self._validate_resource(self.cache.growth_rate, name, route)
    data = await self._client.request(route)
    return self.cache.growth_rate.setdefault(route, GrowthRate.from_payload(data))

fetch_location_area_encounter(name) async ⚓︎

Fetches a location area encounter model by name or id.

Parameters:
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    location_area_encounter = await client.pokemon.fetch_location_area_encounter(1)
...    print(location_area_encounter.location_area.name)
...    await client.close()
>>> asyncio.run(main())
cerulean-city-area
Source code in pokelance/ext/pokemon.py
Python
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
async def fetch_location_area_encounter(self, name: t.Union[str, int]) -> LocationAreaEncounter:
    """
    Fetches a location area encounter model by name or id.

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

    Returns
    -------
    LocationAreaEncounter
        Location area encounter model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if location area encounter was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    location_area_encounter = await client.pokemon.fetch_location_area_encounter(1)
    ...    print(location_area_encounter.location_area.name)
    ...    await client.close()
    >>> asyncio.run(main())
    cerulean-city-area
    """
    route = Endpoint.get_location_area_encounter(name)
    self._validate_resource(self.cache.location_area_encounter, name, route)
    data = await self._client.request(route)
    return self.cache.location_area_encounter.setdefault(route, LocationAreaEncounter.from_payload(data[0]))

fetch_nature(name) async ⚓︎

Fetches a nature model by name or id.

Parameters:
Returns:
  • Nature –

    Nature model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    nature = await client.pokemon.fetch_nature(1)
...    print(nature.name)
...    await client.close()
>>> asyncio.run(main())
hardy
Source code in pokelance/ext/pokemon.py
Python
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
async def fetch_nature(self, name: t.Union[str, int]) -> Nature:
    """
    Fetches a nature model by name or id.

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

    Returns
    -------
    Nature
        Nature model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if nature was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    nature = await client.pokemon.fetch_nature(1)
    ...    print(nature.name)
    ...    await client.close()
    >>> asyncio.run(main())
    hardy
    """
    route = Endpoint.get_nature(name)
    self._validate_resource(self.cache.nature, name, route)
    data = await self._client.request(route)
    return self.cache.nature.setdefault(route, Nature.from_payload(data))

fetch_pokeathlon_stat(name) async ⚓︎

Fetches a pokeathlon stat model by name or id.

Parameters:
Returns:
  • PokeathlonStat –

    Pokeathlon stat model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    pokeathlon_stat = await client.pokemon.fetch_pokeathlon_stat(1)
...    print(pokeathlon_stat.name)
...    await client.close()
>>> asyncio.run(main())
speed
Source code in pokelance/ext/pokemon.py
Python
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
async def fetch_pokeathlon_stat(self, name: t.Union[str, int]) -> PokeathlonStat:
    """
    Fetches a pokeathlon stat model by name or id.

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

    Returns
    -------
    PokeathlonStat
        Pokeathlon stat model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokeathlon stat was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    pokeathlon_stat = await client.pokemon.fetch_pokeathlon_stat(1)
    ...    print(pokeathlon_stat.name)
    ...    await client.close()
    >>> asyncio.run(main())
    speed
    """
    route = Endpoint.get_pokeathlon_stat(name)
    self._validate_resource(self.cache.pokeathlon_stat, name, route)
    data = await self._client.request(route)
    return self.cache.pokeathlon_stat.setdefault(route, PokeathlonStat.from_payload(data))

fetch_pokemon(name) async ⚓︎

Fetches a pokemon model by name or id.

Parameters:
Returns:
  • Pokemon –

    Pokemon model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    pokemon = await client.pokemon.fetch_pokemon(1)
...    print(pokemon.name)
...    await client.close()
>>> asyncio.run(main())
bulbasaur
Source code in pokelance/ext/pokemon.py
Python
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
async def fetch_pokemon(self, name: t.Union[str, int]) -> PokemonModel:
    """
    Fetches a pokemon model by name or id.

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

    Returns
    -------
    PokemonModel
        Pokemon model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    pokemon = await client.pokemon.fetch_pokemon(1)
    ...    print(pokemon.name)
    ...    await client.close()
    >>> asyncio.run(main())
    bulbasaur
    """
    route = Endpoint.get_pokemon(name)
    self._validate_resource(self.cache.pokemon, name, route)
    data = await self._client.request(route)
    return self.cache.pokemon.setdefault(route, PokemonModel.from_payload(data))

fetch_pokemon_color(name) async ⚓︎

Fetches a pokemon color model by name or id.

Parameters:
Returns:
  • PokemonColor –

    Pokemon color model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    pokemon_color = await client.pokemon.fetch_pokemon_color(1)
...    print(pokemon_color.name)
...    await client.close()
>>> asyncio.run(main())
black
Source code in pokelance/ext/pokemon.py
Python
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
async def fetch_pokemon_color(self, name: t.Union[str, int]) -> PokemonColor:
    """
    Fetches a pokemon color model by name or id.

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

    Returns
    -------
    PokemonColor
        Pokemon color model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon color was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    pokemon_color = await client.pokemon.fetch_pokemon_color(1)
    ...    print(pokemon_color.name)
    ...    await client.close()
    >>> asyncio.run(main())
    black
    """
    route = Endpoint.get_pokemon_color(name)
    self._validate_resource(self.cache.pokemon_color, name, route)
    data = await self._client.request(route)
    return self.cache.pokemon_color.setdefault(route, PokemonColor.from_payload(data))

fetch_pokemon_form(name) async ⚓︎

Fetches a pokemon form model by name or id.

Parameters:
Returns:
  • PokemonForm –

    Pokemon form model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    pokemon_form = await client.pokemon.fetch_pokemon_form(1)
...    print(pokemon_form.name)
...    await client.close()
>>> asyncio.run(main())
bulbasaur
Source code in pokelance/ext/pokemon.py
Python
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
async def fetch_pokemon_form(self, name: t.Union[str, int]) -> PokemonForm:
    """
    Fetches a pokemon form model by name or id.

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

    Returns
    -------
    PokemonForm
        Pokemon form model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon form was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    pokemon_form = await client.pokemon.fetch_pokemon_form(1)
    ...    print(pokemon_form.name)
    ...    await client.close()
    >>> asyncio.run(main())
    bulbasaur
    """
    route = Endpoint.get_pokemon_form(name)
    self._validate_resource(self.cache.pokemon_form, name, route)
    data = await self._client.request(route)
    return self.cache.pokemon_form.setdefault(route, PokemonForm.from_payload(data))

fetch_pokemon_habitat(name) async ⚓︎

Fetches a pokemon habitat model by name or id.

Parameters:
Returns:
  • PokemonHabitats –

    Pokemon habitat model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    pokemon_habitat = await client.pokemon.fetch_pokemon_habitat(1)
...    print(pokemon_habitat.name)
...    await client.close()
>>> asyncio.run(main())
cave
Source code in pokelance/ext/pokemon.py
Python
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
async def fetch_pokemon_habitat(self, name: t.Union[str, int]) -> PokemonHabitats:
    """
    Fetches a pokemon habitat model by name or id.

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

    Returns
    -------
    PokemonHabitats
        Pokemon habitat model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon habitat was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    pokemon_habitat = await client.pokemon.fetch_pokemon_habitat(1)
    ...    print(pokemon_habitat.name)
    ...    await client.close()
    >>> asyncio.run(main())
    cave
    """
    route = Endpoint.get_pokemon_habitat(name)
    self._validate_resource(self.cache.pokemon_habitat, name, route)
    data = await self._client.request(route)
    return self.cache.pokemon_habitat.setdefault(route, PokemonHabitats.from_payload(data))

fetch_pokemon_shape(name) async ⚓︎

Fetches a pokemon shape model by name or id.

Parameters:
Returns:
  • PokemonShape –

    Pokemon shape model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    pokemon_shape = await client.pokemon.fetch_pokemon_shape(1)
...    print(pokemon_shape.name)
...    await client.close()
>>> asyncio.run(main())
ball
Source code in pokelance/ext/pokemon.py
Python
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
async def fetch_pokemon_shape(self, name: t.Union[str, int]) -> PokemonShape:
    """
    Fetches a pokemon shape model by name or id.

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

    Returns
    -------
    PokemonShape
        Pokemon shape model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon shape was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    pokemon_shape = await client.pokemon.fetch_pokemon_shape(1)
    ...    print(pokemon_shape.name)
    ...    await client.close()
    >>> asyncio.run(main())
    ball
    """
    route = Endpoint.get_pokemon_shape(name)
    self._validate_resource(self.cache.pokemon_shape, name, route)
    data = await self._client.request(route)
    return self.cache.pokemon_shape.setdefault(route, PokemonShape.from_payload(data))

fetch_pokemon_species(name) async ⚓︎

Fetches a pokemon species model by name or id.

Parameters:
Returns:
  • PokemonSpecies –

    Pokemon species model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    pokemon_species = await client.pokemon.fetch_pokemon_species(1)
...    print(pokemon_species.name)
...    await client.close()
>>> asyncio.run(main())
bulbasaur
Source code in pokelance/ext/pokemon.py
Python
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
async def fetch_pokemon_species(self, name: t.Union[str, int]) -> PokemonSpecies:
    """
    Fetches a pokemon species model by name or id.

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

    Returns
    -------
    PokemonSpecies
        Pokemon species model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon species was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    pokemon_species = await client.pokemon.fetch_pokemon_species(1)
    ...    print(pokemon_species.name)
    ...    await client.close()
    >>> asyncio.run(main())
    bulbasaur
    """
    route = Endpoint.get_pokemon_species(name)
    self._validate_resource(self.cache.pokemon_species, name, route)
    data = await self._client.request(route)
    return self.cache.pokemon_species.setdefault(route, PokemonSpecies.from_payload(data))

fetch_stat(name) async ⚓︎

Fetches a stat model by name or id.

Parameters:
Returns:
  • Stat –

    Stat model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    stat = await client.pokemon.fetch_stat(1)
...    print(stat.name)
...    await client.close()
>>> asyncio.run(main())
hp
Source code in pokelance/ext/pokemon.py
Python
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
async def fetch_stat(self, name: t.Union[str, int]) -> Stat:
    """
    Fetches a stat model by name or id.

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

    Returns
    -------
    Stat
        Stat model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if stat was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    stat = await client.pokemon.fetch_stat(1)
    ...    print(stat.name)
    ...    await client.close()
    >>> asyncio.run(main())
    hp
    """
    route = Endpoint.get_stat(name)
    self._validate_resource(self.cache.stat, name, route)
    data = await self._client.request(route)
    return self.cache.stat.setdefault(route, Stat.from_payload(data))

fetch_type(name) async ⚓︎

Fetches a type model by name or id.

Parameters:
Returns:
  • Type –

    Type model if found, else raises ResourceNotFound.
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> import asyncio
>>> client = PokeLance()
>>> async def main() -> None:
...    type_ = await client.pokemon.fetch_type(1)
...    print(type_.name)
...    await client.close()
>>> asyncio.run(main())
normal
Source code in pokelance/ext/pokemon.py
Python
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
async def fetch_type(self, name: t.Union[str, int]) -> Type:
    """
    Fetches a type model by name or id.

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

    Returns
    -------
    Type
        Type model if found, else raises ResourceNotFound.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if type was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> import asyncio
    >>> client = PokeLance()
    >>> async def main() -> None:
    ...    type_ = await client.pokemon.fetch_type(1)
    ...    print(type_.name)
    ...    await client.close()
    >>> asyncio.run(main())
    normal
    """
    route = Endpoint.get_type(name)
    self._validate_resource(self.cache.type, name, route)
    data = await self._client.request(route)
    return self.cache.type.setdefault(route, Type.from_payload(data))

get_ability(name) ⚓︎

Get an ability by name or id.

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

    The name or id of the ability.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> ability = client.pokemon.get_ability("stench")
>>> ability.id
1
Source code in pokelance/ext/pokemon.py
Python
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
def get_ability(self, name: t.Union[str, int]) -> t.Optional[Ability]:
    """Get an ability by name or id.

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

    Returns
    -------
    t.Optional[Ability]
        The ability if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the ability was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> ability = client.pokemon.get_ability("stench")
    >>> ability.id
    1
    """
    route = Endpoint.get_ability(name)
    self._validate_resource(self.cache.ability, name, route)
    return self.cache.ability.get(route, None)

get_characteristic(id_) ⚓︎

Get a characteristic by id.

Parameters:
  • id_ (int) –

    The id of the characteristic.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> characteristic = client.pokemon.get_characteristic(1)
>>> characteristic.gene_modulo
0
Source code in pokelance/ext/pokemon.py
Python
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def get_characteristic(self, id_: int) -> t.Optional[Characteristic]:
    """Get a characteristic by id.

    Parameters
    ----------
    id_: int
        The id of the characteristic.

    Returns
    -------
    t.Optional[Characteristic]
        The characteristic if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the characteristic was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> characteristic = client.pokemon.get_characteristic(1)
    >>> characteristic.gene_modulo
    0
    """
    route = Endpoint.get_characteristic(id_)
    self._validate_resource(self.cache.characteristic, id_, route)
    return self.cache.characteristic.get(route, None)

get_egg_group(name) ⚓︎

Get an egg group by name or id.

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

    The name or id of the egg group.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> egg_group = client.pokemon.get_egg_group("monster")
>>> egg_group.id
1
Source code in pokelance/ext/pokemon.py
Python
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def get_egg_group(self, name: t.Union[str, int]) -> t.Optional[EggGroup]:
    """Get an egg group by name or id.

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

    Returns
    -------
    t.Optional[EggGroup]
        The egg group if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        If the egg group was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> egg_group = client.pokemon.get_egg_group("monster")
    >>> egg_group.id
    1
    """
    route = Endpoint.get_egg_group(name)
    self._validate_resource(self.cache.egg_group, name, route)
    return self.cache.egg_group.get(route, None)

get_gender(name) ⚓︎

Get gender from cache.

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

    The name or id of the gender.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> gender = client.pokemon.get_gender(1)
>>> gender.name
'female'
Source code in pokelance/ext/pokemon.py
Python
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
def get_gender(self, name: t.Union[str, int]) -> t.Optional[Gender]:
    """
    Get gender from cache.

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

    Returns
    -------
    t.Optional[Gender]
        Gender model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if gender was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> gender = client.pokemon.get_gender(1)
    >>> gender.name
    'female'
    """
    route = Endpoint.get_gender(name)
    self._validate_resource(self.cache.gender, name, route)
    return self.cache.gender.get(route, None)

get_growth_rate(name) ⚓︎

Get growth rate from cache.

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

    The name or id of the growth rate.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> growth_rate = client.pokemon.get_growth_rate(1)
>>> growth_rate.name
'slow'
Source code in pokelance/ext/pokemon.py
Python
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
def get_growth_rate(self, name: t.Union[str, int]) -> t.Optional[GrowthRate]:
    """
    Get growth rate from cache.

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

    Returns
    -------
    t.Optional[GrowthRate]
        Growth rate model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if growth rate was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> growth_rate = client.pokemon.get_growth_rate(1)
    >>> growth_rate.name
    'slow'
    """
    route = Endpoint.get_growth_rate(name)
    self._validate_resource(self.cache.growth_rate, name, route)
    return self.cache.growth_rate.get(route, None)

get_location_area_encounter(name) ⚓︎

Get location area encounter from cache. It gets areas where a pokemon can be found.

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

    The name or id of the location area encounter.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> location_area_encounter = client.pokemon.get_location_area_encounter(1)
>>> location_area_encounter.location_area.name
'cerulean-city-area'
Source code in pokelance/ext/pokemon.py
Python
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
def get_location_area_encounter(self, name: t.Union[str, int]) -> t.Optional[LocationAreaEncounter]:
    """
    Get location area encounter from cache.
    It gets areas where a pokemon can be found.

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

    Returns
    -------
    t.Optional[LocationAreaEncounter]
        Location area encounter model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if location area encounter was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> location_area_encounter = client.pokemon.get_location_area_encounter(1)
    >>> location_area_encounter.location_area.name
    'cerulean-city-area'
    """
    route = Endpoint.get_location_area_encounter(name)
    self._validate_resource(self.cache.location_area_encounter, name, route)
    return self.cache.location_area_encounter.get(route, None)

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

Get nature from cache.

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

    The name or id of the nature.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> nature = client.pokemon.get_nature(1)
>>> nature.name
'hardy'
Source code in pokelance/ext/pokemon.py
Python
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
def get_nature(self, name: t.Union[str, int]) -> t.Optional[Nature]:
    """
    Get nature from cache.

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

    Returns
    -------
    t.Optional[Nature]
        Nature model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if nature was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> nature = client.pokemon.get_nature(1)
    >>> nature.name
    'hardy'
    """
    route = Endpoint.get_nature(name)
    self._validate_resource(self.cache.nature, name, route)
    return self.cache.nature.get(route, None)

get_pokeathlon_stat(name) ⚓︎

Get pokeathlon stat from cache.

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

    The name or id of the pokeathlon stat.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pokeathlon_stat = client.pokemon.get_pokeathlon_stat(1)
>>> pokeathlon_stat.name
'speed'
Source code in pokelance/ext/pokemon.py
Python
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
def get_pokeathlon_stat(self, name: t.Union[str, int]) -> t.Optional[PokeathlonStat]:
    """
    Get pokeathlon stat from cache.

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

    Returns
    -------
    t.Optional[PokeathlonStat]
        Pokeathlon stat model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokeathlon stat was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pokeathlon_stat = client.pokemon.get_pokeathlon_stat(1)
    >>> pokeathlon_stat.name
    'speed'
    """
    route = Endpoint.get_pokeathlon_stat(name)
    self._validate_resource(self.cache.pokeathlon_stat, name, route)
    return self.cache.pokeathlon_stat.get(route, None)

get_pokemon(name) ⚓︎

Get pokemon from cache.

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

    The name or id of the pokemon.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pokemon = client.pokemon.get_pokemon(1)
>>> pokemon.name
'bulbasaur'
Source code in pokelance/ext/pokemon.py
Python
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
def get_pokemon(self, name: t.Union[str, int]) -> t.Optional[PokemonModel]:
    """
    Get pokemon from cache.

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

    Returns
    -------
    t.Optional[PokemonModel]
        Pokemon model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pokemon = client.pokemon.get_pokemon(1)
    >>> pokemon.name
    'bulbasaur'
    """
    route = Endpoint.get_pokemon(name)
    self._validate_resource(self.cache.pokemon, name, route)
    return self.cache.pokemon.get(route, None)

get_pokemon_color(name) ⚓︎

Get pokemon color from cache.

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

    The name or id of the pokemon color.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pokemon_color = client.pokemon.get_pokemon_color(1)
>>> pokemon_color.name
'black'
Source code in pokelance/ext/pokemon.py
Python
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
def get_pokemon_color(self, name: t.Union[str, int]) -> t.Optional[PokemonColor]:
    """
    Get pokemon color from cache.

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

    Returns
    -------
    t.Optional[PokemonColor]
        Pokemon color model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon color was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pokemon_color = client.pokemon.get_pokemon_color(1)
    >>> pokemon_color.name
    'black'
    """
    route = Endpoint.get_pokemon_color(name)
    self._validate_resource(self.cache.pokemon_color, name, route)
    return self.cache.pokemon_color.get(route, None)

get_pokemon_form(name) ⚓︎

Get pokemon form from cache.

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

    The name or id of the pokemon form.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pokemon_form = client.pokemon.get_pokemon_form(1)
>>> pokemon_form.name
'bulbasaur'
Source code in pokelance/ext/pokemon.py
Python
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
def get_pokemon_form(self, name: t.Union[str, int]) -> t.Optional[PokemonForm]:
    """
    Get pokemon form from cache.

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

    Returns
    -------
    t.Optional[PokemonForm]
        Pokemon form model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon form was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pokemon_form = client.pokemon.get_pokemon_form(1)
    >>> pokemon_form.name
    'bulbasaur'
    """
    route = Endpoint.get_pokemon_form(name)
    self._validate_resource(self.cache.pokemon_form, name, route)
    return self.cache.pokemon_form.get(route, None)

get_pokemon_habitat(name) ⚓︎

Get pokemon habitat from cache.

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

    The name or id of the pokemon habitat.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pokemon_habitat = client.pokemon.get_pokemon_habitat(1)
>>> pokemon_habitat.name
'cave'
Source code in pokelance/ext/pokemon.py
Python
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
def get_pokemon_habitat(self, name: t.Union[str, int]) -> t.Optional[PokemonHabitats]:
    """
    Get pokemon habitat from cache.

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

    Returns
    -------
    t.Optional[PokemonHabitats]
        Pokemon habitat model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon habitat was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pokemon_habitat = client.pokemon.get_pokemon_habitat(1)
    >>> pokemon_habitat.name
    'cave'
    """
    route = Endpoint.get_pokemon_habitat(name)
    self._validate_resource(self.cache.pokemon_habitat, name, route)
    return self.cache.pokemon_habitat.get(route, None)

get_pokemon_shape(name) ⚓︎

Get pokemon shape from cache.

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

    The name or id of the pokemon shape.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pokemon_shape = client.pokemon.get_pokemon_shape(1)
>>> pokemon_shape.name
'ball'
Source code in pokelance/ext/pokemon.py
Python
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
def get_pokemon_shape(self, name: t.Union[str, int]) -> t.Optional[PokemonShape]:
    """
    Get pokemon shape from cache.

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

    Returns
    -------
    t.Optional[PokemonShape]
        Pokemon shape model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon shape was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pokemon_shape = client.pokemon.get_pokemon_shape(1)
    >>> pokemon_shape.name
    'ball'
    """
    route = Endpoint.get_pokemon_shape(name)
    self._validate_resource(self.cache.pokemon_shape, name, route)
    return self.cache.pokemon_shape.get(route, None)

get_pokemon_species(name) ⚓︎

Get pokemon species from cache.

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

    The name or id of the pokemon species.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> pokemon_species = client.pokemon.get_pokemon_species(1)
>>> pokemon_species.name
'bulbasaur'
Source code in pokelance/ext/pokemon.py
Python
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
def get_pokemon_species(self, name: t.Union[str, int]) -> t.Optional[PokemonSpecies]:
    """
    Get pokemon species from cache.

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

    Returns
    -------
    t.Optional[PokemonSpecies]
        Pokemon species model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if pokemon species was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> pokemon_species = client.pokemon.get_pokemon_species(1)
    >>> pokemon_species.name
    'bulbasaur'
    """
    route = Endpoint.get_pokemon_species(name)
    self._validate_resource(self.cache.pokemon_species, name, route)
    return self.cache.pokemon_species.get(route, None)

get_stat(name) ⚓︎

Get stat from cache.

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

    The name or id of the stat.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> stat = client.pokemon.get_stat(1)
>>> stat.name
'hp'
Source code in pokelance/ext/pokemon.py
Python
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
def get_stat(self, name: t.Union[str, int]) -> t.Optional[Stat]:
    """
    Get stat from cache.

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

    Returns
    -------
    t.Optional[Stat]
        Stat model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if stat was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> stat = client.pokemon.get_stat(1)
    >>> stat.name
    'hp'
    """
    route = Endpoint.get_stat(name)
    self._validate_resource(self.cache.stat, name, route)
    return self.cache.stat.get(route, None)

get_type(name) ⚓︎

Get type from cache.

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

    The name or id of the type.
Returns:
Raises:

Examples:

Python Console Session
>>> from pokelance import PokeLance
>>> client = PokeLance()
>>> type_ = client.pokemon.get_type(1)
>>> type_.name
'normal'
Source code in pokelance/ext/pokemon.py
Python
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
def get_type(self, name: t.Union[str, int]) -> t.Optional[Type]:
    """
    Get type from cache.

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

    Returns
    -------
    t.Optional[Type]
        Type model if found, else None.

    Raises
    ------
    pokelance.exceptions.ResourceNotFound
        if type was not found.

    Examples
    --------

    >>> from pokelance import PokeLance
    >>> client = PokeLance()
    >>> type_ = client.pokemon.get_type(1)
    >>> type_.name
    'normal'
    """
    route = Endpoint.get_type(name)
    self._validate_resource(self.cache.type, name, route)
    return self.cache.type.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) ⚓︎

Setup the pokemon cog.

Source code in pokelance/ext/pokemon.py
Python
1154
1155
1156
def setup(lance: "PokeLance") -> None:
    """Setup the pokemon cog."""
    lance.add_extension("pokemon", Pokemon(lance.http))