envarify 1.5.0

Environment variables parsing and validation using python type hints

Envarify

Environment variables parsing and validation using python type hints

Usage

Having some environment variables:

export TIMEOUT_S=2.5
export API_KEY=some_key
export ALLOWED_IDS=1,2,3
export ENABLE_FEATURE=true

We can create a config object in Python:

from envarify import BaseConfig, EnvVar, SecretString

class MyConfig(BaseConfig):
    timeout_s: float = EnvVar("TIMEOUT_S")
    api_key: SecretString = EnvVar("API_KEY")
    allowed_ids: set[int] = EnvVar("ALLOWED_IDS")
    enable_feature: bool = EnvVar("ENABLE_FEATURE", default=False)
    optional_arg: str | None = EnvVar("OPTIONAL_ARG", default=None)

config = MyConfig.fromenv()
print(config)
#> MyConfig(timeout_s=2.5, api_key='******', allowed_ids={1,2,3}, enable_feature=True, optional_arg=None)

Missing environment variables

If there are required environment variables not set, they will be grouped into one error e.g.:

config = MyConfig.fromenv()
#> MissingEnvVarsError: TIMEOUT_S, API_KEY, ALLOWED_IDS

Supported Types

• Built-in/standard library types

  • int
  • float
  • bool
  • str
  • typing.StrEnum
  • datetime.date
  • datetime.datetime

• Special types

  • SecretString

    Masks sensitive environment variables by displaying ****** when printed or logged. The actual value is accessible via the reveal() method, and memory is cleared when object is no longer needed.

    from envarify import BaseConfig, EnvVar, SecretString
    
    class MyConfig(BaseConfig):
        api_key: SecretString = EnvVar("API_KEY")
    
    config = MyConfig.fromenv()
    print(config.api_key)
    
    #> MyConfig(api_key='******')
    

  • Url

    Validates that string is a URL.

    from envarify import BaseConfig, EnvVar, Url
    
    class MyConfig(BaseConfig):
        url: Url = EnvVar("ws://example.com")
    
    config = MyConfig.fromenv()
    print(config.api_key)
    
    #> MyConfig(url='ws://example.com')
    

  • HttpUrl

    Same as Url but validates for http protocol

  • HttpsUrl

    Same as Url but validates for https protocol

  • AnyHttpUrl

    Same as Url but validates for either http or https protocol

• Dictionary

  • dict / typing.Dict type reads environmental variable as JSON

• Sequences (delimiter separated values)

  • list[T] / typing.List[T]

  • set[T] / typing.Set[T]

  • tuple[T] / typing.Tuple[T]

    where T is any primitive type

• BaseConfig subtype itself

  With environment variables COMPONENT_TIMEOUT=5 and OTHER=dummy you can do:

  from envarify import BaseConfig, EnvVar
  
  class ComponentConfig(BaseConfig):
      timeout: int = EnvVar("COMPONENT_TIMEOUT")
  
  class ApplicationConfig(BaseConfig):
      component: ComponentConfig
      other: str = EnvVar("OTHER")
  
  config = ApplicationConfig.fromenv()
  print(config)
  #> ApplicationConfig(component=ComponentConfig(timeout=5), other='dummy')
  

Testing

In tests for your application you don't have to worry about mocking the environment variables. Instead just create a mock config object:

mock_config = MyConfig(timeout_s=4.2, api_key="dummy", allowed_ids={1,2,3}, enable_feature=True)