Ligare.web.middleware.feature_flags

Ligare.web’s integration with Ligare.platform.feature_flag.

Functions

_get_feature_flag_blueprint(app, config, log)

Create and return a Flask Blueprint with API endpoints for querying and managing Feature Flags.

Classes

CachingFeatureFlagRouterModule()	An Injector module to work with Feature Flags in-memory.
Config(**data)
DBFeatureFlagRouterModule(feature_flag_table)
FeatureFlagConfig(**data)
FeatureFlagMiddlewareModule(...)	Enable the use of Feature Flags and a Feature Flag management API.
FeatureFlagPatch(name, enabled)
FeatureFlagPatchRequest
FeatureFlagRouterModule([t_feature_flag])	An Injector module to provide an instance of a Feature Flag Router.

class Ligare.web.middleware.feature_flags.CachingFeatureFlagRouterModule

An Injector module to work with Feature Flags in-memory.

__init__()

Get an instance of the generic FeatureFlagRouterModule.

Parameters:

t_feature_flag (type[FeatureFlagRouter[TFeatureFlag]] | None) – The type of Feature Flag Router this Injector module provides, defaults to None

class Ligare.web.middleware.feature_flags.Config(**data)

feature_flag: FeatureFlagConfig

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

post_load()

This method is called by load_config after TOML data has been loaded into the pluggable config type instance.

Return type:

None

class Ligare.web.middleware.feature_flags.DBFeatureFlagRouterModule(feature_flag_table: type[FeatureFlagTableBase[MetaBase]], bases: list[MetaBase | type[MetaBase]] | None = None)

static __new__(cls, feature_flag_table, bases=None)

An Injector module to work with Feature Flags stored in a database.

Parameters:

• feature_flag_table (type[FeatureFlagTableBase]) – The base table type representing columns the database table contains, and other aspects of SQLAlchemy Table object

• bases (list[MetaBase | type[MetaBase]] | None) – All MetaBase types an SQLAlchemy ScopedSession instance is responsible for, defaults to None

Return _type_:

_description_

class Ligare.web.middleware.feature_flags.FeatureFlagConfig(**data)

access_role_name: str | bool | None

api_base_url: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Ligare.web.middleware.feature_flags.FeatureFlagMiddlewareModule(feature_flag_router_module_type)

Enable the use of Feature Flags and a Feature Flag management API.

class FeatureFlagMiddleware(app)

ASGI middleware for Feature Flags.

This middleware create a Flask blueprint the enables a Feature Flag management API.

__init__(app)

__init__(feature_flag_router_module_type)

Create the Injector module.

Parameters:

feature_flag_router_module_type (type[FeatureFlagRouterModule[TFeatureFlag]])

configure(binder)

Override to configure bindings.

Return type:

None

register_middleware(app)

class Ligare.web.middleware.feature_flags.FeatureFlagPatch(name, enabled)

__init__(name, enabled)

enabled: bool

name: str

class Ligare.web.middleware.feature_flags.FeatureFlagPatchRequest

enabled: bool

name: str

class Ligare.web.middleware.feature_flags.FeatureFlagRouterModule(t_feature_flag=None)

An Injector module to provide an instance of a Feature Flag Router.

__init__(t_feature_flag=None)

Get an instance of the generic FeatureFlagRouterModule.

Parameters:

t_feature_flag (type[FeatureFlagRouter[TFeatureFlag]] | None) – The type of Feature Flag Router this Injector module provides, defaults to None

static get_config_type()

Get the Feature Flag Router Module configuration type.

Return type[Ligare.web.middleware.feature_flags.Config]:

Return type:

type[AbstractConfig]