openedx-learning 0.16.1__py2.py3-none-any.whl → 0.16.3__py2.py3-none-any.whl

openedx_learning/__init__.py

@@ -2,4 +2,4 @@
 Open edX Learning ("Learning Core").
 """
 
-__version__ = "0.16.1"
+__version__ = "0.16.3"

openedx_learning/apps/authoring/components/api.py

@@ -12,6 +12,7 @@ are stored in this app.
 """
 from __future__ import annotations
 
+import mimetypes
 from datetime import datetime, timezone
 from enum import StrEnum, auto
 from logging import getLogger
@@ -129,7 +130,7 @@ def create_component_version(
 def create_next_component_version(
     component_pk: int,
     /,
-    content_to_replace: dict[str, int | None],
+    content_to_replace: dict[str, int | None | bytes],
     created: datetime,
     title: str | None = None,
     created_by: int | None = None,
@@ -140,11 +141,14 @@ def create_next_component_version(
     A very common pattern for making a new ComponentVersion is going to be "make
     it just like the last version, except changing these one or two things".
     Before calling this, you should create any new contents via the contents
-    API, since ``content_to_replace`` needs Content IDs for the values.
+    API or send the content bytes as part of ``content_to_replace`` values.
 
     The ``content_to_replace`` dict is a mapping of strings representing the
-    local path/key for a file, to ``Content.id`` values. Using a `None` for
-    a value in this dict means to delete that key in the next version.
+    local path/key for a file, to ``Content.id`` or content bytes values. Using
+    `None` for a value in this dict means to delete that key in the next version.
+
+    Make sure to wrap the function call on a atomic statement:
+    ``with transaction.atomic():``
 
     It is okay to mark entries for deletion that don't exist. For instance, if a
     version has ``a.txt`` and ``b.txt``, sending a ``content_to_replace`` value
@@ -186,11 +190,27 @@ def create_next_component_version(
             component_id=component_pk,
         )
         # First copy the new stuff over...
-        for key, content_pk in content_to_replace.items():
+        for key, content_pk_or_bytes in content_to_replace.items():
             # If the content_pk is None, it means we want to remove the
             # content represented by our key from the next version. Otherwise,
             # we add our key->content_pk mapping to the next version.
-            if content_pk is not None:
+            if content_pk_or_bytes is not None:
+                if isinstance(content_pk_or_bytes, bytes):
+                    file_path, file_content = key, content_pk_or_bytes
+                    media_type_str, _encoding = mimetypes.guess_type(file_path)
+                    # We use "application/octet-stream" as a generic fallback media type, per
+                    # RFC 2046: https://datatracker.ietf.org/doc/html/rfc2046
+                    media_type_str = media_type_str or "application/octet-stream"
+                    media_type = contents_api.get_or_create_media_type(media_type_str)
+                    content = contents_api.get_or_create_file_content(
+                        component.learning_package.id,
+                        media_type.id,
+                        data=file_content,
+                        created=created,
+                    )
+                    content_pk = content.pk
+                else:
+                    content_pk = content_pk_or_bytes
                 ComponentVersionContent.objects.create(
                     content_id=content_pk,
                     component_version=component_version,

openedx_learning/apps/authoring/components/management/commands/add_assets_to_component.py

@@ -4,14 +4,11 @@ Management command to add files to a Component.
 This is mostly meant to be a debugging tool to let us to easily load some test
 asset data into the system.
 """
-import mimetypes
 import pathlib
 from datetime import datetime, timezone
 
 from django.core.management.base import BaseCommand
 
-from ....components.api import create_component_version_content
-from ....contents.api import get_or_create_file_content, get_or_create_media_type
 from ....publishing.api import get_learning_package_by_key
 from ...api import create_next_component_version, get_component_by_key
 
@@ -69,39 +66,18 @@ class Command(BaseCommand):
         )
 
         created = datetime.now(tz=timezone.utc)
-        keys_to_remove = set()
-        local_keys_to_content = {}
+        local_keys_to_content_bytes = {}
 
         for file_mapping in file_mappings:
             local_key, file_path = file_mapping.split(":", 1)
 
-            # No file_path means to delete this entry from the next version.
-            if not file_path:
-                keys_to_remove.add(local_key)
-                continue
-
-            media_type_str, _encoding = mimetypes.guess_type(file_path)
-            media_type = get_or_create_media_type(media_type_str)
-            content = get_or_create_file_content(
-                learning_package.id,
-                media_type.id,
-                data=pathlib.Path(file_path).read_bytes(),
-                created=created,
-            )
-            local_keys_to_content[local_key] = content.id
+            local_keys_to_content_bytes[local_key] = pathlib.Path(file_path).read_bytes() if file_path else None
 
         next_version = create_next_component_version(
             component.pk,
-            content_to_replace={local_key: None for local_key in keys_to_remove},
+            content_to_replace=local_keys_to_content_bytes,
             created=created,
         )
-        for local_key, content_id in sorted(local_keys_to_content.items()):
-            create_component_version_content(
-                next_version.pk,
-                content_id,
-                key=local_key,
-                learner_downloadable=True,
-            )
 
         self.stdout.write(
             f"Created v{next_version.version_num} of "

openedx_learning/apps/authoring/contents/models.py

@@ -6,6 +6,7 @@ more intelligent data models to be useful.
 from __future__ import annotations
 
 from functools import cache, cached_property
+from logging import getLogger
 
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured, ValidationError
@@ -19,6 +20,8 @@ from ....lib.fields import MultiCollationTextField, case_insensitive_char_field,
 from ....lib.managers import WithRelationsManager
 from ..publishing.models import LearningPackage
 
+logger = getLogger()
+
 __all__ = [
     "MediaType",
     "Content",
@@ -316,8 +319,11 @@ class Content(models.Model):
 
         This will return ``None`` if there is no backing file (has_file=False).
         """
-        if self.has_file:
-            return get_storage().path(self.path)
+        try:
+            if self.has_file:
+                return get_storage().path(self.path)
+        except NotImplementedError:
+            logger.warning("Storage backend does not support path()")
         return None
 
     def read_file(self) -> File:

{openedx_learning-0.16.1.dist-info → openedx_learning-0.16.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.16.1
+Version: 0.16.3
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,12 +18,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: attrs
-Requires-Dist: celery
-Requires-Dist: rules<4.0
-Requires-Dist: Django<5.0
 Requires-Dist: edx-drf-extensions
+Requires-Dist: Django<5.0
+Requires-Dist: celery
 Requires-Dist: djangorestframework<4.0
+Requires-Dist: attrs
+Requires-Dist: rules<4.0
 
 Open edX Learning Core (and Tagging)
 ====================================

{openedx_learning-0.16.1.dist-info → openedx_learning-0.16.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-openedx_learning/__init__.py,sha256=kCKLJzAlWTUBzj2ePkbJPdM3AEukJRgn6BpyRHwAbdo,69
+openedx_learning/__init__.py,sha256=bkrow8r93asdRsP0nSEgewxu6wo1JajZgTv--0P_RKk,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=vbRpiQ2wOfN3oR2bbN0-bI2ra0QRtha9tVixKW1ENis,929
@@ -18,12 +18,12 @@ 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=3kFu_PR0BFb8U0zVv3WWhi27i__TDuJG0pFlwr3tKAw,4614
-openedx_learning/apps/authoring/components/api.py,sha256=TCLFCPb7ScoRWhe7YpQ7hBiJGjoa47OmazQWcN2hIwU,25759
+openedx_learning/apps/authoring/components/api.py,sha256=BhLlEEBzxFNDHA1dBxoNvIFj92t-vaDF44VExWBbWrc,26861
 openedx_learning/apps/authoring/components/apps.py,sha256=YoYPsI9gcleA3uEs8CiLIrjUncRMo2DKbYt4mDfzePg,770
 openedx_learning/apps/authoring/components/models.py,sha256=T-wc7vxaWMlulQmMsVH7m6Pd857P3Eguo0vtflTLURI,13415
 openedx_learning/apps/authoring/components/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openedx_learning/apps/authoring/components/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openedx_learning/apps/authoring/components/management/commands/add_assets_to_component.py,sha256=v7mJfnu25M8w4-U1lPPn575W7lYAaOapcHEAZVaxil4,4142
+openedx_learning/apps/authoring/components/management/commands/add_assets_to_component.py,sha256=0dJ77NZZoNzYheOdFPXtJrjdL_Z-pCNg3l1rbEGnMCY,3175
 openedx_learning/apps/authoring/components/migrations/0001_initial.py,sha256=446LkJSFeK8J_-l-bxakZ_BVx_CiJIllGcBYqWcEenA,4664
 openedx_learning/apps/authoring/components/migrations/0002_alter_componentversioncontent_key.py,sha256=98724dtucRjJCRyLt5p45qXYb2d6-ouVGp7PB6zTG6E,539
 openedx_learning/apps/authoring/components/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -31,7 +31,7 @@ openedx_learning/apps/authoring/contents/__init__.py,sha256=47DEQpj8HBSa-_TImW-5
 openedx_learning/apps/authoring/contents/admin.py,sha256=9Njd_lje1emcd168KBWUTGf0mVJ6K-dMYMcqHNjRU4k,1761
 openedx_learning/apps/authoring/contents/api.py,sha256=bXb9yQjPfoP1Ynf1aAYz3BEPffK7H5cnba6KdPFSiG0,8818
 openedx_learning/apps/authoring/contents/apps.py,sha256=EEUZEnww7TcYcyxMovZthG2muNxd7j7nxBIf21gKrp4,398
-openedx_learning/apps/authoring/contents/models.py,sha256=nv6T0SXHJovs0FeAtED1iPg_HbkJF5vz2N6WyzYXS6Q,17720
+openedx_learning/apps/authoring/contents/models.py,sha256=RobNGdqkFhChcpub9FszOeqft4c1TJQgS5vQ3Cp2NCA,17899
 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
@@ -111,8 +111,8 @@ openedx_tagging/core/tagging/rest_api/v1/serializers.py,sha256=D7brBbgmU7MnbU7Ln
 openedx_tagging/core/tagging/rest_api/v1/urls.py,sha256=dNUKCtUCx_YzrwlbEbpDfjGVQbb2QdJ1VuJCkladj6E,752
 openedx_tagging/core/tagging/rest_api/v1/views.py,sha256=LA0EF7-p91JgVrLZpZaG474elKD1dswODGvoPIw47Mg,35837
 openedx_tagging/core/tagging/rest_api/v1/views_import.py,sha256=kbHUPe5A6WaaJ3J1lFIcYCt876ecLNQfd19m7YYub6c,1470
-openedx_learning-0.16.1.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
-openedx_learning-0.16.1.dist-info/METADATA,sha256=hJck_BnmUyKCAGNXMfVpiJrfiI5iZGoAq6OSR88enOI,8777
-openedx_learning-0.16.1.dist-info/WHEEL,sha256=AHX6tWk3qWuce7vKLrj7lnulVHEdWoltgauo8bgCXgU,109
-openedx_learning-0.16.1.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
-openedx_learning-0.16.1.dist-info/RECORD,,
+openedx_learning-0.16.3.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+openedx_learning-0.16.3.dist-info/METADATA,sha256=DmGqGCSBExCF06ztJhI0YSnT_IFUnbLt__WYV9He0qU,8777
+openedx_learning-0.16.3.dist-info/WHEEL,sha256=TJ49d73sNs10F0aze1W_bTW2P_X7-F4YXOlBqoqA-jY,109
+openedx_learning-0.16.3.dist-info/top_level.txt,sha256=IYFbr5mgiEHd-LOtZmXj3q3a0bkGK1M9LY7GXgnfi4M,33
+openedx_learning-0.16.3.dist-info/RECORD,,

{openedx_learning-0.16.1.dist-info → openedx_learning-0.16.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.2.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any