openedx-learning 0.5.0__tar.gz → 0.5.1__tar.gz

{openedx-learning-0.5.0/openedx_learning.egg-info → openedx-learning-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: openedx-learning
-Version: 0.5.0
+Version: 0.5.1
 Summary: An experiment.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning/__init__.py

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

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning/core/components/admin.py

@@ -35,16 +35,15 @@ class ComponentAdmin(ReadOnlyModelAdmin):
     """
     Django admin configuration for Component
     """
-    list_display = ("key", "uuid", "namespace", "type", "created")
+    list_display = ("key", "uuid", "component_type", "created")
     readonly_fields = [
         "learning_package",
         "uuid",
-        "namespace",
-        "type",
+        "component_type",
         "key",
         "created",
     ]
-    list_filter = ("type", "learning_package")
+    list_filter = ("component_type", "learning_package")
     search_fields = ["publishable_entity__uuid", "publishable_entity__key"]
     inlines = [ComponentVersionInline]
 

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning/core/components/api.py

@@ -18,15 +18,28 @@ from pathlib import Path
 from django.db.models import Q, QuerySet
 from django.db.transaction import atomic
 
+from ...lib.cache import lru_cache
 from ..publishing import api as publishing_api
-from .models import Component, ComponentVersion, ComponentVersionRawContent
+from .models import Component, ComponentType, ComponentVersion, ComponentVersionRawContent
+
+
+@lru_cache(maxsize=128)
+def get_or_create_component_type_id(namespace: str, name: str) -> int:
+    """
+    Get the ID of a ComponentType, and create if missing.
+    """
+    component_type, _created = ComponentType.objects.get_or_create(
+        namespace=namespace,
+        name=name,
+    )
+    return component_type.id
 
 
 def create_component(
     learning_package_id: int,
     /,
     namespace: str,
-    type: str,  # pylint: disable=redefined-builtin
+    type_name: str,
     local_key: str,
     created: datetime,
     created_by: int | None,
@@ -34,7 +47,7 @@ def create_component(
     """
     Create a new Component (an entity like a Problem or Video)
     """
-    key = f"{namespace}:{type}@{local_key}"
+    key = f"{namespace}:{type_name}@{local_key}"
     with atomic():
         publishable_entity = publishing_api.create_publishable_entity(
             learning_package_id, key, created, created_by
@@ -42,8 +55,7 @@ def create_component(
         component = Component.objects.create(
             publishable_entity=publishable_entity,
             learning_package_id=learning_package_id,
-            namespace=namespace,
-            type=type,
+            component_type_id=get_or_create_component_type_id(namespace, type_name),
             local_key=local_key,
         )
     return component
@@ -163,7 +175,7 @@ def create_component_and_version(
     learning_package_id: int,
     /,
     namespace: str,
-    type: str,  # pylint: disable=redefined-builtin
+    type_name: str,
     local_key: str,
     title: str,
     created: datetime,
@@ -174,7 +186,7 @@ def create_component_and_version(
     """
     with atomic():
         component = create_component(
-            learning_package_id, namespace, type, local_key, created, created_by
+            learning_package_id, namespace, type_name, local_key, created, created_by
         )
         component_version = create_component_version(
             component.pk,
@@ -199,7 +211,7 @@ def get_component_by_key(
     learning_package_id: int,
     /,
     namespace: str,
-    type: str,  # pylint: disable=redefined-builtin
+    type_name: str,
     local_key: str,
 ) -> Component:
     """
@@ -208,8 +220,8 @@ def get_component_by_key(
     return Component.with_publishing_relations \
                     .get(
                         learning_package_id=learning_package_id,
-                        namespace=namespace,
-                        type=type,
+                        component_type__namespace=namespace,
+                        component_type__name=type_name,
                         local_key=local_key,
                     )
 
@@ -218,7 +230,7 @@ def component_exists_by_key(
     learning_package_id: int,
     /,
     namespace: str,
-    type: str,  # pylint: disable=redefined-builtin
+    type_name: str,
     local_key: str
 ) -> bool:
     """
@@ -228,10 +240,10 @@ def component_exists_by_key(
     no current Draft version for it), or if it's been unpublished.
     """
     try:
-        _component = Component.objects.only('pk').get(
+        _component = Component.objects.only('pk', 'component_type').get(
             learning_package_id=learning_package_id,
-            namespace=namespace,
-            type=type,
+            component_type__namespace=namespace,
+            component_type__name=type_name,
             local_key=local_key,
         )
         return True
@@ -245,7 +257,7 @@ def get_components(
     draft: bool | None = None,
     published: bool | None = None,
     namespace: str | None = None,
-    types: list[str] | None = None,
+    type_names: list[str] | None = None,
     draft_title: str | None = None,
     published_title: str | None = None,
 ) -> QuerySet[Component]:
@@ -265,9 +277,9 @@ def get_components(
     if published is not None:
         qset = qset.filter(publishable_entity__published__version__isnull=not published)
     if namespace is not None:
-        qset = qset.filter(namespace=namespace)
-    if types is not None:
-        qset = qset.filter(type__in=types)
+        qset = qset.filter(component_type__namespace=namespace)
+    if type_names is not None:
+        qset = qset.filter(component_type__name__in=type_names)
     if draft_title is not None:
         qset = qset.filter(
             publishable_entity__draft__version__title__icontains=draft_title

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning/core/components/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 3.2.23 on 2024-01-22 00:38
+# Generated by Django 3.2.23 on 2024-01-31 05:34
 
 import uuid
 
@@ -13,8 +13,8 @@ class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        ('oel_contents', '0001_initial'),
         ('oel_publishing', '0001_initial'),
+        ('oel_contents', '0001_initial'),
     ]
 
     operations = [
@@ -22,16 +22,21 @@ class Migration(migrations.Migration):
             name='Component',
             fields=[
                 ('publishable_entity', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='oel_publishing.publishableentity')),
-                ('namespace', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=100)),
-                ('type', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=100)),
                 ('local_key', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=500)),
-                ('learning_package', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='oel_publishing.learningpackage')),
             ],
             options={
                 'verbose_name': 'Component',
                 'verbose_name_plural': 'Components',
             },
         ),
+        migrations.CreateModel(
+            name='ComponentType',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('namespace', openedx_learning.lib.fields.MultiCollationCharField(db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=100)),
+                ('name', openedx_learning.lib.fields.MultiCollationCharField(blank=True, db_collations={'mysql': 'utf8mb4_bin', 'sqlite': 'BINARY'}, max_length=100)),
+            ],
+        ),
         migrations.CreateModel(
             name='ComponentVersion',
             fields=[
@@ -59,6 +64,16 @@ class Migration(migrations.Migration):
             name='raw_contents',
             field=models.ManyToManyField(related_name='component_versions', through='oel_components.ComponentVersionRawContent', to='oel_contents.RawContent'),
         ),
+        migrations.AddField(
+            model_name='component',
+            name='component_type',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='oel_components.componenttype'),
+        ),
+        migrations.AddField(
+            model_name='component',
+            name='learning_package',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='oel_publishing.learningpackage'),
+        ),
         migrations.AddIndex(
             model_name='componentversionrawcontent',
             index=models.Index(fields=['raw_content', 'component_version'], name='oel_cvrawcontent_c_cv'),
@@ -73,10 +88,10 @@ class Migration(migrations.Migration):
         ),
         migrations.AddIndex(
             model_name='component',
-            index=models.Index(fields=['learning_package', 'namespace', 'type', 'local_key'], name='oel_component_idx_lc_ns_t_lk'),
+            index=models.Index(fields=['component_type', 'local_key'], name='oel_component_idx_ct_lk'),
         ),
         migrations.AddConstraint(
             model_name='component',
-            constraint=models.UniqueConstraint(fields=('learning_package', 'namespace', 'type', 'local_key'), name='oel_component_uniq_lc_ns_t_lk'),
+            constraint=models.UniqueConstraint(fields=('learning_package', 'component_type', 'local_key'), name='oel_component_uniq_lc_ct_lk'),
         ),
     ]

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning/core/components/models.py

@@ -28,6 +28,45 @@ from ..publishing.model_mixins import PublishableEntityMixin, PublishableEntityV
 from ..publishing.models import LearningPackage
 
 
+class ComponentType(models.Model):
+    """
+    Normalized representation of a type of Component.
+
+    The only namespace being used initially will be 'xblock.v1', but we will
+    probably add a few others over time, such as a component type to represent
+    packages of files for things like Files and Uploads or python_lib.zip files.
+
+    Make a ForeignKey against this table if you have to set policy based on the
+    type of Components–e.g. marking certain types of XBlocks as approved vs.
+    experimental for use in libraries.
+    """
+    id = models.AutoField(primary_key=True)
+
+    # namespace and name work together to help figure out what Component needs
+    # to handle this data. A namespace is *required*. The namespace for XBlocks
+    # is "xblock.v1" (to match the setup.py entrypoint naming scheme).
+    namespace = case_sensitive_char_field(max_length=100, blank=False)
+
+    # name is a way to help sub-divide namespace if that's convenient. This
+    # field cannot be null, but it can be blank if it's not necessary. For an
+    # XBlock, this corresponds to tag, e.g. "video". It's also the block_type in
+    # the UsageKey.
+    name = case_sensitive_char_field(max_length=100, blank=True)
+
+    constraints = [
+        models.UniqueConstraint(
+            fields=[
+                "namespace",
+                "name",
+            ],
+            name="oel_component_type_uniq_ns_n",
+        ),
+    ]
+
+    def __str__(self):
+        return f"{self.namespace}:{self.name}"
+
+
 class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
     """
     This represents any Component that has ever existed in a LearningPackage.
@@ -63,7 +102,7 @@ class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
     -----------------
 
     The ``key`` field on Component's ``publishable_entity`` is dervied from the
-    ``(namespace, type, local_key)`` fields in this model. We don't support
+    ``component_type`` and ``local_key`` fields in this model. We don't support
     changing the keys yet, but if we do, those values need to be kept in sync.
 
     How build on this model
@@ -75,9 +114,12 @@ class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
     # Tell mypy what type our objects manager has.
     # It's actually PublishableEntityMixinManager, but that has the exact same
     # interface as the base manager class.
-    objects: models.Manager[Component]
+    objects: models.Manager[Component] = WithRelationsManager(
+        'component_type'
+    )
 
-    with_publishing_relations = WithRelationsManager(
+    with_publishing_relations: models.Manager[Component] = WithRelationsManager(
+        'component_type',
         'publishable_entity',
         'publishable_entity__draft__version',
         'publishable_entity__draft__version__componentversion',
@@ -93,53 +135,43 @@ class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
     # columns from different tables).
     learning_package = models.ForeignKey(LearningPackage, on_delete=models.CASCADE)
 
-    # namespace and type work together to help figure out what Component needs
-    # to handle this data. A namespace is *required*. The namespace for XBlocks
-    # is "xblock.v1" (to match the setup.py entrypoint naming scheme).
-    namespace = case_sensitive_char_field(max_length=100, blank=False)
+    # What kind of Component are we? This will usually represent a specific
+    # XBlock block_type, but we want it to be more flexible in the long term.
+    component_type = models.ForeignKey(ComponentType, on_delete=models.PROTECT)
 
-    # type is a way to help sub-divide namespace if that's convenient. This
-    # field cannot be null, but it can be blank if it's not necessary. For an
-    # XBlock, type corresponds to tag, e.g. "video". It's also the block_type in
-    # the UsageKey.
-    type = case_sensitive_char_field(max_length=100, blank=True)
-
-    # local_key is an identifier that is local to the (namespace, type).  The
-    # publishable.key should be calculated as a combination of (namespace, type,
-    # local_key).
+    # local_key is an identifier that is local to the learning_package and
+    # component_type.  The publishable.key should be calculated as a
+    # combination of component_type and local_key.
     local_key = key_field()
 
     class Meta:
         constraints = [
-            # The combination of (namespace, type, local_key) is unique within
+            # The combination of (component_type, local_key) is unique within
             # a given LearningPackage. Note that this means it is possible to
-            # have two Components that have the exact same local_key. An XBlock
-            # would be modeled as namespace="xblock.v1" with the type as the
-            # block_type, so the local_key would only be the block_id (the
-            # very last part of the UsageKey).
+            # have two Components in the same LearningPackage to have the same
+            # local_key if the component_types are different. So for example,
+            # you could have a ProblemBlock and VideoBlock that both have the
+            # local_key "week_1".
             models.UniqueConstraint(
                 fields=[
                     "learning_package",
-                    "namespace",
-                    "type",
+                    "component_type",
                     "local_key",
                 ],
-                name="oel_component_uniq_lc_ns_t_lk",
+                name="oel_component_uniq_lc_ct_lk",
             ),
         ]
         indexes = [
-            # Global Namespace/Type/Local-Key Index:
+            # Global Component-Type/Local-Key Index:
             #   * Search by the different Components fields across all Learning
             #     Packages on the site. This would be a support-oriented tool
             #     from Django Admin.
             models.Index(
                 fields=[
-                    "learning_package",
-                    "namespace",
-                    "type",
+                    "component_type",
                     "local_key",
                 ],
-                name="oel_component_idx_lc_ns_t_lk",
+                name="oel_component_idx_ct_lk",
             ),
         ]
 
@@ -148,7 +180,7 @@ class Component(PublishableEntityMixin):  # type: ignore[django-manager-missing]
         verbose_name_plural = "Components"
 
     def __str__(self):
-        return f"{self.namespace}:{self.type}:{self.local_key}"
+        return f"{self.component_type.namespace}:{self.component_type.name}:{self.local_key}"
 
 
 class ComponentVersion(PublishableEntityVersionMixin):

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning/core/contents/api.py

@@ -12,9 +12,8 @@ from datetime import datetime
 from django.core.files.base import ContentFile
 from django.db.transaction import atomic
 
-from openedx_learning.lib.cache import lru_cache
-from openedx_learning.lib.fields import create_hash_digest
-
+from ...lib.cache import lru_cache
+from ...lib.fields import create_hash_digest
 from .models import MediaType, RawContent, TextContent
 
 
@@ -33,7 +32,7 @@ def create_raw_content(
 
     raw_content = RawContent.objects.create(
         learning_package_id=learning_package_id,
-        media_type_id=get_media_type_id(mime_type),
+        media_type_id=get_or_create_media_type_id(mime_type),
         hash_digest=hash_digest,
         size=len(data_bytes),
         created=created,
@@ -58,7 +57,7 @@ def create_text_from_raw_content(raw_content: RawContent, encoding="utf-8-sig")
 
 
 @lru_cache(maxsize=128)
-def get_media_type_id(mime_type: str) -> int:
+def get_or_create_media_type_id(mime_type: str) -> int:
     """
     Return the MediaType.id for the desired mime_type string.
 

{openedx-learning-0.5.0 → openedx-learning-0.5.1/openedx_learning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: openedx-learning
-Version: 0.5.0
+Version: 0.5.1
 Summary: An experiment.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning.egg-info/SOURCES.txt

@@ -87,6 +87,7 @@ openedx_tagging/core/tagging/migrations/0011_remove_required.py
 openedx_tagging/core/tagging/migrations/0012_language_taxonomy.py
 openedx_tagging/core/tagging/migrations/0013_tag_parent_blank.py
 openedx_tagging/core/tagging/migrations/0014_minor_fixes.py
+openedx_tagging/core/tagging/migrations/0015_taxonomy_export_id.py
 openedx_tagging/core/tagging/migrations/__init__.py
 openedx_tagging/core/tagging/models/__init__.py
 openedx_tagging/core/tagging/models/base.py

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_tagging/core/tagging/api.py

@@ -17,6 +17,7 @@ from typing import Any
 from django.db import models, transaction
 from django.db.models import F, QuerySet, Value
 from django.db.models.functions import Coalesce, Concat, Lower
+from django.utils.text import slugify
 from django.utils.translation import gettext as _
 
 from .data import TagDataQuerySet
@@ -34,19 +35,26 @@ def create_taxonomy(
     allow_multiple=True,
     allow_free_text=False,
     taxonomy_class: type[Taxonomy] | None = None,
+    export_id: str | None = None,
 ) -> Taxonomy:
     """
     Creates, saves, and returns a new Taxonomy with the given attributes.
     """
+    if not export_id:
+        export_id = f"{Taxonomy.objects.count() + 1}-{slugify(name, allow_unicode=True)}"
+
     taxonomy = Taxonomy(
         name=name,
         description=description or "",
         enabled=enabled,
         allow_multiple=allow_multiple,
         allow_free_text=allow_free_text,
+        export_id=export_id,
     )
     if taxonomy_class:
         taxonomy.taxonomy_class = taxonomy_class
+
+    taxonomy.full_clean()
     taxonomy.save()
     return taxonomy.cast()
 

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_tagging/core/tagging/import_export/api.py

@@ -121,7 +121,7 @@ def import_tags(
         task.end_success()
 
         return True, task, tag_import_plan
-    except Exception as exception:  # pylint: disable=broad-exception-caught
+    except Exception as exception:
         # Log any exception
         task.log_exception(exception)
         return False, task, None

openedx-learning-0.5.1/openedx_tagging/core/tagging/migrations/0015_taxonomy_export_id.py

@@ -0,0 +1,38 @@
+# Generated by Django 3.2.22 on 2024-01-25 14:20
+
+from django.db import migrations, models
+from django.utils.text import slugify
+
+
+def migrate_export_id(apps, schema_editor):
+    Taxonomy = apps.get_model("oel_tagging", "Taxonomy")
+    for taxonomy in Taxonomy.objects.all():
+        # Adds the id of the taxonomy to avoid duplicates
+        taxonomy.export_id = f"{taxonomy.id}-{slugify(taxonomy.name, allow_unicode=True)}"
+        taxonomy.save(update_fields=["export_id"])
+
+def reverse(app, schema_editor):
+    pass
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_tagging', '0014_minor_fixes'),
+    ]
+
+    operations = [
+        # Create the field allowing null 
+        migrations.AddField(
+            model_name='taxonomy',
+            name='export_id',
+            field=models.CharField(help_text="User-facing ID that is used on import/export. Should only contain alphanumeric characters or '_' '-' '.'", max_length=255, null=True, unique=True),
+        ),
+        # Fill the field for created taxonomies
+        migrations.RunPython(migrate_export_id, reverse),
+        # Alter the field to not allowing null
+        migrations.AlterField(
+            model_name='taxonomy',
+            name='export_id',
+            field=models.CharField(help_text="User-facing ID that is used on import/export. Should only contain alphanumeric characters or '_' '-' '.'", max_length=255, null=False, unique=True),
+        ),
+    ]

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_tagging/core/tagging/models/base.py

@@ -4,6 +4,7 @@ Tagging app base data models
 from __future__ import annotations
 
 import logging
+import re
 from typing import List
 
 from django.core.exceptions import ValidationError
@@ -228,6 +229,19 @@ class Taxonomy(models.Model):
             "Indicates whether this taxonomy should be visible to object authors."
         ),
     )
+    # External ID that should only be used on import/export.
+    # NOT use for any other purposes, you can use the numeric ID of the model instead;
+    # this id is editable.
+    export_id = models.CharField(
+        null=False,
+        blank=False,
+        max_length=255,
+        help_text=_(
+            "User-facing ID that is used on import/export."
+            " Should only contain alphanumeric characters or '_' '-' '.'"
+        ),
+        unique=True,
+    )
     _taxonomy_class = models.CharField(
         null=True,
         max_length=255,
@@ -300,6 +314,14 @@ class Taxonomy(models.Model):
         """
         return False
 
+    def clean(self):
+        super().clean()
+
+        if not re.match(r'^[\w\-.]+$', self.export_id):
+            raise ValidationError(
+                "The export_id should only contain alphanumeric characters or '_' '-' '.'"
+            )
+
     def cast(self):
         """
         Returns the current Taxonomy instance cast into its taxonomy_class.
@@ -336,6 +358,7 @@ class Taxonomy(models.Model):
         self.allow_multiple = taxonomy.allow_multiple
         self.allow_free_text = taxonomy.allow_free_text
         self.visible_to_authors = taxonomy.visible_to_authors
+        self.export_id = taxonomy.export_id
         self._taxonomy_class = taxonomy._taxonomy_class  # pylint: disable=protected-access
         return self
 

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_tagging/core/tagging/rest_api/v1/serializers.py

@@ -72,6 +72,7 @@ class TaxonomySerializer(UserPermissionsSerializerMixin, serializers.ModelSerial
     can_change_taxonomy = serializers.SerializerMethodField(method_name='get_can_change')
     can_delete_taxonomy = serializers.SerializerMethodField(method_name='get_can_delete')
     can_tag_object = serializers.SerializerMethodField()
+    export_id = serializers.CharField(required=False)
 
     class Meta:
         model = Taxonomy
@@ -88,6 +89,7 @@ class TaxonomySerializer(UserPermissionsSerializerMixin, serializers.ModelSerial
             "can_change_taxonomy",
             "can_delete_taxonomy",
             "can_tag_object",
+            "export_id",
         ]
 
     def to_representation(self, instance):
@@ -332,6 +334,7 @@ class TaxonomyImportNewBodySerializer(TaxonomyImportBodySerializer):  # pylint:
     """
     taxonomy_name = serializers.CharField(required=True)
     taxonomy_description = serializers.CharField(default="")
+    taxonomy_export_id = serializers.CharField(required=True)
 
 
 class TagImportTaskSerializer(serializers.ModelSerializer):

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_tagging/core/tagging/rest_api/v1/views.py

@@ -3,6 +3,7 @@ Tagging API Views
 """
 from __future__ import annotations
 
+from django.core import exceptions
 from django.db import models
 from django.http import Http404, HttpResponse
 from rest_framework import mixins, status
@@ -57,6 +58,11 @@ class TaxonomyView(ModelViewSet):
     """
     View to list, create, retrieve, update, delete, export or import Taxonomies.
 
+    TODO: We need to add a perform_update and call the api update function when is created.
+    This is because it is necessary to call the model validations. (`full_clean()`).
+    Currently those validations are not run, which means we could update `export_id` with any value
+    through this api.
+
     **List Query Parameters**
         * enabled (optional) - Filter by enabled status. Valid values: true,
           false, 1, 0, "true", "false", "1"
@@ -87,6 +93,8 @@ class TaxonomyView(ModelViewSet):
     **Create Parameters**
         * name (required): User-facing label used when applying tags from this
           taxonomy to Open edX objects.
+        * export_id (required): User-facing ID that is used on import/export.
+          Should only contain alphanumeric characters or '_' '-' '.'.
         * description (optional): Provides extra information for the user when
           applying tags from this taxonomy to an object.
         * enabled (optional): Only enabled taxonomies will be shown to authors
@@ -101,6 +109,7 @@ class TaxonomyView(ModelViewSet):
         POST api/tagging/v1/taxonomy               - Create a taxonomy
         {
             "name": "Taxonomy Name",
+            "export_id": "taxonomy_export_id",
             "description": "This is a description",
             "enabled": True,
             "allow_multiple": True,
@@ -117,6 +126,8 @@ class TaxonomyView(ModelViewSet):
     **Update Request Body**
         * name (optional): User-facing label used when applying tags from this
           taxonomy to Open edX objects.
+        * export_id (optional): User-facing ID that is used on import/export.
+          Should only contain alphanumeric characters or '_' '-' '.'.
         * description (optional): Provides extra information for the user when
           applying tags from this taxonomy to an object.
         * enabled (optional): Only enabled taxonomies will be shown to authors.
@@ -129,6 +140,7 @@ class TaxonomyView(ModelViewSet):
         PUT api/tagging/v1/taxonomy/:pk            - Update a taxonomy
         {
             "name": "Taxonomy New Name",
+            "export_id": "taxonomy_new_name",
             "description": "This is a new description",
             "enabled": False,
             "allow_multiple": False,
@@ -174,6 +186,7 @@ class TaxonomyView(ModelViewSet):
         POST /tagging/rest_api/v1/taxonomy/import/
         {
             "taxonomy_name": "Taxonomy Name",
+            "taxonomy_export_id": "this_is_the_export_id",
             "taxonomy_description": "This is a description",
             "file": <file>,
         }
@@ -245,7 +258,10 @@ class TaxonomyView(ModelViewSet):
         """
         Create a new taxonomy.
         """
-        serializer.instance = create_taxonomy(**serializer.validated_data)
+        try:
+            serializer.instance = create_taxonomy(**serializer.validated_data)
+        except exceptions.ValidationError as e:
+            raise ValidationError() from e
 
     @action(detail=True, methods=["get"])
     def export(self, request, **_kwargs) -> HttpResponse:
@@ -286,11 +302,12 @@ class TaxonomyView(ModelViewSet):
         body.is_valid(raise_exception=True)
 
         taxonomy_name = body.validated_data["taxonomy_name"]
+        taxonomy_export_id = body.validated_data["taxonomy_export_id"]
         taxonomy_description = body.validated_data["taxonomy_description"]
         file = body.validated_data["file"].file
         parser_format = body.validated_data["parser_format"]
 
-        taxonomy = create_taxonomy(taxonomy_name, taxonomy_description)
+        taxonomy = create_taxonomy(taxonomy_name, taxonomy_description, export_id=taxonomy_export_id)
         try:
             import_success, task, _plan = import_tags(taxonomy, file, parser_format)
 

{openedx-learning-0.5.0 → openedx-learning-0.5.1}/openedx_learning.egg-info/requires.txt

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