chore: adds openedx_tagging/core/tagging/rest_api/__init__.py

and fixes resulting pylint issues.

openedx_tagging/core/tagging/rest_api/paginators.py

@@ -1,3 +1,7 @@
+"""
+Paginators uses by the REST API
+"""
+
 from edx_rest_framework_extensions.paginators import DefaultPagination  # type: ignore[import]
 
 # From this point, the tags begin to be paginated

openedx_tagging/core/tagging/rest_api/v1/permissions.py

@@ -6,6 +6,9 @@
 
 
 class TaxonomyObjectPermissions(DjangoObjectPermissions):
+    """
+    Maps each REST API methods to its corresponding Taxonomy permission.
+    """
     perms_map = {
         "GET": ["%(app_label)s.view_%(model_name)s"],
         "OPTIONS": [],
@@ -18,6 +21,9 @@ class TaxonomyObjectPermissions(DjangoObjectPermissions):
 
 
 class ObjectTagObjectPermissions(DjangoObjectPermissions):
+    """
+    Maps each REST API methods to its corresponding ObjectTag permission.
+    """
     perms_map = {
         "GET": ["%(app_label)s.view_%(model_name)s"],
         "OPTIONS": [],
@@ -30,12 +36,21 @@ class ObjectTagObjectPermissions(DjangoObjectPermissions):
 
 
 class TagListPermissions(DjangoObjectPermissions):
+    """
+    Permissions for Tag object views.
+    """
     def has_permission(self, request, view):
+        """
+        Returns True if the user on the given request is allowed the given view.
+        """
         if not request.user or (
             not request.user.is_authenticated and self.authenticated_users_only
         ):
             return False
         return True
 
     def has_object_permission(self, request, view, obj):
+        """
+        Returns True if the user on the given request is allowed the given view for the given object.
+        """
         return rules.has_perm("oel_tagging.list_tag", request.user, obj)

openedx_tagging/core/tagging/rest_api/v1/serializers.py

@@ -8,7 +8,7 @@
 from openedx_tagging.core.tagging.models import ObjectTag, Tag, Taxonomy
 
 
-class TaxonomyListQueryParamsSerializer(serializers.Serializer):
+class TaxonomyListQueryParamsSerializer(serializers.Serializer):  # pylint: disable=abstract-method
     """
     Serializer for the query params for the GET view
     """
@@ -32,7 +32,7 @@ class Meta:
         ]
 
 
-class ObjectTagListQueryParamsSerializer(serializers.Serializer):
+class ObjectTagListQueryParamsSerializer(serializers.Serializer):  # pylint: disable=abstract-method
     """
     Serializer for the query params for the ObjectTag GET view
     """
@@ -58,15 +58,15 @@ class Meta:
         ]
 
 
-class ObjectTagUpdateBodySerializer(serializers.Serializer):
+class ObjectTagUpdateBodySerializer(serializers.Serializer):  # pylint: disable=abstract-method
     """
     Serializer of the body for the ObjectTag UPDATE view
     """
 
     tags = serializers.ListField(child=serializers.CharField(), required=True)
 
 
-class ObjectTagUpdateQueryParamsSerializer(serializers.Serializer):
+class ObjectTagUpdateQueryParamsSerializer(serializers.Serializer):  # pylint: disable=abstract-method
     """
     Serializer of the query params for the ObjectTag UPDATE view
     """
@@ -98,6 +98,9 @@ class Meta:
         )
 
     def get_sub_tags_link(self, obj):
+        """
+        Returns URL for the list of child tags of the current tag.
+        """
         if obj.children.count():
             query_params = f"?parent_tag_id={obj.id}"
             url = (
@@ -106,8 +109,12 @@ def get_sub_tags_link(self, obj):
             )
             request = self.context.get("request")
             return request.build_absolute_uri(url)
+        return None
 
     def get_children_count(self, obj):
+        """
+        Returns the number of child tags of the given tag.
+        """
         return obj.children.count()
 
 
@@ -132,6 +139,9 @@ class Meta:
         )
 
     def get_sub_tags(self, obj):
+        """
+        Returns a serialized list of child tags for the given tag.
+        """
         serializer = TagsWithSubTagsSerializer(
             obj.children.all().order_by("value", "id"),
             many=True,
@@ -140,6 +150,9 @@ def get_sub_tags(self, obj):
         return serializer.data
 
     def get_children_count(self, obj):
+        """
+        Returns the number of child tags of the given tag.
+        """
         return obj.children.count()
 
 
@@ -151,8 +164,14 @@ class TagsForSearchSerializer(TagsWithSubTagsSerializer):
     """
 
     def get_sub_tags(self, obj):
+        """
+        Returns a serialized list of child tags for the given tag.
+        """
         serializer = TagsWithSubTagsSerializer(obj.sub_tags, many=True, read_only=True)
         return serializer.data
 
     def get_children_count(self, obj):
+        """
+        Returns the number of child tags of the given tag.
+        """
         return len(obj.sub_tags)

openedx_tagging/core/tagging/rest_api/v1/views.py

@@ -250,7 +250,7 @@ def get_queryset(self) -> models.QuerySet:
         taxonomy_id = query_params.data.get("taxonomy", None)
         return get_object_tags(object_id, taxonomy_id)
 
-    def retrieve(self, request, object_id=None):
+    def retrieve(self, request, *args, **kwargs):
         """
         Retrieve ObjectTags that belong to a given object_id
 
@@ -265,7 +265,7 @@ def retrieve(self, request, object_id=None):
         serializer = ObjectTagSerializer(object_tags, many=True)
         return Response(serializer.data)
 
-    def update(self, request, object_id, partial=False):
+    def update(self, request, *args, **kwargs):
         """
         Update ObjectTags that belong to a given object_id
 
@@ -290,6 +290,7 @@ def update(self, request, object_id, partial=False):
         }
         """
 
+        partial = kwargs.pop('partial', False)
         if partial:
             raise MethodNotAllowed("PATCH", detail="PATCH not allowed")
 
@@ -302,6 +303,7 @@ def update(self, request, object_id, partial=False):
 
         perm = f"{taxonomy._meta.app_label}.change_objecttag"
 
+        object_id = kwargs.pop('object_id')
         perm_obj = ChangeObjectTagPermissionItem(
             taxonomy=taxonomy,
             object_id=object_id,
@@ -319,9 +321,9 @@ def update(self, request, object_id, partial=False):
         try:
             tag_object(taxonomy, tags, object_id)
         except Tag.DoesNotExist as e:
-            raise ValidationError(e)
+            raise ValidationError from e
         except ValueError as e:
-            raise ValidationError(e)
+            raise ValidationError from e
 
         return self.retrieve(request, object_id)