Pull environment variables into your sanic config.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
sanic_envconfig
tests
.coveragerc
.gitignore
.travis.yml
LICENCE.txt
README.md
TODO.md
requirements.txt
setup.py

README.md

sanic-envconfig

Python Versions PyPI Version Licence Build Status Coverage Status

This extension helps you bring commandline & environment variables into your Sanic config.

The extension also leverages type hints to correctly cast those variables to the appropriate type. This can also be overridden and extended for your own types.

How it Works

Define your config class and subclass sanic_envconfig.EnvConfig. To not pollute your config, only those variables defined (and in uppercase) in your config class will pulled from your environment or commandline variables.

The values set in your class will be the default values, overridden when there is a environment variable or commandline argument with the same name available. The priority order being: commandline arguments > enviroment variables > config.

Casting of the commandline & environment variables is decided by looking at the type hints declared on config class. If no hint has been declared, the type of the default value will be used. When a default value is also not provided the variable will be returned as whatever type it exists in os.environ or sys.argv (most certainly a str).

This extension takes care of correctly casting the common types str, bool, int and float. Though, sanic_envconfig.EnvConfig can be extended for custom types. Additionally, the supplied casting can be overridden if desired.

Just Sanic?

The extension, for the moment, is generic enough where it could be used in another context. Though, future releases may more tightly couple it with Sanic.

Installation

$ pip install sanic_envconfig

Example Usage

DEBUG: false
DB_URL: postgresql://localhost:5433/environ
WORKERS: 4

$ python example.py --db-url "postgresql://localhost:5433/commandline"
# example.py
from sanic import Sanic
from sanic_envconfig import EnvConfig


class Config(EnvConfig):
    DEBUG: bool = True
    DB_URL: str = None
    WORKERS: int = 1

app = Sanic(__name__)
app.config.from_object(Config)

app.config.DEBUG  # False
app.config.DB_URL  # 'postgresql://localhost:5433/commandline'
app.config.WORKERS  # 4

Custom Casting

To override or extend the casting system, sanic_envconfig.EnvConfig provides a decorator. The decorator takes the type as a parameter and hands the decorated function any values of that type from the environment variables.

THEME: blue
from enum import Enum
from sanic_envconfig import EnvConfig


class Color(Enum):
    RED = 0
    BLUE = 1

class Config(EnvConfig):
    THEME: Color = None

@Config.parse(Color)
def parse_color(value):
    return Color[value.upper()]

Config.THEME  # Color.BLUE