openedx-learning 0.20.0__py2.py3-none-any.whl → 0.23.0__py2.py3-none-any.whl

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

@@ -104,3 +104,47 @@ class PublishLogRecord(models.Model):
         ]
         verbose_name = "Publish Log Record"
         verbose_name_plural = "Publish Log Records"
+
+
+class Published(models.Model):
+    """
+    Find the currently published version of an entity.
+
+    Notes:
+
+    * There is only ever one published PublishableEntityVersion per
+      PublishableEntity at any given time.
+    * It may be possible for a PublishableEntity to exist only as a Draft (and thus
+      not show up in this table).
+    * If a row exists for a PublishableEntity, but the ``version`` field is
+      None, it means that the entity was published at some point, but is no
+      longer published now–i.e. it's functionally "deleted", even though all
+      the version history is preserved behind the scenes.
+
+    TODO: Do we need to create a (redundant) title field in this model so that
+    we can more efficiently search across titles within a LearningPackage?
+    Probably not an immediate concern because the number of rows currently
+    shouldn't be > 10,000 in the more extreme cases.
+
+    TODO: Do we need to make a "most_recently" published version when an entry
+    is unpublished/deleted?
+    """
+
+    entity = models.OneToOneField(
+        PublishableEntity,
+        on_delete=models.CASCADE,
+        primary_key=True,
+    )
+    version = models.OneToOneField(
+        PublishableEntityVersion,
+        on_delete=models.RESTRICT,
+        null=True,
+    )
+    publish_log_record = models.ForeignKey(
+        PublishLogRecord,
+        on_delete=models.RESTRICT,
+    )
+
+    class Meta:
+        verbose_name = "Published Entity"
+        verbose_name_plural = "Published Entities"

openedx_learning/apps/authoring/units/api.py

@@ -62,8 +62,7 @@ def create_unit_version(
     version_num: int,
     *,
     title: str,
-    publishable_entities_pks: list[int],
-    entity_version_pks: list[int | None],
+    entity_rows: list[publishing_api.ContainerEntityRow],
     created: datetime,
     created_by: int | None = None,
 ) -> UnitVersion:
@@ -75,11 +74,10 @@ def create_unit_version(
     `create_next_unit_version()` instead.
 
     Args:
-        unit_pk: The unit ID.
+        unit: The unit object.
         version_num: The version number.
         title: The title.
-        publishable_entities_pk: The publishable entities.
-        entity: The entity.
+        entity_rows: child entities/versions
         created: The creation date.
         created_by: The user who created the unit.
     """
@@ -87,8 +85,7 @@ def create_unit_version(
         unit.pk,
         version_num,
         title=title,
-        publishable_entities_pks=publishable_entities_pks,
-        entity_version_pks=entity_version_pks,
+        entity_rows=entity_rows,
         created=created,
         created_by=created_by,
         container_version_cls=UnitVersion,
@@ -97,30 +94,34 @@ def create_unit_version(
 
 def _pub_entities_for_components(
     components: list[Component | ComponentVersion] | None,
-) -> tuple[list[int], list[int | None]] | tuple[None, None]:
+) -> list[publishing_api.ContainerEntityRow] | None:
     """
     Helper method: given a list of Component | ComponentVersion, return the
-    lists of publishable_entities_pks and entity_version_pks needed for the
-    base container APIs.
+    list of ContainerEntityRows needed for the base container APIs.
 
     ComponentVersion is passed when we want to pin a specific version, otherwise
     Component is used for unpinned.
     """
     if components is None:
         # When these are None, that means don't change the entities in the list.
-        return None, None
+        return None
     for c in components:
         if not isinstance(c, (Component, ComponentVersion)):
             raise TypeError("Unit components must be either Component or ComponentVersion.")
-    publishable_entities_pks = [
-        (c.publishable_entity_id if isinstance(c, Component) else c.component.publishable_entity_id)
+    return [
+        (
+            publishing_api.ContainerEntityRow(
+                entity_pk=c.publishable_entity_id,
+                version_pk=None,
+            ) if isinstance(c, Component)
+            else  # isinstance(c, ComponentVersion)
+            publishing_api.ContainerEntityRow(
+                entity_pk=c.component.publishable_entity_id,
+                version_pk=c.pk,
+            )
+        )
         for c in components
     ]
-    entity_version_pks = [
-        (cv.pk if isinstance(cv, ComponentVersion) else None)
-        for cv in components
-    ]
-    return publishable_entities_pks, entity_version_pks
 
 
 def create_next_unit_version(
@@ -143,12 +144,11 @@ def create_next_unit_version(
         created: The creation date.
         created_by: The user who created the unit.
     """
-    publishable_entities_pks, entity_version_pks = _pub_entities_for_components(components)
+    entity_rows = _pub_entities_for_components(components)
     unit_version = publishing_api.create_next_container_version(
         unit.pk,
         title=title,
-        publishable_entities_pks=publishable_entities_pks,
-        entity_version_pks=entity_version_pks,
+        entity_rows=entity_rows,
         created=created,
         created_by=created_by,
         container_version_cls=UnitVersion,
@@ -177,7 +177,7 @@ def create_unit_and_version(
         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)
+    entity_rows = _pub_entities_for_components(components)
     with atomic():
         unit = create_unit(
             learning_package_id,
@@ -190,8 +190,7 @@ def create_unit_and_version(
             unit,
             1,
             title=title,
-            publishable_entities_pks=publishable_entities_pks or [],
-            entity_version_pks=entity_version_pks or [],
+            entity_rows=entity_rows or [],
             created=created,
             created_by=created_by,
         )

{openedx_learning-0.20.0.dist-info → openedx_learning-0.23.0.dist-info}/METADATA

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

{openedx_learning-0.20.0.dist-info → openedx_learning-0.23.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-openedx_learning/__init__.py,sha256=WDokxtzsuwd2W-qT4Q9Xle8FEzeUPjSqHq6jSb3YHow,69
+openedx_learning/__init__.py,sha256=_QT8vl820lRjYpoDGXnsI6kcftcuz00aGlyEs_b9UBg,69
 openedx_learning/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/api/authoring.py,sha256=AuEegFTT3tAer_3zSxcxqLq3Yd_eilk-Hxt4ESYearA,970
@@ -7,7 +7,7 @@ openedx_learning/apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 openedx_learning/apps/authoring/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/collections/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/collections/admin.py,sha256=f0hySjDMfIphVDEGkCSMIUHoEiqHRA7EE2NiO7lvL4g,1156
-openedx_learning/apps/authoring/collections/api.py,sha256=Lui-9mvlUjXSfCcaHrYJc2y2aJ1obJPCIp5hvxYwnkI,5894
+openedx_learning/apps/authoring/collections/api.py,sha256=DaGg73iom7fN9fODajo8B2e9Jkx2syfLEVjip0cAzlQ,7747
 openedx_learning/apps/authoring/collections/apps.py,sha256=67imy9vnyXml4cfLNGFJhuZr2yx1q92-xz4ih3yJgNU,416
 openedx_learning/apps/authoring/collections/models.py,sha256=os8EKUVZ2IhMfFo2XN9tklByCUXphEtzAkKAOc0KyW8,8451
 openedx_learning/apps/authoring/collections/migrations/0001_initial.py,sha256=xcJoqMLROW9FTILYrz6UsyotVu9wBN5tRBwRoAWG6dg,1496
@@ -18,7 +18,7 @@ openedx_learning/apps/authoring/collections/migrations/0005_alter_collection_opt
 openedx_learning/apps/authoring/collections/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/components/admin.py,sha256=zfEpuBEySMYpUZzygaE2MDoI8SH-2H3xIL20YCSCMLo,4582
-openedx_learning/apps/authoring/components/api.py,sha256=PmCtJiyw0Vy4PGSRt9JCStJQv9OJ4FchtOyiY1sfJ-s,25254
+openedx_learning/apps/authoring/components/api.py,sha256=nJZcGXN5gOz8EYX3XHCiDILowNRcm__RxTfTNt5rZZw,22780
 openedx_learning/apps/authoring/components/apps.py,sha256=Rcydv_FH-rVvuWIFqUezBNOh8DtrZHyozZM2yqX2JKE,778
 openedx_learning/apps/authoring/components/models.py,sha256=ttZzVnMZTa14-qudrLb4CFuCanEQJT8cuC_iVPH8XTA,10887
 openedx_learning/apps/authoring/components/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -36,24 +36,27 @@ openedx_learning/apps/authoring/contents/models.py,sha256=8CYrHK7CZ4U3F7Den4ZV_a
 openedx_learning/apps/authoring/contents/migrations/0001_initial.py,sha256=FtOTmIGX2KHpjw-PHbfRjxkFEomI5CEDhNKCZ7IpFeE,3060
 openedx_learning/apps/authoring/contents/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/publishing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/publishing/admin.py,sha256=yPtqznDzlWHj0xpJ_FGFRviyftgPmuql5EoqKLeZQFo,4911
-openedx_learning/apps/authoring/publishing/api.py,sha256=tNpDYfQXwjpkp3acVXNItNXN4oCCekGSQa9M5TozXEs,41130
+openedx_learning/apps/authoring/publishing/admin.py,sha256=sLmtttaYIQi8XWw_wOdDD9xbF34g1giMEj5yIN-b-4M,7012
+openedx_learning/apps/authoring/publishing/api.py,sha256=14JojKz57Vl_16JwWcDSOM9JzZm6h0sxAmldmb3SVeE,55712
 openedx_learning/apps/authoring/publishing/apps.py,sha256=v9PTe3YoICaYT9wfu268ZkVAlnZFvxi-DqYdbRi25bY,750
+openedx_learning/apps/authoring/publishing/contextmanagers.py,sha256=AH5zhr0Tz_gUG9--dfr_oZAu8DMy94n6mnOJuPbWkeU,6723
 openedx_learning/apps/authoring/publishing/migrations/0001_initial.py,sha256=wvekNV19YRSdxRmQaFnLSn_nCsQlHIucPDVMmgKf_OE,9272
 openedx_learning/apps/authoring/publishing/migrations/0002_alter_learningpackage_key_and_more.py,sha256=toI7qJhNukk6hirKfFx9EpqTpzF2O2Yq1VpFJusDn2M,806
 openedx_learning/apps/authoring/publishing/migrations/0003_containers.py,sha256=k5P1LFkjQT-42yyHE2f57dAMQKafLuJCTRaCBMKWcjc,2519
 openedx_learning/apps/authoring/publishing/migrations/0004_publishableentity_can_stand_alone.py,sha256=RapDZKcjTp5QGgob9DUaf-zl_pQgg-5nz8PZWoXMlVA,549
 openedx_learning/apps/authoring/publishing/migrations/0005_alter_entitylistrow_options.py,sha256=Pp4O-VSI75n3UTZZW6CU4TOVIVc5lZvUg5YfMvZyrYM,377
+openedx_learning/apps/authoring/publishing/migrations/0006_draftchangelog.py,sha256=TdioE59_fXCf4ykWhXJfEjyxdDmqbbbLCwLeT1C9irA,3497
+openedx_learning/apps/authoring/publishing/migrations/0007_bootstrap_draftchangelog.py,sha256=EoFFSv52CeiuMGf3KmBvr34sx9N-tv8afdXWVR8wPFA,4154
 openedx_learning/apps/authoring/publishing/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/publishing/models/__init__.py,sha256=Ou6Ks3qxEhel9uHLpzi77jlkb_IHc9_WIfqxOZJuqaE,1059
+openedx_learning/apps/authoring/publishing/models/__init__.py,sha256=ZhpKo4F30VJatp1F-jQSJnKw8AeHFig9E9SlGnxxBCc,1108
 openedx_learning/apps/authoring/publishing/models/container.py,sha256=GCUD3WTlgvgZSQOKcoOsfhNAfc5pz3Wbs9ClE9mhtB0,2594
-openedx_learning/apps/authoring/publishing/models/draft_published.py,sha256=dDZfbTcqLmnOhgIG-H8mhPFLRks_c03VE-ynGD_CNeo,3632
+openedx_learning/apps/authoring/publishing/models/draft_log.py,sha256=7hpbtnnc3yD_3YpH7uqO91FC5KYQkNxtBFSewkIf_AQ,13670
 openedx_learning/apps/authoring/publishing/models/entity_list.py,sha256=8MyJqDdC8dqJY-N9UAu-WS-ZeFOYuRNMKloSY9wMH1w,3042
 openedx_learning/apps/authoring/publishing/models/learning_package.py,sha256=1fuNLHD6k0qGuL0jXYGf4-TA5WczgxJrXUdAIM_JNBI,2688
-openedx_learning/apps/authoring/publishing/models/publish_log.py,sha256=-uMj1X8umqRM259ucOqNt6POeKDpY5RLdA8XnWXt7Go,4109
+openedx_learning/apps/authoring/publishing/models/publish_log.py,sha256=QD7Fb00yUMWM4HHae_m60JW-TDX8upbQdWCEIdhB0yE,5615
 openedx_learning/apps/authoring/publishing/models/publishable_entity.py,sha256=-6Fde_sYqaq1AUC4sw4Rf1X9Hh4jun2Py7Xhsl4VWuY,25419
 openedx_learning/apps/authoring/units/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/units/api.py,sha256=nhAATIC0j4We1-3K5yr9FvNr7Dyg-LVHyxfa1ik6IMw,10106
+openedx_learning/apps/authoring/units/api.py,sha256=KJA7Bh7IBE22E6cMSZNp6pamjjA1Vf8EhHw0rvQtlPM,9797
 openedx_learning/apps/authoring/units/apps.py,sha256=cIzphjDw5sjIZ3NLE911N7IMUa8JQSXMReNl03uI7jg,701
 openedx_learning/apps/authoring/units/models.py,sha256=eTOwFWC9coQLf0ovx08Mj7zi8mPAWCw9QOznybajRk0,1418
 openedx_learning/apps/authoring/units/migrations/0001_initial.py,sha256=qM_0JGffxECVgXzncHXfgSE-g8u3L3a14R0M1Bnj_Ys,1129
@@ -71,7 +74,7 @@ openedx_learning/lib/fields.py,sha256=eiGoXMPhRuq25EH2qf6BAODshAQE3DBVdIYAMIUAXW
 openedx_learning/lib/managers.py,sha256=-Q3gxalSqyPZ9Im4DTROW5tF8wVTZLlmfTe62_xmowY,1643
 openedx_learning/lib/test_utils.py,sha256=g3KLuepIZbaDBCsaj9711YuqyUx7LD4gXDcfNC-mWdc,527
 openedx_learning/lib/validators.py,sha256=iqEdEAvFV2tC7Ecssx69kjecpdU8nE87AlDJYrqrsnc,404
-openedx_learning-0.20.0.dist-info/licenses/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+openedx_learning-0.23.0.dist-info/licenses/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
 openedx_tagging/__init__.py,sha256=V9N8M7f9LYlAbA_DdPUsHzTnWjYRXKGa5qHw9P1JnNI,30
 openedx_tagging/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_tagging/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -127,7 +130,7 @@ openedx_tagging/core/tagging/rest_api/v1/serializers.py,sha256=0HQD_Jrf6-YpocYfz
 openedx_tagging/core/tagging/rest_api/v1/urls.py,sha256=dNUKCtUCx_YzrwlbEbpDfjGVQbb2QdJ1VuJCkladj6E,752
 openedx_tagging/core/tagging/rest_api/v1/views.py,sha256=Hf92cy-tE767DE9FgsZcPKiCYrf5ihfETz8qGKBnuiU,36278
 openedx_tagging/core/tagging/rest_api/v1/views_import.py,sha256=kbHUPe5A6WaaJ3J1lFIcYCt876ecLNQfd19m7YYub6c,1470
-openedx_learning-0.20.0.dist-info/METADATA,sha256=oaXh99UqYsZ_dgDsbiwKAFvtP_kxGCUgDNAl0OBW4VI,9032
-openedx_learning-0.20.0.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
-openedx_learning-0.20.0.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
-openedx_learning-0.20.0.dist-info/RECORD,,
+openedx_learning-0.23.0.dist-info/METADATA,sha256=a-4VMoLSKMLrTvXd95FvsONcKLBbluQ8skrJ3SuVpPo,9032
+openedx_learning-0.23.0.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
+openedx_learning-0.23.0.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
+openedx_learning-0.23.0.dist-info/RECORD,,

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

@@ -1,95 +0,0 @@
-"""
-Draft and Published models
-"""
-from django.db import models
-
-from .publish_log import PublishLogRecord
-from .publishable_entity import PublishableEntity, PublishableEntityVersion
-
-
-class Draft(models.Model):
-    """
-    Find the active draft version of an entity (usually most recently created).
-
-    This model mostly only exists to allow us to join against a bunch of
-    PublishableEntity objects at once and get all their latest drafts. You might
-    use this together with Published in order to see which Drafts haven't been
-    published yet.
-
-    A Draft entry should be created whenever a new PublishableEntityVersion is
-    created. This means there are three possible states:
-
-    1. No Draft entry for a PublishableEntity: This means a PublishableEntity
-       was created, but no PublishableEntityVersion was ever made for it, so
-       there was never a Draft version.
-    2. A Draft entry exists and points to a PublishableEntityVersion: This is
-       the most common state.
-    3. A Draft entry exists and points to a null version: This means a version
-       used to be the draft, but it's been functionally "deleted". The versions
-       still exist in our history, but we're done using it.
-
-    It would have saved a little space to add this data to the Published model
-    (and possibly call the combined model something else). Split Modulestore did
-    this with its active_versions table. I keep it separate here to get a better
-    separation of lifecycle events: i.e. this table *only* changes when drafts
-    are updated, not when publishing happens. The Published model only changes
-    when something is published.
-    """
-    # If we're removing a PublishableEntity entirely, also remove the Draft
-    # entry for it. This isn't a normal operation, but can happen if you're
-    # deleting an entire LearningPackage.
-    entity = models.OneToOneField(
-        PublishableEntity,
-        on_delete=models.CASCADE,
-        primary_key=True,
-    )
-    version = models.OneToOneField(
-        PublishableEntityVersion,
-        on_delete=models.RESTRICT,
-        null=True,
-        blank=True,
-    )
-
-
-class Published(models.Model):
-    """
-    Find the currently published version of an entity.
-
-    Notes:
-
-    * There is only ever one published PublishableEntityVersion per
-      PublishableEntity at any given time.
-    * It may be possible for a PublishableEntity to exist only as a Draft (and thus
-      not show up in this table).
-    * If a row exists for a PublishableEntity, but the ``version`` field is
-      None, it means that the entity was published at some point, but is no
-      longer published now–i.e. it's functionally "deleted", even though all
-      the version history is preserved behind the scenes.
-
-    TODO: Do we need to create a (redundant) title field in this model so that
-    we can more efficiently search across titles within a LearningPackage?
-    Probably not an immediate concern because the number of rows currently
-    shouldn't be > 10,000 in the more extreme cases.
-
-    TODO: Do we need to make a "most_recently" published version when an entry
-    is unpublished/deleted?
-    """
-
-    entity = models.OneToOneField(
-        PublishableEntity,
-        on_delete=models.CASCADE,
-        primary_key=True,
-    )
-    version = models.OneToOneField(
-        PublishableEntityVersion,
-        on_delete=models.RESTRICT,
-        null=True,
-    )
-    publish_log_record = models.ForeignKey(
-        PublishLogRecord,
-        on_delete=models.RESTRICT,
-    )
-
-    class Meta:
-        verbose_name = "Published Entity"
-        verbose_name_plural = "Published Entities"