refactor: update '.pk' -> '.id' for LearningPackage uses

Author: bradenmacdonald

src/openedx_content/applets/backup_restore/zipper.py

@@ -176,7 +176,7 @@ def get_publishable_entities(self) -> QuerySet[PublishableEntity]:
         Retrieve the publishable entities associated with the learning package.
         Prefetches related data for efficiency.
         """
-        lp_id = self.learning_package.pk
+        lp_id = self.learning_package.id
         publishable_entities: QuerySet[PublishableEntity] = publishing_api.get_publishable_entities(lp_id)
         return (
             publishable_entities  # type: ignore[no-redef]
@@ -210,7 +210,7 @@ def get_collections(self) -> QuerySet[Collection]:
         Get the collections associated with the learning package.
         """
         return (
-            collections_api.get_collections(self.learning_package.pk)
+            collections_api.get_collections(self.learning_package.id)
             .prefetch_related("entities")
         )
 

tests/openedx_content/applets/backup_restore/test_backup.py

@@ -101,7 +101,7 @@ def setUpTestData(cls):
         )
 
         new_txt_media = api.get_or_create_text_media(
-            cls.learning_package.pk,
+            cls.learning_package.id,
             text_media_type.id,
             text="This is some data",
             created=cls.now,

tests/openedx_content/applets/collections/test_api.py

@@ -108,22 +108,22 @@ def test_get_collection(self):
         """
         Test getting a single collection.
         """
-        collection = api.get_collection(self.learning_package.pk, 'COL1')
+        collection = api.get_collection(self.learning_package.id, 'COL1')
         assert collection == self.collection1
 
     def test_get_collection_not_found(self):
         """
         Test getting a collection that doesn't exist.
         """
         with self.assertRaises(ObjectDoesNotExist):
-            api.get_collection(self.learning_package.pk, '12345')
+            api.get_collection(self.learning_package.id, '12345')
 
     def test_get_collection_wrong_learning_package(self):
         """
         Test getting a collection that doesn't exist in the requested learning package.
         """
         with self.assertRaises(ObjectDoesNotExist):
-            api.get_collection(self.learning_package.pk, self.another_library_collection.key)
+            api.get_collection(self.learning_package.id, self.another_library_collection.key)
 
     def test_get_collections(self):
         """

tests/openedx_content/applets/components/test_api.py

@@ -48,8 +48,8 @@ def publish_component(self, component: Component):
         Helper method to publish a single component.
         """
         publishing_api.publish_from_drafts(
-            self.learning_package.pk,
-            draft_qset=publishing_api.get_all_drafts(self.learning_package.pk).filter(
+            self.learning_package.id,
+            draft_qset=publishing_api.get_all_drafts(self.learning_package.id).filter(
                 entity=component.publishable_entity,
             ),
         )
@@ -92,7 +92,7 @@ def test_component_num_queries(self) -> None:
             created_by=None,
         )
         publishing_api.publish_all_drafts(
-            self.learning_package.pk,
+            self.learning_package.id,
             published_at=self.now
         )
 
@@ -145,7 +145,7 @@ def setUpTestData(cls) -> None:
             created_by=None,
         )
         publishing_api.publish_all_drafts(
-            cls.learning_package.pk,
+            cls.learning_package.id,
             published_at=cls.now
         )
 
@@ -414,7 +414,7 @@ def test_add(self):
             created_by=None,
         )
         new_media = media_api.get_or_create_text_media(
-            self.learning_package.pk,
+            self.learning_package.id,
             self.text_media_type.id,
             text="This is some data",
             created=self.now,
@@ -610,7 +610,7 @@ def test_create_multiple_next_versions_and_diff_content(self):
         assert version_1_published.version_num == 1
 
         publishing_api.publish_all_drafts(
-            self.learning_package.pk,
+            self.learning_package.id,
             published_at=self.now
         )
 

tests/openedx_content/applets/components/test_models.py

@@ -58,7 +58,7 @@ def test_latest_version(self) -> None:
         )
         assert component.versioning.draft == component_version
         assert component.versioning.published is None
-        publish_all_drafts(self.learning_package.pk, published_at=self.now)
+        publish_all_drafts(self.learning_package.id, published_at=self.now)
 
         # Publishing isn't immediately reflected in the component obj (it's
         # using a cached version).

tests/openedx_content/applets/containers/test_api.py

@@ -234,7 +234,7 @@ def _container_of_uninstalled_type(lp: LearningPackage, child_entity1: TestEntit
     """
     # First create a TestContainer, then we'll modify it to simulate it being from an uninstalled plugin
     container, _ = containers_api.create_container_and_version(
-        lp.pk,
+        lp.id,
         key="abandoned-container",
         title="Abandoned Container 1",
         entities=[child_entity1],
@@ -301,7 +301,7 @@ def test_create_generic_empty_container(lp: LearningPackage, admin_user) -> None
     Creating an empty TestContainer. It will have only a draft version.
     """
     container, container_v1 = containers_api.create_container_and_version(
-        lp.pk,
+        lp.id,
         key="new-container-1",
         title="Test Container 1",
         container_cls=TestContainer,
@@ -356,10 +356,10 @@ def test_create_container_queries(lp: LearningPackage, child_entity1: TestEntity
     }
     # The exact numbers here aren't too important - this is just to alert us if anything significant changes.
     with django_assert_num_queries(31):
-        containers_api.create_container_and_version(lp.pk, key="c1", **base_args)
+        containers_api.create_container_and_version(lp.id, key="c1", **base_args)
     # And try with a a container that has children:
     with django_assert_num_queries(32):
-        containers_api.create_container_and_version(lp.pk, key="c2", **base_args, entities=[child_entity1])
+        containers_api.create_container_and_version(lp.id, key="c2", **base_args, entities=[child_entity1])
 
 
 # versioning helpers
@@ -761,7 +761,7 @@ def test_get_container_by_key(lp: LearningPackage, parent_of_two: TestContainer)
     """
     Test getting a specific container by key
     """
-    result = containers_api.get_container_by_key(lp.pk, parent_of_two.key)
+    result = containers_api.get_container_by_key(lp.id, parent_of_two.key)
     assert result == parent_of_two.container
     # The API always returns "Container", not specific subclasses like TestContainer:
     assert result.__class__ is Container
@@ -1015,7 +1015,7 @@ def test_add_entity_after_publish(lp: LearningPackage, parent_of_two: TestContai
     assert parent_of_two_v1.version_num == 1
     assert parent_of_two.versioning.published is None
     # Publish everything in the learning package:
-    publishing_api.publish_all_drafts(lp.pk)
+    publishing_api.publish_all_drafts(lp.id)
     parent_of_two.refresh_from_db()  # Reloading is necessary
     assert not parent_of_two.versioning.has_unpublished_changes  # Shallow check
     assert not containers_api.contains_unpublished_changes(parent_of_two)  # Deeper check
@@ -1151,7 +1151,7 @@ def test_publishing_shared_component(lp: LearningPackage):
     c4_v1 = c4.versioning.draft
     c5_v1 = c5.versioning.draft
     unit1, _ = containers_api.create_container_and_version(
-        lp.pk,
+        lp.id,
         entities=[c1, c2, c3],
         title="Unit 1",
         key="unit:1",
@@ -1160,15 +1160,15 @@ def test_publishing_shared_component(lp: LearningPackage):
         container_cls=TestContainer,
     )
     unit2, _ = containers_api.create_container_and_version(
-        lp.pk,
+        lp.id,
         entities=[c2, c4, c5],
         title="Unit 2",
         key="unit:2",
         created=now,
         created_by=None,
         container_cls=TestContainer,
     )
-    publishing_api.publish_all_drafts(lp.pk)
+    publishing_api.publish_all_drafts(lp.id)
     assert containers_api.contains_unpublished_changes(unit1.id) is False
     assert containers_api.contains_unpublished_changes(unit2.id) is False
 
@@ -1541,7 +1541,7 @@ def test_get_container_children_count(
     grandparent: ContainerContainer,
 ):
     """Test `get_container_children_count()`"""
-    publishing_api.publish_all_drafts(lp.pk)
+    publishing_api.publish_all_drafts(lp.id)
     assert containers_api.get_container_children_count(parent_of_two, published=False) == 2
     assert containers_api.get_container_children_count(parent_of_two, published=True) == 2
 
@@ -1574,7 +1574,7 @@ def test_get_container_children_count_soft_deletion(
     child_entity2: TestEntity,
 ):
     """Test `get_container_children_count()` when an entity is soft deleted"""
-    publishing_api.publish_all_drafts(lp.pk)
+    publishing_api.publish_all_drafts(lp.id)
     publishing_api.soft_delete_draft(child_entity2.pk)
     # "parent_of_two" contains the soft deleted child, so its draft child count is decreased by one:
     assert containers_api.get_container_children_count(parent_of_two, published=False) == 1
@@ -1592,7 +1592,7 @@ def test_get_container_children_count_queries(
     django_assert_num_queries,
 ):
     """Test how many database queries `get_container_children_count()` needs"""
-    publishing_api.publish_all_drafts(lp.pk)
+    publishing_api.publish_all_drafts(lp.id)
     # The 6 queries are:
     # - Draft.objects.get()
     # - PublishableEntityVersion.objects.get()

tests/openedx_content/applets/sections/test_api.py

@@ -77,7 +77,7 @@ def create_section_with_subsections(
         )
         return section
 
-    def test_create_empty_section_and_version(self):
+    def test_create_empty_section_and_version(self) -> None:
         """Test creating a section with no units.
 
         Expected results:
@@ -87,7 +87,7 @@ def test_create_empty_section_and_version(self):
         4. There is no published version of the section.
         """
         section, section_version = content_api.create_section_and_version(
-            learning_package_id=self.learning_package.pk,
+            learning_package_id=self.learning_package.id,
             key="section:key",
             title="Section",
             created=self.now,
@@ -103,7 +103,7 @@ def test_create_empty_section_and_version(self):
         assert section.versioning.published is None
         assert section.publishable_entity.can_stand_alone
 
-    def test_create_next_section_version_with_unpinned_subsections(self):
+    def test_create_next_section_version_with_unpinned_subsections(self) -> None:
         """Test creating a unit version with an unpinned unit.
 
         Expected results:

tests/openedx_content/applets/subsections/test_api.py

@@ -65,7 +65,7 @@ def test_create_empty_subsection_and_version(self):
         4. There is no published version of the subsection.
         """
         subsection, subsection_version = content_api.create_subsection_and_version(
-            learning_package_id=self.learning_package.pk,
+            learning_package_id=self.learning_package.id,
             key="subsection:key",
             title="Subsection",
             created=self.now,

tests/openedx_content/applets/units/test_api.py

@@ -58,7 +58,7 @@ def test_create_empty_unit_and_version(self):
         4. There is no published version of the unit.
         """
         unit, unit_version = content_api.create_unit_and_version(
-            learning_package_id=self.learning_package.pk,
+            learning_package_id=self.learning_package.id,
             key="unit:key",
             title="Unit",
             created=self.now,