temp: pylint cleanup

Author: ormsbee

openedx_learning/api/authoring.py

@@ -9,14 +9,7 @@
 """
 # These wildcard imports are okay because these api modules declare __all__.
 # pylint: disable=wildcard-import
-from ..apps.authoring.applets.backup_restore.api import *
-from ..apps.authoring.applets.collections.api import *
-from ..apps.authoring.applets.components.api import *
-from ..apps.authoring.applets.contents.api import *
-from ..apps.authoring.applets.publishing.api import *
-from ..apps.authoring.applets.sections.api import *
-from ..apps.authoring.applets.subsections.api import *
-from ..apps.authoring.applets.units.api import *
+from ..apps.authoring.api import *
 
 # This was renamed after the authoring API refactoring pushed this and other
 # app APIs into the openedx_learning.api.authoring module. Here I'm aliasing to

openedx_learning/apps/authoring/admin.py

@@ -1,3 +1,8 @@
+"""
+This module aggregates all applet Django Admin modules.
+"""
+# pylint: disable=wildcard-import
+
 from .applets.backup_restore.admin import *
 from .applets.collections.admin import *
 from .applets.components.admin import *
@@ -6,7 +11,3 @@
 from .applets.sections.admin import *
 from .applets.subsections.admin import *
 from .applets.units.admin import *
-
-#from openedx_learning.lib import appletslib
-
-#globals().update(appletslib.auto_import_admin())

openedx_learning/apps/authoring/api.py

@@ -1,3 +1,11 @@
+"""
+This module aggregates all applet API modules.
+
+Question: Should this replace openedx_learning.api.authoring?
+"""
+
+# pylint: disable=wildcard-import
+
 from .applets.backup_restore.api import *
 from .applets.collections.api import *
 from .applets.components.api import *
@@ -6,7 +14,3 @@
 from .applets.sections.api import *
 from .applets.subsections.api import *
 from .applets.units.api import *
-
-#from openedx_learning.lib import appletslib
-
-#globals().update(appletslib.auto_import_api())

openedx_learning/apps/authoring/applets/contents/models.py

@@ -16,7 +16,12 @@
 from django.db import models
 from django.utils.module_loading import import_string
 
-from openedx_learning.lib.fields import MultiCollationTextField, case_insensitive_char_field, hash_field, manual_date_time_field
+from openedx_learning.lib.fields import (
+    MultiCollationTextField,
+    case_insensitive_char_field,
+    hash_field,
+    manual_date_time_field,
+)
 from openedx_learning.lib.managers import WithRelationsManager
 from ..publishing.models import LearningPackage
 

openedx_learning/apps/authoring/apps.py

@@ -1,5 +1,9 @@
+"""
+Docstring for openedx_learning.apps.authoring.apps
+"""
 from django.apps import AppConfig
 
+
 class AuthoringConfig(AppConfig):
     name = "openedx_learning.apps.authoring"
     verbose_name = "Learning Core > Authoring"

openedx_learning/apps/authoring/management/commands/add_assets_to_component.py

@@ -9,8 +9,7 @@
 
 from django.core.management.base import BaseCommand
 
-from ....publishing.api import get_learning_package_by_key
-from ...api import create_next_component_version, get_component_by_key
+from ...api import create_next_component_version, get_component_by_key, get_learning_package_by_key
 
 
 class Command(BaseCommand):

openedx_learning/apps/authoring/models.py

@@ -1,3 +1,12 @@
+"""
+This module aggregates all applet model modules.
+
+I experimented with creating a utility to auto-detect applets and magically
+import their modules, but that broke code introspection.
+"""
+
+# pylint: disable=wildcard-import
+
 from .applets.backup_restore.models import *
 from .applets.collections.models import *
 from .applets.components.models import *
@@ -6,7 +15,3 @@
 from .applets.sections.models import *
 from .applets.subsections.models import *
 from .applets.units.models import *
-
-# from openedx_learning.lib import appletslib
-
-# globals().update(appletslib.auto_import_models())

openedx_learning/lib/appletslib.py

@@ -7,7 +7,10 @@
 from django.contrib.auth import get_user_model
 from django.core.management import call_command
 
-from openedx_learning.apps.authoring.applets.backup_restore.zipper import LearningPackageUnzipper, generate_staged_lp_key
+from openedx_learning.apps.authoring.applets.backup_restore.zipper import (
+    LearningPackageUnzipper,
+    generate_staged_lp_key,
+)
 from openedx_learning.apps.authoring.applets.collections import api as collections_api
 from openedx_learning.apps.authoring.applets.components import api as components_api
 from openedx_learning.apps.authoring.applets.publishing import api as publishing_api

tests/openedx_learning/apps/authoring/applets/backup_restore/test_restore.py

@@ -3,7 +3,10 @@
 """
 from typing import TYPE_CHECKING, assert_type
 
-from openedx_learning.apps.authoring.applets.publishing.models import PublishableEntityMixin, PublishableEntityVersionMixin
+from openedx_learning.apps.authoring.applets.publishing.models import (
+    PublishableEntityMixin,
+    PublishableEntityVersionMixin,
+)
 from openedx_learning.lib.managers import WithRelationsManager
 
 if TYPE_CHECKING: