Merge branch 'master' into include_related_field

Author: n2ygk

AUTHORS

@@ -31,6 +31,7 @@ Raphael Cohen <[email protected]>
 René Kälin <[email protected]>
 Roberto Barreda <[email protected]>
 Rohith PR <[email protected]>
+Safa AlFulaij <[email protected]>
 santiavenda <[email protected]>
 Sergey Kolomenkin <https://kolomenkin.com>
 Stas S. <[email protected]>

CHANGELOG.md

@@ -13,6 +13,17 @@ any parts of the framework not mentioned in the documentation should generally b
 ### Added
 
 * Added support for Django 3.2.
+* Added support for tags in OAS schema
+
+### Fixed
+
+* Allow `get_serializer_class` to be overwritten when using related urls without defining `serializer_class` fallback
+* Preserve field names when no formatting is configured.
+
+### Deprecated
+
+* Deprecated default `format_type` argument of `rest_framework_json_api.utils.format_value`. Use `rest_framework_json_api.utils.format_field_name` or specify specifc `format_type` instead.
+* Deprecated `format_type` argument of `rest_framework_json_api.utils.format_link_segment`. Use `format_value` instead.
 
 ### Fixed
 

example/tests/snapshots/snap_test_openapi.py

@@ -121,7 +121,10 @@
       },
       "description": "not found"
     }
-  }
+  },
+  "tags": [
+    "authors"
+  ]
 }"""
 
 snapshots[
@@ -227,7 +230,10 @@
       },
       "description": "not found"
     }
-  }
+  },
+  "tags": [
+    "authors"
+  ]
 }"""
 
 snapshots[
@@ -411,7 +417,10 @@
       },
       "description": "[Conflict](https://jsonapi.org/format/#crud-creating-responses-409)"
     }
-  }
+  },
+  "tags": [
+    "authors"
+  ]
 }"""
 
 snapshots[
@@ -589,7 +598,10 @@
       },
       "description": "[Conflict]([Conflict](https://jsonapi.org/format/#crud-updating-responses-409)"
     }
-  }
+  },
+  "tags": [
+    "authors"
+  ]
 }"""
 
 snapshots[
@@ -652,5 +664,8 @@
       },
       "description": "[Resource does not exist](https://jsonapi.org/format/#crud-deleting-responses-404)"
     }
-  }
+  },
+  "tags": [
+    "authors"
+  ]
 }"""

example/tests/test_views.py

@@ -417,12 +417,11 @@ def test_get_related_serializer_class_many(self):
     def test_get_serializer_comes_from_included_serializers(self):
         kwargs = {"pk": self.author.id, "related_field": "type"}
         view = self._get_view(kwargs)
-        related_serializers = view.serializer_class.related_serializers
-        delattr(view.serializer_class, "related_serializers")
+        related_serializers = view.get_serializer_class().related_serializers
+        delattr(view.get_serializer_class(), "related_serializers")
         got = view.get_related_serializer_class()
         self.assertEqual(got, AuthorTypeSerializer)
-
-        view.serializer_class.related_serializers = related_serializers
+        view.get_serializer_class().related_serializers = related_serializers
 
     def test_get_related_serializer_class_raises_error(self):
         kwargs = {"pk": self.author.id, "related_field": "unknown"}

example/views.py

@@ -208,17 +208,15 @@ class NoFiltersetEntryViewSet(EntryViewSet):
 
 class AuthorViewSet(ModelViewSet):
     queryset = Author.objects.all()
-    serializer_classes = {
-        "list": AuthorListSerializer,
-        "retrieve": AuthorDetailSerializer,
-    }
-    serializer_class = AuthorSerializer  # fallback
 
     def get_serializer_class(self):
-        try:
-            return self.serializer_classes.get(self.action, self.serializer_class)
-        except AttributeError:
-            return self.serializer_class
+        serializer_classes = {
+            "list": AuthorListSerializer,
+            "retrieve": AuthorDetailSerializer,
+        }
+
+        action = getattr(self, "action", "")
+        return serializer_classes.get(action, AuthorSerializer)
 
 
 class CommentViewSet(ModelViewSet):

requirements/requirements-codestyle.txt

@@ -1,4 +1,4 @@
 black==20.8b1
-flake8==3.9.0
+flake8==3.9.1
 flake8-isort==4.0.0
-isort==5.7.0
+isort==5.8.0

requirements/requirements-documentation.txt

@@ -1,3 +1,3 @@
 recommonmark==0.7.1
-Sphinx==3.5.2
-sphinx_rtd_theme==0.5.1
+Sphinx==3.5.4
+sphinx_rtd_theme==0.5.2

requirements/requirements-packaging.txt

@@ -1 +1 @@
-twine==3.3.0
+twine==3.4.1

requirements/requirements-testing.txt

@@ -1,8 +1,8 @@
-django-debug-toolbar==3.2
+django-debug-toolbar==3.2.1
 factory-boy==3.2.0
-Faker==6.6.0
-pytest==6.2.2
+Faker==8.1.0
+pytest==6.2.3
 pytest-cov==2.11.1
-pytest-django==4.1.0
+pytest-django==4.2.0
 pytest-factoryboy==2.1.0
 snapshottest==0.6.0

rest_framework_json_api/django_filters/backends.py

@@ -4,7 +4,7 @@
 from rest_framework.exceptions import ValidationError
 from rest_framework.settings import api_settings
 
-from rest_framework_json_api.utils import format_value
+from rest_framework_json_api.utils import undo_format_field_name
 
 
 class DjangoFilterBackend(DjangoFilterBackend):
@@ -119,8 +119,7 @@ def get_filterset_kwargs(self, request, queryset, view):
                     )
                 # convert jsonapi relationship path to Django ORM's __ notation
                 key = m.groupdict()["assoc"].replace(".", "__")
-                # undo JSON_API_FORMAT_FIELD_NAMES conversion:
-                key = format_value(key, "underscore")
+                key = undo_format_field_name(key)
                 data.setlist(key, val)
                 filter_keys.append(key)
                 del data[qp]

rest_framework_json_api/filters.py

@@ -3,7 +3,7 @@
 from rest_framework.exceptions import ValidationError
 from rest_framework.filters import BaseFilterBackend, OrderingFilter
 
-from rest_framework_json_api.utils import format_value
+from rest_framework_json_api.utils import undo_format_field_name
 
 
 class OrderingFilter(OrderingFilter):
@@ -15,7 +15,7 @@ class OrderingFilter(OrderingFilter):
     :py:class:`rest_framework.filters.OrderingFilter` with
     :py:attr:`~rest_framework.filters.OrderingFilter.ordering_param` = "sort"
 
-    Also applies DJA format_value() to convert (e.g. camelcase) to underscore.
+    Also supports undo of field name formatting
     (See JSON_API_FORMAT_FIELD_NAMES in docs/usage.md)
     """
 
@@ -38,7 +38,7 @@ def remove_invalid_fields(self, queryset, fields, view, request):
         bad_terms = [
             term
             for term in fields
-            if format_value(term.replace(".", "__").lstrip("-"), "underscore")
+            if undo_format_field_name(term.replace(".", "__").lstrip("-"))
             not in valid_fields
         ]
         if bad_terms:
@@ -56,10 +56,10 @@ def remove_invalid_fields(self, queryset, fields, view, request):
             item_rewritten = item.replace(".", "__")
             if item_rewritten.startswith("-"):
                 underscore_fields.append(
-                    "-" + format_value(item_rewritten.lstrip("-"), "underscore")
+                    "-" + undo_format_field_name(item_rewritten.lstrip("-"))
                 )
             else:
-                underscore_fields.append(format_value(item_rewritten, "underscore"))
+                underscore_fields.append(undo_format_field_name(item_rewritten))
 
         return super(OrderingFilter, self).remove_invalid_fields(
             queryset, underscore_fields, view, request

rest_framework_json_api/metadata.py

@@ -7,7 +7,7 @@
 from rest_framework.settings import api_settings
 from rest_framework.utils.field_mapping import ClassLookupDict
 
-from rest_framework_json_api.utils import format_value, get_related_resource_type
+from rest_framework_json_api.utils import format_field_name, get_related_resource_type
 
 
 class JSONAPIMetadata(SimpleMetadata):
@@ -93,7 +93,7 @@ def get_serializer_info(self, serializer):
 
         return OrderedDict(
             [
-                (format_value(field_name), self.get_field_info(field))
+                (format_field_name(field_name), self.get_field_info(field))
                 for field_name, field in serializer.fields.items()
             ]
         )

rest_framework_json_api/parsers.py

@@ -4,8 +4,8 @@
 from rest_framework import parsers
 from rest_framework.exceptions import ParseError
 
-from . import exceptions, renderers, serializers, utils
-from .settings import json_api_settings
+from rest_framework_json_api import exceptions, renderers, serializers
+from rest_framework_json_api.utils import get_resource_name, undo_format_field_names
 
 
 class JSONParser(parsers.JSONParser):
@@ -37,27 +37,13 @@ class JSONParser(parsers.JSONParser):
 
     @staticmethod
     def parse_attributes(data):
-        attributes = data.get("attributes")
-        uses_format_translation = json_api_settings.FORMAT_FIELD_NAMES
-
-        if not attributes:
-            return dict()
-        elif uses_format_translation:
-            # convert back to python/rest_framework's preferred underscore format
-            return utils.format_field_names(attributes, "underscore")
-        else:
-            return attributes
+        attributes = data.get("attributes") or dict()
+        return undo_format_field_names(attributes)
 
     @staticmethod
     def parse_relationships(data):
-        uses_format_translation = json_api_settings.FORMAT_FIELD_NAMES
-        relationships = data.get("relationships")
-
-        if not relationships:
-            relationships = dict()
-        elif uses_format_translation:
-            # convert back to python/rest_framework's preferred underscore format
-            relationships = utils.format_field_names(relationships, "underscore")
+        relationships = data.get("relationships") or dict()
+        relationships = undo_format_field_names(relationships)
 
         # Parse the relationships
         parsed_relationships = dict()
@@ -130,7 +116,7 @@ def parse(self, stream, media_type=None, parser_context=None):
 
         # Check for inconsistencies
         if request.method in ("PUT", "POST", "PATCH"):
-            resource_name = utils.get_resource_name(
+            resource_name = get_resource_name(
                 parser_context, expand_polymorphic_types=True
             )
             if isinstance(resource_name, str):

rest_framework_json_api/schemas/openapi.py

@@ -427,6 +427,7 @@ def get_operation(self, path, method):
             parameters += self.get_pagination_parameters(path, method)
             parameters += self.get_filter_parameters(path, method)
         operation["parameters"] = parameters
+        operation["tags"] = self.get_tags(path, method)
 
         # get request and response code schemas
         if method == "GET":