jam.ext.flask.extensions¶

extensions ¶

Classes:

Name	Description
`BaseAuthExtension`	Base Jam authentication extension for Flask.
`BaseExtension`	Base Jam extension for Flask.
`JWTExtension`	JWT extension for Flask.
`OAuth2Extension`	OAuth2 extension for Flask.
`PASETOExtension`	PASETO extension for Flask.
`SessionExtension`	Session extension for Flask.

BaseAuthExtension ¶

BaseAuthExtension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    cookie_name: str | None = None,
    header_name: str | None = None,
    bearer: bool = True,
    **kwargs: Any,
)

Bases: BaseExtension

Base Jam authentication extension for Flask.

Parameters:

Name	Type	Description	Default
`app`	`Flask \| None`	Flask application instance	`None`
`config`	`dict[str, Any] \| str \| None`	Jam config as path/to/file or dict.	`None`
`pointer`	`str`	Config pointer	`GENERIC_POINTER`
`cookie_name`	`str \| None`	Cookie name to read token	`None`
`header_name`	`str \| None`	Header name to read token	`None`
`bearer`	`bool`	Strip "Bearer " prefix from header	`True`
`**kwargs`	`Any`	Configuration arguments if config=None	`{}`

Methods:

Name	Description
`init_app`	Initialize the Flask application.

init_app ¶

init_app(app: Flask) -> None

Initialize the Flask application.

BaseExtension ¶

BaseExtension(app: Flask | None = None, **kwargs: Any)

Base Jam extension for Flask.

Parameters:

Name	Type	Description	Default
`app`	`Flask \| None`	Flask application instance	`None`
`auth`	`Any \| None`	Pre-created auth module instance	required
`**kwargs`	`Any`	Configuration arguments	`{}`

Methods:

Name	Description
`init_app`	Initialize the Flask application.

init_app ¶

init_app(app: Flask) -> None

Initialize the Flask application.

Parameters:

Name	Type	Description	Default
`app`	`Flask`	Flask application instance	required

JWTExtension ¶

JWTExtension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    cookie_name: str | None = None,
    header_name: str | None = None,
    use_list: bool = False,
    bearer: bool = True,
    **kwargs: Any,
)

Bases: BaseAuthExtension

JWT extension for Flask.

Parameters:

Name	Type	Description	Default
`app`	`Flask \| None`	Flask application instance	`None`
`config`	`dict[str, Any] \| str \| None`	Jam config as path/to/file or dict.	`None`
`pointer`	`str`	Config pointer	`GENERIC_POINTER`
`cookie_name`	`str \| None`	Cookie name to read token	`None`
`header_name`	`str \| None`	Header name to read token	`None`
`use_list`	`bool`	Use a list for token	`False`
`bearer`	`bool`	Strip "Bearer " prefix from header	`True`
`**kwargs`	`Any`	Configuration arguments if config=None	`{}`

OAuth2Extension ¶

OAuth2Extension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    **kwargs: Any,
)

Bases: BaseExtension

OAuth2 extension for Flask.

Parameters:

Name	Type	Description	Default
`app`	`Flask \| None`	Flask application instance	`None`
`config`	`dict[str, Any] \| str \| None`	Jam config as path/to/file or dict.	`None`
`pointer`	`str`	Config pointer	`GENERIC_POINTER`
`**kwargs`	`Any`	Configuration arguments if config=None	`{}`

PASETOExtension ¶

PASETOExtension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    cookie_name: str | None = None,
    header_name: str | None = None,
    bearer: bool = True,
    **kwargs: Any,
)

Bases: BaseAuthExtension

PASETO extension for Flask.

SessionExtension ¶

SessionExtension(
    app: Flask | None = None,
    config: dict[str, Any] | str | None = None,
    pointer: str = GENERIC_POINTER,
    cookie_name: str | None = None,
    header_name: str | None = None,
    bearer: bool = True,
    **kwargs: Any,
)

Bases: BaseAuthExtension

Session extension for Flask.