Berry

berry ¶

Berry ¶

Berry(client: _HTTPClientT_co)

Bases: SyncBaseExtension[Berry]

Extension for berry related endpoints.

Source code in pokelance/ext/_base.py

def __init__(self, client: _HTTPClientT_co) -> None:
    self._client = client
    self._cache_manager = client.cache_manager
    self._cache_group = getattr(self._cache_manager, self.__class__.__name__.lower())

get_berry ¶

get_berry(name: str | int) -> Berry | None

Gets a berry from the cache.

Parameters:

Name	Type	Description	Default
`name`	`str \| int`	The name or id.	required

Returns:

Type	Description
`Berry \| None`	The cached model or None.

Examples:

berry = client.berry.get_berry("cheri")
if berry:
    print(berry)

Source code in pokelance/ext/sync/berry.py

def get_berry(self, name: str | int) -> models.Berry | None:
    """Gets a berry from the cache.

    Parameters
    ----------
    name : str | int
        The name or id.

    Returns
    -------
    models.Berry | None
        The cached model or None.

    Examples
    --------
    ```python
    berry = client.berry.get_berry("cheri")
    if berry:
        print(berry)
    ```"""
    route = Endpoint.get_berry(name)
    self._validate_resource(self._cache_group.berry, name, route)
    return self._cache_group.berry.get(route, None)

fetch_berry ¶

fetch_berry(name: str | int) -> Berry

Fetches a berry from the API.

Parameters:

Name	Type	Description	Default
`name`	`str \| int`	The name or id.	required

Returns:

Type	Description
`Berry`	The fetched model.

Examples:

berry = client.berry.fetch_berry("cheri")
print(berry)

Source code in pokelance/ext/sync/berry.py

def fetch_berry(self, name: str | int) -> models.Berry:
    """Fetches a berry from the API.

    Parameters
    ----------
    name : str | int
        The name or id.

    Returns
    -------
    models.Berry
        The fetched model.

    Examples
    --------
    ```python
    berry = client.berry.fetch_berry("cheri")
    print(berry)
    ```"""
    route = Endpoint.get_berry(name)
    self._validate_resource(self._cache_group.berry, name, route)
    data = self._client.request(route)
    return self._cache_group.berry.setdefault(route, self._cache_group.berry.from_payload(data))

get_berry_firmness ¶

get_berry_firmness(name: str | int) -> BerryFirmness | None

Gets a berry firmness from the cache.

Parameters:

Name	Type	Description	Default
`name`	`str \| int`	The name or id.	required

Returns:

Type	Description
`BerryFirmness \| None`	The cached model or None.

Examples:

firmness = client.berry.get_berry_firmness("very-soft")
if firmness:
    print(firmness)

Source code in pokelance/ext/sync/berry.py

def get_berry_firmness(self, name: str | int) -> models.BerryFirmness | None:
    """Gets a berry firmness from the cache.

    Parameters
    ----------
    name : str | int
        The name or id.

    Returns
    -------
    models.BerryFirmness | None
        The cached model or None.

    Examples
    --------
    ```python
    firmness = client.berry.get_berry_firmness("very-soft")
    if firmness:
        print(firmness)
    ```"""
    route = Endpoint.get_berry_firmness(name)
    self._validate_resource(self._cache_group.berry_firmness, name, route)
    return self._cache_group.berry_firmness.get(route, None)

fetch_berry_firmness ¶

fetch_berry_firmness(name: str | int) -> BerryFirmness

Fetches a berry firmness from the API.

Parameters:

Name	Type	Description	Default
`name`	`str \| int`	The name or id.	required

Returns:

Type	Description
`BerryFirmness`	The fetched model.

Examples:

firmness = client.berry.fetch_berry_firmness("very-soft")
print(firmness)

Source code in pokelance/ext/sync/berry.py

def fetch_berry_firmness(self, name: str | int) -> models.BerryFirmness:
    """Fetches a berry firmness from the API.

    Parameters
    ----------
    name : str | int
        The name or id.

    Returns
    -------
    models.BerryFirmness
        The fetched model.

    Examples
    --------
    ```python
    firmness = client.berry.fetch_berry_firmness("very-soft")
    print(firmness)
    ```"""
    route = Endpoint.get_berry_firmness(name)
    self._validate_resource(self._cache_group.berry_firmness, name, route)
    data = self._client.request(route)
    return self._cache_group.berry_firmness.setdefault(route, self._cache_group.berry_firmness.from_payload(data))

get_berry_flavor ¶

get_berry_flavor(name: str | int) -> BerryFlavor | None

Gets a berry flavor from the cache.

Parameters:

Name	Type	Description	Default
`name`	`str \| int`	The name or id.	required

Returns:

Type	Description
`BerryFlavor \| None`	The cached model or None.

Examples:

flavor = client.berry.get_berry_flavor("spicy")
if flavor:
    print(flavor)

Source code in pokelance/ext/sync/berry.py

def get_berry_flavor(self, name: str | int) -> models.BerryFlavor | None:
    """Gets a berry flavor from the cache.

    Parameters
    ----------
    name : str | int
        The name or id.

    Returns
    -------
    models.BerryFlavor | None
        The cached model or None.

    Examples
    --------
    ```python
    flavor = client.berry.get_berry_flavor("spicy")
    if flavor:
        print(flavor)
    ```"""
    route = Endpoint.get_berry_flavor(name)
    self._validate_resource(self._cache_group.berry_flavor, name, route)
    return self._cache_group.berry_flavor.get(route, None)

fetch_berry_flavor ¶

fetch_berry_flavor(name: str | int) -> BerryFlavor

Fetches a berry flavor from the API.

Parameters:

Name	Type	Description	Default
`name`	`str \| int`	The name or id.	required

Returns:

Type	Description
`BerryFlavor`	The fetched model.

Examples:

flavor = client.berry.fetch_berry_flavor("spicy")
print(flavor)

Source code in pokelance/ext/sync/berry.py

def fetch_berry_flavor(self, name: str | int) -> models.BerryFlavor:
    """Fetches a berry flavor from the API.

    Parameters
    ----------
    name : str | int
        The name or id.

    Returns
    -------
    models.BerryFlavor
        The fetched model.

    Examples
    --------
    ```python
    flavor = client.berry.fetch_berry_flavor("spicy")
    print(flavor)
    ```"""
    route = Endpoint.get_berry_flavor(name)
    self._validate_resource(self._cache_group.berry_flavor, name, route)
    data = self._client.request(route)
    return self._cache_group.berry_flavor.setdefault(route, self._cache_group.berry_flavor.from_payload(data))

setup ¶

setup(lance: PokeLanceSyncClient) -> None

Sets up the berry extension.

Source code in pokelance/ext/sync/berry.py

def setup(lance: PokeLanceSyncClient) -> None:
    """Sets up the berry extension."""
    lance.add_extension("berry", Berry(lance.http))

Berry

berry ¶

Berry ¶

get_berry ¶

fetch_berry ¶

get_berry_firmness ¶

fetch_berry_firmness ¶

get_berry_flavor ¶

fetch_berry_flavor ¶

setup ¶

Comments