openedx-learning 0.10.0__tar.gz → 0.11.1__tar.gz

{openedx_learning-0.10.0/openedx_learning.egg-info → openedx_learning-0.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.10.0
+Version: 0.11.1
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -14,17 +14,16 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
+Requires-Python: >=3.11
 License-File: LICENSE.txt
 Requires-Dist: rules<4.0
-Requires-Dist: Django<5.0
 Requires-Dist: edx-drf-extensions
-Requires-Dist: attrs
 Requires-Dist: celery
+Requires-Dist: attrs
 Requires-Dist: djangorestframework<4.0
+Requires-Dist: Django<5.0
 
 Open edX Learning Core (and Tagging)
 ====================================

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/__init__.py

@@ -1,4 +1,4 @@
 """
 Open edX Learning ("Learning Core").
 """
-__version__ = "0.10.0"
+__version__ = "0.11.1"

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/api/authoring.py

@@ -9,6 +9,12 @@ APIs.
 """
 # These wildcard imports are okay because these api modules declare __all__.
 # pylint: disable=wildcard-import
+from ..apps.authoring.collections.api import *
 from ..apps.authoring.components.api import *
 from ..apps.authoring.contents.api import *
 from ..apps.authoring.publishing.api import *
+
+# This was renamed after the authoring API refactoring pushed this and other
+# app APIs into the openedx_learning.api.authoring module. Here I'm aliasing to
+# it's previous name, to make migration a little easier.
+create_next_version = create_next_component_version

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/api/authoring_models.py

@@ -7,6 +7,7 @@ consistent.
 """
 # These wildcard imports are okay because these modules declare __all__.
 # pylint: disable=wildcard-import
+from ..apps.authoring.collections.models import *
 from ..apps.authoring.components.models import *
 from ..apps.authoring.contents.models import *
 from ..apps.authoring.publishing.model_mixins import *

openedx_learning-0.11.1/openedx_learning/apps/authoring/collections/api.py

@@ -0,0 +1,80 @@
+"""
+Collections API (warning: UNSTABLE, in progress API)
+"""
+from __future__ import annotations
+
+from django.db.models import QuerySet
+
+from .models import Collection
+
+# The public API that will be re-exported by openedx_learning.apps.authoring.api
+# is listed in the __all__ entries below. Internal helper functions that are
+# private to this module should start with an underscore. If a function does not
+# start with an underscore AND it is not in __all__, that function is considered
+# to be callable only by other apps in the authoring package.
+__all__ = [
+    "create_collection",
+    "get_collection",
+    "get_learning_package_collections",
+    "update_collection",
+]
+
+
+def create_collection(
+    learning_package_id: int,
+    title: str,
+    created_by: int | None,
+    description: str = "",
+) -> Collection:
+    """
+    Create a new Collection
+    """
+    collection = Collection.objects.create(
+        learning_package_id=learning_package_id,
+        title=title,
+        created_by_id=created_by,
+        description=description,
+    )
+    return collection
+
+
+def get_collection(collection_id: int) -> Collection:
+    """
+    Get a Collection by ID
+    """
+    return Collection.objects.get(id=collection_id)
+
+
+def update_collection(
+    collection_id: int,
+    title: str | None = None,
+    description: str | None = None,
+) -> Collection:
+    """
+    Update a Collection
+    """
+    collection = Collection.objects.get(id=collection_id)
+
+    # If no changes were requested, there's nothing to update, so just return
+    # the Collection as-is
+    if all(field is None for field in [title, description]):
+        return collection
+
+    if title is not None:
+        collection.title = title
+    if description is not None:
+        collection.description = description
+
+    collection.save()
+    return collection
+
+
+def get_learning_package_collections(learning_package_id: int) -> QuerySet[Collection]:
+    """
+    Get all collections for a given learning package
+
+    Only enabled collections are returned
+    """
+    return Collection.objects \
+                     .filter(learning_package_id=learning_package_id, enabled=True) \
+                     .select_related("learning_package")

openedx_learning-0.11.1/openedx_learning/apps/authoring/collections/apps.py

@@ -0,0 +1,15 @@
+"""
+Django metadata for the Collections Django application.
+"""
+from django.apps import AppConfig
+
+
+class CollectionsConfig(AppConfig):
+    """
+    Configuration for the Collections Django application.
+    """
+
+    name = "openedx_learning.apps.authoring.collections"
+    verbose_name = "Learning Core > Authoring > Collections"
+    default_auto_field = "django.db.models.BigAutoField"
+    label = "oel_collections"

openedx_learning-0.11.1/openedx_learning/apps/authoring/collections/migrations/0001_initial.py

@@ -0,0 +1,33 @@
+# Generated by Django 4.2.14 on 2024-08-05 20:42
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+import openedx_learning.lib.fields
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('oel_publishing', '0002_alter_learningpackage_key_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Collection',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, db_index=True, help_text='The name of the collection.', max_length=255)),
+                ('description', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, help_text='Provides extra information for the user about this collection.', max_length=10000)),
+                ('enabled', models.BooleanField(default=True, help_text='Whether the collection is enabled or not.')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('modified', models.DateTimeField(auto_now=True)),
+                ('learning_package', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='oel_publishing.learningpackage')),
+            ],
+            options={
+                'verbose_name_plural': 'Collections',
+            },
+        ),
+    ]

openedx_learning-0.11.1/openedx_learning/apps/authoring/collections/migrations/0002_remove_collection_name_collection_created_by_and_more.py

@@ -0,0 +1,53 @@
+# Generated by Django 4.2.14 on 2024-08-14 14:20
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+import openedx_learning.lib.fields
+import openedx_learning.lib.validators
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('oel_collections', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='collection',
+            name='name',
+        ),
+        migrations.AddField(
+            model_name='collection',
+            name='created_by',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AddField(
+            model_name='collection',
+            name='title',
+            field=openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, default='Collection', help_text='The title of the collection.', max_length=500),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='collection',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, validators=[openedx_learning.lib.validators.validate_utc_datetime]),
+        ),
+        migrations.AlterField(
+            model_name='collection',
+            name='description',
+            field=openedx_learning.lib.fields.MultiCollationTextField(blank=True, db_collations={'mysql': 'utf8mb4_unicode_ci', 'sqlite': 'NOCASE'}, default='', help_text='Provides extra information for the user about this collection.', max_length=10000),
+        ),
+        migrations.AlterField(
+            model_name='collection',
+            name='modified',
+            field=models.DateTimeField(auto_now=True, validators=[openedx_learning.lib.validators.validate_utc_datetime]),
+        ),
+        migrations.AddIndex(
+            model_name='collection',
+            index=models.Index(fields=['learning_package', 'title'], name='oel_collect_learnin_dfaf89_idx'),
+        ),
+    ]

openedx_learning-0.11.1/openedx_learning/apps/authoring/collections/models.py

@@ -0,0 +1,98 @@
+"""
+Core models for Collections
+"""
+from __future__ import annotations
+
+from django.conf import settings
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from ....lib.fields import MultiCollationTextField, case_insensitive_char_field
+from ....lib.validators import validate_utc_datetime
+from ..publishing.models import LearningPackage
+
+__all__ = [
+    "Collection",
+]
+
+
+class Collection(models.Model):
+    """
+    Represents a collection of library components
+    """
+
+    id = models.AutoField(primary_key=True)
+
+    # Each collection belongs to a learning package
+    learning_package = models.ForeignKey(LearningPackage, on_delete=models.CASCADE)
+
+    title = case_insensitive_char_field(
+        null=False,
+        blank=False,
+        max_length=500,
+        help_text=_(
+            "The title of the collection."
+        ),
+    )
+
+    description = MultiCollationTextField(
+        blank=True,
+        null=False,
+        default="",
+        max_length=10_000,
+        help_text=_(
+            "Provides extra information for the user about this collection."
+        ),
+        db_collations={
+            "sqlite": "NOCASE",
+            "mysql": "utf8mb4_unicode_ci",
+        }
+    )
+
+    # We don't have api functions to handle the enabled field. This is a placeholder for future use and
+    # a way to "soft delete" collections.
+    enabled = models.BooleanField(
+        default=True,
+        help_text=_(
+            "Whether the collection is enabled or not."
+        ),
+    )
+
+    created_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+    )
+
+    created = models.DateTimeField(
+        auto_now_add=True,
+        validators=[
+            validate_utc_datetime,
+        ],
+    )
+
+    modified = models.DateTimeField(
+        auto_now=True,
+        validators=[
+            validate_utc_datetime,
+        ],
+    )
+
+    class Meta:
+        verbose_name_plural = "Collections"
+        indexes = [
+            models.Index(fields=["learning_package", "title"]),
+        ]
+
+    def __repr__(self) -> str:
+        """
+        Developer-facing representation of a Collection.
+        """
+        return str(self)
+
+    def __str__(self) -> str:
+        """
+        User-facing string representation of a Collection.
+        """
+        return f"<{self.__class__.__name__}> ({self.id}:{self.title})"

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/apps/authoring/components/api.py

@@ -30,7 +30,7 @@ __all__ = [
     "get_or_create_component_type",
     "create_component",
     "create_component_version",
-    "create_next_version",
+    "create_next_component_version",
     "create_component_and_version",
     "get_component",
     "get_component_by_key",
@@ -109,7 +109,7 @@ def create_component_version(
     return component_version
 
 
-def create_next_version(
+def create_next_component_version(
     component_pk: int,
     /,
     title: str,

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/apps/authoring/components/models.py

@@ -134,6 +134,8 @@ class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
         'publishable_entity__draft__version__componentversion',
         'publishable_entity__published__version',
         'publishable_entity__published__version__componentversion',
+        'publishable_entity__published__publish_log_record',
+        'publishable_entity__published__publish_log_record__publish_log',
     )
 
     # This foreign key is technically redundant because we're already locked to

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/apps/authoring/publishing/api.py

@@ -9,7 +9,7 @@ from __future__ import annotations
 from datetime import datetime, timezone
 
 from django.core.exceptions import ObjectDoesNotExist
-from django.db.models import F, QuerySet
+from django.db.models import F, Q, QuerySet
 from django.db.transaction import atomic
 
 from .model_mixins import PublishableContentModelRegistry, PublishableEntityMixin, PublishableEntityVersionMixin
@@ -216,10 +216,36 @@ def get_all_drafts(learning_package_id: int, /) -> QuerySet[Draft]:
     )
 
 
-def get_entities_with_unpublished_changes(learning_package_id: int, /) -> QuerySet[PublishableEntity]:
-    return PublishableEntity.objects \
-                            .filter(learning_package_id=learning_package_id) \
-                            .exclude(draft__version=F('published__version'))
+def get_entities_with_unpublished_changes(
+    learning_package_id: int,
+    /,
+    include_deleted_drafts: bool = False
+) -> QuerySet[PublishableEntity]:
+    """
+    Fetch entities that have unpublished changes.
+
+    By default, this excludes soft-deleted drafts but can be included using include_deleted_drafts option.
+    """
+    entities_qs = (
+        PublishableEntity.objects
+        .filter(learning_package_id=learning_package_id)
+        .exclude(draft__version=F('published__version'))
+    )
+
+    if include_deleted_drafts:
+        # This means that we should also return PublishableEntities where the draft
+        # has been soft-deleted, but that deletion has not been published yet. Just
+        # excluding records where the Draft and Published versions don't match won't
+        # be enough here, because that will return soft-deletes that have already
+        # been published (since NULL != NULL in SQL).
+        #
+        # So we explicitly exclude already-published soft-deletes:
+        return entities_qs.exclude(
+            Q(draft__version__isnull=True) & Q(published__version__isnull=True)
+        )
+
+    # Simple case: exclude all entities that have been soft-deleted.
+    return entities_qs.exclude(draft__version__isnull=True)
 
 
 def get_entities_with_unpublished_deletes(learning_package_id: int, /) -> QuerySet[PublishableEntity]:
@@ -245,10 +271,23 @@ def publish_all_drafts(
     """
     Publish everything that is a Draft and is not already published.
     """
-    draft_qset = Draft.objects \
-                      .select_related("entity__published") \
-                      .filter(entity__learning_package_id=learning_package_id) \
-                      .exclude(entity__published__version_id=F("version_id"))
+    draft_qset = (
+        Draft.objects.select_related("entity__published")
+        .filter(entity__learning_package_id=learning_package_id)
+
+        # Exclude entities where the Published version already matches the
+        # Draft version.
+        .exclude(entity__published__version_id=F("version_id"))
+
+        # Account for soft-deletes:
+        # NULL != NULL in SQL, so simply excluding entities where the Draft
+        # and Published versions match will not catch the case where a
+        # soft-delete has been published (i.e. both the Draft and Published
+        # versions are NULL). We need to explicitly check for that case
+        # instead, or else we will re-publish the same soft-deletes over
+        # and over again.
+        .exclude(Q(version__isnull=True) & Q(entity__published__version__isnull=True))
+    )
     return publish_from_drafts(
         learning_package_id, draft_qset, message, published_at, published_by
     )

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/apps/authoring/publishing/model_mixins.py

@@ -243,6 +243,18 @@ class PublishableEntityMixin(models.Model):
 
             return draft_version_id != published_version_id
 
+        @property
+        def last_publish_log(self):
+            """
+            Return the most recent PublishLog for this component.
+
+            Return None if the component is not published.
+            """
+            pub_entity = self.content_obj.publishable_entity
+            if hasattr(pub_entity, 'published'):
+                return pub_entity.published.publish_log_record.publish_log
+            return None
+
         @property
         def versions(self):
             """

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning/lib/collations.py

@@ -36,48 +36,6 @@ class MultiCollationMixin:
         super().__init__(*args, **kwargs)
         self.db_collations = db_collations or {}
 
-        # This is part of a hack to get this to work for Django < 4.1. Please
-        # see comments in the db_collation method for details.
-        self._vendor = None
-
-    @property
-    def db_collation(self):
-        """
-        Return the db_collation, understanding that it varies by vendor.
-
-        This method is a hack for Django 3.2 compatibility and should be removed
-        after we move to 4.2.
-
-        Description of why this is hacky:
-
-        In Django 4.2, the schema builder pulls the collation settings from the
-        field using the value returned from the ``db_parameters`` method, and
-        this does what we want it to do. In Django 3.2, field.db_parameters is
-        called, but any collation value sent back is ignored and the code grabs
-        the value of db_collation directly from the field:
-
-        https://github.com/django/django/blob/stable/3.2.x/django/db/backends/base/schema.py#L214-L224
-
-        But this call to get the ``field.db_collation`` attribute happens almost
-        immediately after the ``field.db_parameters`` method call. So our
-        fragile hack is to set ``self._vendor`` in the ``db_parameters`` method,
-        using the value we get from the connection that is passed in there. We
-        can then use ``self._vendor`` to return the right value when Django
-        calls ``field.db_collation`` (which is this property method).
-
-        This method, the corresponding setter, and all references to
-        ``self._vendor`` should be removed after we've cut over to Django 4.2.
-        """
-        return self.db_collations.get(self._vendor)
-
-    @db_collation.setter
-    def db_collation(self, value):
-        """
-        Don't allow db_collation to be set manually (just ignore).
-
-        This can be removed when we move to Django 4.2.
-        """
-
     def db_parameters(self, connection):
         """
         Return database parameters for this field. This adds collation info.
@@ -88,9 +46,6 @@ class MultiCollationMixin:
         """
         db_params = models.Field.db_parameters(self, connection)
 
-        # Remove once we no longer need to support Django < 4.1
-        self._vendor = connection.vendor
-
         # Now determine collation based on DB vendor (e.g. 'sqlite', 'mysql')
         if connection.vendor in self.db_collations:
             db_params["collation"] = self.db_collations[connection.vendor]

{openedx_learning-0.10.0 → openedx_learning-0.11.1/openedx_learning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.10.0
+Version: 0.11.1
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -14,17 +14,16 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
+Requires-Python: >=3.11
 License-File: LICENSE.txt
 Requires-Dist: rules<4.0
-Requires-Dist: Django<5.0
 Requires-Dist: edx-drf-extensions
-Requires-Dist: attrs
 Requires-Dist: celery
+Requires-Dist: attrs
 Requires-Dist: djangorestframework<4.0
+Requires-Dist: Django<5.0
 
 Open edX Learning Core (and Tagging)
 ====================================

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning.egg-info/SOURCES.txt

@@ -17,6 +17,13 @@ openedx_learning/api/authoring.py
 openedx_learning/api/authoring_models.py
 openedx_learning/apps/__init__.py
 openedx_learning/apps/authoring/__init__.py
+openedx_learning/apps/authoring/collections/__init__.py
+openedx_learning/apps/authoring/collections/api.py
+openedx_learning/apps/authoring/collections/apps.py
+openedx_learning/apps/authoring/collections/models.py
+openedx_learning/apps/authoring/collections/migrations/0001_initial.py
+openedx_learning/apps/authoring/collections/migrations/0002_remove_collection_name_collection_created_by_and_more.py
+openedx_learning/apps/authoring/collections/migrations/__init__.py
 openedx_learning/apps/authoring/components/__init__.py
 openedx_learning/apps/authoring/components/admin.py
 openedx_learning/apps/authoring/components/api.py

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_tagging/core/tagging/api.py

@@ -190,8 +190,10 @@ def get_object_tags(
         .exclude(taxonomy__enabled=False)  # Exclude if the whole taxonomy is disabled
     )
     if not include_deleted:
-        base_qs = base_qs.exclude(taxonomy_id=None)  # Exclude if the whole taxonomy was deleted
-        base_qs = base_qs.exclude(tag_id=None, taxonomy__allow_free_text=False)  # Exclude if just the tag is deleted
+        # Exclude if the whole taxonomy was deleted
+        base_qs = base_qs.exclude(taxonomy_id=None)  # type: ignore
+        # Exclude if just the tag is deleted
+        base_qs = base_qs.exclude(tag_id=None, taxonomy__allow_free_text=False)  # type: ignore
     tags = (
         base_qs
         # Preload related objects, including data for the "get_lineage" method on ObjectTag/Tag:

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/setup.py

@@ -78,7 +78,7 @@ setup(
     ),
     include_package_data=True,
     install_requires=load_requirements('requirements/base.in'),
-    python_requires=">=3.8",
+    python_requires=">=3.11",
     license="AGPL 3.0",
     zip_safe=False,
     keywords='Python edx',
@@ -90,7 +90,6 @@ setup(
         'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)',
         'Natural Language :: English',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
     ],

{openedx_learning-0.10.0 → openedx_learning-0.11.1}/openedx_learning.egg-info/requires.txt

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