refactor: Unit -> UnitType, etc.

Author: bradenmacdonald

src/openedx_content/api.py

@@ -15,6 +15,6 @@
 from .applets.components.api import *
 from .applets.media.api import *
 from .applets.publishing.api import *
-from .applets.sections.models import Section  # Note this isn't a model. Should we move it?
-from .applets.subsections.models import Subsection  # Note this isn't a model. Should we move it?
-from .applets.units.models import Unit  # Note this isn't a model. Should we move it?
+from .applets.sections.models import SectionType  # Note this isn't a model. Should we move it?
+from .applets.subsections.models import SubsectionType  # Note this isn't a model. Should we move it?
+from .applets.units.models import UnitType  # Note this isn't a model. Should we move it?

src/openedx_content/applets/backup_restore/zipper.py

@@ -33,9 +33,9 @@
 from ..components import api as components_api
 from ..media import api as media_api
 from ..publishing import api as publishing_api
-from ..units.models import Unit
-from ..subsections.models import Subsection
-from ..sections.models import Section
+from ..units.models import UnitType
+from ..subsections.models import SubsectionType
+from ..sections.models import SectionType
 from .serializers import (
     CollectionSerializer,
     ComponentSerializer,
@@ -843,7 +843,7 @@ def _save_units(self, learning_package, containers):
         self._save_container(
             learning_package,
             containers,
-            container_type=Unit,
+            container_type=UnitType,
             container_map=self.units_map_by_key,
             children_map=self.components_map_by_key,
         )
@@ -853,7 +853,7 @@ def _save_subsections(self, learning_package, containers):
         self._save_container(
             learning_package,
             containers,
-            container_type=Subsection,
+            container_type=SubsectionType,
             container_map=self.subsections_map_by_key,
             children_map=self.units_map_by_key,
         )
@@ -863,7 +863,7 @@ def _save_sections(self, learning_package, containers):
         self._save_container(
             learning_package,
             containers,
-            container_type=Section,
+            container_type=SectionType,
             container_map=self.sections_map_by_key,
             children_map=self.subsections_map_by_key,
         )
@@ -907,9 +907,9 @@ def _process_draft_containers(
                     created_by=self.user_id,
                 )
 
-        _process_draft_containers(Unit, self.units_map_by_key, children_map=self.components_map_by_key)
-        _process_draft_containers(Subsection, self.subsections_map_by_key, children_map=self.units_map_by_key)
-        _process_draft_containers(Section, self.sections_map_by_key, children_map=self.subsections_map_by_key)
+        _process_draft_containers(UnitType, self.units_map_by_key, children_map=self.components_map_by_key)
+        _process_draft_containers(SubsectionType, self.subsections_map_by_key, children_map=self.units_map_by_key)
+        _process_draft_containers(SectionType, self.sections_map_by_key, children_map=self.subsections_map_by_key)
 
     # --------------------------
     # Utilities

src/openedx_content/applets/sections/models.py

@@ -8,14 +8,14 @@
 
 from ..publishing.api import ContainerTypeImplementation, get_container_type
 from ..publishing.models import PublishableEntity
-from ..subsections.models import Subsection
+from ..subsections.models import SubsectionType
 
 __all__ = [
-    "Section",
+    "SectionType",
 ]
 
 
-class Section(ContainerTypeImplementation):
+class SectionType(ContainerTypeImplementation):
     """
     A Section is type of Container that holds Subsections.
 
@@ -31,10 +31,10 @@ def validate_entity(cls, entity: PublishableEntity) -> None:
         """Check if the given entity is allowed as a child of a Section"""
         # Sections only allow Subsections as children, so the entity must be 1:1 with Container:
         container = entity.container  # Could raise PublishableEntity.container.RelatedObjectDoesNotExist
-        if get_container_type(container) is not Subsection:
+        if get_container_type(container) is not SubsectionType:
             raise ValidationError("Only Subsection can be added as children of a Section")
 
     # validate settings
 
 
-ContainerTypeImplementation.register(Section)
+ContainerTypeImplementation.register(SectionType)

src/openedx_content/applets/subsections/models.py

@@ -8,14 +8,14 @@
 
 from ..publishing.api import ContainerTypeImplementation, get_container_type
 from ..publishing.models import PublishableEntity
-from ..units.models import Unit
+from ..units.models import UnitType
 
 __all__ = [
-    "Subsection",
+    "SubsectionType",
 ]
 
 
-class Subsection(ContainerTypeImplementation):
+class SubsectionType(ContainerTypeImplementation):
     """
     A Subsection is type of Container that holds Units.
 
@@ -31,10 +31,10 @@ def validate_entity(cls, entity: PublishableEntity) -> None:
         """Check if the given entity is allowed as a child of a Subsection"""
         # Subsections only allow Units as children, so the entity must be 1:1 with Container:
         container = entity.container  # Could raise PublishableEntity.container.RelatedObjectDoesNotExist
-        if get_container_type(container) is not Unit:
+        if get_container_type(container) is not UnitType:
             raise ValidationError("Only Units can be added as children of a Subsection")
 
     # validate settings
 
 
-ContainerTypeImplementation.register(Subsection)
+ContainerTypeImplementation.register(SubsectionType)

src/openedx_content/applets/units/models.py

@@ -8,11 +8,11 @@
 from ..publishing.models import PublishableEntity
 
 __all__ = [
-    "Unit",
+    "UnitType",
 ]
 
 
-class Unit(ContainerTypeImplementation):
+class UnitType(ContainerTypeImplementation):
     """
     A Unit is type of Container that holds Components.
 
@@ -32,4 +32,4 @@ def validate_entity(cls, entity: PublishableEntity) -> None:
     # validate settings
 
 
-ContainerTypeImplementation.register(Unit)
+ContainerTypeImplementation.register(UnitType)

tests/openedx_content/applets/backup_restore/test_backup.py

@@ -163,7 +163,7 @@ def setUpTestData(cls):
             key="unit-1",
             created=cls.now,
             created_by=cls.user.id,
-            container_type=api.Unit,
+            container_type=api.UnitType,
         )
 
     def check_toml_file(self, zip_path: Path, zip_member_name: Path, content_to_check: list):

tests/openedx_content/applets/collections/test_api.py

@@ -251,7 +251,7 @@ def setUpTestData(cls) -> None:
             key="unit-1",
             created=created_time,
             created_by=cls.user.id,
-            container_type=api.Unit,
+            container_type=api.UnitType,
         )
 
         # Make and publish one Component

tests/openedx_content/applets/publishing/container_test_case.py

@@ -40,14 +40,14 @@ class ContainerTestCase(ComponentTestCase):
 
     def setUp(self) -> None:
         super().setUp()
-        self.create_unit = partial(self.create_container, container_type=content_api.Unit)
-        self.create_unit_and_version = partial(self.create_container_and_version, container_type=content_api.Unit)
-        self.create_subsection = partial(self.create_container, container_type=content_api.Subsection)
+        self.create_unit = partial(self.create_container, container_type=content_api.UnitType)
+        self.create_unit_and_version = partial(self.create_container_and_version, container_type=content_api.UnitType)
+        self.create_subsection = partial(self.create_container, container_type=content_api.SubsectionType)
         self.create_subsection_and_version = partial(
-            self.create_container_and_version, container_type=content_api.Subsection
+            self.create_container_and_version, container_type=content_api.SubsectionType
         )
-        self.create_section = partial(self.create_container, container_type=content_api.Section)
-        self.create_section_and_version = partial(self.create_container_and_version, container_type=content_api.Section)
+        self.create_section = partial(self.create_container, container_type=content_api.SectionType)
+        self.create_section_and_version = partial(self.create_container_and_version, container_type=content_api.SectionType)
 
     def create_component(
         self, *, title: str = "Test Component", key: str = "component:1"

tests/openedx_content/applets/subsections/test_api.py

@@ -95,7 +95,7 @@ def test_create_subsection_with_invalid_children(self):
             title="Subsection",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         assert subsection.versioning.draft == subsection_version
         subsection2, _s2v1 = content_api.create_container_and_version(
@@ -104,7 +104,7 @@ def test_create_subsection_with_invalid_children(self):
             title="Subsection 2",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         # Try adding a Subsection to a Subsection
         with pytest.raises(
@@ -135,7 +135,7 @@ def test_adding_external_units(self):
             title="Subsection",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         assert self.unit_1.publishable_entity.learning_package != learning_package2
         # Try adding a a unit from LP 1 (self.learning_package) to a subsection from LP 2
@@ -187,7 +187,7 @@ def test_create_empty_subsection_and_version(self):
             title="Subsection",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         assert subsection, subsection_version
         assert subsection_version.version_num == 1
@@ -212,7 +212,7 @@ def test_create_next_subsection_version_with_two_unpinned_units(self):
             title="Subsection",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         subsection_version_v2 = content_api.create_next_container_version(
             subsection.pk,
@@ -241,7 +241,7 @@ def test_create_next_subsection_version_forcing_version_num(self):
             title="Subsection",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         subsection_version_v2 = content_api.create_next_container_version(
             subsection.pk,
@@ -263,7 +263,7 @@ def test_create_next_subsection_version_with_unpinned_and_pinned_units(self):
             title="Subsection",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         subsection_version_v2 = content_api.create_next_container_version(
             subsection.pk,
@@ -346,7 +346,7 @@ def test_add_unit_after_publish(self):
             title="Subsection",
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         assert subsection.versioning.draft == subsection_version
         assert subsection.versioning.published is None
@@ -972,7 +972,7 @@ def test_add_remove_container_children(self):
             entities=[self.unit_1],
             created=self.now,
             created_by=None,
-            container_type=content_api.Subsection,
+            container_type=content_api.SubsectionType,
         )
         assert content_api.get_entities_in_container(subsection, published=False) == [
             Entry(self.unit_1.versioning.draft),

tests/openedx_content/applets/units/test_api.py

@@ -142,7 +142,7 @@ def test_adding_external_components(self):
             title="Unit",
             created=self.now,
             created_by=None,
-            container_type=content_api.Unit,
+            container_type=content_api.UnitType,
         )
         assert self.component_1.learning_package != learning_package2
         # Try adding a a component from LP 1 (self.learning_package) to a unit from LP 2