sdsstools 1.9.2__py3-none-any.whl → 1.9.4__py3-none-any.whl

sdsstools/configuration.py

@@ -15,7 +15,7 @@ import pathlib
 import re
 from copy import deepcopy
 
-from typing import Any, Dict, Optional, Type, TypeVar, Union
+from typing import Any, Dict, Optional, Type, Union
 
 import yaml
 from typing_extensions import Self
@@ -330,7 +330,7 @@ class Configuration(RecursiveDict):
             if isinstance(config, dict):
                 return config
             elif isinstance(config, (str, pathlib.Path)):
-                return read_yaml_file(config)
+                return read_yaml_file(config, return_class=self.__class__)
             else:
                 raise ValueError("Invalid config of type {}".format(type(config)))
 
@@ -385,16 +385,37 @@ class Configuration(RecursiveDict):
         return self
 
 
-ReturnClass = TypeVar("ReturnClass", bound=dict)
-
-
 def read_yaml_file(
     path: AnyPath,
     use_extends: bool = True,
     loader: Any = yaml.FullLoader,
-    return_class: Type[ReturnClass] = Configuration,
-) -> ReturnClass:
-    """Read a YAML file and returns a dictionary."""
+    return_class: Type | None = None,
+    use_variables: bool = True,
+):
+    """Reads a YAML file and returns a dictionary.
+
+    Parameters
+    ----------
+    path
+        The path to the YAML file or a file-like object.
+    use_extends
+        If :obj:`True`, looks for lines starting with ``#!extends <basefile>`` and
+        merges the current file with the base file. This requires both the current and
+        base files to be formatted as dictionaries.
+    loader
+        The YAML loader to use.
+    return_class
+        Casts the read YAML data to ``return_class`` if possible.
+    use_variables
+        If :obj:`True`, looks for a ``variables`` section in the YAML file and
+        replaces occurrences of ``$(VARNAME)`` with the value of that variable.
+
+    Returns
+    -------
+    yaml_data
+        The YAML data as an object of type ``return_class``.
+
+    """
 
     if isinstance(path, (str, pathlib.Path)):
         fp = open(path, "r")
@@ -402,12 +423,24 @@ def read_yaml_file(
         fp = path
 
     fp.seek(0)
-    config: Union[ConfigType, None] = yaml.load(fp, Loader=loader)
+    yaml_data: Union[ConfigType, None] = yaml.load(fp, Loader=loader)
+
+    if yaml_data is None or yaml_data == {}:
+        return (
+            return_class({}) if return_class and issubclass(return_class, dict) else {}
+        )
+
+    if use_variables and isinstance(yaml_data, dict):
+        variables = yaml_data.get("variables", {})
+
+        fp.seek(0)
+        file_content = fp.read()
 
-    if config is None or config == {}:
-        return return_class({})
+        for var, value in variables.items():
+            file_content = re.sub(rf"\$\(\s*{var}\s*\)", str(value), file_content)
+        yaml_data = yaml.load(file_content, Loader=loader)
 
-    if use_extends:
+    if use_extends and isinstance(yaml_data, dict):
         fp.seek(0)
         for line in fp.readlines():
             if line.strip().startswith("#!extends"):
@@ -418,10 +451,10 @@ def read_yaml_file(
                     raise FileExistsError(f"cannot find !extends file {base_file}.")
 
                 base = read_yaml_file(base_file, use_extends=False, return_class=dict)
-                new_config = merge_config(base, config)
-                return return_class(new_config)
+                new_config = merge_config(base, yaml_data)
+                return return_class(new_config) if return_class else new_config
 
             elif line.strip().startswith("#") or line.strip() == "":
                 continue
 
-    return return_class(config)
+    return return_class(yaml_data) if return_class else yaml_data

{sdsstools-1.9.2.dist-info → sdsstools-1.9.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdsstools
-Version: 1.9.2
+Version: 1.9.4
 Summary: Small tools for SDSS products
 Project-URL: Homepage, https://github.com/sdss/sdsstools
 Project-URL: Repository, https://github.com/sdss/sdsstools
@@ -141,6 +141,25 @@ you can use `read_yaml_file` to parse the result
 
 The path to the base file must be absolute or relative to the location of the file to be extended.
 
+### Using variables in YAML files
+
+`read_yaml_file` and `get_config` support the use of variables in YAML files. A special section `variables` can be defined at the top level of the YAML file, and any `$(VAR)` string in the file will be replaced by the value of the variable. For example
+
+```yaml
+variables:
+  greeting: hello
+
+cat1:
+  key1: $(greeting) world
+```
+
+```python
+>>> read_yaml_file('file.yaml', use_variables=True)
+{'cat1': {'key1': 'hello world'}, 'variables': {'greeting': 'hello'}}
+```
+
+Environment variables can also be used by including a `${ENV_VAR}` string in the YAML file, which will be replaced with the content of the `$ENV_VAR` environment variable.
+
 ### The `Configuration` class
 
 By default `get_config()` and `read_yaml_file()` return a `Configuration` instance. For the most part a `Configuration` object is the same as a dictionary, and it can be used as such. It has two main differences:

{sdsstools-1.9.2.dist-info → sdsstools-1.9.4.dist-info}/RECORD

@@ -1,7 +1,7 @@
 sdsstools/__init__.py,sha256=G8u94gRu4THFJvptEITykK0Q_3jHqhQY9p01j9QCQH4,744
 sdsstools/_tasks.py,sha256=U7fvxk9IExzE6voNjio2QqRTw-H9Upu1d0zKQlQFs5I,4263
 sdsstools/cli.py,sha256=e4BS4b1cJThCj5tytajr_VMUvmVP1xYq_r90EtEscg8,1348
-sdsstools/configuration.py,sha256=i2KkrjS5hE4o-d4VDwzWZKacxO-rNKewgDKoeqE3uuQ,13417
+sdsstools/configuration.py,sha256=y_nmF_TN_o68ib2YIpdypHfwggvBpjz_dwKjNd0jzc8,14673
 sdsstools/daemonizer.py,sha256=TMzq3RgD0KqY6jmeeJASlCsw7CjDpLmF8QrENaxCHBU,7796
 sdsstools/logger.py,sha256=nGAC_hDK0dWVMAS-a-vBsw0oSCxAwx-ZsJUE5GMzILs,18382
 sdsstools/metadata.py,sha256=LZWO0KI-gVvzdJNIaVlIn4bBBHxbglU8BLW-MdlxOFA,3268
@@ -15,8 +15,8 @@ sdsstools/_vendor/toml/decoder.py,sha256=hWUJ3UQ43MGVER35rSUUj7Hdh85Vat8Od_B4HeF
 sdsstools/_vendor/toml/encoder.py,sha256=OBRwH2tRUhRI8nJgKBwKbkyQnBAuhcUf60r3wykjPco,9989
 sdsstools/_vendor/toml/ordered.py,sha256=aW5woa5xOqR4BjIz9t10_lghxyhF54KQ7FqUNVv7WJ0,334
 sdsstools/_vendor/toml/tz.py,sha256=8TAiXrTqU08sE0ruz2TXH_pFY2rlwNKE47MSE4rDo8Y,618
-sdsstools-1.9.2.dist-info/METADATA,sha256=9bnqmiMtQf6NMdheCumFfHFjGL9YvAvRzPnUqjceNPw,15027
-sdsstools-1.9.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sdsstools-1.9.2.dist-info/entry_points.txt,sha256=H1UefQFMHyzmGcdNib_qxiOfFSx3351wr4c2ax0PJbQ,87
-sdsstools-1.9.2.dist-info/licenses/LICENSE.md,sha256=_7dAUQQ5Ph_x1hcFXhi9aHBcqq9H11zco12eO4B3Cyg,1504
-sdsstools-1.9.2.dist-info/RECORD,,
+sdsstools-1.9.4.dist-info/METADATA,sha256=MXPK8lZT3NZeTdKjO10nznLWlh0ZPqPtlZG3J3wE9hU,15701
+sdsstools-1.9.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sdsstools-1.9.4.dist-info/entry_points.txt,sha256=H1UefQFMHyzmGcdNib_qxiOfFSx3351wr4c2ax0PJbQ,87
+sdsstools-1.9.4.dist-info/licenses/LICENSE.md,sha256=_7dAUQQ5Ph_x1hcFXhi9aHBcqq9H11zco12eO4B3Cyg,1504
+sdsstools-1.9.4.dist-info/RECORD,,