Introduce a dedicated validate_properties() method in plugin API (#107)

* Introduce a dedicated `validate_properties()` method in plugin API

* Merge the obsolete `BasePluginLoader._get_configs()` helper

* Change the API to a single-property `validate_property()`

Given that the benefit (if any) from validating all properties at once
is minimal, change the protocol to much simpler `validate_property()`
method.  This avoids problems with custom property types that aren't
suitable as `dict` keys, as well as the more general problem of "what
if dict contains different keys than the properties we've given it".

Author: mgorny

pyproject.toml

@@ -76,7 +76,6 @@ show = "variantlib.commands.config.show:show"
 
 [project.entry-points."variantlib.actions.plugins"]
 list = "variantlib.commands.plugins.list_plugins:list_plugins"
-get-all-configs = "variantlib.commands.plugins.get_all_configs:get_all_configs"
 get-supported-configs = "variantlib.commands.plugins.get_supported_configs:get_supported_configs"
 
 [tool.pytest.ini_options]

tests/artifacts/test-plugin-package/dist/test_plugin_package-0-py3-none-any.whl

@@ -17,15 +17,19 @@ class FeatConfig:
 dynamic = False
 
 
-def get_all_configs(known_properties: frozenset[VariantPropertyType] | None) -> list[FeatConfig]:
-    assert known_properties is None
-    return [
-        FeatConfig("feat1", ["val1a", "val1b", "val1c"]),
-        FeatConfig("feat2", ["val2a", "val2b"]),
-    ]
-
-
-def get_supported_configs(known_properties: frozenset[VariantPropertyType] | None) -> list[FeatConfig]:
+def validate_property(
+    variant_property: VariantPropertyType,
+) -> bool:
+    assert variant_property.namespace == namespace
+    return (
+        (variant_property.feature == "feat1" and variant_property.value in ["val1a", "val1b", "val1c"])
+        or (variant_property.feature == "feat2" and variant_property.value in ["val2a", "val2b"])
+        )
+
+
+def get_supported_configs(
+    known_properties: frozenset[VariantPropertyType] | None,
+) -> list[FeatConfig]:
     assert known_properties is None
     return [
         FeatConfig("feat1", ["val1c", "val1b"]),

tests/artifacts/test-plugin-package/test_plugin_package.py

@@ -23,62 +23,6 @@ def test_plugins_list(
     )
 
 
-def test_plugins_get_all_configs(
-    capsys: pytest.CaptureFixture[str],
-    mocked_entry_points: None,
-) -> None:
-    main(["plugins", "get-all-configs"])
-    assert (
-        capsys.readouterr().out
-        == """\
-incompatible_namespace :: flag1 :: on
-incompatible_namespace :: flag2 :: on
-incompatible_namespace :: flag3 :: on
-incompatible_namespace :: flag4 :: on
-second_namespace :: name3 :: val3a
-second_namespace :: name3 :: val3b
-second_namespace :: name3 :: val3c
-test_namespace :: name1 :: val1a
-test_namespace :: name1 :: val1b
-test_namespace :: name1 :: val1c
-test_namespace :: name1 :: val1d
-test_namespace :: name2 :: val2a
-test_namespace :: name2 :: val2b
-test_namespace :: name2 :: val2c
-"""
-    )
-
-
-def test_plugins_get_all_configs_filter_namespace(
-    capsys: pytest.CaptureFixture[str],
-    mocked_entry_points: None,
-) -> None:
-    main(["plugins", "get-all-configs", "-n", "second_namespace"])
-    assert (
-        capsys.readouterr().out
-        == """\
-second_namespace :: name3 :: val3a
-second_namespace :: name3 :: val3b
-second_namespace :: name3 :: val3c
-"""
-    )
-
-
-def test_plugins_get_all_configs_filter_feature(
-    capsys: pytest.CaptureFixture[str],
-    mocked_entry_points: None,
-) -> None:
-    main(["plugins", "get-all-configs", "-f", "name2"])
-    assert (
-        capsys.readouterr().out
-        == """\
-test_namespace :: name2 :: val2a
-test_namespace :: name2 :: val2b
-test_namespace :: name2 :: val2c
-"""
-    )
-
-
 def test_plugins_get_supported_configs(
     capsys: pytest.CaptureFixture[str],
     mocked_entry_points: None,

tests/commands/test_plugins.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from argparse import Namespace
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -12,11 +11,14 @@
 dynamic = False
 
 
-def get_all_configs(
-    known_properties: frozenset[VariantPropertyType] | None,
-) -> list[VariantFeatureConfigType]:
-    assert known_properties is None
-    return [Namespace(name="feature", values=["a", "b"])]
+def validate_property(
+    variant_property: VariantPropertyType,
+) -> bool:
+    assert variant_property.namespace == namespace
+    return variant_property.feature == "feature" and variant_property.value in [
+        "a",
+        "b",
+    ]
 
 
 def get_supported_configs(

tests/mocked_plugin_as_module.py

@@ -20,14 +20,15 @@ class MockedPluginA(PluginType):
     namespace = "test_namespace"  # pyright: ignore[reportAssignmentType,reportIncompatibleMethodOverride]
     dynamic = False  # pyright: ignore[reportAssignmentType,reportIncompatibleMethodOverride]
 
-    def get_all_configs(
-        self, known_properties: frozenset[VariantPropertyType] | None
-    ) -> list[VariantFeatureConfigType]:
-        assert known_properties is None
-        return [
-            VariantFeatureConfig("name1", ["val1a", "val1b", "val1c", "val1d"]),
-            VariantFeatureConfig("name2", ["val2a", "val2b", "val2c"]),
-        ]
+    def validate_property(self, variant_property: VariantPropertyType) -> bool:
+        assert variant_property.namespace == self.namespace
+        return (
+            variant_property.feature == "name1"
+            and variant_property.value in ["val1a", "val1b", "val1c", "val1d"]
+        ) or (
+            variant_property.feature == "name2"
+            and variant_property.value in ["val2a", "val2b", "val2c"]
+        )
 
     def get_supported_configs(
         self, known_properties: frozenset[VariantPropertyType] | None
@@ -61,20 +62,9 @@ class MockedPluginB:
     namespace = "second_namespace"
     dynamic = True
 
-    def get_all_configs(
-        self, known_properties: frozenset[VariantPropertyType] | None
-    ) -> list[MyVariantFeatureConfig]:
-        assert known_properties is not None
-        assert all(prop.namespace == self.namespace for prop in known_properties)
-        vals3 = ["val3a", "val3b", "val3c"]
-        vals3.extend(
-            x.value
-            for x in known_properties
-            if x.feature == "name3" and x.value not in vals3
-        )
-        return [
-            MyVariantFeatureConfig("name3", vals3),
-        ]
+    def validate_property(self, variant_property: VariantPropertyType) -> bool:
+        assert variant_property.namespace == self.namespace
+        return variant_property.feature == "name3"
 
     def get_supported_configs(
         self, known_properties: frozenset[VariantPropertyType] | None
@@ -105,16 +95,12 @@ class MockedPluginC(PluginType):
     namespace = "incompatible_namespace"
     dynamic = False
 
-    def get_all_configs(
-        self, known_properties: frozenset[VariantPropertyType] | None
-    ) -> list[VariantFeatureConfigType]:
-        assert known_properties is None
-        return [
-            MyFlag("flag1"),
-            MyFlag("flag2"),
-            MyFlag("flag3"),
-            MyFlag("flag4"),
-        ]
+    def validate_property(self, variant_property: VariantPropertyType) -> bool:
+        assert variant_property.namespace == self.namespace
+        return (
+            variant_property.feature in ("flag1", "flag2", "flag3", "flag4")
+            and variant_property.value == "on"
+        )
 
     def get_supported_configs(
         self, known_properties: frozenset[VariantPropertyType] | None