Containers/units: High level APIs and expanded test cases

openedx_learning/api/authoring.py

@@ -11,9 +11,9 @@
 # pylint: disable=wildcard-import
 from ..apps.authoring.collections.api import *
 from ..apps.authoring.components.api import *
+from ..apps.authoring.containers.api import *
 from ..apps.authoring.contents.api import *
 from ..apps.authoring.publishing.api import *
-from ..apps.authoring.containers.api import *
 from ..apps.authoring.units.api import *
 
 # This was renamed after the authoring API refactoring pushed this and other

openedx_learning/api/authoring_models.py

@@ -9,6 +9,8 @@
 # pylint: disable=wildcard-import
 from ..apps.authoring.collections.models import *
 from ..apps.authoring.components.models import *
+from ..apps.authoring.containers.models import *
 from ..apps.authoring.contents.models import *
 from ..apps.authoring.publishing.model_mixins import *
 from ..apps.authoring.publishing.models import *
+from ..apps.authoring.units.models import *

openedx_learning/apps/authoring/components/api.py

@@ -231,7 +231,7 @@ def create_next_component_version(
         return component_version
 
 
-def create_component_and_version(
+def create_component_and_version(  # pylint: disable=too-many-positional-arguments
     learning_package_id: int,
     /,
     component_type: ComponentType,
@@ -326,7 +326,7 @@ def component_exists_by_key(
         return False
 
 
-def get_components(
+def get_components(  # pylint: disable=too-many-positional-arguments
     learning_package_id: int,
     /,
     draft: bool | None = None,

openedx_learning/apps/authoring/components/models.py

@@ -17,6 +17,8 @@
 """
 from __future__ import annotations
 
+from typing import ClassVar
+
 from django.db import models
 
 from ....lib.fields import case_sensitive_char_field, immutable_uuid_field, key_field
@@ -76,7 +78,7 @@ def __str__(self):
         return f"{self.namespace}:{self.name}"
 
 
-class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
+class Component(PublishableEntityMixin):
     """
     This represents any Component that has ever existed in a LearningPackage.
 
@@ -120,14 +122,12 @@ class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
     Make a foreign key to the Component model when you need a stable reference
     that will exist for as long as the LearningPackage itself exists.
     """
-    # Tell mypy what type our objects manager has.
-    # It's actually PublishableEntityMixinManager, but that has the exact same
-    # interface as the base manager class.
-    objects: models.Manager[Component] = WithRelationsManager(
+    # Set up our custom manager. It has the same API as the default one, but selects related objects by default.
+    objects: ClassVar[WithRelationsManager[Component]] = WithRelationsManager(  # type: ignore[assignment]
         'component_type'
     )
 
-    with_publishing_relations: models.Manager[Component] = WithRelationsManager(
+    with_publishing_relations = WithRelationsManager(
         'component_type',
         'publishable_entity',
         'publishable_entity__draft__version',
@@ -201,10 +201,6 @@ class ComponentVersion(PublishableEntityVersionMixin):
     This holds the content using a M:M relationship with Content via
     ComponentVersionContent.
     """
-    # Tell mypy what type our objects manager has.
-    # It's actually PublishableEntityVersionMixinManager, but that has the exact
-    # same interface as the base manager class.
-    objects: models.Manager[ComponentVersion]
 
     # This is technically redundant, since we can get this through
     # publishable_entity_version.publishable.component, but this is more