toml-combine 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

{toml_combine-1.0.0.dist-info → toml_combine-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: toml-combine
-Version: 1.0.0
+Version: 1.0.1
 Summary: A tool for combining complex configurations in TOML format.
 Author-email: Joachim Jablon <ewjoachim@gmail.com>
 License-Expression: MIT
@@ -74,18 +74,28 @@ Overrides define a set of condition where they apply (`when.<dimension> =
 - 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.
+- If 2 applicable overrides both define a dimension that the other one doesn't, they're
+  incompatible, and running the tool with a configuration that would select both of them
+  will yield an error.
+
+  Examples:
+  - Override 1: `env=staging` & Override 2: `region=eu` are incompatible (1 defines
+    `env` not in 2, 2 defines `region` not in 1).
+  - Override 1: `env=staging` & Override 2: `env=staging, region=eu` are compatible
+    (all dimensions defined in 1 are also in 2)
+  - Override 1: `env=staging` & Override 2: `env=prod` are compatible
+    (they define the same dimensions)
+  - Override 1: `env=staging, service=frontend` & Override 2: `region=eu, service=frontend`
+    are incompatible (1 defines `env` not in 2, 2 defines `region` not in 1)
 
 > [!Note]
-> Defining a list as the value of one or more conditions in an override
-> means that the override will apply to any of the dimension values of the list
+> Instead of defining a single value for the override dimensions, you can define a list.
+> This is a shortcut to duplicating the override with each individual value:
+> ```
+> [[override]]
+> when.environment = ["staging", "prod"]
+> service_account = "my-service-account"
+> ```
 
 ### The configuration itself
 

{toml_combine-1.0.0.dist-info → toml_combine-1.0.1.dist-info}/RECORD

@@ -5,8 +5,8 @@ toml_combine/combiner.py,sha256=HG7KV3EGwmcHOMruhp7sMkH-uXqWKpsO7_BvhNQ2KQY,5668
 toml_combine/exceptions.py,sha256=cRAZhxg3OHgzp5hJzyxNGG_jvGUm8gG8XzndQXBhvo8,1116
 toml_combine/lib.py,sha256=jh6OG57JefpGa-WE-mLSIK6KjyJ0-1yGBynr_kiVTww,1634
 toml_combine/toml.py,sha256=iBV8xj0qWcvGp2AZaML8FCT3i2X9DL7iA6jd-wcP5Bc,814
-toml_combine-1.0.0.dist-info/METADATA,sha256=JxCXUhIW1v3MyM1ut0ZXbE6B6IuiXj4bf0YpwvlxGCw,8466
-toml_combine-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-toml_combine-1.0.0.dist-info/entry_points.txt,sha256=dXUQNom54uZt_7ylEG81iNYMamYpaFo9-ItcZJU6Uzc,58
-toml_combine-1.0.0.dist-info/licenses/LICENSE,sha256=tA7wpipzIPGl7xL5xzMMg0RhhXz9CKOa-ZnlYzgiTKg,1059
-toml_combine-1.0.0.dist-info/RECORD,,
+toml_combine-1.0.1.dist-info/METADATA,sha256=K0j97FCiS7tpENiP_HVoxE1b6_nLDqk_E1OklTtFhpk,8812
+toml_combine-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+toml_combine-1.0.1.dist-info/entry_points.txt,sha256=dXUQNom54uZt_7ylEG81iNYMamYpaFo9-ItcZJU6Uzc,58
+toml_combine-1.0.1.dist-info/licenses/LICENSE,sha256=tA7wpipzIPGl7xL5xzMMg0RhhXz9CKOa-ZnlYzgiTKg,1059
+toml_combine-1.0.1.dist-info/RECORD,,