🏳 feature_flag¶

The basic component of fastfeatureflag.

Usage¶

In [1]:

from fastfeatureflag.feature_flag import feature_flag

@feature_flag("off", name="grouped_feature", response="Custom response")
def broken_feature():
    return "broken feature"

broken_feature()

from fastfeatureflag.feature_flag import feature_flag @feature_flag("off", name="grouped_feature", response="Custom response") def broken_feature(): return "broken feature" broken_feature()

Out[1]:

'Custom response'

Update¶

In [2]:

@feature_flag("off", name="grouped_feature", response="Custom response")
def broken_feature():
    return "broken feature"

broken_feature()

@feature_flag("off", name="grouped_feature", response="Custom response") def broken_feature(): return "broken feature" broken_feature()

Out[2]:

'Custom response'

To change the behavior of the single feature_flag, use the update method. Every flagged object has this function.

In [3]:

broken_feature.update(activation="on")
broken_feature()

broken_feature.update(activation="on") broken_feature()

Out[3]:

'broken feature'

Configuration¶

Having several features might make the update difficult. It is also possible to reconfigure all flags. Provided a configuration dictionary.

In [4]:

@feature_flag("off", name="grouped_feature", response="Custom response")
def broken_feature():
    return "broken feature"

broken_feature()

@feature_flag("off", name="grouped_feature", response="Custom response") def broken_feature(): return "broken feature" broken_feature()

Out[4]:

'Custom response'

In [5]:

@feature_flag("off", name="grouped_feature", response="Custom response")
def broken_feature():
    return "broken feature"

configuration = {"grouped_feature": {"activation":"on"}}

broken_feature.configuration = configuration
broken_feature()

@feature_flag("off", name="grouped_feature", response="Custom response") def broken_feature(): return "broken feature" configuration = {"grouped_feature": {"activation":"on"}} broken_feature.configuration = configuration broken_feature()

Out[5]:

'broken feature'

In [6]:

configuration = {"grouped_feature": {"activation":"off","response":"Configured response"}}

broken_feature.configuration = configuration
broken_feature()

configuration = {"grouped_feature": {"activation":"off","response":"Configured response"}} broken_feature.configuration = configuration broken_feature()

Out[6]:

'Configured response'

Reconfiguration via a file¶

Instead of providing a dictionary, it is also possible to point to a *.toml file, containing the configuration.

In [7]:

with open("sample_config.toml","r") as file:
    print(file.read())

with open("sample_config.toml","r") as file: print(file.read())

[grouped_feature]
activation="off"
response="Response defined by toml"

In [8]:

@feature_flag("off", name="grouped_feature")
def broken_feature():
    return "broken feature"

broken_feature()

@feature_flag("off", name="grouped_feature") def broken_feature(): return "broken feature" broken_feature()

Out[8]:

'Configured response'

In [9]:

import pathlib
broken_feature.configuration_path = pathlib.Path("sample_config.toml")
broken_feature()

import pathlib broken_feature.configuration_path = pathlib.Path("sample_config.toml") broken_feature()

Out[9]:

'Response defined by toml'

Show and clean registered features¶

It might be necessary to clean all registered features (un-grouping the features).

In [10]:

@feature_flag("off", name="grouped_feature")
def broken_feature():
    return "broken feature"

broken_feature.registered_features

@feature_flag("off", name="grouped_feature") def broken_feature(): return "broken feature" broken_feature.registered_features

Out[10]:

[FeatureContent(activation='off', name='grouped_feature', response='Response defined by toml', shadow=None, func=<function broken_feature at 0x7fe0c8d17c40>, configuration=None, configuration_path=None)]

In [11]:

broken_feature.clean()
broken_feature.registered_features

broken_feature.clean() broken_feature.registered_features

Out[11]:

[]

---

Last update: October 28, 2023
Created: October 28, 2023