jam.ext.flask.extensions

extensions ¶

Classes:

Name	Description
`JWTExtension`	JWT extension fot flask.
`JamExtension`	Base jam extension.
`SessionExtension`	Session extension for Jam.

JWTExtension ¶

JWTExtension(
    jam: Jam,
    app: Optional[Flask] = None,
    header_name: Optional[str] = "Authorization",
    cookie_name: Optional[str] = None,
)

Bases: JamExtension

JWT extension fot flask.

Parameters:

Name	Type	Description	Default
`jam`	`Jam`	Jam instance	required
`app`	`Flask \| None`	Flask app	`None`
`header_name`	`str \| None`	Header with access token	`'Authorization'`
`cookie_name`	`str \| None`	Cookie with access token	`None`

Methods:

Name	Description
`init_app`	Flask app init.

init_app ¶

init_app(app: Flask) -> None

Flask app init.

JamExtension ¶

JamExtension(jam: Jam, app: Optional[Flask] = None)

Base jam extension.

Simply adds instance jam to app.extensions.

Parameters:

Name	Type	Description	Default
`jam`	`jam`	Jam instance	required
`app`	`Flask \| None`	Flask app	`None`

Methods:

Name	Description
`init_app`	Flask app init.

init_app ¶

init_app(app: Flask) -> None

Flask app init.

SessionExtension ¶

SessionExtension(
    jam: Jam,
    app: Optional[Flask] = None,
    header_name: Optional[str] = None,
    cookie_name: Optional[str] = "sessionId",
)

Bases: JamExtension

Session extension for Jam.

Parameters:

Name	Type	Description	Default
`jam`	`Jam`	Jam instance	required
`app`	`Flask \| None`	Flask app	`None`
`header_name`	`str \| None`	Session id header	`None`
`cookie_name`	`str \| None`	Session id cookie	`'sessionId'`

Methods:

Name	Description
`init_app`	Flask app init.

init_app ¶

init_app(app: Flask) -> None

Flask app init.

FILE PATH: jam/ext/flask/extensions.py