openedx-learning 0.19.0__tar.gz → 0.19.2__tar.gz

{openedx_learning-0.19.0/openedx_learning.egg-info → openedx_learning-0.19.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: openedx-learning
-Version: 0.19.0
+Version: 0.19.2
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,12 +18,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: attrs
-Requires-Dist: Django<5.0
-Requires-Dist: rules<4.0
 Requires-Dist: edx-drf-extensions
-Requires-Dist: celery
+Requires-Dist: rules<4.0
 Requires-Dist: djangorestframework<4.0
+Requires-Dist: Django<5.0
+Requires-Dist: celery
+Requires-Dist: attrs
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -31,6 +31,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/openedx_learning/__init__.py

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

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/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,
@@ -239,13 +245,20 @@ def create_component_and_version(  # pylint: disable=too-many-positional-argumen
     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,

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/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):

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/openedx_learning/apps/authoring/publishing/api.py

@@ -8,6 +8,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from datetime import datetime, timezone
+from enum import Enum
 from typing import TypeVar
 
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
@@ -71,10 +72,14 @@ __all__ = [
     "create_container_version",
     "create_next_container_version",
     "get_container",
+    "get_container_by_key",
+    "get_containers",
+    "ChildrenEntitiesAction",
     "ContainerEntityListEntry",
     "get_entities_in_container",
     "contains_unpublished_changes",
     "get_containers_with_entity",
+    "get_container_children_count",
 ]
 
 
@@ -173,6 +178,8 @@ def create_publishable_entity(
     created: datetime,
     # User ID who created this
     created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
 ) -> PublishableEntity:
     """
     Create a PublishableEntity.
@@ -185,6 +192,7 @@ def create_publishable_entity(
         key=key,
         created=created,
         created_by_id=created_by,
+        can_stand_alone=can_stand_alone,
     )
 
 
@@ -583,6 +591,8 @@ def create_container(
     key: str,
     created: datetime,
     created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
     # The types on the following line are correct, but mypy will complain - https://github.com/python/mypy/issues/3737
     container_cls: type[ContainerModel] = Container,  # type: ignore[assignment]
 ) -> ContainerModel:
@@ -595,6 +605,7 @@ def create_container(
         key: The key of the container.
         created: The date and time the container was created.
         created_by: The ID of the user who created the container
+        can_stand_alone: Set to False when created as part of containers
         container_cls: The subclass of Container to use, if applicable
 
     Returns:
@@ -603,7 +614,11 @@ def create_container(
     assert issubclass(container_cls, Container)
     with atomic():
         publishable_entity = create_publishable_entity(
-            learning_package_id, key, created, created_by
+            learning_package_id,
+            key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone,
         )
         container = container_cls.objects.create(
             publishable_entity=publishable_entity,
@@ -759,6 +774,70 @@ def create_container_version(
     return container_version
 
 
+class ChildrenEntitiesAction(Enum):
+    """Possible actions for children entities"""
+
+    APPEND = "append"
+    REMOVE = "remove"
+    REPLACE = "replace"
+
+
+def create_next_entity_list(
+    learning_package_id: int,
+    last_version: ContainerVersion,
+    publishable_entities_pks: list[int],
+    entity_version_pks: list[int | None] | None,
+    entities_action: ChildrenEntitiesAction = ChildrenEntitiesAction.REPLACE,
+) -> EntityList:
+    """
+    Creates next entity list based on the given entities_action.
+
+    Args:
+        learning_package_id: Learning package ID
+        last_version: Last version of container.
+        publishable_entities_pks: The IDs of the members current members of the container.
+        entity_version_pks: The IDs of the versions to pin to, if pinning is desired.
+        entities_action: APPEND, REMOVE or REPLACE given entities from/to the container
+
+    Returns:
+        The newly created entity list.
+    """
+    if entity_version_pks is None:
+        entity_version_pks: list[int | None] = [None] * len(publishable_entities_pks)  # type: ignore[no-redef]
+    if entities_action == ChildrenEntitiesAction.APPEND:
+        # get previous entity list rows
+        last_entities = last_version.entity_list.entitylistrow_set.only(
+            "entity_id",
+            "entity_version_id"
+        ).order_by("order_num")
+        # append given publishable_entities_pks and entity_version_pks
+        publishable_entities_pks = [entity.entity_id for entity in last_entities] + publishable_entities_pks
+        entity_version_pks = [  # type: ignore[operator, assignment]
+            entity.entity_version_id
+            for entity in last_entities
+        ] + entity_version_pks
+    elif entities_action == ChildrenEntitiesAction.REMOVE:
+        # get previous entity list rows
+        last_entities = last_version.entity_list.entitylistrow_set.only(
+            "entity_id",
+            "entity_version_id"
+        ).order_by("order_num")
+        # Remove entities that are in publishable_entities_pks
+        new_entities = [
+            entity
+            for entity in last_entities
+            if entity.entity_id not in publishable_entities_pks
+        ]
+        publishable_entities_pks = [entity.entity_id for entity in new_entities]
+        entity_version_pks = [entity.entity_version_id for entity in new_entities]
+    next_entity_list = create_entity_list_with_rows(
+        entity_pks=publishable_entities_pks,
+        entity_version_pks=entity_version_pks,  # type: ignore[arg-type]
+        learning_package_id=learning_package_id,
+    )
+    return next_entity_list
+
+
 def create_next_container_version(
     container_pk: int,
     *,
@@ -768,6 +847,7 @@ def create_next_container_version(
     created: datetime,
     created_by: int | None,
     container_version_cls: type[ContainerVersionModel] = ContainerVersion,  # type: ignore[assignment]
+    entities_action: ChildrenEntitiesAction = ChildrenEntitiesAction.REPLACE,
 ) -> ContainerVersionModel:
     """
     [ 🛑 UNSTABLE ]
@@ -803,13 +883,14 @@ def create_next_container_version(
             # We're only changing metadata. Keep the same entity list.
             next_entity_list = last_version.entity_list
         else:
-            if entity_version_pks is None:
-                entity_version_pks = [None] * len(publishable_entities_pks)
-            next_entity_list = create_entity_list_with_rows(
-                entity_pks=publishable_entities_pks,
-                entity_version_pks=entity_version_pks,
-                learning_package_id=entity.learning_package_id,
+            next_entity_list = create_next_entity_list(
+                entity.learning_package_id,
+                last_version,
+                publishable_entities_pks,
+                entity_version_pks,
+                entities_action
             )
+
         next_container_version = _create_container_version(
             container,
             next_version_num,
@@ -837,6 +918,43 @@ def get_container(pk: int) -> Container:
     return Container.objects.get(pk=pk)
 
 
+def get_container_by_key(learning_package_id: int, /, key: str) -> Container:
+    """
+    [ 🛑 UNSTABLE ]
+    Get a container by its learning package and primary key.
+
+    Args:
+        learning_package_id: The ID of the learning package that contains the container.
+        key: The primary key of the container.
+
+    Returns:
+        The container with the given primary key.
+    """
+    return Container.objects.get(
+        publishable_entity__learning_package_id=learning_package_id,
+        publishable_entity__key=key,
+    )
+
+
+def get_containers(
+    learning_package_id: int,
+    container_cls: type[ContainerModel] = Container,  # type: ignore[assignment]
+) -> QuerySet[ContainerModel]:
+    """
+    [ 🛑 UNSTABLE ]
+    Get all containers in the given learning package.
+
+    Args:
+        learning_package_id: The primary key of the learning package
+        container_cls: The subclass of Container to use, if applicable
+
+    Returns:
+        A queryset containing the container associated with the given learning package.
+    """
+    assert issubclass(container_cls, Container)
+    return container_cls.objects.filter(publishable_entity__learning_package=learning_package_id)
+
+
 @dataclass(frozen=True)
 class ContainerEntityListEntry:
     """
@@ -969,3 +1087,29 @@ def get_containers_with_entity(
     #     publishable_entity__draft__version__containerversion__entity_list__in=lists
     # )
     return qs
+
+
+def get_container_children_count(
+    container: Container,
+    *,
+    published: bool,
+):
+    """
+    [ 🛑 UNSTABLE ]
+    Get the count of entities in the current draft or published version of the given container.
+
+    Args:
+        container: The Container, e.g. returned by `get_container()`
+        published: `True` if we want the published version of the container, or
+            `False` for the draft version.
+    """
+    assert isinstance(container, Container)
+    container_version = container.versioning.published if published else container.versioning.draft
+    if container_version is None:
+        raise ContainerVersion.DoesNotExist  # This container has not been published yet, or has been deleted.
+    assert isinstance(container_version, ContainerVersion)
+    if published:
+        filter_deleted = {"entity__published__version__isnull": False}
+    else:
+        filter_deleted = {"entity__draft__version__isnull": False}
+    return container_version.entity_list.entitylistrow_set.filter(**filter_deleted).count()

openedx_learning-0.19.2/openedx_learning/apps/authoring/publishing/migrations/0004_publishableentity_can_stand_alone.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.19 on 2025-03-17 11:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_publishing', '0003_containers'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='publishableentity',
+            name='can_stand_alone',
+            field=models.BooleanField(
+                default=True,
+                help_text="Set to True when created independently, False when created as part of a container.",
+            ),
+        ),
+    ]

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/openedx_learning/apps/authoring/publishing/models/entity_list.py

@@ -60,6 +60,7 @@ class EntityListRow(models.Model):
     )
 
     class Meta:
+        ordering = ["order_num"]
         constraints = [
             # If (entity_list, order_num) is not unique, it likely indicates a race condition - so force uniqueness.
             models.UniqueConstraint(

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/openedx_learning/apps/authoring/publishing/models/publishable_entity.py

@@ -9,6 +9,7 @@ from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.core.validators import MinValueValidator
 from django.db import models
+from django.utils.translation import gettext as _
 
 from openedx_learning.lib.fields import (
     case_insensitive_char_field,
@@ -126,6 +127,10 @@ class PublishableEntity(models.Model):
         null=True,
         blank=True,
     )
+    can_stand_alone = models.BooleanField(
+        default=True,
+        help_text=_("Set to True when created independently, False when created as part of a container."),
+    )
 
     class Meta:
         constraints = [

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/openedx_learning/apps/authoring/units/api.py

@@ -30,7 +30,12 @@ __all__ = [
 
 
 def create_unit(
-    learning_package_id: int, key: str, created: datetime, created_by: int | None
+    learning_package_id: int,
+    key: str,
+    created: datetime,
+    created_by: int | None,
+    *,
+    can_stand_alone: bool = True,
 ) -> Unit:
     """
     [ 🛑 UNSTABLE ] Create a new unit.
@@ -40,12 +45,14 @@ def create_unit(
         key: The key.
         created: The creation date.
         created_by: The user who created the unit.
+        can_stand_alone: Set to False when created as part of containers
     """
     return publishing_api.create_container(
         learning_package_id,
         key,
         created,
         created_by,
+        can_stand_alone=can_stand_alone,
         container_cls=Unit,
     )
 
@@ -123,6 +130,7 @@ def create_next_unit_version(
     components: list[Component | ComponentVersion] | None = None,
     created: datetime,
     created_by: int | None = None,
+    entities_action: publishing_api.ChildrenEntitiesAction = publishing_api.ChildrenEntitiesAction.REPLACE,
 ) -> UnitVersion:
     """
     [ 🛑 UNSTABLE ] Create the next unit version.
@@ -144,6 +152,7 @@ def create_next_unit_version(
         created=created,
         created_by=created_by,
         container_version_cls=UnitVersion,
+        entities_action=entities_action,
     )
     return unit_version
 
@@ -156,6 +165,7 @@ def create_unit_and_version(
     components: list[Component | ComponentVersion] | None = None,
     created: datetime,
     created_by: int | None = None,
+    can_stand_alone: bool = True,
 ) -> tuple[Unit, UnitVersion]:
     """
     [ 🛑 UNSTABLE ] Create a new unit and its version.
@@ -165,10 +175,17 @@ def create_unit_and_version(
         key: The key.
         created: The creation date.
         created_by: The user who created the unit.
+        can_stand_alone: Set to False when created as part of containers
     """
     publishable_entities_pks, entity_version_pks = _pub_entities_for_components(components)
     with atomic():
-        unit = create_unit(learning_package_id, key, created, created_by)
+        unit = create_unit(
+            learning_package_id,
+            key,
+            created,
+            created_by,
+            can_stand_alone=can_stand_alone,
+        )
         unit_version = create_unit_version(
             unit,
             1,

{openedx_learning-0.19.0 → openedx_learning-0.19.2/openedx_learning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: openedx-learning
-Version: 0.19.0
+Version: 0.19.2
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,12 +18,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: attrs
-Requires-Dist: Django<5.0
-Requires-Dist: rules<4.0
 Requires-Dist: edx-drf-extensions
-Requires-Dist: celery
+Requires-Dist: rules<4.0
 Requires-Dist: djangorestframework<4.0
+Requires-Dist: Django<5.0
+Requires-Dist: celery
+Requires-Dist: attrs
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -31,6 +31,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/openedx_learning.egg-info/SOURCES.txt

@@ -54,6 +54,7 @@ openedx_learning/apps/authoring/publishing/apps.py
 openedx_learning/apps/authoring/publishing/migrations/0001_initial.py
 openedx_learning/apps/authoring/publishing/migrations/0002_alter_learningpackage_key_and_more.py
 openedx_learning/apps/authoring/publishing/migrations/0003_containers.py
+openedx_learning/apps/authoring/publishing/migrations/0004_publishableentity_can_stand_alone.py
 openedx_learning/apps/authoring/publishing/migrations/__init__.py
 openedx_learning/apps/authoring/publishing/models/__init__.py
 openedx_learning/apps/authoring/publishing/models/container.py

{openedx_learning-0.19.0 → openedx_learning-0.19.2}/openedx_learning.egg-info/requires.txt

@@ -1,6 +1,6 @@
-attrs
-Django<5.0
-rules<4.0
 edx-drf-extensions
-celery
+rules<4.0
 djangorestframework<4.0
+Django<5.0
+celery
+attrs