Skip to content

Field

settus.Field ยค

Field(*args, keyvault_url=None, keyvault_credentials=None, **kwargs)

Settus Field

PARAMETER DESCRIPTION
args

Pydantic field args

DEFAULT: ()

keyvault_url

Keyvault URL for this specific field. Overwrite model config.

TYPE: str DEFAULT: None

keyvault_credentials

Keyvault credentials for this specific field. Overwrite model config.

TYPE: TokenCredential DEFAULT: None

kwargs

Pydantic field kwargs

DEFAULT: {}

RETURNS DESCRIPTION
Field

Field

Examples:

from settus import BaseSettings
from settus import Field

class Settings(BaseSettings):
    my_azure_secret: str = Field(
        default="undefined",
        alias="my-secret",
        keyvault_url="https://o3-kv-settus-dev.vault.azure.net/",
    )

settings = Settings()
print(settings)
#> my_azure_secret='secretsauce'
Source code in settus/field.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def Field(
    *args,
    keyvault_url: str = None,
    keyvault_credentials: C = None,
    **kwargs,
) -> _Field:
    """
    Settus Field

    Parameters
    ----------
    args:
        Pydantic field args
    keyvault_url:
        Keyvault URL for this specific field. Overwrite model config.
    keyvault_credentials
        Keyvault credentials for this specific field.  Overwrite model config.
    kwargs
        Pydantic field kwargs

    Returns
    -------
    :
        Field

    Examples
    --------
    ```py
    from settus import BaseSettings
    from settus import Field

    class Settings(BaseSettings):
        my_azure_secret: str = Field(
            default="undefined",
            alias="my-secret",
            keyvault_url="https://o3-kv-settus-dev.vault.azure.net/",
        )

    settings = Settings()
    print(settings)
    #> my_azure_secret='secretsauce'
    ```
    """
    field_info = _Field(
        *args,
        keyvault_url=keyvault_url,
        keyvault_credentials=keyvault_credentials,
        **kwargs,
    )
    # TODO: Create instance of FieldInfo instead of _FieldInfo
    return field_info