Minor convenience -- Resource.opaque.

Author: Julian

.flake8

@@ -16,6 +16,8 @@ ignore =
     D200,
     # This rule misses sassy docstrings ending with ! or ?.
     D400,
+    # Plz spaces after section headers
+    D412,
     # This conflicts with the hilarious way one tells mypy you mean to
     # re-export an imported object
     I250,

referencing/_core.py

@@ -76,6 +76,15 @@ def from_contents(
             raise CannotDetermineSpecification(contents)
         return cls(contents=contents, specification=specification)  # type: ignore[reportUnknownArgumentType]  # noqa: E501
 
+    @classmethod
+    def opaque(cls, contents: D) -> Resource[D]:
+        """
+        Create an opaque `Resource` -- i.e. one with opaque specification.
+
+        See `Specification.OPAQUE` for details.
+        """
+        return cls(contents=contents, specification=Specification.OPAQUE)
+
     def id(self) -> URI | None:
         """
         Retrieve this resource's (specification-specific) identifier.
@@ -221,7 +230,6 @@ def lookup(self, ref: URI) -> Resolved[D]:
         """
         Resolve the given reference to the resource it points to.
 
-
         Raises:
 
             `Unresolvable`

referencing/tests/test_core.py

@@ -10,10 +10,7 @@ def test_with_resource(self):
         Adding a resource to the registry then allows re-retrieving it.
         """
 
-        resource = Resource(
-            contents={"foo": "bar"},
-            specification=Specification.OPAQUE,
-        )
+        resource = Resource.opaque(contents={"foo": "bar"})
         uri = "urn:example"
         registry = Registry().with_resource(uri=uri, resource=resource)
         assert registry[uri] is resource
@@ -23,7 +20,7 @@ def test_with_resources(self):
         Adding multiple resources to the registry is like adding each one.
         """
 
-        one = Resource(contents={}, specification=Specification.OPAQUE)
+        one = Resource.opaque(contents={})
         two = Resource(contents={"foo": "bar"}, specification=DRAFT202012)
         registry = Registry().with_resources(
             [
@@ -53,11 +50,7 @@ def test_with_contents_and_default_specification(self):
             [(uri, {"foo": "bar"})],
             default_specification=Specification.OPAQUE,
         )
-        expected = Resource(
-            contents={"foo": "bar"},
-            specification=Specification.OPAQUE,
-        )
-        assert registry[uri] == expected
+        assert registry[uri] == Resource.opaque({"foo": "bar"})
 
     def test_len(self):
         total = 5
@@ -75,25 +68,19 @@ def test_iter(self):
         assert set(registry) == {str(i) for i in range(8)}
 
     def test_crawl_still_has_top_level_resource(self):
-        resource = Resource(
-            contents={"foo": "bar"},
-            specification=Specification.OPAQUE,
-        )
+        resource = Resource.opaque({"foo": "bar"})
         uri = "urn:example"
         registry = Registry().with_resources([(uri, resource)]).crawl()
         assert registry[uri] is resource
 
     def test_contents(self):
-        resource = Resource(
-            contents={"foo": "bar"},
-            specification=Specification.OPAQUE,
-        )
+        resource = Resource.opaque({"foo": "bar"})
         uri = "urn:example"
         registry = Registry().with_resources([(uri, resource)])
         assert registry.contents(uri) == {"foo": "bar"}
 
     def test_init(self):
-        one = Resource(contents={}, specification=Specification.OPAQUE)
+        one = Resource.opaque(contents={})
         two = Resource(contents={"foo": "bar"}, specification=DRAFT202012)
         registry = Registry(
             {
@@ -115,7 +102,7 @@ def test_dict_conversion(self):
         So continuing to use the registry works.
         """
 
-        one = Resource(contents={}, specification=Specification.OPAQUE)
+        one = Resource.opaque(contents={})
         two = Resource(contents={"foo": "bar"}, specification=DRAFT202012)
         registry = Registry(
             {"http://example.com/1": one},
@@ -128,7 +115,7 @@ def test_dict_conversion(self):
         )
 
     def test_combine(self):
-        one = Resource(contents={}, specification=Specification.OPAQUE)
+        one = Resource.opaque(contents={})
         two = Resource(contents={"foo": "bar"}, specification=DRAFT202012)
         three = Resource(contents={"baz": "quux"}, specification=DRAFT202012)
 
@@ -170,10 +157,7 @@ def test_from_contents_with_no_discernible_information_and_default(self):
             {"foo": "bar"},
             default_specification=Specification.OPAQUE,
         )
-        assert resource == Resource(
-            contents={"foo": "bar"},
-            specification=Specification.OPAQUE,
-        )
+        assert resource == Resource.opaque(contents={"foo": "bar"})
 
     def test_from_contents_unneeded_default(self):
         schema = {"$schema": "https://json-schema.org/draft/2020-12/schema"}
@@ -189,22 +173,16 @@ def test_from_contents_unneeded_default(self):
     def test_non_mapping_from_contents(self):
         resource = Resource.from_contents(
             True,
-            default_specification=Specification.OPAQUE,
-        )
-        assert resource == Resource(
-            contents=True,
-            specification=Specification.OPAQUE,
+            default_specification=DRAFT202012,
         )
+        assert resource == Resource(contents=True, specification=DRAFT202012)
 
     def test_from_contents_with_fallback(self):
         resource = Resource.from_contents(
             {"foo": "bar"},
             default_specification=Specification.OPAQUE,
         )
-        assert resource == Resource(
-            contents={"foo": "bar"},
-            specification=Specification.OPAQUE,
-        )
+        assert resource == Resource.opaque(contents={"foo": "bar"})
 
     def test_id_delegates_to_specification(self):
         specification = Specification(id_of=lambda contents: "urn:fixedID")
@@ -215,28 +193,26 @@ def test_id_delegates_to_specification(self):
         assert resource.id() == "urn:fixedID"
 
     def test_pointer_to_mapping(self):
-        resource = Resource(
-            contents={"foo": "baz"},
-            specification=Specification.OPAQUE,
-        )
+        resource = Resource.opaque(contents={"foo": "baz"})
         resolver = Registry().resolver()
         assert resource.pointer("/foo", resolver=resolver).contents == "baz"
 
     def test_pointer_to_array(self):
-        resource = Resource(
-            contents={"foo": {"bar": [3]}},
-            specification=Specification.OPAQUE,
-        )
+        resource = Resource.opaque(contents={"foo": {"bar": [3]}})
         resolver = Registry().resolver()
         assert resource.pointer("/foo/bar/0", resolver=resolver).contents == 3
 
+    def test_opaque(self):
+        contents = {"foo": "bar"}
+        assert Resource.opaque(contents) == Resource(
+            contents=contents,
+            specification=Specification.OPAQUE,
+        )
+
 
 class TestResolver:
     def test_lookup_exact_uri(self):
-        resource = Resource(
-            contents={"foo": "baz"},
-            specification=Specification.OPAQUE,
-        )
+        resource = Resource.opaque(contents={"foo": "baz"})
         resolver = Registry({"http://example.com/1": resource}).resolver()
         resolved = resolver.lookup("http://example.com/1")
         assert resolved.contents == resource.contents

referencing/tests/test_referencing_suite.py

@@ -8,7 +8,7 @@
 
 import pytest
 
-from referencing import Registry, Resource, Specification
+from referencing import Registry, Resource
 
 
 class SuiteNotFound(Exception):
@@ -34,7 +34,7 @@ def test_referencing_suite(test_path):
     loaded = toml.loads(test_path.read_text())
     registry = loaded["registry"]
     registry = Registry().with_resources(
-        (uri, Resource(contents=contents, specification=Specification.OPAQUE))
+        (uri, Resource.opaque(contents=contents))
         for uri, contents in loaded["registry"].items()
     )
     for test in loaded["tests"]: