refactor: LibraryUsageLocatorV2 as LibraryElementKey

Author: ChrisChV

opaque_keys/edx/locator.py

@@ -1550,16 +1550,15 @@ def for_branch(self, branch: str | None):
         return self
 
 
-class LibraryUsageLocatorV2(CheckFieldMixin, UsageKeyV2):
+class LibraryUsageLocatorV2(CheckFieldMixin, UsageKeyV2, LibraryItemKey):
     """
     An XBlock in a Learning-Core-based content library.
 
     When serialized, these keys look like:
         lb:MITx:reallyhardproblems:problem:problem1
     """
     CANONICAL_NAMESPACE = 'lb'  # "Library Block"
-    KEY_FIELDS = ('lib_key', 'block_type', 'usage_id')
-    lib_key: LibraryLocatorV2
+    KEY_FIELDS = ('library_key', 'block_type', 'usage_id')
     usage_id: str
 
     __slots__ = KEY_FIELDS
@@ -1577,14 +1576,14 @@ def __init__(self, lib_key: LibraryLocatorV2, block_type: str, usage_id: str):
         self._check_key_string_field("block_type", block_type)
         self._check_key_string_field("usage_id", usage_id, regexp=self.USAGE_ID_REGEXP)
         super().__init__(
-            lib_key=lib_key,
+            library_key=lib_key,
             block_type=block_type,
             usage_id=usage_id,
         )
 
     @property
     def context_key(self) -> LibraryLocatorV2:
-        return self.lib_key
+        return self.library_key
 
     @property
     def block_id(self) -> str:
@@ -1593,11 +1592,18 @@ def block_id(self) -> str:
         """
         return self.usage_id
 
+    @property
+    def org(self) -> str | None:  # pragma: no cover
+        """
+        The organization that this XBlock belongs to.
+        """
+        raise self.library_key.org
+
     def _to_string(self) -> str:
         """
         Serialize this key as a string
         """
-        return ":".join((self.lib_key.org, self.lib_key.slug, self.block_type, self.usage_id))
+        return ":".join((self.library_key.org, self.library_key.slug, self.block_type, self.usage_id))
 
     @classmethod
     def _from_string(cls, serialized: str) -> Self:
@@ -1654,7 +1660,7 @@ def __init__(self, library_key: LibraryLocatorV2, collection_id: str):
     @property
     def org(self) -> str | None:  # pragma: no cover
         """
-        The organization that this object belongs to.
+        The organization that this collection belongs to.
         """
         return self.library_key.org
 
@@ -1711,7 +1717,7 @@ def __init__(self, library_key: LibraryLocatorV2, container_type: str, container
     @property
     def org(self) -> str | None:  # pragma: no cover
         """
-        The organization that this object belongs to.
+        The organization that this Container belongs to.
         """
         return self.library_key.org
 

opaque_keys/edx/tests/test_library_usage_locators.py

@@ -55,6 +55,7 @@ def test_constructor(self, org, lib, block_type, block_id):
         self.assertEqual(lib_usage_key, lib_usage_key2)
         self.assertEqual(lib_usage_key.library_key, lib_key)
         self.assertEqual(lib_usage_key.library_key, lib_key)
+        self.assertEqual(lib_usage_key.org, org)
         self.assertEqual(lib_usage_key.branch, None)
         self.assertEqual(lib_usage_key.run, LibraryLocator.RUN)
         self.assertIsInstance(lib_usage_key2, LibraryUsageLocator)