Skip to content

Commit 6c55c16

Browse files
mgornymgorny
committed
Use title case for Core Metadata keys
Fixes #93
1 parent f7ca718 commit 6c55c16

File tree

5 files changed

+46
-46
lines changed

5 files changed

+46
-46
lines changed

‎tests/test_api.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ def test_set_variant_metadata(
317317
metadata["variant-property"] = "a :: b :: c"
318318
metadata["VARIANT-REQUIRES"] = "ns1: frobnicate"
319319
metadata["variant-requires"] = "ns2: barnicate"
320-
metadata["Variant-requires"] = "ns3: baznicate"
320+
metadata["Variant-Requires"] = "ns3: baznicate"
321321
metadata["variant-property"] = "d :: e :: f"
322322
metadata["VARIANT-plugin-API"] = "ns1: frobnicate:Plugin"
323323
metadata["variant-Plugin-apI"] = "ns2: barnicate.plugin:BarPlugin"
@@ -345,26 +345,26 @@ def test_set_variant_metadata(
345345
"Metadata-Version: 2.1\n"
346346
"Name: test-package\n"
347347
"Version: 1.2.3\n"
348-
"Variant-property: ns1 :: f1 :: p1\n"
349-
"Variant-property: ns1 :: f2 :: p2\n"
350-
"Variant-property: ns2 :: f1 :: p1\n"
351-
"Variant-hash: 67fcaf38\n"
348+
"Variant-Property: ns1 :: f1 :: p1\n"
349+
"Variant-Property: ns1 :: f2 :: p2\n"
350+
"Variant-Property: ns2 :: f1 :: p1\n"
351+
"Variant-Hash: 67fcaf38\n"
352352
)
353353

354354
if pyproject_toml is not None:
355355
expected += (
356-
"Variant-requires: ns1: ns1-provider >= 1.2.3\n"
357-
"Variant-enable-if: ns1: python_version >= '3.12'\n"
358-
"Variant-plugin-api: ns1: ns1_provider.plugin:NS1Plugin\n"
359-
"Variant-requires: ns2: ns2_provider; python_version >= '3.11'\n"
360-
"Variant-requires: ns2: old_ns2_provider; python_version < '3.11'\n"
361-
"Variant-plugin-api: ns2: ns2_provider:Plugin\n"
362-
"Variant-default-namespace-priorities: ns1, ns2\n"
356+
"Variant-Requires: ns1: ns1-provider >= 1.2.3\n"
357+
"Variant-Enable-If: ns1: python_version >= '3.12'\n"
358+
"Variant-Plugin-API: ns1: ns1_provider.plugin:NS1Plugin\n"
359+
"Variant-Requires: ns2: ns2_provider; python_version >= '3.11'\n"
360+
"Variant-Requires: ns2: old_ns2_provider; python_version < '3.11'\n"
361+
"Variant-Plugin-API: ns2: ns2_provider:Plugin\n"
362+
"Variant-Default-Namespace-Priorities: ns1, ns2\n"
363363
)
364364
if pyproject_toml is PYPROJECT_TOML:
365365
expected += (
366-
"Variant-default-feature-priorities: ns2 :: f1, ns1 :: f2\n"
367-
"Variant-default-property-priorities: ns1 :: f2 :: p1, ns2 :: f1 :: p2\n"
366+
"Variant-Default-Feature-Priorities: ns2 :: f1, ns1 :: f2\n"
367+
"Variant-Default-Property-Priorities: ns1 :: f2 :: p1, ns2 :: f1 :: p2\n"
368368
)
369369

370370
expected += "\nlong description\nof a package\n"

‎tests/test_dist_metadata.py

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@
3434

3535
TEST_METADATA = f"""\
3636
{COMMON_METADATA}
37-
Variant-property: ns1 :: f1 :: p1
37+
Variant-Property: ns1 :: f1 :: p1
3838
Variant-Property: ns1 :: f2 :: p2
39-
Variant-property: ns2 :: f1 :: p1
39+
Variant-Property: ns2 :: f1 :: p1
4040
Variant-Hash: 67fcaf38
4141
Variant-Requires: ns1: ns1-provider >= 1.2.3
4242
Variant-Enable-If: ns1: python_version >= '3.12'
@@ -149,7 +149,7 @@ def test_missing_plugin_api():
149149
ValidationError,
150150
match=rf"{METADATA_VARIANT_PROVIDER_REQUIRES_HEADER} and "
151151
rf"{METADATA_VARIANT_PROVIDER_ENABLE_IF_HEADER} include namespaces "
152-
r"that are not included in Variant-plugin-api",
152+
r"that are not included in Variant-Plugin-API",
153153
):
154154
DistMetadata(message_from_string(mangled))
155155

@@ -266,19 +266,19 @@ def test_update_message(message: Message):
266266
"Metadata-Version: 2.1\n"
267267
"Name: test-package\n"
268268
"Version: 1.2.3\n"
269-
"Variant-property: ns1 :: f1 :: p1\n"
270-
"Variant-property: ns1 :: f2 :: p2\n"
271-
"Variant-property: ns2 :: f1 :: p1\n"
272-
"Variant-hash: 67fcaf38\n"
273-
"Variant-requires: ns1: ns1-provider >= 1.2.3\n"
274-
"Variant-enable-if: ns1: python_version >= '3.12'\n"
275-
"Variant-plugin-api: ns1: ns1_provider.plugin:NS1Plugin\n"
276-
"Variant-requires: ns2: ns2_provider; python_version >= '3.11'\n"
277-
"Variant-requires: ns2: old_ns2_provider; python_version < '3.11'\n"
278-
"Variant-plugin-api: ns2: ns2_provider:Plugin\n"
279-
"Variant-default-namespace-priorities: ns1, ns2\n"
280-
"Variant-default-feature-priorities: ns2 :: f1, ns1 :: f2\n"
281-
"Variant-default-property-priorities: ns1 :: f2 :: p1, ns2 :: f1 :: p2\n"
269+
"Variant-Property: ns1 :: f1 :: p1\n"
270+
"Variant-Property: ns1 :: f2 :: p2\n"
271+
"Variant-Property: ns2 :: f1 :: p1\n"
272+
"Variant-Hash: 67fcaf38\n"
273+
"Variant-Requires: ns1: ns1-provider >= 1.2.3\n"
274+
"Variant-Enable-If: ns1: python_version >= '3.12'\n"
275+
"Variant-Plugin-API: ns1: ns1_provider.plugin:NS1Plugin\n"
276+
"Variant-Requires: ns2: ns2_provider; python_version >= '3.11'\n"
277+
"Variant-Requires: ns2: old_ns2_provider; python_version < '3.11'\n"
278+
"Variant-Plugin-API: ns2: ns2_provider:Plugin\n"
279+
"Variant-Default-Namespace-Priorities: ns1, ns2\n"
280+
"Variant-Default-Feature-Priorities: ns2 :: f1, ns1 :: f2\n"
281+
"Variant-Default-Property-Priorities: ns1 :: f2 :: p1, ns2 :: f1 :: p2\n"
282282
"\n"
283283
"long description\n"
284284
"of a package\n"

‎tests/test_plugins.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -376,12 +376,12 @@ def test_load_plugin_invalid_arg():
376376
Metadata-Version: 2.1
377377
Name: test-package
378378
Version: 1.2.3
379-
Variant-property: test_namespace :: name1 :: val1a
380-
Variant-property: second_namespace :: name3 :: val3c
381-
Variant-hash: faf70e73
382-
Variant-plugin-api: test_namespace: tests.mocked_plugins:MockedPluginA
383-
Variant-plugin-api: second_namespace: tests.mocked_plugins:MockedPluginB
384-
Variant-default-namespace-priorities: test_namespace, second_namespace
379+
Variant-Property: test_namespace :: name1 :: val1a
380+
Variant-Property: second_namespace :: name3 :: val3c
381+
Variant-Hash: faf70e73
382+
Variant-Plugin-API: test_namespace: tests.mocked_plugins:MockedPluginA
383+
Variant-Plugin-API: second_namespace: tests.mocked_plugins:MockedPluginB
384+
Variant-Default-Namespace-Priorities: test_namespace, second_namespace
385385
""")
386386
),
387387
VariantPyProjectToml(

‎variantlib/constants.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@
2626
VARIANTS_JSON_VARIANT_DATA_KEY = "variants"
2727

2828
# fmt: off
29-
METADATA_VARIANT_HASH_HEADER = "Variant-hash"
30-
METADATA_VARIANT_PROPERTY_HEADER = "Variant-property"
31-
METADATA_VARIANT_DEFAULT_PRIO_FEATURE_HEADER = f"Variant-default-{PYPROJECT_TOML_FEATURE_KEY}-priorities" # noqa: E501
32-
METADATA_VARIANT_DEFAULT_PRIO_NAMESPACE_HEADER = f"Variant-default-{PYPROJECT_TOML_NAMESPACE_KEY}-priorities" # noqa: E501
33-
METADATA_VARIANT_DEFAULT_PRIO_PROPERTY_HEADER = f"Variant-default-{PYPROJECT_TOML_PROPERTY_KEY}-priorities" # noqa: E501
34-
METADATA_VARIANT_PROVIDER_ENABLE_IF_HEADER = f"Variant-{PYPROJECT_TOML_PROVIDER_ENABLE_IF_KEY}" # noqa: E501
35-
METADATA_VARIANT_PROVIDER_PLUGIN_API_HEADER = f"Variant-{PYPROJECT_TOML_PROVIDER_PLUGIN_API_KEY}" # noqa: E501
36-
METADATA_VARIANT_PROVIDER_REQUIRES_HEADER = f"Variant-{PYPROJECT_TOML_PROVIDER_REQUIRES_KEY}" # noqa: E501
29+
METADATA_VARIANT_HASH_HEADER = "Variant-Hash"
30+
METADATA_VARIANT_PROPERTY_HEADER = "Variant-Property"
31+
METADATA_VARIANT_DEFAULT_PRIO_FEATURE_HEADER = "Variant-Default-Feature-Priorities"
32+
METADATA_VARIANT_DEFAULT_PRIO_NAMESPACE_HEADER = "Variant-Default-Namespace-Priorities"
33+
METADATA_VARIANT_DEFAULT_PRIO_PROPERTY_HEADER = "Variant-Default-Property-Priorities"
34+
METADATA_VARIANT_PROVIDER_ENABLE_IF_HEADER = "Variant-Enable-If"
35+
METADATA_VARIANT_PROVIDER_PLUGIN_API_HEADER = "Variant-Plugin-API"
36+
METADATA_VARIANT_PROVIDER_REQUIRES_HEADER = "Variant-Requires"
3737
# fmt: on
3838

3939
METADATA_ALL_HEADERS = (

‎variantlib/models/variant.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def feature_hash(self) -> int:
6060
return hash((VariantFeature, self.namespace, self.feature))
6161

6262
def to_str(self) -> str:
63-
# Variant-property: <namespace> :: <feature> :: <val>
63+
# Variant-Property: <namespace> :: <feature> :: <val>
6464
return f"{self.namespace} :: {self.feature}"
6565

6666
def serialize(self) -> dict[str, str]:
@@ -115,7 +115,7 @@ def feature_object(self) -> VariantFeature:
115115
return VariantFeature(namespace=self.namespace, feature=self.feature)
116116

117117
def to_str(self) -> str:
118-
# Variant-property: <namespace> :: <feature> :: <val>
118+
# Variant-Property: <namespace> :: <feature> :: <val>
119119
return f"{self.namespace} :: {self.feature} :: {self.value}"
120120

121121
@classmethod

0 commit comments

Comments
 (0)