Skip to main content

Feature Flagging for Flask

Project description

flask-pancake

Feature Flagging for Flask

This library was heavily inspired by django-waffle.

Installation

flask-pancake depends on Redis and the flask-redis Python package.

$ python -m pip install flask-pancake
Successfully installed flask-pancake
from flask import Flask
from flask_pancake import FlaskPancake, Switch
from flask_redis import FlaskRedis

app = Flask(__name__)
pancake = FlaskPancake(app)
redis = FlaskRedis(app)

SWITCH_FEATURE = Switch("FEATURE", default=False)


@app.route("/")
def index():
    if SWITCH_FEATURE.is_active():
        return "Hello World!", 200
    else:
        return "Not found", 404

Alternatively, if you use a create_app() method to configure your Flask app, use pancake.init_app():

from flask import Flask
from flask_pancake import FlaskPancake

pancake = FlaskPancake()


def create_app() -> Flask:
    app = Flask(__name__)
    pancake.init_app(app)
    return app

Usage

flask-pancake provides three types of flags:

  • Switches, which are either globally active or inactive. A common use case for these are system-wide enabling or disabling of a feature. E.g. in the context of a dependency on a third party service, disabling a feature with a global switch when that service is unavailable.

  • Flags are like Switches but can be overridden per user. To make use of Flags, one needs to define a function that returns a user's unique ID or None:

    from flask import request
    from flask_pancake import FlaskPancake
    
    def get_user_id():
        return getattr(getattr(request, "user", None), "uid", None)
    
    pancake = FlaskPancake(get_user_id_func=get_user_id)
    # Or, if importing a function from somewhere isn't possible, a string based
    # approach can be used.
    # Separate the the fully qualified module path from the function with a `:`
    pancake = FlaskPancake(get_user_id_func="my.app.account.utils:get_uid")
    
  • Samples, have a global "ratio" of 0 - 100%. Each time a check is done on a sample, a random value is checked within these bounds. Hence:

    # DO THIS!
    def foo():
        is_active = MY_SAMPLE.is_active()
        if is_active:
            # do something
            pass
        ...
        if is_active:
            # do more
            pass
    
    # DO NOT DO THIS!
    def foo():
        if MY_SAMPLE.is_active():
            # do something
            pass
        ...
        if MY_SAMPLE.is_active():
            # do more
            pass
    

    In the second example, each call to is_active() will be evaluated again. Thus, the first block might be executed, but the second might not (or vice versa).

The persisted state for all three types of feature flags can be cleared, using the clear() method.

Similarly, one can change the persisted state for Flags and Switches using their disable() and enable() methods. Samples can be updated using their set(value: float) method.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

flask_pancake-0.0.1.dev1-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file flask_pancake-0.0.1.dev1-py3-none-any.whl.

File metadata

  • Download URL: flask_pancake-0.0.1.dev1-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.8.1

File hashes

Hashes for flask_pancake-0.0.1.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 6697f4f5457d6df87337d9e026e79d1d6618432ce2af6d996d212133ccbad04e
MD5 b3f5189f283750cd6d16cd7c181fd92d
BLAKE2b-256 4c602786ee7a8864e3ab1dfe3ed49296fcc7d5886167d4c6bf72ee0486d0bddf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page