fix: minor corrections to units/containers API

openedx · Feb 15, 2025 · fd83bd6 · fd83bd6
1 parent 5750147
commit fd83bd6
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/openedx_learning/apps/authoring/containers/api.py b/openedx_learning/apps/authoring/containers/api.py
@@ -481,6 +481,8 @@ def get_entities_in_published_container(
         cev = container.container_entity.versioning.published
     elif isinstance(container, ContainerEntity):
         cev = container.versioning.published
+    else:
+        raise TypeError(f"Expected ContainerEntity or ContainerEntityMixin; got {type(container)}")
     if cev == None:
         return None  # There is no published version of this container. Should this be an exception?
     assert isinstance(cev, ContainerEntityVersion)

diff --git a/openedx_learning/apps/authoring/units/api.py b/openedx_learning/apps/authoring/units/api.py
@@ -236,14 +236,14 @@ def get_components_in_draft_unit(
 
 
 def get_components_in_published_unit(
-    unit: Unit | UnitVersion,
+    unit: Unit,
 ) -> list[UnitListEntry]:
     """
     [ 🛑 UNSTABLE ]
     Get the list of entities and their versions in the draft version of the
     given container.
     """
-    assert isinstance(unit, (Unit, UnitVersion))
+    assert isinstance(unit, Unit)
     published_entities = container_api.get_entities_in_published_container(unit)
     if published_entities == None:
         return None  # There is no published version of this unit. Should this be an exception?

diff --git a/tests/openedx_learning/apps/authoring/units/test_api.py b/tests/openedx_learning/apps/authoring/units/test_api.py
@@ -276,7 +276,6 @@ def test_modify_pinned_component(self):
         assert authoring_api.get_components_in_draft_unit(unit) == expected_unit_contents
         assert authoring_api.get_components_in_published_unit(unit) == expected_unit_contents
 
-
     def test_query_count_of_contains_unpublished_changes(self):
         """
         Checking for unpublished changes in a unit should require a fixed number
@@ -319,7 +318,6 @@ def test_query_count_of_contains_unpublished_changes(self):
     # Test viewing old snapshots of units and components by passing in a timestamp (or PublishLog PK) to a
     #     get_historic_unit() API?
 
-
     def test_next_version_with_different_different_title(self):
         """Test creating a unit version with a different title.