lagom.environment

Complexity

Total Complexity

3

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	Env.__init__()	0	13	3

"""
This module provides code to automatically load environment variables from the container.
It is built on top of (and requires) pydantic.

At first one or more classes representing the required environment variables are defined.
All environment variables are assumed to be all uppercase and are automatically lowercased.

class MyWebEnv(Env):
    port: str
    host: str

class DBEnv(Env):
    db_host: str
    db_password: str


@bind_to_container(c)
def some_function(env: DBEnv):
    do_something(env.db_host, env.db_password)

"""
import os
from abc import ABC
from typing import ClassVar, Optional

try:
    from pydantic.main import BaseModel
except ImportError as error:
    raise ImportError(
        "Using Env requires pydantic to be installed. Try `pip install lagom[env]`"
    ) from error


class Env(ABC, BaseModel):
    """
    This class implements logic to automatically load properties from ENV
    variables.
    """

    PREFIX: ClassVar[Optional[str]] = None

    def __init__(self, **kwargs):
        if len(kwargs) == 0:
            prefix = f"{self.PREFIX}_" if self.PREFIX else ""
            envs = os.environ.items()
            super().__init__(
                **{
                    key.replace(prefix, "").lower(): value
                    for (key, value) in envs
                    if key.startswith(prefix)
                }
            )
        else:
            super().__init__(**kwargs)