Introduce a VariantDistInfo subclass (and clean up metadata refs) (#100)

* Introduce a `WheelMetadata` subclass

Introduce a `WheelMetadata` subclass that provides a more convenient
API to access the `variant.json` data from wheels.  Notably, it adds
verification that the file contains only one variant (with an option
to verify its hash against the filename) and properties to query
the variant description and hash, and to set it.

* Rename `WheelMetadata` to `VariantDistInfo`

* Rename `VariantMetadata` to `VariantInfo`

* Rename `VARIANT_METADATA_*` to `VARIANT_INFO_*`

* Rename `*wheel_metadata.py` to `*variant_dist_info.py`

* Rename `models/metadata.py` to `models/variant_info.py`

* Remove obsolete `VALIDATION_METADATA*` constants

* Update the remaining metadata references and improve consistency

Author: mgorny

tests/plugins/test_loader.py

@@ -9,12 +9,12 @@
 from variantlib.errors import PluginError
 from variantlib.errors import PluginMissingError
 from variantlib.errors import ValidationError
-from variantlib.models.metadata import ProviderInfo
-from variantlib.models.metadata import VariantMetadata
 from variantlib.models.provider import ProviderConfig
 from variantlib.models.provider import VariantFeatureConfig
 from variantlib.models.variant import VariantDescription
 from variantlib.models.variant import VariantProperty
+from variantlib.models.variant_info import ProviderInfo
+from variantlib.models.variant_info import VariantInfo
 from variantlib.plugins.loader import BasePluginLoader
 from variantlib.plugins.loader import EntryPointPluginLoader
 from variantlib.plugins.loader import ListPluginLoader
@@ -377,9 +377,9 @@ def test_load_plugin_invalid_arg() -> None:
 
 
 @pytest.mark.parametrize(
-    "metadata",
+    "variant_info",
     [
-        VariantMetadata(
+        VariantInfo(
             namespace_priorities=[
                 "test_namespace",
                 "second_namespace",
@@ -433,8 +433,8 @@ def test_load_plugin_invalid_arg() -> None:
         ),
     ],
 )
-def test_load_plugins_from_metadata(metadata: VariantMetadata) -> None:
-    with PluginLoader(metadata, use_auto_install=False) as loader:
+def test_load_plugins_from_variant_info(variant_info: VariantInfo) -> None:
+    with PluginLoader(variant_info, use_auto_install=False) as loader:
         assert set(loader.namespaces) == {"test_namespace", "second_namespace"}
 
 
@@ -448,7 +448,7 @@ def test_load_plugins_from_entry_points(mocked_entry_points: None) -> None:
 
 
 def test_install_plugin(test_plugin_package_req: str) -> None:
-    metadata = VariantMetadata(
+    variant_info = VariantInfo(
         namespace_priorities=["installable_plugin"],
         providers={
             "installable_plugin": ProviderInfo(
@@ -458,12 +458,12 @@ def test_install_plugin(test_plugin_package_req: str) -> None:
         },
     )
 
-    with PluginLoader(metadata, use_auto_install=True, isolated=True) as loader:
+    with PluginLoader(variant_info, use_auto_install=True, isolated=True) as loader:
         assert set(loader.namespaces) == {"installable_plugin"}
 
 
 def test_no_plugin_api(test_plugin_package_req: str) -> None:
-    metadata = VariantMetadata(
+    variant_info = VariantInfo(
         namespace_priorities=["installable_plugin"],
         providers={
             "installable_plugin": ProviderInfo(
@@ -472,5 +472,5 @@ def test_no_plugin_api(test_plugin_package_req: str) -> None:
         },
     )
 
-    with PluginLoader(metadata, use_auto_install=True, isolated=True) as loader:
+    with PluginLoader(variant_info, use_auto_install=True, isolated=True) as loader:
         assert set(loader.namespaces) == {"installable_plugin"}

tests/test_api.py

@@ -30,19 +30,19 @@
 from variantlib.constants import VALIDATION_FEATURE_NAME_REGEX
 from variantlib.constants import VALIDATION_NAMESPACE_REGEX
 from variantlib.constants import VALIDATION_VALUE_REGEX
-from variantlib.constants import VARIANT_METADATA_DEFAULT_PRIO_KEY
-from variantlib.constants import VARIANT_METADATA_NAMESPACE_KEY
-from variantlib.constants import VARIANT_METADATA_PROVIDER_DATA_KEY
-from variantlib.constants import VARIANT_METADATA_PROVIDER_PLUGIN_API_KEY
-from variantlib.constants import VARIANT_METADATA_PROVIDER_REQUIRES_KEY
+from variantlib.constants import VARIANT_INFO_DEFAULT_PRIO_KEY
+from variantlib.constants import VARIANT_INFO_NAMESPACE_KEY
+from variantlib.constants import VARIANT_INFO_PROVIDER_DATA_KEY
+from variantlib.constants import VARIANT_INFO_PROVIDER_PLUGIN_API_KEY
+from variantlib.constants import VARIANT_INFO_PROVIDER_REQUIRES_KEY
 from variantlib.constants import VARIANTS_JSON_SCHEMA_URL
 from variantlib.constants import VARIANTS_JSON_VARIANT_DATA_KEY
 from variantlib.constants import VariantsJsonDict
 from variantlib.models import provider as pconfig
 from variantlib.models import variant as vconfig
 from variantlib.models.configuration import VariantConfiguration as VConfigurationModel
-from variantlib.models.metadata import ProviderInfo
-from variantlib.models.metadata import VariantMetadata
+from variantlib.models.variant_info import ProviderInfo
+from variantlib.models.variant_info import VariantInfo
 from variantlib.pyproject_toml import VariantPyProjectToml
 from variantlib.variants_json import VariantsJson
 
@@ -91,13 +91,13 @@ def test_get_variant_hashes_by_priority_roundtrip(
 
     variants_json = {
         "$schema": VARIANTS_JSON_SCHEMA_URL,
-        VARIANT_METADATA_DEFAULT_PRIO_KEY: {
-            VARIANT_METADATA_NAMESPACE_KEY: namespace_priorities,
+        VARIANT_INFO_DEFAULT_PRIO_KEY: {
+            VARIANT_INFO_NAMESPACE_KEY: namespace_priorities,
         },
-        VARIANT_METADATA_PROVIDER_DATA_KEY: {
+        VARIANT_INFO_PROVIDER_DATA_KEY: {
             namespace: {
-                VARIANT_METADATA_PROVIDER_PLUGIN_API_KEY: plugin_api,
-                VARIANT_METADATA_PROVIDER_REQUIRES_KEY: [],
+                VARIANT_INFO_PROVIDER_PLUGIN_API_KEY: plugin_api,
+                VARIANT_INFO_PROVIDER_REQUIRES_KEY: [],
             }
             for namespace, plugin_api in plugin_apis.items()
         },
@@ -262,7 +262,7 @@ def test_validation_result_properties() -> None:
 
 
 def test_validate_variant(mocked_plugin_apis: list[str]) -> None:
-    vmeta = VariantMetadata(
+    variant_info = VariantInfo(
         namespace_priorities=[
             "test_namespace",
             "second_namespace",
@@ -296,7 +296,7 @@ def test_validate_variant(mocked_plugin_apis: list[str]) -> None:
                 VariantProperty("private", "build_type", "debug"),
             ]
         ),
-        metadata=vmeta,
+        variant_info=variant_info,
         use_auto_install=False,
     )
 
@@ -392,7 +392,7 @@ def test_make_variant_dist_info(
                         VariantProperty("ns2", "f1", "p1"),
                     ]
                 ),
-                variant_metadata=VariantPyProjectToml(pyproject_toml)  # type: ignore[arg-type]
+                variant_info=VariantPyProjectToml(pyproject_toml)  # type: ignore[arg-type]
                 if pyproject_toml is not None
                 else None,
             )
@@ -402,8 +402,8 @@ def test_make_variant_dist_info(
 
 
 @pytest.fixture
-def common_metadata() -> VariantMetadata:
-    return VariantMetadata(
+def common_variant_info() -> VariantInfo:
+    return VariantInfo(
         namespace_priorities=["test_namespace", "second_namespace"],
         providers={
             "test_namespace": ProviderInfo(
@@ -440,21 +440,21 @@ def common_metadata() -> VariantMetadata:
     ],
 )
 def test_check_variant_supported_dist(
-    common_metadata: VariantMetadata, vdesc: VariantDescription, expected: bool
+    common_variant_info: VariantInfo, vdesc: VariantDescription, expected: bool
 ) -> None:
-    variant_json = VariantsJson(common_metadata)
+    variant_json = VariantsJson(common_variant_info)
     variant_json.variants[vdesc.hexdigest] = vdesc
     assert (
         check_variant_supported(
-            metadata=variant_json, use_auto_install=False, venv_path=None
+            variant_info=variant_json, use_auto_install=False, venv_path=None
         )
         is expected
     )
 
 
 def test_check_variant_supported_generic() -> None:
-    # metadata should only be used to load plugins
-    vmeta = VariantMetadata(
+    # variant_info should only be used to load plugins
+    variant_info = VariantInfo(
         namespace_priorities=["test_namespace", "second_namespace"],
         providers={
             "test_namespace": ProviderInfo(
@@ -469,7 +469,7 @@ def test_check_variant_supported_generic() -> None:
     # test the null variant
     assert check_variant_supported(
         vdesc=VariantDescription(),
-        metadata=vmeta,
+        variant_info=variant_info,
         use_auto_install=False,
         venv_path=None,
     )
@@ -482,15 +482,15 @@ def test_check_variant_supported_generic() -> None:
                 VariantProperty("second_namespace", "name3", "val3a"),
             ]
         ),
-        metadata=vmeta,
+        variant_info=variant_info,
         use_auto_install=False,
         venv_path=None,
     )
 
     # test an usupported variant
     assert not check_variant_supported(
         vdesc=VariantDescription([VariantProperty("test_namespace", "name1", "val1c")]),
-        metadata=vmeta,
+        variant_info=variant_info,
         use_auto_install=False,
         venv_path=None,
     )