openedx-learning 0.18.3__tar.gz → 0.19.1__tar.gz

{openedx_learning-0.18.3/openedx_learning.egg-info → openedx_learning-0.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: openedx-learning
-Version: 0.18.3
+Version: 0.19.1
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,11 +18,11 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: rules<4.0
-Requires-Dist: attrs
 Requires-Dist: edx-drf-extensions
 Requires-Dist: Django<5.0
+Requires-Dist: rules<4.0
 Requires-Dist: celery
+Requires-Dist: attrs
 Requires-Dist: djangorestframework<4.0
 Dynamic: author
 Dynamic: author-email

{openedx_learning-0.18.3 → openedx_learning-0.19.1}/openedx_learning/__init__.py

@@ -2,4 +2,4 @@
 Open edX Learning ("Learning Core").
 """
 
-__version__ = "0.18.3"
+__version__ = "0.19.1"

{openedx_learning-0.18.3 → openedx_learning-0.19.1}/openedx_learning/api/authoring.py

@@ -13,6 +13,7 @@ from ..apps.authoring.collections.api import *
 from ..apps.authoring.components.api import *
 from ..apps.authoring.contents.api import *
 from ..apps.authoring.publishing.api import *
+from ..apps.authoring.units.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-0.18.3 → openedx_learning-0.19.1}/openedx_learning/api/authoring_models.py

@@ -10,5 +10,5 @@ consistent.
 from ..apps.authoring.collections.models import *
 from ..apps.authoring.components.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-0.18.3 → openedx_learning-0.19.1}/openedx_learning/apps/authoring/components/api.py

@@ -83,6 +83,8 @@ def create_component(
     local_key: str,
     created: datetime,
     created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
 ) -> Component:
     """
     Create a new Component (an entity like a Problem or Video)
@@ -90,7 +92,11 @@ def create_component(
     key = f"{component_type.namespace}:{component_type.name}:{local_key}"
     with atomic():
         publishable_entity = publishing_api.create_publishable_entity(
-            learning_package_id, key, created, created_by
+            learning_package_id,
+            key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone
         )
         component = Component.objects.create(
             publishable_entity=publishable_entity,
@@ -231,7 +237,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,
@@ -239,13 +245,20 @@ def create_component_and_version(
     title: str,
     created: datetime,
     created_by: int | None = None,
+    *,
+    can_stand_alone: bool = True,
 ) -> tuple[Component, ComponentVersion]:
     """
     Create a Component and associated ComponentVersion atomically
     """
     with atomic():
         component = create_component(
-            learning_package_id, component_type, local_key, created, created_by
+            learning_package_id,
+            component_type,
+            local_key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone,
         )
         component_version = create_component_version(
             component.pk,
@@ -326,7 +339,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,
@@ -468,7 +481,7 @@ def _get_component_version_info_headers(component_version: ComponentVersion) ->
         "X-Open-edX-Component-Uuid": component.uuid,
         # Component Version
         "X-Open-edX-Component-Version-Uuid": component_version.uuid,
-        "X-Open-edX-Component-Version-Num": component_version.version_num,
+        "X-Open-edX-Component-Version-Num": str(component_version.version_num),
         # Learning Package
         "X-Open-edX-Learning-Package-Key": learning_package.key,
         "X-Open-edX-Learning-Package-Uuid": learning_package.uuid,

{openedx_learning-0.18.3 → openedx_learning-0.19.1}/openedx_learning/apps/authoring/components/apps.py

@@ -14,7 +14,7 @@ class ComponentsConfig(AppConfig):
     default_auto_field = "django.db.models.BigAutoField"
     label = "oel_components"
 
-    def ready(self):
+    def ready(self) -> None:
         """
         Register Component and ComponentVersion.
         """

{openedx_learning-0.18.3 → openedx_learning-0.19.1}/openedx_learning/apps/authoring/components/models.py

@@ -17,13 +17,14 @@ convention, but it's possible we might want to have special identifiers later.
 """
 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
 from ....lib.managers import WithRelationsManager
 from ..contents.models import Content
-from ..publishing.model_mixins import PublishableEntityMixin, PublishableEntityVersionMixin
-from ..publishing.models import LearningPackage
+from ..publishing.models import LearningPackage, PublishableEntityMixin, PublishableEntityVersionMixin
 
 __all__ = [
     "ComponentType",
@@ -72,11 +73,11 @@ class ComponentType(models.Model):
         ),
     ]
 
-    def __str__(self):
+    def __str__(self) -> str:
         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 +121,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',
@@ -190,7 +189,7 @@ class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
         verbose_name = "Component"
         verbose_name_plural = "Components"
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.component_type.namespace}:{self.component_type.name}:{self.local_key}"
 
 
@@ -201,10 +200,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

{openedx_learning-0.18.3 → openedx_learning-0.19.1}/openedx_learning/apps/authoring/contents/models.py

@@ -121,7 +121,7 @@ class MediaType(models.Model):
             ),
         ]
 
-    def __str__(self):
+    def __str__(self) -> str:
         base = f"{self.type}/{self.sub_type}"
         if self.suffix:
             return f"{base}+{self.suffix}"

{openedx_learning-0.18.3 → openedx_learning-0.19.1}/openedx_learning/apps/authoring/publishing/admin.py

@@ -85,6 +85,7 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "learning_package",
         "created",
         "created_by",
+        "can_stand_alone",
     ]
     list_filter = ["learning_package"]
     search_fields = ["key", "uuid"]
@@ -98,6 +99,7 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "created",
         "created_by",
         "see_also",
+        "can_stand_alone",
     ]
     readonly_fields = [
         "key",
@@ -108,6 +110,7 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "created",
         "created_by",
         "see_also",
+        "can_stand_alone",
     ]
 
     def get_queryset(self, request):