feat: support fragments

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: henryiii

docs/dev-guide.rst

@@ -154,6 +154,9 @@ An example of the plugin structure needed for this system is shown below:
             "schemas": [my_extra_schema],
         }
 
+Fragments for schemas are also supported with this system; use ``#`` to split
+the tool name and fragment path in the dictionary key.
+
 .. _entry-point: https://setuptools.pypa.io/en/stable/userguide/entry_point.html#entry-points
 .. _JSON Schema: https://json-schema.org/
 .. _Python package: https://packaging.python.org/

src/validate_pyproject/plugins/__init__.py

@@ -66,7 +66,7 @@ def __repr__(self) -> str:
 
 class StoredPlugin:
     def __init__(self, tool: str, schema: Schema):
-        self._tool = tool
+        self._tool, _, self._fragment = tool.partition("#")
         self._schema = schema
 
     @property
@@ -83,14 +83,17 @@ def schema(self) -> Schema:
 
     @property
     def fragment(self) -> str:
-        return ""
+        return self._fragment
 
     @property
     def help_text(self) -> str:
         return self.schema.get("description", "")
 
     def __repr__(self) -> str:
-        return f"{self.__class__.__name__}({self.tool!r}, <schema: {self.id}>)"
+        args = [repr(self.tool), self.id]
+        if self.fragment:
+            args.append(f"fragment={self.fragment!r}")
+        return f"{self.__class__.__name__}({', '.join(args)}, <schema: {self.id}>)"
 
 
 if typing.TYPE_CHECKING:

src/validate_pyproject/repo_review.py

@@ -28,9 +28,9 @@ def repo_review_checks() -> Dict[str, VPP001]:
 
 def repo_review_families(pyproject: Dict[str, Any]) -> Dict[str, Dict[str, str]]:
     has_distutils = "distutils" in pyproject.get("tool", {})
-    plugin_names = plugins.list_from_entry_points(
+    plugin_list = plugins.list_from_entry_points(
         lambda e: e.name != "distutils" or has_distutils
     )
-    plugin_list = (f"`[tool.{n}]`" for n in plugin_names)
-    descr = f"Checks `[build-system]`, `[project]`, {', '.join(plugin_list)}"
+    plugin_names = (f"`[tool.{n.tool}]`" for n in plugin_list if n.tool)
+    descr = f"Checks `[build-system]`, `[project]`, {', '.join(plugin_names)}"
     return {"validate-pyproject": {"name": "Validate-PyProject", "description": descr}}

tests/test_plugins.py

@@ -91,7 +91,7 @@ def test_multi_plugins(monkeypatch):
     s3 = {"id": "example3"}
     sys.modules["test_module"] = ModuleType("test_module")
     sys.modules["test_module"].f = lambda: {
-        "tools": {"example": s1},
+        "tools": {"example#frag": s1},
         "schemas": [s2, s3],
     }  # type: ignore[attr-defined]
     monkeypatch.setattr(
@@ -101,3 +101,8 @@ def test_multi_plugins(monkeypatch):
     lst = plugins.list_from_entry_points()
     assert len(lst) == 3
     assert all(e.id.startswith("example") for e in lst)
+
+    (fragmented,) = (e for e in lst if e.tool)
+    assert fragmented.tool == "example"
+    assert fragmented.fragment == "frag"
+    assert fragmented.schema == s1