Created
May 7, 2021 11:48
-
-
Save ryan-blunden/f03a16b3cec54d59a408daa9614e3755 to your computer and use it in GitHub Desktop.
Python class for App Configuration
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import os | |
from typing import get_type_hints, Union | |
from dotenv import load_dotenv | |
load_dotenv() | |
class AppConfigError(Exception): | |
pass | |
def _parse_bool(val: Union[str, bool]) -> bool: # pylint: disable=E1136 | |
return val if type(val) == bool else val.lower() in ['true', 'yes', '1'] | |
# AppConfig class with required fields, default values, type checking, and typecasting for int and bool values | |
class AppConfig: | |
DEBUG: bool = False | |
ENV: str = 'production' | |
API_KEY: str | |
HOSTNAME: str | |
PORT: int | |
""" | |
Map environment variables to class fields according to these rules: | |
- Field won't be parsed unless it has a type annotation | |
- Field will be skipped if not in all caps | |
- Class field and environment variable name are the same | |
""" | |
def __init__(self, env): | |
for field in self.__annotations__: | |
if not field.isupper(): | |
continue | |
# Raise AppConfigError if required field not supplied | |
default_value = getattr(self, field, None) | |
if default_value is None and env.get(field) is None: | |
raise AppConfigError('The {} field is required'.format(field)) | |
# Cast env var value to expected type and raise AppConfigError on failure | |
try: | |
var_type = get_type_hints(AppConfig)[field] | |
if var_type == bool: | |
value = _parse_bool(env.get(field, default_value)) | |
else: | |
value = var_type(env.get(field, default_value)) | |
self.__setattr__(field, value) | |
except ValueError: | |
raise AppConfigError('Unable to cast value of "{}" to type "{}" for "{}" field'.format( | |
env[field], | |
var_type, | |
field | |
) | |
) | |
def __repr__(self): | |
return str(self.__dict__) | |
# Expose Config object for app to import | |
Config = AppConfig(os.environ) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment