fix: pylint and mypy

Author: kdmccormick

cms/djangoapps/modulestore_migrator/tasks.py

@@ -867,7 +867,7 @@ def _migrate_container(
         container_exists = False
         if PublishableEntity.objects.filter(
             learning_package_id=context.target_package_id,
-            key=target_key.container_id,
+            entity_ref=target_key.container_id,
         ).exists():
             libraries_api.restore_container(container_key=target_key)
             container = libraries_api.get_container(target_key)

openedx/core/djangoapps/content/search/documents.py

@@ -7,6 +7,7 @@
 from hashlib import blake2b
 
 from django.core.exceptions import ObjectDoesNotExist
+from django.db.models import F
 from django.utils.text import slugify
 from opaque_keys.edx.keys import ContainerKey, LearningContextKey, OpaqueKey, UsageKey
 from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryContainerLocator
@@ -64,7 +65,8 @@ class Fields:
     tags_level2 = "level2"
     tags_level3 = "level3"
     # Collections (dictionary) that this object belongs to.
-    # Similarly to tags above, we collect the collection.titles and collection.collection_codes into hierarchical facets.
+    # Similarly to tags above, we collect the collection.titles and collection.collection_codes
+    # into hierarchical facets.
     collections = "collections"
     collections_display_name = "display_name"
     collections_key = "key"
@@ -448,10 +450,13 @@ def searchable_doc_collections(object_id: OpaqueKey) -> dict:
     try:
         if isinstance(object_id, UsageKey):
             component = lib_api.get_component_from_usage_key(object_id)
+            # Temporarily alias collection_code to "key" so downstream consumers
+            # (search indexer, REST API) keep the same field name.  We will update
+            # downstream consumers later: https://github.com/openedx/openedx-platform/issues/38406
             collections = content_api.get_entity_collections(
                 component.learning_package_id,
                 component.entity_ref,
-            ).values('key', 'title')
+            ).values(key=F('collection_code'), title=F('title'))
         elif isinstance(object_id, LibraryContainerLocator):
             container = lib_api.get_container(object_id, include_collections=True)
             collections = container.collections

openedx/core/djangoapps/content_libraries/api/blocks.py

@@ -15,7 +15,7 @@
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.core.validators import validate_unicode_slug
 from django.db import transaction
-from django.db.models import QuerySet
+from django.db.models import F, QuerySet
 from django.urls import reverse
 from django.utils.text import slugify
 from django.utils.translation import gettext as _
@@ -176,10 +176,13 @@ def get_library_block(usage_key: LibraryUsageLocatorV2, include_collections=Fals
         raise ContentLibraryBlockNotFound(usage_key)
 
     if include_collections:
+        # Temporarily alias collection_code to "key" so downstream consumers
+        # (search indexer, REST API) keep the same field name.  We will update
+        # downstream consumers later: https://github.com/openedx/openedx-platform/issues/38406
         associated_collections = content_api.get_entity_collections(
             component.learning_package_id,
             component.entity_ref,
-        ).values('key', 'title')
+        ).values(key=F('collection_code'), title=F('title'))
     else:
         associated_collections = None
     xblock_metadata = LibraryXBlockMetadata.from_component(

openedx/core/djangoapps/content_libraries/api/containers.py

@@ -10,6 +10,7 @@
 from uuid import uuid4
 
 from django.db import transaction
+from django.db.models import F
 from django.utils.text import slugify
 from opaque_keys.edx.locator import LibraryContainerLocator, LibraryLocatorV2, LibraryUsageLocatorV2
 from openedx_content import api as content_api
@@ -73,10 +74,13 @@ def get_container(
     """
     container = get_container_from_key(container_key)
     if include_collections:
+        # Temporarily alias collection_code to "key" so downstream consumers
+        # (search indexer, REST API) keep the same field name.  We will update
+        # downstream consumers later: https://github.com/openedx/openedx-platform/issues/38406
         associated_collections = content_api.get_entity_collections(
             container.publishable_entity.learning_package_id,
             container_key.container_id,
-        ).values("key", "title")
+        ).values(key=F("collection_code"), title=F("title"))
     else:
         associated_collections = None
     container_meta = ContainerMetadata.from_container(

openedx/core/djangoapps/content_libraries/tasks.py

@@ -142,8 +142,8 @@ def send_events_after_publish(publish_log_pk: int, library_key_str: str) -> None
                 pass
         else:
             log.warning(
-                f"PublishableEntity {record.entity.pk} / {record.entity.entity_ref} was modified during publish operation "
-                "but is of unknown type."
+                f"PublishableEntity {record.entity.pk} / {record.entity.entity_ref} "
+                "was modified during publish operation but is of unknown type."
             )
 
     for container_key in affected_containers:
@@ -246,8 +246,8 @@ def send_events_after_revert(draft_change_log_id: int, library_key_str: str) ->
                 updated_container_keys.add(container_key)
         else:
             log.warning(
-                f"PublishableEntity {record.entity.pk} / {record.entity.entity_ref} was modified during publish operation "
-                "but is of unknown type."
+                f"PublishableEntity {record.entity.pk} / {record.entity.entity_ref} "
+                "was modified during publish operation but is of unknown type."
             )
         # If any collections contain this entity, their item count may need to be updated, e.g. if this was a
         # newly created component in the collection and is now deleted, or this was deleted and is now re-added.
@@ -256,7 +256,7 @@ def send_events_after_revert(draft_change_log_id: int, library_key_str: str) ->
         ):
             collection_key = api.library_collection_locator(
                 library_key=library_key,
-                collection_key=parent_collection.key,
+                collection_key=parent_collection.collection_code,
             )
             affected_collection_keys.add(collection_key)
 
@@ -541,7 +541,7 @@ def backup_library(self, user_id: int, library_key_str: str) -> None:
         file_path = os.path.join(root_dir, filename)
         user = User.objects.get(id=user_id)
         origin_server = getattr(settings, 'CMS_BASE', None)
-        create_lib_zip_file(lp_key=str(library_key), path=file_path, user=user, origin_server=origin_server)
+        create_lib_zip_file(package_ref=str(library_key), path=file_path, user=user, origin_server=origin_server)
         set_custom_attribute("exporting_completed", str(library_key))
 
         with open(file_path, 'rb') as zipfile:

openedx/core/djangoapps/content_libraries/tests/test_api.py

@@ -325,8 +325,10 @@ def test_set_library_component_collections(self) -> None:
         )
 
         assert self.lib2.learning_package_id is not None
-        assert len(content_api.get_collection(self.lib2.learning_package_id, self.col2.collection_code).entities.all()) == 1
-        assert len(content_api.get_collection(self.lib2.learning_package_id, self.col3.collection_code).entities.all()) == 1
+        col2 = content_api.get_collection(self.lib2.learning_package_id, self.col2.collection_code)
+        col3 = content_api.get_collection(self.lib2.learning_package_id, self.col3.collection_code)
+        assert len(col2.entities.all()) == 1
+        assert len(col3.entities.all()) == 1
 
         self.assertDictContainsEntries(
             event_receiver.call_args_list[0].kwargs,
@@ -345,11 +347,15 @@ def test_set_library_component_collections(self) -> None:
         assert all(event["signal"] == LIBRARY_COLLECTION_UPDATED for event in collection_update_events)
         assert {event["library_collection"] for event in collection_update_events} == {
             LibraryCollectionData(
-                collection_key=api.library_collection_locator(self.lib2.library_key, collection_key=self.col2.collection_code),
+                collection_key=api.library_collection_locator(
+                    self.lib2.library_key, collection_key=self.col2.collection_code,
+                ),
                 background=True,
             ),
             LibraryCollectionData(
-                collection_key=api.library_collection_locator(self.lib2.library_key, collection_key=self.col3.collection_code),
+                collection_key=api.library_collection_locator(
+                    self.lib2.library_key, collection_key=self.col3.collection_code,
+                ),
                 background=True,
             )
         }