feat: add can_stand_alone flag to publishable entity

It allows us to track components that were created independently and
components that were created under a container like unit or subsection.

Author: navinkarkera

openedx_learning/apps/authoring/components/api.py

@@ -76,21 +76,23 @@ def get_or_create_component_type(namespace: str, name: str) -> ComponentType:
     return component_type
 
 
-def create_component(
+def create_component(  # pylint: disable=too-many-positional-arguments
     learning_package_id: int,
     /,
     component_type: ComponentType,
     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)
     """
     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
         )
         component = Component.objects.create(
             publishable_entity=publishable_entity,
@@ -239,13 +241,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/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/apps/authoring/publishing/api.py

@@ -173,6 +173,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 +187,7 @@ def create_publishable_entity(
         key=key,
         created=created,
         created_by_id=created_by,
+        can_stand_alone=can_stand_alone,
     )
 
 
@@ -583,6 +586,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:
@@ -603,7 +608,7 @@ 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
         )
         container = container_cls.objects.create(
             publishable_entity=publishable_entity,

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

@@ -0,0 +1,18 @@
+# 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),
+        ),
+    ]

openedx_learning/apps/authoring/publishing/models/publishable_entity.py

@@ -126,6 +126,7 @@ class PublishableEntity(models.Model):
         null=True,
         blank=True,
     )
+    can_stand_alone = models.BooleanField(default=True)
 
     class Meta:
         constraints = [

openedx_learning/apps/authoring/units/api.py

@@ -30,7 +30,12 @@
 
 
 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.
@@ -46,6 +51,7 @@ def create_unit(
         key,
         created,
         created_by,
+        can_stand_alone=can_stand_alone,
         container_cls=Unit,
     )
 
@@ -156,6 +162,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.
@@ -168,7 +175,7 @@ def create_unit_and_version(
     """
     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)
         unit_version = create_unit_version(
             unit,
             1,

tests/openedx_learning/apps/authoring/components/test_api.py

@@ -322,6 +322,7 @@ def setUpTestData(cls) -> None:
             local_key='my_component',
             created=cls.now,
             created_by=None,
+            can_stand_alone=False,
         )
 
     def test_simple_get(self):
@@ -333,6 +334,16 @@ def test_publishing_entity_key_convention(self):
         """Our mapping convention is {namespace}:{component_type}:{local_key}"""
         assert self.problem.key == "xblock.v1:problem:my_component"
 
+    def test_stand_alone_flag(self):
+        """Check if can_stand_alone flag is set"""
+        component = components_api.get_component_by_key(
+            self.learning_package.id,
+            namespace='xblock.v1',
+            type_name='html',
+            local_key='my_component',
+        )
+        assert not component.publishable_entity.can_stand_alone
+
     def test_get_by_key(self):
         assert self.html == components_api.get_component_by_key(
             self.learning_package.id,

tests/openedx_learning/apps/authoring/units/test_api.py

@@ -222,6 +222,7 @@ def test_create_empty_unit_and_version(self):
         assert unit.versioning.has_unpublished_changes
         assert unit.versioning.draft == unit_version
         assert unit.versioning.published is None
+        assert unit.publishable_entity.can_stand_alone
 
     def test_create_next_unit_version_with_two_unpinned_components(self):
         """Test creating a unit version with two unpinned components.