envTOML 0.2.1__py3-none-any.whl

envtoml/__init__.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+import json
+import os
+import re
+import sys
+from datetime import date, datetime, time
+from typing import Any, BinaryIO, Callable, Dict, List, Match, Optional, Union
+
+if sys.version_info >= (3, 11):
+    import tomllib
+else:  # pragma: no cover - fallback for Python < 3.11
+    import tomli as tomllib
+
+__version__ = '0.2.1'
+
+RE_ENV_VAR: str = r'\$([A-Z_][A-Z0-9_]+)'
+
+TOMLDict = Dict[str, 'TOMLValue']
+TOMLList = List['TOMLValue']
+TOMLPrimitive = Union[str, int, float, bool, datetime, date, time]
+TOMLValue = Union[TOMLPrimitive, TOMLDict, TOMLList]
+ParseFloat = Callable[[str], float]
+
+
+def env_replace(match: Match[str]) -> str:
+    env_var = match.group(1)
+    return os.environ.get(env_var, '')
+
+
+def _load_inline_value(value: str, parse_float: ParseFloat) -> TOMLValue:
+    data = tomllib.loads(f'v = {value}', parse_float=parse_float)
+    return data['v']
+
+
+def _replace_env_value(
+    value: str,
+    parse_float: ParseFloat,
+) -> Optional[TOMLValue]:
+    if not re.match(RE_ENV_VAR, value):
+        return None
+
+    replaced = re.sub(RE_ENV_VAR, env_replace, value)
+
+    # Try to parse the value as TOML (float, bool, inline table, etc.).
+    # If that fails, fall back to a basic string.
+    try:
+        return _load_inline_value(replaced, parse_float)
+    except tomllib.TOMLDecodeError:
+        quoted = json.dumps(replaced)
+        return _load_inline_value(quoted, parse_float)
+
+
+def process(item: TOMLValue, parse_float: ParseFloat) -> None:
+    if isinstance(item, dict):
+        for key, val in item.items():
+            if isinstance(val, (dict, list)):
+                process(val, parse_float)
+            elif isinstance(val, str):
+                replaced = _replace_env_value(val, parse_float)
+                if replaced is not None:
+                    item[key] = replaced
+    elif isinstance(item, list):
+        for index, val in enumerate(item):
+            if isinstance(val, (dict, list)):
+                process(val, parse_float)
+            elif isinstance(val, str):
+                replaced = _replace_env_value(val, parse_float)
+                if replaced is not None:
+                    item[index] = replaced
+
+
+def load(
+    fp: BinaryIO,
+    /,
+    *,
+    parse_float: ParseFloat = float,
+) -> dict[str, Any]:
+    """Parse TOML from a binary file object and replace environment variables.
+
+    Args:
+        fp: Binary file object to read.
+        parse_float: Callable to parse TOML float values.
+    """
+    data = tomllib.load(fp, parse_float=parse_float)
+    process(data, parse_float)
+    return data
+
+
+def loads(
+    s: str,
+    /,
+    *,
+    parse_float: ParseFloat = float,
+) -> dict[str, Any]:
+    """Parse TOML from a string and replace environment variables.
+
+    Args:
+        s: TOML string to parse.
+        parse_float: Callable to parse TOML float values.
+    """
+    data = tomllib.loads(s, parse_float=parse_float)
+    process(data, parse_float)
+    return data

envtoml-0.2.1.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: envTOML
+Version: 0.2.1
+Summary: A simple way of using environment variables in TOML configs (via interpolation)
+Project-URL: Repository, https://github.com/mrshu/envtoml
+Author-email: "mr.Shu" <mr@shu.io>
+License: MIT
+License-File: LICENSE
+Keywords: TOML,config,environment,variables
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Description-Content-Type: text/x-rst
+
+envTOML
+=======
+
+.. image:: https://img.shields.io/pypi/v/envtoml.svg
+    :target: https://pypi.python.org/pypi/envtoml
+    :alt: PyPI Status
+
+.. image:: https://img.shields.io/pypi/pyversions/envtoml.svg
+    :target: https://pypi.python.org/pypi/envtoml
+    :alt: Python Versions
+
+.. image:: https://img.shields.io/pypi/wheel/envtoml.svg
+    :target: https://pypi.python.org/pypi/envtoml
+    :alt: Wheel Status
+
+.. image:: https://img.shields.io/pypi/dm/envtoml.svg
+    :target: https://pypi.python.org/pypi/envtoml
+    :alt: PyPI Downloads
+
+.. image:: https://coveralls.io/repos/github/mrshu/envtoml/badge.svg?branch=master
+    :target: https://coveralls.io/github/mrshu/envtoml?branch=master
+    :alt: Code coverage Status
+
+.. image:: https://img.shields.io/pypi/l/envtoml.svg
+   :target: ./LICENSE
+   :alt: License Status
+
+``envTOML`` is an answer to a fairly simple problem: including values from
+environment variables in TOML configuration files. In this way, it is very
+similar to both `envyaml <https://github.com/thesimj/envyaml>`_ and
+`varyaml <https://github.com/abe-winter/varyaml>`_ which provide very
+similar functionality for YAML and which greatly inspired this small
+package.
+
+Under the hood it uses the standard library ``tomllib`` (and ``tomli`` as a
+fallback for Python < 3.11).
+
+Example
+-------
+
+Suppose we have the following configuration saved in ``config.toml``
+
+.. code:: toml
+
+  [db]
+  host = "$DB_HOST"
+  port = "$DB_PORT"
+  username = "$DB_USERNAME"
+  password = "$DB_PASSWORD"
+  name = "my_database"
+
+with the environment variables being set to the following
+
+.. code::
+
+  DB_HOST=some-host.tld
+  DB_PORT=3306
+  DB_USERNAME=user01
+  DB_PASSWORD=veryToughPas$w0rd
+
+this config can then be parsed with ``envTOML`` in the following way:
+
+
+.. code:: python
+
+  import envtoml
+
+  cfg = envtoml.load(open('./config.toml', 'rb'))
+
+  print(cfg)
+  # {'db': {'host': 'some-host.tld',
+  #   'port': 3306,
+  #   'username': 'user01',
+  #   'password': 'veryToughPas$w0rd',
+  #   'name': 'my_database'}}
+
+Tests
+-----
+
+This project uses `uv <https://github.com/astral-sh/uv>`_. After installing it,
+run the following from the project's root directory:
+
+.. code:: bash
+
+    uv sync --group dev
+    uv run pytest
+
+For coverage:
+
+.. code:: bash
+
+    uv run pytest --cov=envtoml
+
+
+License
+-------
+
+Licensed under the MIT license (see `LICENSE <./LICENSE>`_ file for more
+details).

envtoml-0.2.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+envtoml/__init__.py,sha256=D7CAJLiCnKt5IorC0KOmv8REfjpw_Gzv05iC35k97mk,2957
+envtoml/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+envtoml-0.2.1.dist-info/METADATA,sha256=Gif0oqkB8zjvw_bb_dvLYWjyZbo0VCAipT0_h0QUiOs,3434
+envtoml-0.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+envtoml-0.2.1.dist-info/licenses/LICENSE,sha256=t7ueYYR3D93iNvDVAAz3I5MI-TuywdhWvxInchEN5X0,1068
+envtoml-0.2.1.dist-info/RECORD,,

envtoml-0.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

envtoml-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Marek Suppa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.