Skip to content

TomlEnv

Overview

Minimal Env-style adapter backed by a TOML-loaded mapping with optional env var overrides.

call {#call}

Call self as a function.

Signature {#call-signature}

__call__(self, key, default)

Parameters {#call-parameters}

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns {#call-returns}

typing.Any

Source {#call-source}

server/vueda/core/config.py:60

_expand

Signature

_expand(self, value)

Parameters

NameTypeRequiredDescription
selfyes
value<function TomlEnv.str at 0x7d813986b740>yes

Returns

<function TomlEnv.str at 0x7d813986b740>

Source

server/vueda/core/config.py:377

_get

Signature

_get(self, key)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes

Returns

typing.Any

Source

server/vueda/core/config.py:369

_parse_duration

Signature

_parse_duration(self, value)

Parameters

NameTypeRequiredDescription
selfyes
value<function TomlEnv.str at 0x7d813986b740>yes

Returns

<function TomlEnv.timedelta at 0x7d813986ba60>

Source

server/vueda/core/config.py:390

_parse_iso_duration

Signature

_parse_iso_duration(self, value)

Parameters

NameTypeRequiredDescription
selfyes
value<function TomlEnv.str at 0x7d813986b740>yes

Returns

<function TomlEnv.timedelta at 0x7d813986ba60>

Source

server/vueda/core/config.py:419

bool

Signature

bool(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.bool at 0x7d813986b2e0>

Source

server/vueda/core/config.py:70

date

Signature

date(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.date at 0x7d813986b920>

Source

server/vueda/core/config.py:241

datetime

Signature

datetime(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.datetime at 0x7d813986b880>

Source

server/vueda/core/config.py:231

decimal

Signature

decimal(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<class 'decimal.Decimal'>

Source

server/vueda/core/config.py:221

dict

Signature

dict(self, key, default, delimiter, key_value_delimiter, subcast_keys, subcast_key, subcast_values)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes
delimiter<function TomlEnv.str at 0x7d813986b740>yes
key_value_delimiter<function TomlEnv.str at 0x7d813986b740>yes
subcast_keyscollections.abc.Callable[[typing.Any], typing.Any] | Noneyes
subcast_keycollections.abc.Callable[[typing.Any], typing.Any] | Noneyes
subcast_valuescollections.abc.Callable[[typing.Any], typing.Any] | Noneyes

Returns

dict[Any, Any]

Source

server/vueda/core/config.py:159

dj_cache_url

Signature

dj_cache_url(self, key, default, kwargs)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes
kwargstyping.Anyyes

Returns

dict[str, Any]

Source

server/vueda/core/config.py:361

dj_db_url

Signature

dj_db_url(self, key, default, kwargs)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes
kwargstyping.Anyyes

Returns

dict[str, Any]

Source

server/vueda/core/config.py:345

dj_email_url

Signature

dj_email_url(self, key, default, kwargs)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes
kwargstyping.Anyyes

Returns

dict[str, Any]

Source

server/vueda/core/config.py:353

enum

Signature

enum(self, key, enum_cls, default, by_value, case_sensitive)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
enum_clstype[~_T]yes
defaulttyping.Anyyes
by_value<function TomlEnv.bool at 0x7d813986b2e0>yes
case_sensitive<function TomlEnv.bool at 0x7d813986b2e0>yes

Returns

~_T

Source

server/vueda/core/config.py:315

float

Signature

float(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.float at 0x7d813986b420>

Source

server/vueda/core/config.py:98

int

Signature

int(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.int at 0x7d813986b380>

Source

server/vueda/core/config.py:86

json

Signature

json(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

list[Any] | dict[Any, Any] | None

Source

server/vueda/core/config.py:200

list

Signature

list(self, key, default, delimiter, subcast)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes
delimiter<function TomlEnv.str at 0x7d813986b740>yes
subcastcollections.abc.Callable[[typing.Any], typing.Any] | Noneyes

Returns

list[Any]

Source

server/vueda/core/config.py:110

log_level

Signature

log_level(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.int at 0x7d813986b380>

Source

server/vueda/core/config.py:303

path

Signature

path(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<class 'pathlib.Path'>

Source

server/vueda/core/config.py:273

str

Signature

str(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.str at 0x7d813986b740>

Source

server/vueda/core/config.py:213

time

Signature

time(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.time at 0x7d813986b9c0>

Source

server/vueda/core/config.py:251

timedelta

Signature

timedelta(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<function TomlEnv.timedelta at 0x7d813986ba60>

Source

server/vueda/core/config.py:261

tuple

Signature

tuple(self, key, default, delimiter, subcast)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes
delimiter<function TomlEnv.str at 0x7d813986b740>yes
subcastcollections.abc.Callable[[typing.Any], typing.Any] | Noneyes

Returns

tuple[Any, ...]

Source

server/vueda/core/config.py:136

url

Signature

url(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<class 'urllib.parse.ParseResult'>

Source

server/vueda/core/config.py:283

uuid

Signature

uuid(self, key, default)

Parameters

NameTypeRequiredDescription
selfyes
key<function TomlEnv.str at 0x7d813986b740>yes
defaulttyping.Anyyes

Returns

<class 'uuid.UUID'>

Source

server/vueda/core/config.py:293

dict {#dict}

dictionary for instance variables

weakref {#weakref}

list of weak references to the object

_config

_environ

_expand_vars

_prefer_env

_prefix

Source

server/vueda/core/config.py:40

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2