envcon 1.8.3

envcon: environment variables parsing using type-hints

envcon: easy environment variables parsing

Envcon - easy environment variables parsing.
Envcon allows you to store configuration separated from your code, like The Twelve-Factor App suggests.
Envcon heavily leaned on python type-hints and makes configuration simple and declerative.

Contents

• Features
• Install
• Usage
  • Basic usage
  • Prefix
  • Optional
  • Freezing Class
  • Another Source
• Supported types
  • Casting
• Reading .env files
• Why...?
  • Why environment variables?
  • Why not os.environ?
• License

Features

• Simple usage
• Type-casting
• Parse .env file as well as environment variables (os.environ)
• Default values
• Prefix
• human readable errors
• freezing classes after injection

Install

pip install envcon

Usage

Assuming these environment variables are set (or written in .env file)

export MONGO_USER=myMongoUser
export MONGO_PASSWORD=shh_its_a_secret
export SECRET_NUMBER=0.42
export ONE_TO_TEN=1,2,3,4,5,6,7,8,9,10
export IS_ENABLED=true
export URL=http://www.google.com

Basic usage

from envcon import environment_configuration

@environment_configuration
class Configs:
    SECRET_NUMBER: float
    IS_ENABLED: bool
    ONE_TO_TEN: list[int] # on python 3.8 use List[int] (from typing import List) 

print(Configs.SECRET_NUMBER) # 0,42
print(type(Configs.SECRET_NUMBER)) # <class 'float'>
print(Configs.IS_ENABLED) # True
print(type(Configs.IS_ENABLED)) # <class 'bool'>
print(type(Configs.ONE_TO_TEN[0])) # <class 'int'> 

Prefix

from envcon import environment_configuration

@environment_configuration(prefix="MONGO_")
class MongoConfiguration:
    USER: str
    PASSWORD: str

print(MongoConfiguration.USER) # myMongoUser
    

Optional

All variables without default value are considered required. Optional annotation suggests non-required variable and default set to None.

from typing import Optional
from envcon import environment_configuration

@environment_configuration
class Configuration:
    NON_EXISTING_ENV_VER: Optional[int]

print(type(Configuration.NON_EXISTING_ENV_VER)) # <class 'NoneType'>
    

Freezing Class

By default, after injection, modifications of fields is prevented. This feature is inspired by @dataclass frozen flag. This behaviour can be overridden, or explicitly described:

from envcon import environment_configuration

@environment_configuration(frozen=False)
class MyConfiguration:
  SOME_CONFIGURATION: str


@environment_configuration
class AnotherConfiguration:
  SOME_CONFIGURATION: str


MyConfiguration.SOME_CONFIGURATION = "yey"
print(MyConfiguration.SOME_CONFIGURATION)  # yey
AnotherConfiguration.SOME_CONFIGURATION = "oh"
# Traceback (most recent call last):
#   File "<input>", line 1, in <module>
#   File "example.py", line 10, in __setattr__
#     raise FrozenClassAttributesError()
# envcon.metaclasses.FrozenClassAttributesError: Class is frozen. modifying attributes is not allowed

Another Source

What if I want different source other than my .env file / os.environ?

from envcon import configuration

my_config_dict = {
  "MONGO_USER": "myUser",
  "MONGO_PASSWORD": "myPassword",
}

@configuration(prefix="MONGO_", source=my_config_dict)
class MongoConfiguration:
    USER: str
    PASSWORD: str

print(MongoConfiguration.USER) # myUser
    

Exceptions

from envcon import environment_configuration

@environment_configuration
class ConfigurationA:
    NON_EXISTING_ENV_VER: int

# LookupError: NON_EXISTING_ENV_VER is not an environment variable, nor has default value
    

Supported types

The following types hints are supported

Builtins and from typing:

• str
• bool
• int
• float
• list
• list[T] # >= python 3.9. T = str/bool/int/float
• dict
• List
• List[T]
• Dict
• Optional[T] # T = str/bool/int/float/dict/list/list[T]

Casting

int float

Simple casting.

i, f = "42",  "4.2"
int(i)
float(i)

bool

The following case-insensitive strings are considered True and False.

• True:
  • 1
  • y
  • yes
  • true
• False
  • "" (empty string)
  • 0
  • n
  • no
  • false

Anything but these values raises an exception.
Its strongly suggested sticking with simple lowercase "false/true" and not something like fALsE.

list

List is parsed as comma separated values.
If sub-type is provided (e.g. list[int]) each element will be converted as well.

dict

JSON string which loaded using json.loads()

Reading .env files

By default, envcon will parse your .env file. This feature is useful for local development.
.env will not override your environment variables.

You can turn this feature off:

@environment_configuration(include_dot_env_file=False)
class MyConfigClass:
    ...

Why...?

Why environment variables?

See The 12-factor App section on configuration.

Why not os.environ?

Basically, because this:

class Config:
    MAX_CONNECTION = int(os.environ.get("MAX_CONNECTION", "42"))
    TIMEOUT = float(os.environ.get("TIMEOUT", "4.2"))
    MY_PASSWORD = os.environ["MY_PASSWORD"] #required w/o default value
    OPTIONAL_URL = os.environ.get("OPTIONAL_URL", None)
    OPTIONAL_NUMBER = int(os.environ.get("OPTIONAL_NUMBER", "0")) or None
    NUMS_LIST = [int(i) for i in os.environ["NUMS_LIST"].splite(",")]
    NUMS_LIST_WITH_DEFAULT = [int(i) for i in os.environ.get("NUMS_LIST", "1,2,3").splite(",")]

will simply turn into this:

from typing import Optional, List

@environment_configuration
class Config:
    MAX_CONNECTION: int = 42
    TIMEOUT: float = 4.2
    MY_PASSWORD: str
    OPTIONAL_URL: Optional[str]
    OPTIONAL_NUMBER: Optional[int]
    NUMS_LIST: list[int] # in python 3.8 use List[int]
    NUMS_LIST_WITH_DEFAULT: list[int] = [1, 2, 3]

envcon will help you

• cast environment variables to the correct type
• specify required environment variables
• define default values
• parse list and dict

License

MIT licensed.