fix: fix quality check for video block code

Author: farhan

docs/conf.py

@@ -26,6 +26,10 @@
     USE_TZ=True,
     LANGUAGE_CODE="en-us",
     LANGUAGES=[("en", "English")],
+    INSTALLED_APPS=[
+        "edxval",
+    ],
+    TRANSCRIPT_LANG_CACHE_TIMEOUT=60 * 60 * 24,  # 24 hours, required by edxval
 )
 
 django.setup()

test_settings.py

@@ -5,10 +5,13 @@
 INSTALLED_APPS = [
     "django.contrib.auth",
     "django.contrib.contenttypes",
+    "edxval",
 ]
 
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
     }
 }
+
+TRANSCRIPT_LANG_CACHE_TIMEOUT = 60 * 60 * 24  # 24 hours

xblocks_contrib/common/utils.py

@@ -5,7 +5,6 @@
 from django.conf import settings
 
 
-
 def get_resource_url(xblock, path, package_scope=None):
     """
     Return the runtime URL for a static resource in this XBlock's package.

xblocks_contrib/html/html.py

@@ -322,7 +322,7 @@ def get_context(self):
         # the root /c4x/ url for assets. This allows client-side substitutions to occur.
         return {
             "module": self,
-            "editable_metadata_fields": self.editable_metadata_fields,  # pylint: disable=no-member
+            "editable_metadata_fields": self.editable_metadata_fields,
             "data": self.data,
             "base_asset_url": self.get_base_url_path_for_course_assets(self.location.course_key),
             "enable_latex_compiler": self.use_latex_compiler,
@@ -371,7 +371,7 @@ def bind_for_student(self, user_id, wrappers=None):
         if self.scope_ids.user_id is not None and user_id == self.scope_ids.user_id:
             if getattr(self.runtime, "position", None):
                 # update the position of the tab
-                self.position = self.runtime.position  # pylint: disable=attribute-defined-outside-init
+                self.position = self.runtime.position
             return
 
         # # If we are switching users mid-request, save the data from the old user.
@@ -402,7 +402,7 @@ def bind_for_student(self, user_id, wrappers=None):
             wrapped_field_data = self.runtime.service(self, "field-data-unbound")
             for wrapper in wrappers:
                 wrapped_field_data = wrapper(wrapped_field_data)
-            self._bound_field_data = wrapped_field_data  # pylint: disable=attribute-defined-outside-init
+            self._bound_field_data = wrapped_field_data
             if getattr(self.runtime, "uses_deprecated_field_data", False):
                 # This approach is deprecated but old mongo's CachingDescriptorSystem still requires it.
                 # For Split mongo's CachingDescriptor system, don't set ._field_data this way.

xblocks_contrib/video/content.py

@@ -1,13 +1,24 @@
-""" Video Block Static Content, class copied from StaticContent class in edx-platform/xmodule/contentstore/content.py """
+"""
+Video Block Static Content.
+
+Class copied from StaticContent class in edx-platform/xmodule/contentstore/content.py
+"""
 from opaque_keys import InvalidKeyError
 from opaque_keys.edx.keys import AssetKey
 from opaque_keys.edx.locator import AssetLocator
 
-class VideoBlockStaticContent:  # lint-amnesty, pylint: disable=missing-class-docstring
-    def __init__(self, loc, name, content_type, data, last_modified_at=None, thumbnail_location=None, import_path=None,
-                 length=None, locked=False, content_digest=None):
+
+class VideoBlockStaticContent:
+    """
+    Represents static content associated with a video block (such as video files or related assets).
+    """
+    def __init__(  # pylint: disable=too-many-positional-arguments
+        self, loc, name, content_type, data, last_modified_at=None,
+        thumbnail_location=None, import_path=None, length=None, locked=False, content_digest=None
+    ):
         self.location = loc
-        self.name = name  # a display string which can be edited, and thus not part of the location which needs to be fixed  # lint-amnesty, pylint: disable=line-too-long
+        # a display string which can be edited, and thus not part of the location which needs to be fixed
+        self.name = name
         self.content_type = content_type
         self._data = data
         self.length = length
@@ -20,7 +31,7 @@ def __init__(self, loc, name, content_type, data, last_modified_at=None, thumbna
         self.content_digest = content_digest
 
     @staticmethod
-    def compute_location(course_key, path, revision=None, is_thumbnail=False):  # lint-amnesty, pylint: disable=unused-argument
+    def compute_location(course_key, path, revision=None, is_thumbnail=False):  # pylint: disable=unused-argument
         """
         Constructs a location object for static content.
 
@@ -48,6 +59,7 @@ def get_location_from_path(path):
             if path.startswith('/') or path.endswith('/'):
                 # try stripping off the leading slash and try again
                 return AssetKey.from_string(path.strip('/'))
+            return None
 
     @staticmethod
     def serialize_asset_key_with_slash(asset_key):

xblocks_contrib/video/mixin.py

@@ -5,9 +5,11 @@
 from xblock.core import XBlockMixin
 from xblock.fields import Scope, String
 
-# Make '_' a no-op so we can scrape strings. Using lambda instead of
+
+# Make '_' a no-op so we can scrape strings. Using dummy function instead of
 #  `django.utils.translation.gettext_noop` because Django cannot be imported in this file
-_ = lambda text: text
+def _(text):
+    return text
 
 
 class LicenseMixin(XBlockMixin):

xblocks_contrib/video/studio_metadata_mixin.py

@@ -123,7 +123,7 @@ def editable_metadata_fields(self):
         editable_fields.pop('sub')
 
         languages = [{'label': label, 'code': lang} for lang, label in settings.ALL_LANGUAGES]
-        languages.sort(key=lambda l: l['label'])
+        languages.sort(key=lambda lang_item: lang_item['label'])
         editable_fields['transcripts']['custom'] = True
         editable_fields['transcripts']['languages'] = languages
         editable_fields['transcripts']['type'] = 'VideoTranslations'
@@ -148,7 +148,9 @@ def editable_metadata_fields(self):
         if video_config_service:
             for sub_id in possible_sub_ids:
                 try:
-                    _, sub_id, _ = video_config_service.get_transcript(self, lang='en', output_format=TranscriptExtensions.TXT)
+                    _, sub_id, _ = video_config_service.get_transcript(
+                        self, lang='en', output_format=TranscriptExtensions.TXT
+                    )
                     transcripts_info['transcripts'] = dict(transcripts_info['transcripts'], en=sub_id)
                     break
                 except TranscriptNotFoundError:

xblocks_contrib/video/tests/__init__.py

@@ -0,0 +1,3 @@
+"""
+Tests for the video xblock.
+"""

xblocks_contrib/video/tests/test_video.py

@@ -15,7 +15,9 @@ class StudioValidationMessage(ValidationMessage):
 
     TYPES = [ValidationMessage.WARNING, ValidationMessage.ERROR, NOT_CONFIGURED]
 
-    def __init__(self, message_type, message_text, action_label=None, action_class=None, action_runtime_event=None):
+    def __init__(  # pylint: disable=too-many-positional-arguments
+        self, message_type, message_text, action_label=None, action_class=None, action_runtime_event=None
+    ):
         """
         Create a new message.