コンテンツにスキップ

pytilpack.environ

必要なextra

pip install pytilpack[environ]

pytilpack.environ

環境変数ユーティリティ。

load_dotenv(path=None, override=False)

python-dotenvを使用して.envファイルを読み込む。

ソースコード位置： pytilpack/environ.py 
20
21
22
def load_dotenv(path: str | pathlib.Path | None = None, override: bool = False) -> None:
    """python-dotenvを使用して.envファイルを読み込む。"""
    dotenv.load_dotenv(dotenv_path=path, override=override)

get_str(key, default=_UNSET) 

get_str(key: str) -> str

get_str(key: str, default: str) -> str

環境変数を文字列として取得する。

ソースコード位置： pytilpack/environ.py 
33
34
35
36
37
38
39
40
def get_str(key: str, default: str | _Unset = _UNSET) -> str:
    """環境変数を文字列として取得する。"""
    value = os.environ.get(key)
    if value is None:
        if isinstance(default, _Unset):
            raise ValueError(f"環境変数 {key} が設定されていません")
        return default
    return value

get_int(key, default=_UNSET) 

get_int(key: str) -> int

get_int(key: str, default: int) -> int

環境変数を整数として取得する。

ソースコード位置： pytilpack/environ.py 
51
52
53
54
55
56
57
58
def get_int(key: str, default: int | _Unset = _UNSET) -> int:
    """環境変数を整数として取得する。"""
    value = os.environ.get(key)
    if value is None:
        if isinstance(default, _Unset):
            raise ValueError(f"環境変数 {key} が設定されていません")
        return default
    return pytilpack.python.convert(value, int, 0, errors="strict")

get_float(key, default=_UNSET) 

get_float(key: str) -> float

get_float(key: str, default: float) -> float

環境変数を浮動小数点数として取得する。

ソースコード位置： pytilpack/environ.py 
69
70
71
72
73
74
75
76
def get_float(key: str, default: float | _Unset = _UNSET) -> float:
    """環境変数を浮動小数点数として取得する。"""
    value = os.environ.get(key)
    if value is None:
        if isinstance(default, _Unset):
            raise ValueError(f"環境変数 {key} が設定されていません")
        return default
    return pytilpack.python.convert(value, float, 0.0, errors="strict")

get_bool(key, default=_UNSET) 

get_bool(key: str) -> bool

get_bool(key: str, default: bool) -> bool

環境変数を真偽値として取得する。

ソースコード位置： pytilpack/environ.py 
87
88
89
90
91
92
93
94
def get_bool(key: str, default: bool | _Unset = _UNSET) -> bool:
    """環境変数を真偽値として取得する。"""
    value = os.environ.get(key)
    if value is None:
        if isinstance(default, _Unset):
            raise ValueError(f"環境変数 {key} が設定されていません")
        return default
    return pytilpack.python.convert(value, bool, False, errors="strict")

get_decimal(key, default=_UNSET) 

get_decimal(key: str) -> decimal.Decimal

get_decimal(
    key: str, default: decimal.Decimal
) -> decimal.Decimal

環境変数をDecimalとして取得する。

ソースコード位置： pytilpack/environ.py 
105
106
107
108
109
110
111
112
113
114
115
def get_decimal(key: str, default: decimal.Decimal | _Unset = _UNSET) -> decimal.Decimal:
    """環境変数をDecimalとして取得する。"""
    value = os.environ.get(key)
    if value is None:
        if isinstance(default, _Unset):
            raise ValueError(f"環境変数 {key} が設定されていません")
        return default
    try:
        return decimal.Decimal(value)
    except decimal.InvalidOperation as e:
        raise ValueError(f"環境変数 {key} の値 '{value}' をDecimalに変換できません") from e

get_path(key, default=_UNSET) 

get_path(key: str) -> pathlib.Path

get_path(key: str, default: pathlib.Path) -> pathlib.Path

環境変数をPathとして取得する。

ソースコード位置： pytilpack/environ.py 
126
127
128
129
130
131
132
133
def get_path(key: str, default: pathlib.Path | _Unset = _UNSET) -> pathlib.Path:
    """環境変数をPathとして取得する。"""
    value = os.environ.get(key)
    if value is None:
        if isinstance(default, _Unset):
            raise ValueError(f"環境変数 {key} が設定されていません")
        return default
    return pathlib.Path(value).resolve()

get_list(key, separator=',', *, default=_UNSET) 

get_list(key: str, separator: str = ',') -> list[str]

get_list(
    key: str, separator: str = ",", *, default: list[str]
) -> list[str]

環境変数をリストとして取得する。

セパレータで分割し、各要素の前後の空白を除去し、空文字列を除外する。

ソースコード位置： pytilpack/environ.py 
144
145
146
147
148
149
150
151
152
153
154
def get_list(key: str, separator: str = ",", *, default: list[str] | _Unset = _UNSET) -> list[str]:
    """環境変数をリストとして取得する。

    セパレータで分割し、各要素の前後の空白を除去し、空文字列を除外する。
    """
    value = os.environ.get(key)
    if value is None:
        if isinstance(default, _Unset):
            raise ValueError(f"環境変数 {key} が設定されていません")
        return default
    return [s for s in (item.strip() for item in value.split(separator)) if s]

get_or_none(key)

環境変数を取得する。未設定の場合はNoneを返す。

ソースコード位置： pytilpack/environ.py 
157
158
159
def get_or_none(key: str) -> str | None:
    """環境変数を取得する。未設定の場合はNoneを返す。"""
    return os.environ.get(key)