refactor: even simpler boilerplate, all types now just called 'ID'

Author: bradenmacdonald

src/openedx_content/applets/components/models.py

@@ -85,9 +85,6 @@ def __str__(self) -> str:
         return f"{self.namespace}:{self.name}"
 
 
-ComponentID = NewType("ComponentID", PublishableEntity.ID)
-
-
 class Component(PublishableEntityMixin):
     """
     This represents any Component that has ever existed in a LearningPackage.
@@ -133,11 +130,11 @@ class Component(PublishableEntityMixin):
     that will exist for as long as the LearningPackage itself exists.
     """
 
-    type ID = ComponentID
+    ID = NewType("ID", PublishableEntity.ID)
 
     @property
-    def id(self) -> ComponentID:
-        return cast(ComponentID, self.publishable_entity_id)
+    def id(self) -> ID:
+        return cast(Component.ID, self.publishable_entity_id)
 
     @property
     @deprecated("Use .id instead")

src/openedx_content/applets/containers/models.py

@@ -150,9 +150,6 @@ def __str__(self) -> str:  # pylint: disable=invalid-str-returned
         return self.type_code
 
 
-ContainerID = NewType("ContainerID", PublishableEntity.ID)
-
-
 class Container(PublishableEntityMixin):
     """
     A Container is a type of PublishableEntity that holds other
@@ -165,7 +162,7 @@ class Container(PublishableEntityMixin):
     entities for different learners or at different times.
     """
 
-    type ID = ContainerID
+    ID = NewType("ID", PublishableEntity.ID)
 
     type_code: str  # Subclasses must override this, e.g. "unit"
     # olx_code: the OLX <tag_name> for XML serialization. Subclasses _may_ override this.
@@ -182,8 +179,8 @@ class Container(PublishableEntityMixin):
     )
 
     @property
-    def id(self) -> ContainerID:
-        return cast(ContainerID, self.publishable_entity_id)
+    def id(self) -> ID:
+        return cast(Container.ID, self.publishable_entity_id)
 
     @property
     @deprecated("Use .id instead")

src/openedx_content/applets/publishing/models/learning_package.py

@@ -9,7 +9,7 @@
 
 from openedx_django_lib.fields import (
     MultiCollationTextField,
-    TypedBigAutoField,
+    TypedAutoField,
     case_insensitive_char_field,
     immutable_uuid_field,
     key_field,
@@ -29,17 +29,13 @@ class LearningPackage(models.Model):
     # site. Furthermore, many, many things have foreign keys to this model and
     # uniqueness indexes on those foreign keys + their own fields, so the 4
     # bytes saved will add up over time.
-    LearningPackageID = NewType("LearningPackageID", int)
-    type ID = LearningPackageID
-
-    class IDField(TypedBigAutoField[ID]):
-        pass
-
+    ID = NewType("ID", int)
+    class IDField(TypedAutoField[ID]): ...  # Note: this is ...AutoField not ...BigAutoField
     id = IDField(primary_key=True)
 
     @property  # type: ignore[no-redef]
     @deprecated("Use .id instead")
-    def pk(self) -> LearningPackageID:
+    def pk(self) -> ID:
         return self.id
 
     uuid = immutable_uuid_field()

src/openedx_content/applets/publishing/models/publishable_entity.py

@@ -112,12 +112,9 @@ class PublishableEntity(models.Model):
     mixins will provide a little syntactic sugar to make common access patterns
     more convenient, like file access.
     """
-    PublishableEntityID = NewType("PublishableEntityID", int)
-    type ID = PublishableEntityID
-
-    class IDField(TypedBigAutoField[ID]):
-        pass
-
+    # Boilerplate for fully-typed ID field:
+    ID = NewType("ID", int)
+    class IDField(TypedBigAutoField[ID]): ...
     id = IDField(primary_key=True)
 
     uuid = immutable_uuid_field()
@@ -146,7 +143,7 @@ class IDField(TypedBigAutoField[ID]):
 
     @property  # type: ignore[no-redef]
     @deprecated("Use .id instead")
-    def pk(self) -> PublishableEntityID:
+    def pk(self) -> ID:
         return self.id
 
     class Meta:

src/openedx_content/applets/sections/models.py

@@ -8,7 +8,7 @@
 from django.db import models
 
 from ..containers.api import get_container_subclass_of
-from ..containers.models import Container, ContainerID, ContainerVersion
+from ..containers.models import Container, ContainerVersion
 from ..publishing.models import PublishableEntity
 from ..subsections.models import Subsection
 
@@ -17,8 +17,6 @@
     "SectionVersion",
 ]
 
-SectionID = NewType("SectionID", ContainerID)
-
 
 @Container.register_subclass
 class Section(Container):
@@ -29,7 +27,7 @@ class Section(Container):
     entities and can be added to other containers.
     """
 
-    type ID = SectionID
+    ID = NewType("ID", Container.ID)
 
     type_code = "section"
     olx_tag_name = "chapter"  # Serializes to OLX as `<chapter>...</chapter>`.
@@ -42,8 +40,8 @@ class Section(Container):
     )
 
     @property
-    def id(self) -> SectionID:
-        return cast(SectionID, self.publishable_entity_id)
+    def id(self) -> ID:
+        return cast(Section.ID, self.publishable_entity_id)
 
     @override
     @classmethod

src/openedx_content/applets/subsections/models.py

@@ -8,7 +8,7 @@
 from django.db import models
 
 from ..containers.api import get_container_subclass_of
-from ..containers.models import Container, ContainerID, ContainerVersion
+from ..containers.models import Container, ContainerVersion
 from ..publishing.models import PublishableEntity
 from ..units.models import Unit
 
@@ -17,8 +17,6 @@
     "SubsectionVersion",
 ]
 
-SubsectionID = NewType("SubsectionID", ContainerID)
-
 
 @Container.register_subclass
 class Subsection(Container):
@@ -29,7 +27,7 @@ class Subsection(Container):
     entities and can be added to other containers.
     """
 
-    type ID = SubsectionID
+    ID = NewType("ID", Container.ID)
 
     type_code = "subsection"
     olx_tag_name = "sequential"  # Serializes to OLX as `<sequential>...</sequential>`.
@@ -42,8 +40,8 @@ class Subsection(Container):
     )
 
     @property
-    def id(self) -> SubsectionID:
-        return cast(SubsectionID, self.publishable_entity_id)
+    def id(self) -> ID:
+        return cast(Subsection.ID, self.publishable_entity_id)
 
     @override
     @classmethod

src/openedx_content/applets/units/models.py

@@ -7,16 +7,14 @@
 from django.core.exceptions import ValidationError
 from django.db import models
 
-from ..containers.models import Container, ContainerID, ContainerVersion
+from ..containers.models import Container, ContainerVersion
 from ..publishing.models import PublishableEntity
 
 __all__ = [
     "Unit",
     "UnitVersion",
 ]
 
-UnitID = NewType("UnitID", ContainerID)
-
 
 @Container.register_subclass
 class Unit(Container):
@@ -27,7 +25,7 @@ class Unit(Container):
     entities and can be added to other containers.
     """
 
-    type ID = UnitID
+    ID = NewType("ID", Container.ID)
 
     type_code = "unit"
     olx_tag_name = "vertical"  # Serializes to OLX as `<unit>...</unit>`.
@@ -40,8 +38,8 @@ class Unit(Container):
     )
 
     @property
-    def id(self) -> UnitID:
-        return cast(UnitID, self.publishable_entity_id)
+    def id(self) -> ID:
+        return cast(Unit.ID, self.publishable_entity_id)
 
     @override
     @classmethod

src/openedx_django_lib/fields.py

@@ -17,8 +17,8 @@
 from django.db import models
 
 from .collations import MultiCollationMixin
-# Re-export this field which is in a separate file so we can use a .pyi file with it:
-from .id_fields import TypedBigAutoField  # pylint: disable=unused-import
+# Re-export these fields which are in a separate file so we can use .pyi type stubs:
+from .id_fields import TypedAutoField, TypedBigAutoField  # pylint: disable=unused-import
 from .validators import validate_utc_datetime
 
 

src/openedx_django_lib/id_fields.py

@@ -12,21 +12,13 @@ class TypedBigAutoField(models.BigAutoField):
 
     ```
     class MyModel(models.Model):
-        MyModelID = NewType("MyModelID", int)
-        type ID = MyModelID
-
-        class IDField(TypedBigAutoField[ID]):
-            pass
-
+        # Boilerplate for fully-typed ID field:
+        ID = NewType("ID", int)
+        class IDField(TypedBigAutoField[ID]): ...
         id = IDField(primary_key=True)
 
-        ...
+        ... # rest of your model's fields...
     ```
-
-    Note: using a full explicit name like "MyModelID" for the `NewType(...)` and
-    then aliasing it to `ID` is recommended, so you can use `MyModel.ID`
-    everywhere for convenience, but will still see "MyModelID" in the mypy
-    output, as opposed to confusing messages like "expected 'ID' but got 'ID'".
     """
 
     # The actual typing + django-stubs "magic" is handled entirely by the .pyi file.
@@ -37,3 +29,14 @@ def __class_getitem__(cls, _):
         # and `class XxxField(TypedBigAutoField[XxxID])` work without `Generic` in the MRO.
         # (Including `Generic` as a superclass here breaks Django's field __deepcopy__.)
         return cls
+
+
+class TypedAutoField(models.AutoField):
+    """
+    Use sparingly. This is a 32-bit version of `TypedBigAutoField`, and you
+    should usually be using that instead of this for primary key fields.
+    """
+
+    @classmethod
+    def __class_getitem__(cls, _):  # See explanation on the class above.
+        return cls

src/openedx_django_lib/id_fields.pyi

@@ -11,3 +11,7 @@ _IDType = TypeVar("_IDType", bound=int)
 class TypedBigAutoField(models.BigAutoField[_IDType, _IDType]):
     _pyi_private_set_type: _IDType | int
     _pyi_private_get_type: _IDType
+
+class TypedAutoField(models.AutoField[_IDType, _IDType]):
+    _pyi_private_set_type: _IDType | int
+    _pyi_private_get_type: _IDType