fix: move common function to a new file

Author: marslanabdulrauf

cms/djangoapps/contentstore/git_export_utils.py

@@ -85,7 +85,7 @@ def export_library_v2_to_zip(library_key, root_dir, library_dir, user=None):
     Raises:
         Exception: If backup creation or extraction fails
     """
-    from openedx.core.djangoapps.content_libraries.tasks import create_library_v2_zip
+    from openedx.core.djangoapps.content_libraries.api import create_library_v2_zip
 
     # Get user object for backup API
     user_obj = User.objects.filter(username=user).first()

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

@@ -1,6 +1,7 @@
 """
 Python API for working with content libraries
 """
+from .backup import *
 from .block_metadata import *
 from .collections import *
 from .container_metadata import *

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

@@ -0,0 +1,41 @@
+"""
+Public API for content library backup (zip export) utilities.
+"""
+from __future__ import annotations
+
+import os
+from datetime import datetime
+from tempfile import mkdtemp
+
+from django.conf import settings
+from django.utils.text import slugify
+from opaque_keys.edx.locator import LibraryLocatorV2
+from path import Path
+
+from openedx_content.api import create_zip_file as create_lib_zip_file
+
+__all__ = ["create_library_v2_zip"]
+
+
+def create_library_v2_zip(library_key: LibraryLocatorV2, user) -> tuple:
+    """
+    Create a zip backup of a v2 library and return ``(temp_dir, zip_file_path)``.
+
+    The caller is responsible for cleaning up ``temp_dir`` when done.
+
+    Args:
+        library_key: LibraryLocatorV2 identifying the library to export.
+        user: User object passed to the backup API.
+
+    Returns:
+        A tuple of ``(temp_dir as Path, zip_file_path as str)``.
+    """
+    root_dir = Path(mkdtemp())
+    sanitized_lib_key = str(library_key).replace(":", "-")
+    sanitized_lib_key = slugify(sanitized_lib_key, allow_unicode=True)
+    timestamp = datetime.now().strftime("%Y-%m-%d-%H%M%S")
+    filename = f'{sanitized_lib_key}-{timestamp}.zip'
+    file_path = os.path.join(root_dir, filename)
+    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)
+    return root_dir, file_path

openedx/core/djangoapps/content_libraries/tasks.py

@@ -19,20 +19,17 @@
 from io import StringIO
 import logging
 import os
-from datetime import datetime
-from tempfile import mkdtemp, NamedTemporaryFile
+from tempfile import NamedTemporaryFile
 import json
 import shutil
 
 from django.core.files.base import ContentFile
 from django.contrib.auth import get_user_model
 from django.core.serializers.json import DjangoJSONEncoder
-from django.conf import settings
 from celery import shared_task
 from celery.utils.log import get_task_logger
 from celery_utils.logged_task import LoggedTask
 from django.core.files import File
-from django.utils.text import slugify
 from edx_django_utils.monitoring import (
     set_code_owner_attribute,
     set_code_owner_attribute_from_module,
@@ -58,9 +55,7 @@
     LIBRARY_CONTAINER_UPDATED
 )
 from openedx_content import api as content_api
-from openedx_content.api import create_zip_file as create_lib_zip_file
 from openedx_content.models_api import DraftChangeLog, PublishLog
-from path import Path
 from user_tasks.models import UserTaskArtifact
 from user_tasks.tasks import UserTask, UserTaskStatus
 from xblock.fields import Scope
@@ -76,6 +71,7 @@
 from cms.djangoapps.contentstore.storage import course_import_export_storage
 
 from . import api
+from .api import create_library_v2_zip
 from .models import ContentLibraryBlockImportTask
 
 log = logging.getLogger(__name__)
@@ -508,30 +504,6 @@ def _copy_overrides(
     store.update_item(dest_block, user_id)
 
 
-def create_library_v2_zip(library_key: LibraryLocatorV2, user: User) -> tuple:
-    """
-    Create a zip backup of a v2 library and return ``(temp_dir, zip_file_path)``.
-
-    The caller is responsible for cleaning up ``temp_dir`` when done.
-
-    Args:
-        library_key: LibraryLocatorV2 identifying the library to export.
-        user: User object passed to the backup API.
-
-    Returns:
-        A tuple of ``(temp_dir as Path, zip_file_path as str)``.
-    """
-    root_dir = Path(mkdtemp())
-    sanitized_lib_key = str(library_key).replace(":", "-")
-    sanitized_lib_key = slugify(sanitized_lib_key, allow_unicode=True)
-    timestamp = datetime.now().strftime("%Y-%m-%d-%H%M%S")
-    filename = f'{sanitized_lib_key}-{timestamp}.zip'
-    file_path = os.path.join(root_dir, filename)
-    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)
-    return root_dir, file_path
-
-
 class LibraryBackupTask(UserTask):  # pylint: disable=abstract-method
     """
     Base class for tasks related with Library backup functionality.