jam.ext.starlette.objects

objects

Classes:

Name	Description
BaseUser	BaseUser with builder from payload.
SimpleUser	Simple user with payload only.

BaseUser

Bases: ABC, BaseUser

BaseUser with builder from payload.

Methods:

Name	Description
from_payload	Create instance by payload.

from_payload abstractmethod classmethod

from_payload(payload: dict[str, Any]) -> User

Create instance by payload.

Parameters:

Name	Type	Description	Default
payload	dict[str, Any]	Payload from auth	required

Example:

class MyUser(JamBaseUser):
    id: int
    username: str

    @classmethod
    def from_payload(cls, payload):
        return cls(
            id=payload["id"],
            username=payload["username"]
        )

payload = jwt.decode(token)
user = MyUser.from_payload(payload)

SimpleUser dataclass

SimpleUser(payload: dict[str, Any])

Bases: BaseUser

Simple user with payload only.