Skip to content

jam.sessions

sessions

Module for making server auth sessions.

Modules:

Name Description
__base__
json
redis

Functions:

Name Description
create_instance

Create session module instance.

create_instance

create_instance(
    session_type: str | None = None,
    sessions_type: str | None = None,
    logger: BaseLogger = logger,
    serializer: BaseEncoder
    | type[BaseEncoder] = JsonEncoder,
    **kwargs: Any,
) -> BaseSessionModule

Create session module instance.

Parameters:

Name Type Description Default
session_type str | None

"redis" | "json" | "custom"

None
sessions_type str | None

Alias for session_type (deprecated, use 'session_type')

None
logger BaseLogger

Logger instance

logger
serializer BaseEncoder | type[BaseEncoder]

JSON encoder/decoder

JsonEncoder
**kwargs Any

Config params specific to session type

{}

Returns:

Type Description
BaseSessionModule

BaseSessionModule instance