---
url: "https://vueda.dev/v3/reference/api/py/vueda.core.config/TomlEnv.md"
title: "TomlEnv"
---

# TomlEnv

## Overview

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

## `__init__` {#--init--}

### Signature {#--init---signature}

`__init__(config, environ, prefer_env, prefix, expand_vars)`

#### Parameters {#--init---parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="--init---param-config">config</span> | `Mapping[str, Any] \| None` | no | `None` |  |
| <span id="--init---param-environ">environ</span> | `Mapping[str, str] \| None` | no | `None` |  |
| <span id="--init---param-prefer_env">prefer_env</span> | `bool` | no | `True` |  |
| <span id="--init---param-prefix">prefix</span> | `str \| None` | no | `None` |  |
| <span id="--init---param-expand_vars">expand_vars</span> | `bool` | no | `False` |  |

### Source {#--init---source}

`server/vueda/core/config.py:45`

## `bool` {#bool}

### Signature {#bool-signature}

`bool(self, key, default)`

#### Parameters {#bool-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="bool-param-key">key</span> | `str` | yes |  |  |
| <span id="bool-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#bool-returns}

`bool`

### Source {#bool-source}

`server/vueda/core/config.py:70`

## `date` {#date}

### Signature {#date-signature}

`date(self, key, default)`

#### Parameters {#date-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="date-param-key">key</span> | `str` | yes |  |  |
| <span id="date-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#date-returns}

`date`

### Source {#date-source}

`server/vueda/core/config.py:241`

## `datetime` {#datetime}

### Signature {#datetime-signature}

`datetime(self, key, default)`

#### Parameters {#datetime-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="datetime-param-key">key</span> | `str` | yes |  |  |
| <span id="datetime-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#datetime-returns}

`datetime`

### Source {#datetime-source}

`server/vueda/core/config.py:231`

## `decimal` {#decimal}

### Signature {#decimal-signature}

`decimal(self, key, default)`

#### Parameters {#decimal-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="decimal-param-key">key</span> | `str` | yes |  |  |
| <span id="decimal-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#decimal-returns}

`Decimal`

### Source {#decimal-source}

`server/vueda/core/config.py:221`

## `dict` {#dict}

### Signature {#dict-signature}

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

#### Parameters {#dict-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="dict-param-key">key</span> | `str` | yes |  |  |
| <span id="dict-param-default">default</span> | `Any` | no | `_MISSING` |  |
| <span id="dict-param-delimiter">delimiter</span> | `str` | no | `','` |  |
| <span id="dict-param-key_value_delimiter">key_value_delimiter</span> | `str` | no | `'='` |  |
| <span id="dict-param-subcast_keys">subcast_keys</span> | `Callable[[Any], Any] \| None` | no | `None` |  |
| <span id="dict-param-subcast_key">subcast_key</span> | `Callable[[Any], Any] \| None` | no | `None` |  |
| <span id="dict-param-subcast_values">subcast_values</span> | `Callable[[Any], Any] \| None` | no | `None` |  |

#### Returns {#dict-returns}

`dict[Any, Any]`

### Source {#dict-source}

`server/vueda/core/config.py:159`

## `dj_cache_url` {#dj_cache_url}

### Signature {#dj_cache_url-signature}

`dj_cache_url(self, key, default, kwargs)`

#### Parameters {#dj_cache_url-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="dj_cache_url-param-key">key</span> | `str` | yes |  |  |
| <span id="dj_cache_url-param-default">default</span> | `Any` | no | `_MISSING` |  |
| <span id="dj_cache_url-param-kwargs">kwargs</span> | `Any` | no |  |  |

#### Returns {#dj_cache_url-returns}

`dict[str, Any]`

### Source {#dj_cache_url-source}

`server/vueda/core/config.py:361`

## `dj_db_url` {#dj_db_url}

### Signature {#dj_db_url-signature}

`dj_db_url(self, key, default, kwargs)`

#### Parameters {#dj_db_url-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="dj_db_url-param-key">key</span> | `str` | yes |  |  |
| <span id="dj_db_url-param-default">default</span> | `Any` | no | `_MISSING` |  |
| <span id="dj_db_url-param-kwargs">kwargs</span> | `Any` | no |  |  |

#### Returns {#dj_db_url-returns}

`dict[str, Any]`

### Source {#dj_db_url-source}

`server/vueda/core/config.py:345`

## `dj_email_url` {#dj_email_url}

### Signature {#dj_email_url-signature}

`dj_email_url(self, key, default, kwargs)`

#### Parameters {#dj_email_url-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="dj_email_url-param-key">key</span> | `str` | yes |  |  |
| <span id="dj_email_url-param-default">default</span> | `Any` | no | `_MISSING` |  |
| <span id="dj_email_url-param-kwargs">kwargs</span> | `Any` | no |  |  |

#### Returns {#dj_email_url-returns}

`dict[str, Any]`

### Source {#dj_email_url-source}

`server/vueda/core/config.py:353`

## `enum` {#enum}

### Signature {#enum-signature}

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

#### Parameters {#enum-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="enum-param-key">key</span> | `str` | yes |  |  |
| <span id="enum-param-enum_cls">enum_cls</span> | `type[_T]` | yes |  |  |
| <span id="enum-param-default">default</span> | `Any` | no | `_MISSING` |  |
| <span id="enum-param-by_value">by_value</span> | `bool` | no | `False` |  |
| <span id="enum-param-case_sensitive">case_sensitive</span> | `bool` | no | `False` |  |

#### Returns {#enum-returns}

`_T`

### Source {#enum-source}

`server/vueda/core/config.py:315`

## `float` {#float}

### Signature {#float-signature}

`float(self, key, default)`

#### Parameters {#float-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="float-param-key">key</span> | `str` | yes |  |  |
| <span id="float-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#float-returns}

`float`

### Source {#float-source}

`server/vueda/core/config.py:98`

## `int` {#int}

### Signature {#int-signature}

`int(self, key, default)`

#### Parameters {#int-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="int-param-key">key</span> | `str` | yes |  |  |
| <span id="int-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#int-returns}

`int`

### Source {#int-source}

`server/vueda/core/config.py:86`

## `json` {#json}

### Signature {#json-signature}

`json(self, key, default)`

#### Parameters {#json-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="json-param-key">key</span> | `str` | yes |  |  |
| <span id="json-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#json-returns}

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

### Source {#json-source}

`server/vueda/core/config.py:200`

## `list` {#list}

### Signature {#list-signature}

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

#### Parameters {#list-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="list-param-key">key</span> | `str` | yes |  |  |
| <span id="list-param-default">default</span> | `Any` | no | `_MISSING` |  |
| <span id="list-param-delimiter">delimiter</span> | `str` | no | `','` |  |
| <span id="list-param-subcast">subcast</span> | `Callable[[Any], Any] \| None` | no | `None` |  |

#### Returns {#list-returns}

`list[Any]`

### Source {#list-source}

`server/vueda/core/config.py:110`

## `log_level` {#log_level}

### Signature {#log_level-signature}

`log_level(self, key, default)`

#### Parameters {#log_level-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="log_level-param-key">key</span> | `str` | yes |  |  |
| <span id="log_level-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#log_level-returns}

`int`

### Source {#log_level-source}

`server/vueda/core/config.py:303`

## `path` {#path}

### Signature {#path-signature}

`path(self, key, default)`

#### Parameters {#path-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="path-param-key">key</span> | `str` | yes |  |  |
| <span id="path-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#path-returns}

`Path`

### Source {#path-source}

`server/vueda/core/config.py:273`

## `str` {#str}

### Signature {#str-signature}

`str(self, key, default)`

#### Parameters {#str-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="str-param-key">key</span> | `str` | yes |  |  |
| <span id="str-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#str-returns}

`str`

### Source {#str-source}

`server/vueda/core/config.py:213`

## `time` {#time}

### Signature {#time-signature}

`time(self, key, default)`

#### Parameters {#time-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="time-param-key">key</span> | `str` | yes |  |  |
| <span id="time-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#time-returns}

`time`

### Source {#time-source}

`server/vueda/core/config.py:251`

## `timedelta` {#timedelta}

### Signature {#timedelta-signature}

`timedelta(self, key, default)`

#### Parameters {#timedelta-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="timedelta-param-key">key</span> | `str` | yes |  |  |
| <span id="timedelta-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#timedelta-returns}

`timedelta`

### Source {#timedelta-source}

`server/vueda/core/config.py:261`

## `tuple` {#tuple}

### Signature {#tuple-signature}

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

#### Parameters {#tuple-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="tuple-param-key">key</span> | `str` | yes |  |  |
| <span id="tuple-param-default">default</span> | `Any` | no | `_MISSING` |  |
| <span id="tuple-param-delimiter">delimiter</span> | `str` | no | `','` |  |
| <span id="tuple-param-subcast">subcast</span> | `Callable[[Any], Any] \| None` | no | `None` |  |

#### Returns {#tuple-returns}

`tuple[Any, ...]`

### Source {#tuple-source}

`server/vueda/core/config.py:136`

## `url` {#url}

### Signature {#url-signature}

`url(self, key, default)`

#### Parameters {#url-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="url-param-key">key</span> | `str` | yes |  |  |
| <span id="url-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#url-returns}

`ParseResult`

### Source {#url-source}

`server/vueda/core/config.py:283`

## `uuid` {#uuid}

### Signature {#uuid-signature}

`uuid(self, key, default)`

#### Parameters {#uuid-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| self |  | yes |  |  |
| <span id="uuid-param-key">key</span> | `str` | yes |  |  |
| <span id="uuid-param-default">default</span> | `Any` | no | `_MISSING` |  |

#### Returns {#uuid-returns}

`uuid.UUID`

### Source {#uuid-source}

`server/vueda/core/config.py:293`

## Source

`server/vueda/core/config.py:40`