Ligare.web.application

The framework API for creating Flask and Connexion applications.

Functions

_get_exec_dir()
_get_program_dir()
_import_blueprint_modules(app, ...)
_register_blueprint_modules(app, ...)
configure_blueprint_routes(config[, ...])	Register Flask blueprints and API routes
configure_openapi(config[, name])	Instantiate Connexion and set Flask logging options

Classes

AppInjector(app, flask_injector)	Contains an instantiated T_app application in app, and its associated FlaskInjector IoC container.
ApplicationBuilder(exec)
ApplicationConfigBuilder()
CreateAppResult(flask_app, app_injector)	Contains an instantiated Flask application and its associated application "container." This is either the same Flask instance, or an OpenAPI application.

class Ligare.web.application.AppInjector(app, flask_injector)

Contains an instantiated T_app application in app, and its associated FlaskInjector IoC container.

Parameters:

• Generic (T_app) – An instance of Flask or FlaskApp.

• FlaskInject (flask_inject) – The applications IoC container.

__init__(app, flask_injector)

app: TypeVar(T_app, bound= Flask | FlaskApp)

flask_injector: FlaskInjector

final class Ligare.web.application.ApplicationBuilder(exec)

__init__(exec)

build()

Return type:

CreateAppResult[TypeVar(T_app, bound= Flask | FlaskApp)]

use_configuration(_ApplicationBuilder__application_config_builder_callback)

Execute changes to the builder’s ApplicationConfigBuilder[TAppConfig] instance.

__builder_callback can return None, or the instance of ApplicationConfigBuilder[TAppConfig] passed to its config_builder argument. This allowance is so lambdas can be used; ApplicationBuilder[T_app, TAppConfig] does not use the return value.

Return type:

Self

with_flask_app_name(value)

Return type:

Self

with_flask_env(value)

Return type:

Self

final class Ligare.web.application.ApplicationConfigBuilder

__init__()

build()

Return type:

Optional[TypeVar(TAppConfig, bound= Config)]

enable_ssm(value)

Try to load config from AWS SSM. If use_filename was configured, a failed attempt to load from SSM will instead attempt to load from the configured filename. If use_filename is not configured and SSM fails, an exception is raised. If SSM succeeds, build will not load from the configured filename.

Parameters:

value (bool) – Whether to use SSM

Return Self:

Return type:

Self

with_config_builder(config_builder)

Return type:

Self

with_config_filename(filename)

Return type:

Self

with_config_type(config_type)

Return type:

Self

with_config_types(configs)

Return type:

Self

with_config_value_overrides(values)

Return type:

Self

protocol Ligare.web.application.ApplicationConfigBuilderCallback

typing.Protocol.

Classes that implement this protocol must have the following methods / attributes:

__call__(config_builder)

A method used to configure an ApplicationConfigBuilder. Call the builder methods on config_builder to set the desired options.

Do not call `build()` as it is called by the ApplicationBuilder.

Parameters:

config_builder (ApplicationConfigBuilder[TAppConfig])

Return None | ApplicationConfigBuilder[TAppConfig]:

Any return value is ignored.

Return type:

Optional[ApplicationConfigBuilder[TypeVar(TAppConfig, bound= Config)]]

class Ligare.web.application.CreateAppResult(flask_app, app_injector)

Contains an instantiated Flask application and its associated application “container.” This is either the same Flask instance, or an OpenAPI application.

Parameters:

• Generic (flask_app) – The Flask application.

• AppInjector[T_app] (app_injector) – The application’s wrapper and IoC container.

__init__(flask_app, app_injector)

property app: T_app

app_injector: AppInjector[TypeVar(T_app, bound= Flask | FlaskApp)]

flask_app: Flask

property injector: Injector

run(*, import_string=None, host=None, port=None, **kwargs)

Call this method to start your application. This method is partly a passthrough for uvicorn.run.

Reference https://github.com/encode/uvicorn/blob/fe3910083e3990695bc19c2ef671dd447262ae18/uvicorn/main.py#L463

Parameters:

• import_string (Optional[str]) – application as import string (eg. “main:app”). This is needed to run using reload.

• host (Optional[str]) – The hostname this application should accept requests for. If None, the value in the application’s FlaskConfig instance is used; otherwise, this parameter value is used.

• port (Optional[int]) – The port this application should listen on for requests. If None, the value in the application’s FlaskConfig instance is used; otherwise, this parameter value is used.

protocol Ligare.web.application.UseConfigurationCallback

The callback for configuring an application’s configuration.

Parameters:

Protocol (TAppConfig) – The AbstractConfig type to be configured.

Classes that implement this protocol must have the following methods / attributes:

__call__(config_builder, config_overrides)

Set up parameters for the application’s configuration.

Parameters:

• config_builder (ConfigBuilder[TAppConfig]) – The ConfigBuilder instance.

• config_overrides (dict[str, Any]) – A dictionary of key/values that are applied over all keys that might exist in an instantiated config.

Raises:

• InvalidBuilderStateError – Upon a call to build(), the builder is misconfigured.

• BuilderBuildError – Upon a call to build(), a failure occurred during the instantiation of the configuration.

• Exception – Upon a call to build(), an unknown error occurred.

Return None | ConfigBuilder[TAppConfig]:

The callback may return None or the received ConfigBuilder instance so as to support the use of lambdas. This return value is not used.

Return type:

Optional[ConfigBuilder[TypeVar(TAppConfig, bound= Config)]]

Ligare.web.application.configure_blueprint_routes(config, blueprint_import_subdir='endpoints')

Register Flask blueprints and API routes

Ligare.web.application.configure_openapi(config, name=None)

Instantiate Connexion and set Flask logging options