toml-combine 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

toml_combine/combiner.py

@@ -2,8 +2,7 @@ from __future__ import annotations
 
 import copy
 import dataclasses
-from collections.abc import Mapping, Sequence
-from functools import partial
+from collections.abc import Iterable, Mapping, Sequence
 from typing import Any, TypeVar
 
 from . import exceptions
@@ -59,36 +58,6 @@ def clean_dimensions_dict(
     return result
 
 
-def override_sort_key(
-    override: Override, dimensions: dict[str, list[str]]
-) -> tuple[int, ...]:
-    """
-    We sort overrides before applying them, and they are applied in the order of the
-    sorted list, each override replacing the common values of the previous overrides.
-
-    override_sort_key defines the sort key for overrides that ensures less specific
-    overrides come first:
-    - Overrides with fewer dimensions come first (will be overridden
-      by more specific ones)
-    - If two overrides have the same number of dimensions but define different
-      dimensions, we sort by the definition order of the dimensions.
-
-    Example:
-    dimensions = {"env": ["dev", "prod"], "region": ["us", "eu"]}
-
-    - Override with {"env": "dev"} comes before override with
-      {"env": "dev", "region": "us"} (less specific)
-    - Override with {"env": "dev"} comes before override with {"region": "us"} ("env"
-      is defined before "region" in the dimensions list)
-    """
-    result = [len(override.when)]
-    for i, dimension in enumerate(dimensions):
-        if dimension in override.when:
-            result.append(i)
-
-    return tuple(result)
-
-
 T = TypeVar("T", dict, list, str, int, float, bool)
 
 
@@ -111,6 +80,41 @@ def merge_configs(a: T, b: T, /) -> T:
     return result
 
 
+def extract_keys(config: Any) -> Iterable[tuple[str, ...]]:
+    """
+    Extract the keys from a config.
+    """
+    if isinstance(config, dict):
+        for key, value in config.items():
+            for sub_key in extract_keys(value):
+                yield (key, *sub_key)
+    else:
+        yield tuple()
+
+
+def are_conditions_compatible(
+    a: Mapping[str, list[str]], b: Mapping[str, list[str]], /
+) -> bool:
+    """
+    `a` and `b` are dictionaries representing override conditions (`when`). Return
+    `True` if the conditions represented by `a` are compatible. Conditions are
+    compatible if one is stricly more specific than the other or if they're mutually
+    exclusive.
+    """
+    # Subset
+    if set(a) < set(b) or set(b) < set(a):
+        return True
+
+    # Disjoint or overlapping sets
+    if set(a) != set(b):
+        return False
+
+    # Equal sets: it's only compatible if the values are disjoint
+    if any(set(a[key]) & set(b[key]) for key in a.keys()):
+        return False
+    return True
+
+
 def build_config(config: dict[str, Any]) -> Config:
     config = copy.deepcopy(config)
     # Parse dimensions
@@ -119,7 +123,6 @@ def build_config(config: dict[str, Any]) -> Config:
     # Parse template
     default = config.pop("default", {})
 
-    seen_conditions = set()
     overrides = []
     for override in config.pop("override", []):
         try:
@@ -132,25 +135,10 @@ def build_config(config: dict[str, Any]) -> Config:
             type="override",
         )
 
-        conditions = tuple((k, tuple(v)) for k, v in when.items())
-        if conditions in seen_conditions:
-            raise exceptions.DuplicateError(type="override", id=when)
-
-        seen_conditions.add(conditions)
+        overrides.append(Override(when=when, config=override))
 
-        overrides.append(
-            Override(
-                when=clean_dimensions_dict(
-                    to_sort=when, clean=dimensions, type="override"
-                ),
-                config=override,
-            )
-        )
     # Sort overrides by increasing specificity
-    overrides = sorted(
-        overrides,
-        key=partial(override_sort_key, dimensions=dimensions),
-    )
+    overrides = sorted(overrides, key=lambda override: len(override.when))
 
     return Config(
         dimensions=dimensions,
@@ -159,7 +147,7 @@ def build_config(config: dict[str, Any]) -> Config:
     )
 
 
-def mapping_matches_override(mapping: dict[str, str], override: Override) -> bool:
+def mapping_matches_override(mapping: Mapping[str, str], override: Override) -> bool:
     """
     Check if the values in the override match the given dimensions.
     """
@@ -174,16 +162,32 @@ def mapping_matches_override(mapping: dict[str, str], override: Override) -> boo
 
 
 def generate_for_mapping(
-    default: Mapping[str, Any],
-    overrides: Sequence[Override],
-    mapping: dict[str, str],
-) -> dict[str, Any]:
-    result = copy.deepcopy(default)
+    config: Config,
+    mapping: Mapping[str, str],
+) -> Mapping[str, Any]:
+    result = copy.deepcopy(config.default)
+    keys_to_conditions: dict[tuple[str, ...], list[dict[str, list[str]]]] = {}
     # Apply each matching override
-    for override in overrides:
+    for override in config.overrides:
         # Check if all dimension values in the override match
 
         if mapping_matches_override(mapping=mapping, override=override):
+            # Check that all applicableoverrides are compatible
+            keys = extract_keys(override.config)
+
+            for key in keys:
+                previous_conditions = keys_to_conditions.setdefault(key, [])
+
+                for previous_condition in previous_conditions:
+                    if not are_conditions_compatible(previous_condition, override.when):
+                        raise exceptions.DuplicateError(
+                            id=override.when,
+                            key=".".join(key),
+                            other_override=previous_condition,
+                        )
+
+                keys_to_conditions[key].append(override.when)
+
             result = merge_configs(result, override.config)
 
     return result

toml_combine/exceptions.py

@@ -20,7 +20,7 @@ class TomlEncodeError(TomlCombineError):
 
 
 class DuplicateError(TomlCombineError):
-    """In {type} {id}: Cannot have multiple {type}s with the same dimensions."""
+    """In override {id}: Overrides defining the same configuration keys must be included in one another or mutually exclusive.\nKey defined multiple times: {key}\nOther override: {other_override}"""
 
 
 class DimensionNotFound(TomlCombineError):

toml_combine/lib.py

@@ -52,7 +52,6 @@ def combine(*, config=None, config_file=None, **mapping):
     config_obj = combiner.build_config(dict_config)
 
     return combiner.generate_for_mapping(
-        default=config_obj.default,
-        overrides=config_obj.overrides,
+        config=config_obj,
         mapping=mapping,
     )

{toml_combine-0.4.0.dist-info → toml_combine-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: toml-combine
-Version: 0.4.0
+Version: 0.6.0
 Summary: A tool for combining complex configurations in TOML format.
 Author-email: Joachim Jablon <ewjoachim@gmail.com>
 License-Expression: MIT
@@ -29,7 +29,7 @@ parts that are common to everyone.
 
 ### The config file
 
-The configuration file is usually a TOML file. Here's a small example:
+The configuration file is (usually) a TOML file. Here's a small example:
 
 ```toml
 [dimensions]
@@ -62,14 +62,19 @@ The common configuration to start from, before we start overlaying overrides on
 ### Overrides
 
 Overrides define a set of condition where they apply (`when.<dimension> =
-"<value>"`) and the values that are overriden. Overrides are applied in order from less
-specific to more specific, each one overriding the values of the previous ones:
+"<value>"`) and the values that are overridden when they're applicable.
 
-- If an override contains conditions on more dimensions than another one, it's applied
-  later
-- In case 2 overrides contain the same number of dimensions and they're a disjoint set,
-  then it depends on how the dimensions are defined at the top of the file: dimensions
-  defined last have a greater priority
+- In case 2 overrides are applicable and define a value for the same key, if one is more
+  specific than the other (e.g. env=prod,region=us is more specific than env=prod) then
+  its values will have precedence.
+- If they are mutually exclusive, (env=prod vs env=staging) precedence is irrelevant.
+- If you try to generate the configuration and 2 applicable overrides define a value for
+  the same key, an error will be raised (e.g. env=staging and region=eu). In that case,
+  you should add dimensions to either override to make them mutually exclusive or make
+  one more specific than the other.
+
+  Note that it's not a problem if incompatible overrides exist in your configuration, as
+  long as they are not both applicable in the same call.
 
 > [!Note]
 > Defining a list as the value of one or more conditions in an override
@@ -77,14 +82,11 @@ specific to more specific, each one overriding the values of the previous ones:
 
 ### The configuration itself
 
-Under the layer of `dimensions/default/override/mapping` system, what you actually define
-in the configuration is completely up to you. That said, only nested
+Under the layer of `dimensions/default/override/mapping` system, what you actually
+define in the configuration is completely up to you. That said, only nested
 "dictionnaries"/"objects"/"tables"/"mapping" (those are all the same things in
-Python/JS/Toml lingo) will be merged between the default and the overrides, while
-arrays will just replace one another. See `Arrays` below.
-
-In the generated configuration, the dimensions of the output will appear in the generated
-object as an object under the `dimensions` key.
+Python/JS/Toml lingo) will be merged between the default and the applicable overrides,
+while arrays will just replace one another. See `Arrays` below.
 
 ### Arrays
 
@@ -141,9 +143,9 @@ Example with the config from the previous section:
 
 ```console
 $ toml-combine path/to/config.toml --environment=staging
-[dimensions]
-environment = "staging"
+```
 
+```toml
 [fruits]
 apple.color = "red"
 orange.color = "orange"
@@ -188,8 +190,9 @@ container.image_name = "my-image-backend"
 container.port = 8080
 
 [[override]]
-name = "service-dev"
+when.service = "backend"
 when.environment = "dev"
+name = "service-dev"
 container.env.DEBUG = true
 
 [[override]]
@@ -202,6 +205,9 @@ This produces the following configs:
 
 ```console
 $ toml-combine example.toml --environment=production --service=frontend
+```
+
+```toml
 registry = "gcr.io/my-project/"
 service_account = "my-service-account"
 name = "service-frontend"
@@ -212,6 +218,9 @@ image_name = "my-image-frontend"
 
 ```console
 $ toml-combine example.toml --environment=production --service=backend
+```
+
+```toml
 registry = "gcr.io/my-project/"
 service_account = "my-service-account"
 name = "service-backend"
@@ -223,6 +232,9 @@ port = 8080
 
 ```console
 $ toml-combine example.toml --environment=staging --service=frontend
+```
+
+```toml
 registry = "gcr.io/my-project/"
 service_account = "my-service-account"
 name = "service-frontend"
@@ -233,6 +245,9 @@ image_name = "my-image-frontend"
 
 ```console
 $ toml-combine example.toml --environment=staging --service=backend
+```
+
+```toml
 registry = "gcr.io/my-project/"
 service_account = "my-service-account"
 name = "service-backend"
@@ -247,6 +262,9 @@ ENABLE_EXPENSIVE_MONITORING = false
 
 ```console
 $ toml-combine example.toml --environment=dev --service=backend
+```
+
+```toml
 registry = "gcr.io/my-project/"
 service_account = "my-service-account"
 name = "service-backend"
@@ -257,5 +275,4 @@ port = 8080
 [container.env]
 DEBUG = true
 ENABLE_EXPENSIVE_MONITORING = false
-
 ```

toml_combine-0.6.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+toml_combine/__init__.py,sha256=TDkOwwEM-nS6hOh79u9Qae6g2Q6VfANpPpnKGfSgu80,84
+toml_combine/__main__.py,sha256=hmF8N8xX6UEApzbKTVZ-4E1HU5-rjgUkdXNLO-mF6vo,100
+toml_combine/cli.py,sha256=hG03eDKz7xU-ydJIa1kDuu6WlFzNS3GTMJ6zals9M9c,2843
+toml_combine/combiner.py,sha256=nwq3q06UhXZkM2Nch_gEnn7K8WUlKbbYxFk1myH63CE,5649
+toml_combine/exceptions.py,sha256=2b-EkmSoe6bbuE7txDVjEDuix_9bfLQrapkNhy8i-lU,1109
+toml_combine/lib.py,sha256=jh6OG57JefpGa-WE-mLSIK6KjyJ0-1yGBynr_kiVTww,1634
+toml_combine/toml.py,sha256=iBV8xj0qWcvGp2AZaML8FCT3i2X9DL7iA6jd-wcP5Bc,814
+toml_combine-0.6.0.dist-info/METADATA,sha256=1TbVtui8W4B4zumo-rCpPnnuxx83GD5Xkyk-rRqCE5E,7625
+toml_combine-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+toml_combine-0.6.0.dist-info/entry_points.txt,sha256=dXUQNom54uZt_7ylEG81iNYMamYpaFo9-ItcZJU6Uzc,58
+toml_combine-0.6.0.dist-info/RECORD,,

toml_combine-0.4.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-toml_combine/__init__.py,sha256=TDkOwwEM-nS6hOh79u9Qae6g2Q6VfANpPpnKGfSgu80,84
-toml_combine/__main__.py,sha256=hmF8N8xX6UEApzbKTVZ-4E1HU5-rjgUkdXNLO-mF6vo,100
-toml_combine/cli.py,sha256=hG03eDKz7xU-ydJIa1kDuu6WlFzNS3GTMJ6zals9M9c,2843
-toml_combine/combiner.py,sha256=RhhCevncnVvxFYNywvtVWkVMpiqtF0mq_APjg76Tg4Q,5546
-toml_combine/exceptions.py,sha256=tAFTDRSg6d10bBruBhsasZXrNNgLTmr_nKfvIsRR_yU,991
-toml_combine/lib.py,sha256=Iw7F8SCyQMlhaqSD2vtnmM6jbnrgzCZeX0d-LTM3VVg,1683
-toml_combine/toml.py,sha256=iBV8xj0qWcvGp2AZaML8FCT3i2X9DL7iA6jd-wcP5Bc,814
-toml_combine-0.4.0.dist-info/METADATA,sha256=WKLq2pGpPRwfLhdpBuqxoAtCwVKXipgcega_4GTl_r4,7347
-toml_combine-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-toml_combine-0.4.0.dist-info/entry_points.txt,sha256=dXUQNom54uZt_7ylEG81iNYMamYpaFo9-ItcZJU6Uzc,58
-toml_combine-0.4.0.dist-info/RECORD,,