feat: adds get_container_by_key to authoring api

Author: pomegranited

openedx_learning/apps/authoring/publishing/api.py

@@ -71,6 +71,7 @@
     "create_container_version",
     "create_next_container_version",
     "get_container",
+    "get_container_by_key",
     "get_containers",
     "ContainerEntityListEntry",
     "get_entities_in_container",
@@ -838,6 +839,25 @@ def get_container(pk: int) -> Container:
     return Container.objects.get(pk=pk)
 
 
+def get_container_by_key(learning_package_id: int, /, key: str) -> Container:
+    """
+    [ 🛑 UNSTABLE ]
+    Get a container by its learning package and primary key.
+
+    Args:
+        learning_package_id: The ID of the learning package that contains the container.
+        key: The primary key of the container.
+
+    Returns:
+        The container with the given primary key.
+    """
+    entity = get_publishable_entity_by_key(
+        learning_package_id,
+        key=key,
+    )
+    return get_container(entity.id)
+
+
 def get_containers(
     learning_package_id: int,
     container_cls: type[ContainerModel] = Container,  # type: ignore[assignment]

tests/openedx_learning/apps/authoring/units/test_api.py

@@ -114,6 +114,21 @@ def test_get_container(self):
         with self.assertNumQueries(0):
             assert result.versioning.has_unpublished_changes
 
+    def test_get_container_by_key(self):
+        """
+        Test get_container_by_key()
+        """
+        unit = self.create_unit_with_components([])
+        with self.assertNumQueries(2):
+            result = authoring_api.get_container_by_key(
+                self.learning_package.id,
+                key=unit.publishable_entity.key,
+            )
+        assert result == unit.container
+        # Versioning data should be pre-loaded via select_related()
+        with self.assertNumQueries(0):
+            assert result.versioning.has_unpublished_changes
+
     def test_unit_container_versioning(self):
         """
         Test that the .versioning helper of a Unit returns a UnitVersion, and