App & Blueprint Objects

class flask_jeroboam.jeroboam.Jeroboam(*args, **kwargs)

Bases: JeroboamScaffoldOverRide, Flask

A Flask Object with extra functionalities.

The route method is overriden by a custom flask_jeroboam route decorator.

Parameters:

  • args (Any)

  • kwargs (Any)

init_app(app=None)

Setup is performed after app has received all its configuration.

Parameters:

app (Jeroboam | None)

Return type:

None

property openapi: OpenAPI

Get the OpenApi object.

query_string_key_transformer: Callable | None = None
response_class

alias of JSONResponse

url_rule_class

alias of JeroboamRule

class flask_jeroboam.blueprint.Blueprint(*args, tags=None, include_in_openapi=True, **kwargs)

Bases: JeroboamScaffoldOverRide, Blueprint

Regular Blueprint with extra behavior on route definition.

Parameters:

  • args (Any)

  • tags (list[str] | None)

  • include_in_openapi (bool)

  • kwargs (Any)