Skip to content

Base

pokelance.models._base ⚓︎

BaseModel ⚓︎

Base model for all models

from_payload(payload) classmethod ⚓︎

Create a model from a payload

Parameters:

Name Type Description Default
payload Dict[str, Any]

The payload to create the model from.

 required

Returns:

Type Description
BaseModel

The model created from the payload.
Source code in pokelance/models/_base.py
Python
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@classmethod
def from_payload(cls, payload: t.Dict[str, t.Any]) -> "BaseModel":
    """Create a model from a payload

    Parameters
    ----------
    payload: typing.Dict[str, Any]
        The payload to create the model from.

    Returns
    -------
    BaseModel
        The model created from the payload.
    """
    return cls(raw=payload)

to_dict() ⚓︎

Convert the model to a dict

Returns:

Type Description
Dict[str, Any]

The model as a dict.
Source code in pokelance/models/_base.py
Python
19
20
21
22
23
24
25
26
27
28
29
def to_dict(self) -> t.Dict[str, t.Any]:
    """Convert the model to a dict

    Returns
    -------
    typing.Dict[str, Any]
        The model as a dict.
    """
    return attrs.asdict(
        self, filter=attrs.filters.exclude(attrs.fields(BaseModel).raw), value_serializer=_serializer
    )

Comments