refactor: move transcripts_utils from xmodule to video-config (#37600)

As part of the ongoing effort to deprecate and eventually remove xmodule,
we’ve started gradually migrating the necessary code files from xmodule
to more appropriate locations within the codebase.

Ticket: openedx/public-engineering#445

Also: this tweaks importlinter ignores & add follow-up issue links

Co-authored-by: Kyle McCormick <[email protected]>

Author: farhan

cms/djangoapps/contentstore/helpers.py

@@ -1,5 +1,10 @@
 """
 Helper methods for Studio views.
+
+Before adding more stuff here, take a look at:
+https://github.com/openedx/edx-platform/issues/37637
+Only Studio-specfic helper functions should be added here.
+Platform-wide Python APIs should be added to an appropriate api.py file instead.
 """
 from __future__ import annotations
 import json
@@ -26,7 +31,7 @@
 from xmodule.exceptions import NotFoundError
 from xmodule.modulestore.django import modulestore
 from xmodule.xml_block import XmlMixin
-from xmodule.video_block.transcripts_utils import Transcript, build_components_import_path
+from openedx.core.djangoapps.video_config.transcripts_utils import Transcript, build_components_import_path
 from edxval.api import (
     create_external_video,
     create_or_update_video_transcript,

cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py

@@ -122,7 +122,7 @@
 from openedx.core.djangoapps.content_libraries import api as lib_api
 from xmodule.modulestore.django import modulestore
 from xmodule.modulestore.exceptions import ItemNotFoundError
-from xmodule.video_block.transcripts_utils import clear_transcripts
+from openedx.core.djangoapps.video_config.transcripts_utils import clear_transcripts
 
 logger = logging.getLogger(__name__)
 

cms/djangoapps/contentstore/tests/test_transcripts_utils.py

@@ -23,7 +23,7 @@
 from xmodule.exceptions import NotFoundError  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory  # lint-amnesty, pylint: disable=wrong-import-order
-from xmodule.video_block import transcripts_utils  # lint-amnesty, pylint: disable=wrong-import-order
+from openedx.core.djangoapps.video_config import transcripts_utils  # lint-amnesty, pylint: disable=wrong-import-order
 
 TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE)
 TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex
@@ -235,7 +235,7 @@ def test_success_downloading_subs(self):
         self.clear_sub_content(good_youtube_sub)
 
         language_code = 'en'
-        with patch('xmodule.video_block.transcripts_utils.requests.get') as mock_get:
+        with patch('openedx.core.djangoapps.video_config.transcripts_utils.requests.get') as mock_get:
             setup_caption_responses(mock_get, language_code, caption_response_string)
             transcripts_utils.download_youtube_subs(good_youtube_sub, self.course, settings)
 
@@ -258,7 +258,7 @@ def test_subs_for_html5_vid_with_periods(self):
         self.assertEqual(html5_ids[2], 'baz.1.4')
         self.assertEqual(html5_ids[3], 'foo')
 
-    @patch('xmodule.video_block.transcripts_utils.requests.get')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.requests.get')
     def test_fail_downloading_subs(self, mock_get):
 
         track_status_code = 404
@@ -459,7 +459,7 @@ class TestYoutubeTranscripts(unittest.TestCase):
     """
     Tests for checking right datastructure returning when using youtube api.
     """
-    @patch('xmodule.video_block.transcripts_utils.requests.get')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.requests.get')
     def test_youtube_bad_status_code(self, mock_get):
         track_status_code = 404
         setup_caption_responses(mock_get, 'en', 'test', track_status_code)
@@ -468,7 +468,7 @@ def test_youtube_bad_status_code(self, mock_get):
             link = transcripts_utils.get_transcript_links_from_youtube(youtube_id, settings, translation)
             transcripts_utils.get_transcript_from_youtube(link, youtube_id, translation)
 
-    @patch('xmodule.video_block.transcripts_utils.requests.get')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.requests.get')
     def test_youtube_empty_text(self, mock_get):
         setup_caption_responses(mock_get, 'en', '')
         youtube_id = 'bad_youtube_id'
@@ -492,7 +492,7 @@ def test_youtube_good_result(self):
         }
         youtube_id = 'good_youtube_id'
         language_code = 'en'
-        with patch('xmodule.video_block.transcripts_utils.requests.get') as mock_get:
+        with patch('openedx.core.djangoapps.video_config.transcripts_utils.requests.get') as mock_get:
             setup_caption_responses(mock_get, language_code, caption_response_string)
             link = transcripts_utils.get_transcript_links_from_youtube(youtube_id, settings, translation)
             transcripts = transcripts_utils.get_transcript_from_youtube(link['en'], youtube_id, translation)
@@ -890,7 +890,7 @@ def test_get_transcript_from_content_store_for_ur(self):
         self.assertEqual(filename, 'ur_video_101.sjson')
         self.assertEqual(mimetype, self.sjson_mime_type)
 
-    @patch('xmodule.video_block.transcripts_utils.get_video_transcript_content')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_video_transcript_content')
     def test_get_transcript_from_val(self, mock_get_video_transcript_content):
         """
         Verify that `get_transcript` function returns correct data when transcript is in val.
@@ -952,7 +952,7 @@ def test_get_transcript_no_en_transcript(self):
         exception_message = str(no_en_transcript_exception.exception)
         self.assertEqual(exception_message, 'No transcript for `en` language')
 
-    @patch('xmodule.video_block.transcripts_utils.edxval_api.get_video_transcript_data')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.edxval_api.get_video_transcript_data')
     def test_get_transcript_incorrect_json_(self, mock_get_video_transcript_data):
         """
         Verify that `get transcript` function returns a working json file if the original throws an error
@@ -966,7 +966,7 @@ def test_get_transcript_incorrect_json_(self, mock_get_video_transcript_data):
         transcripts_utils.TranscriptsGenerationException,
         UnicodeDecodeError('aliencodec', b'\x02\x01', 1, 2, 'alien codec found!')
     )
-    @patch('xmodule.video_block.transcripts_utils.Transcript')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.Transcript')
     def test_get_transcript_val_exceptions(self, exception_to_raise, mock_Transcript):
         """
         Verify that `get_transcript_from_val` function raises `NotFoundError` when specified exceptions raised.
@@ -986,7 +986,7 @@ def test_get_transcript_val_exceptions(self, exception_to_raise, mock_Transcript
         transcripts_utils.TranscriptsGenerationException,
         UnicodeDecodeError('aliencodec', b'\x02\x01', 1, 2, 'alien codec found!')
     )
-    @patch('xmodule.video_block.transcripts_utils.Transcript')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.Transcript')
     def test_get_transcript_content_store_exceptions(self, exception_to_raise, mock_Transcript):
         """
         Verify that `get_transcript_from_contentstore` function raises `NotFoundError` when specified exceptions raised.
@@ -1051,7 +1051,7 @@ def mock_django_get_language_info(self, side_effect=None):
         """
         Helper for cleaner mocking
         """
-        with patch('xmodule.video_block.transcripts_utils.get_language_info') as mock_get:
+        with patch('openedx.core.djangoapps.video_config.transcripts_utils.get_language_info') as mock_get:
             if side_effect:
                 mock_get.side_effect = side_effect
             yield mock_get

cms/djangoapps/contentstore/tests/utils.py

@@ -15,7 +15,7 @@
 from xmodule.modulestore.tests.django_utils import TEST_DATA_SPLIT_MODULESTORE, ModuleStoreTestCase
 from xmodule.modulestore.tests.factories import CourseFactory
 from xmodule.modulestore.tests.utils import ProceduralCourseTestMixin
-from xmodule.tests.test_transcripts_utils import YoutubeVideoHTMLResponse
+from openedx.core.djangoapps.video_config.tests.test_transcripts_utils import YoutubeVideoHTMLResponse
 
 from cms.djangoapps.contentstore.utils import reverse_url
 from common.djangoapps.student.models import Registration

cms/djangoapps/contentstore/transcript_storage_handlers.py

@@ -23,7 +23,7 @@
 from common.djangoapps.util.json_request import JsonResponse
 from openedx.core.djangoapps.video_config.models import VideoTranscriptEnabledFlag
 from openedx.core.djangoapps.video_pipeline.api import update_3rd_party_transcription_service_credentials
-from xmodule.video_block.transcripts_utils import Transcript, TranscriptsGenerationException  # lint-amnesty, pylint: disable=wrong-import-order
+from openedx.core.djangoapps.video_config.transcripts_utils import Transcript, TranscriptsGenerationException  # lint-amnesty, pylint: disable=wrong-import-order
 
 from .toggles import use_mock_video_uploads
 from .video_storage_handlers import TranscriptProvider

cms/djangoapps/contentstore/utils.py

@@ -1811,7 +1811,7 @@ def get_course_videos_context(course_block, pagination_conf, course_key=None):
     )
     from openedx.core.djangoapps.video_config.models import VideoTranscriptEnabledFlag
     from openedx.core.djangoapps.video_config.toggles import use_xpert_translations_component
-    from xmodule.video_block.transcripts_utils import Transcript  # lint-amnesty, pylint: disable=wrong-import-order
+    from openedx.core.djangoapps.video_config.transcripts_utils import Transcript  # lint-amnesty, pylint: disable=wrong-import-order
 
     from .video_storage_handlers import (
         get_all_transcript_languages,

cms/djangoapps/contentstore/views/tests/test_transcripts.py

@@ -25,7 +25,7 @@
 from xmodule.exceptions import NotFoundError  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.modulestore.django import modulestore  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.video_block import VideoBlock  # lint-amnesty, pylint: disable=wrong-import-order
-from xmodule.video_block.transcripts_utils import (  # lint-amnesty, pylint: disable=wrong-import-order
+from openedx.core.djangoapps.video_config.transcripts_utils import (  # lint-amnesty, pylint: disable=wrong-import-order
     GetTranscriptsFromYouTubeException,
     Transcript,
     get_video_transcript_content,
@@ -981,7 +981,7 @@ def test_check_youtube(self):
             }
         )
 
-    @patch('xmodule.video_block.transcripts_utils.requests.get')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.requests.get')
     def test_check_youtube_with_transcript_name(self, mock_get):
         """
         Test that the transcripts are fetched correctly when the the transcript name is set
@@ -1121,7 +1121,7 @@ def test_fail_for_non_video_block(self):
             'Transcripts are supported only for "video" blocks.',
         )
 
-    @patch('xmodule.video_block.transcripts_utils.get_video_transcript_content')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_video_transcript_content')
     def test_command_for_fallback_transcript(self, mock_get_video_transcript_content):
         """
         Verify the command if a transcript is there in edx-val.

cms/djangoapps/contentstore/views/transcripts_ajax.py

@@ -30,7 +30,7 @@
 from xmodule.exceptions import NotFoundError  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.modulestore.django import modulestore  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.modulestore.exceptions import ItemNotFoundError  # lint-amnesty, pylint: disable=wrong-import-order
-from xmodule.video_block.transcripts_utils import (  # lint-amnesty, pylint: disable=wrong-import-order
+from openedx.core.djangoapps.video_config.transcripts_utils import (  # lint-amnesty, pylint: disable=wrong-import-order
     GetTranscriptsFromYouTubeException,
     Transcript,
     TranscriptsGenerationException,

lms/djangoapps/courseware/tests/test_video_handlers.py

@@ -28,7 +28,7 @@
 # noinspection PyUnresolvedReferences
 from xmodule.tests.helpers import override_descriptor_system  # pylint: disable=unused-import
 from xmodule.video_block import VideoBlock  # lint-amnesty, pylint: disable=wrong-import-order
-from xmodule.video_block.transcripts_utils import (  # lint-amnesty, pylint: disable=wrong-import-order
+from openedx.core.djangoapps.video_config.transcripts_utils import (  # lint-amnesty, pylint: disable=wrong-import-order
     Transcript,
     edxval_api,
     get_transcript,
@@ -293,7 +293,7 @@ def test_available_translation_non_en(self):
         response = self.block.transcript(request=request, dispatch='available_translations')
         assert json.loads(response.body.decode('utf-8')) == ['uk']
 
-    @patch('xmodule.video_block.transcripts_utils.get_video_transcript_content')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_video_transcript_content')
     def test_multiple_available_translations(self, mock_get_video_transcript_content):
         mock_get_video_transcript_content.return_value = {
             'content': json.dumps({
@@ -319,8 +319,8 @@ def test_multiple_available_translations(self, mock_get_video_transcript_content
         response = self.block.transcript(request=request, dispatch='available_translations')
         assert sorted(json.loads(response.body.decode('utf-8'))) == sorted(['en', 'uk'])
 
-    @patch('xmodule.video_block.transcripts_utils.get_video_transcript_content')
-    @patch('xmodule.video_block.transcripts_utils.get_available_transcript_languages')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_video_transcript_content')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_available_transcript_languages')
     @ddt.data(
         (
             ['en', 'uk', 'ro'],
@@ -396,7 +396,7 @@ def test_val_available_translations(
         response = self.block.transcript(request=request, dispatch='available_translations')
         self.assertCountEqual(json.loads(response.body.decode('utf-8')), result)
 
-    @patch('xmodule.video_block.transcripts_utils.edxval_api.get_available_transcript_languages')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.edxval_api.get_available_transcript_languages')
     def test_val_available_translations_feature_disabled(self, mock_get_available_transcript_languages):
         """
         Tests available translations with val transcript languages when feature is disabled.
@@ -445,7 +445,7 @@ def test_available_translation_en_and_non_en(self, lang):
         response = self.block.transcript(request=request, dispatch=self.dispatch)
         assert json.loads(response.body.decode('utf-8')) == [lang]
 
-    @patch('xmodule.video_block.transcripts_utils.get_available_transcript_languages')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_available_transcript_languages')
     def test_multiple_available_translations(self, mock_get_transcript_languages):
         """
         Verify that available translations dispatch works as expected for multiple
@@ -534,7 +534,7 @@ def test_download_en_no_sub(self):
             get_transcript(self.block)
 
     @patch(
-        'xmodule.video_block.transcripts_utils.get_transcript_for_video',
+        'openedx.core.djangoapps.video_config.transcripts_utils.get_transcript_for_video',
         return_value=(Transcript.SRT, "塞", 'Subs!')
     )
     def test_download_non_en_non_ascii_filename(self, __):
@@ -544,7 +544,7 @@ def test_download_non_en_non_ascii_filename(self, __):
         assert response.headers['Content-Type'] == 'application/x-subrip; charset=utf-8'
         assert response.headers['Content-Disposition'] == 'attachment; filename="en_塞.srt"'
 
-    @patch('xmodule.video_block.transcripts_utils.edxval_api.get_video_transcript_data')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.edxval_api.get_video_transcript_data')
     @patch('xmodule.video_block.get_transcript', Mock(side_effect=NotFoundError))
     def test_download_fallback_transcript(self, mock_get_video_transcript_data):
         """
@@ -814,7 +814,7 @@ def _set_static_asset_path(self):
         with store.branch_setting(ModuleStoreEnum.Branch.draft_preferred, self.course.id):
             store.update_item(self.course, self.user.id)
 
-    @patch('xmodule.video_block.transcripts_utils.edxval_api.get_video_transcript_data')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.edxval_api.get_video_transcript_data')
     @patch('xmodule.video_block.VideoBlock.translation', Mock(side_effect=NotFoundError))
     @patch('xmodule.video_block.VideoBlock.get_static_transcript', Mock(return_value=Response(status=404)))
     def test_translation_fallback_transcript(self, mock_get_video_transcript_data):

lms/djangoapps/courseware/tests/test_video_mongo.py

@@ -50,7 +50,7 @@
 from xmodule.tests.test_import import DummyModuleStoreRuntime
 from xmodule.tests.test_video import VideoBlockTestBase
 from xmodule.video_block import VideoBlock, bumper_utils, video_utils
-from xmodule.video_block.transcripts_utils import Transcript, save_to_store, subs_filename
+from openedx.core.djangoapps.video_config.transcripts_utils import Transcript, save_to_store, subs_filename
 from xmodule.video_block.video_block import EXPORT_IMPORT_COURSE_DIR, EXPORT_IMPORT_STATIC_DIR
 from xmodule.x_module import PUBLIC_VIEW, STUDENT_VIEW
 
@@ -1755,7 +1755,7 @@ def test_with_edx_video_id_video_not_in_val(self, allow_cache_miss):
         ({'uk': 1, 'de': 1}, 'en-subs', ['de', 'en'], ['en', 'uk', 'de']),
     )
     @ddt.unpack
-    @patch('xmodule.video_block.transcripts_utils.edxval_api.get_available_transcript_languages')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.edxval_api.get_available_transcript_languages')
     def test_student_view_with_val_transcripts_enabled(self, transcripts, english_sub, val_transcripts,
                                                        expected_transcripts, mock_get_transcript_languages):
         """
@@ -1950,7 +1950,7 @@ def test_export_val_data_not_found(self):
         expected = etree.XML(expected_str, parser=parser)
         self.assertXmlEqual(expected, actual)
 
-    @patch('xmodule.video_block.transcripts_utils.get_video_ids_info')
+    @patch('openedx.core.djangoapps.video_config.transcripts_utils.get_video_ids_info')
     def test_export_no_video_ids(self, mock_get_video_ids_info):
         """
         Tests export when there is no video id. `export_to_xml` only works in case of video id.