Merge branch 'master' into fix/openapi31-nullable-choice-fields-regression

Author: tfranzel

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,10 +8,10 @@ assignees: ''
 ---
 
 **Describe the bug**
-A clear and concise description of what the bug is.
+<!--A clear and concise description of what the bug is.-->
 
 **To Reproduce**
-It would be most helpful to provide a small snippet to see how the bug was provoked.
+<!--It would be most helpful to provide a small snippet to see how the bug was provoked.-->
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+<!--A clear and concise description of what you expected to happen.-->

README.rst

@@ -63,7 +63,7 @@ Requirements
 
 -  Python >= 3.7
 -  Django (2.2, 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2)
--  Django REST Framework (3.10.3, 3.11, 3.12, 3.13, 3.14, 3.15)
+-  Django REST Framework (3.10.3, 3.11, 3.12, 3.13, 3.14, 3.15, 3.16)
 
 Installation
 ------------

docs/customization.rst

@@ -136,8 +136,8 @@ On rare occasions (e.g. envelope serializers), overriding list detection with ``
                     'songs': {'top10': True},
                     'single': {'top10': True}
                 },
-                request_only=True, # signal that example only applies to requests
-                response_only=True, # signal that example only applies to responses
+                # request_only=True, # signal that example only applies to requests
+                # response_only=True, # signal that example only applies to responses
             ),
         ]
     )

drf_spectacular/contrib/django_filters.py

@@ -234,6 +234,9 @@ def _get_model_field(self, filter_field, model):
         if not filter_field.field_name:
             return None
         path = filter_field.field_name.split('__')
+        to_field_name = filter_field.extra.get("to_field_name")
+        if to_field_name is not None:
+            path.append(to_field_name)
         return follow_field_source(model, path, emit_warnings=False)
 
     def _get_schema_from_model_field(self, auto_schema, filter_field, model):

drf_spectacular/contrib/djangorestframework_camel_case.py

@@ -1,5 +1,5 @@
 import re
-from typing import Optional
+from typing import MutableMapping, Optional
 
 from django.utils.module_loading import import_string
 
@@ -20,20 +20,18 @@ def has_middleware_installed():
         except ImportError:
             return False
 
-        for middleware in [import_string(m) for m in settings.MIDDLEWARE]:
-            try:
-                if issubclass(middleware, CamelCaseMiddleWare):
-                    return True
-            except TypeError:
-                pass
+        return any(
+            isinstance(m, type) and issubclass(m, CamelCaseMiddleWare)
+            for m in map(import_string, settings.MIDDLEWARE)
+        )
 
     def camelize_str(key: str) -> str:
         new_key = re.sub(camelize_re, underscore_to_camel, key) if "_" in key else key
         if key in ignore_keys or new_key in ignore_keys:
             return key
         return new_key
 
-    def camelize_component(schema: dict, name: Optional[str] = None) -> dict:
+    def camelize_component(schema: MutableMapping, name: Optional[str] = None) -> MutableMapping:
         if name is not None and (name in ignore_fields or camelize_str(name) in ignore_fields):
             return schema
         elif schema.get('type') == 'object':
@@ -44,7 +42,7 @@ def camelize_component(schema: dict, name: Optional[str] = None) -> dict:
                 }
             if 'required' in schema:
                 schema['required'] = [camelize_str(field) for field in schema['required']]
-        elif schema.get('type') == 'array':
+        elif schema.get('type') == 'array' and isinstance(schema['items'], MutableMapping):
             camelize_component(schema['items'])
         return schema
 

drf_spectacular/extensions.py

@@ -106,18 +106,30 @@ class OpenApiViewExtension(OpenApiGeneratorExtension['OpenApiViewExtension']):
     Extension for replacing discovered views with a more schema-appropriate/annotated version.
 
     ``view_replacement()`` is expected to return a subclass of ``APIView`` (which includes
-    ``ViewSet`` et al.). The discovered original view instance can be accessed with
-    ``self.target`` and be subclassed if desired.
+    ``ViewSet`` et al.). The discovered original view callback can be accessed with
+    ``self.target_callback``, while the discovered original view class can be accessed
+    with ``self.target`` and can be subclassed if desired.
     """
     _registry: List[Type['OpenApiViewExtension']] = []
 
+    def __init__(self, target_callback):
+        super().__init__(target_callback.cls)
+        self.target_callback = target_callback
+
     @classmethod
     def _load_class(cls):
         super()._load_class()
         # special case @api_view: view class is nested in the cls attr of the function object
         if hasattr(cls.target_class, 'cls'):
             cls.target_class = cls.target_class.cls
 
+    @classmethod
+    def get_match(cls, target_callback) -> 'Optional[OpenApiViewExtension]':
+        for extension in sorted(cls._registry, key=lambda e: e.priority, reverse=True):
+            if extension._matches(target_callback.cls):
+                return extension(target_callback)
+        return None
+
     @abstractmethod
     def view_replacement(self) -> 'Type[APIView]':
         pass  # pragma: no cover

drf_spectacular/generators.py

@@ -1,5 +1,6 @@
-import os
+import posixpath
 import re
+import weakref
 
 from django.urls import URLPattern, URLResolver
 from rest_framework import views, viewsets
@@ -106,6 +107,7 @@ def __init__(self, *args, **kwargs):
         self.registry = ComponentRegistry()
         self.api_version = kwargs.pop('api_version', None)
         self.inspector = None
+        self.schemas_storage = []
         super().__init__(*args, **kwargs)
 
     def coerce_path(self, path, method, view):
@@ -126,7 +128,7 @@ def create_view(self, callback, method, request=None):
         decorating plain views like retrieve, this initialization logic is not running.
         Therefore forcefully set the schema if @extend_schema decorator was used.
         """
-        override_view = OpenApiViewExtension.get_match(callback.cls)
+        override_view = OpenApiViewExtension.get_match(callback)
         if override_view:
             original_cls = callback.cls
             callback.cls = override_view.view_replacement()
@@ -179,7 +181,7 @@ def create_view(self, callback, method, request=None):
             ) + view_schema_class.__mro__
             action_schema_class = type('ExtendedRearrangedSchema', mro, {})
 
-        view.schema = action_schema_class()
+        self._set_schema_to_view(view, action_schema_class())
         return view
 
     def _initialise_endpoints(self):
@@ -210,7 +212,7 @@ def parse(self, input_request, public):
             # than one view to prevent emission of erroneous and unnecessary fallback names.
             non_trivial_prefix = len(set([view.__class__ for _, _, _, view in endpoints])) > 1
             if non_trivial_prefix:
-                path_prefix = os.path.commonpath([path for path, _, _, _ in endpoints])
+                path_prefix = posixpath.commonpath([path for path, _, _, _ in endpoints])
                 path_prefix = re.escape(path_prefix)  # guard for RE special chars in path
             else:
                 path_prefix = '/'
@@ -291,3 +293,11 @@ def get_schema(self, request=None, public=False):
             result = hook(result=result, generator=self, request=request, public=public)
 
         return sanitize_result_object(normalize_result_object(result))
+
+    def _set_schema_to_view(self, view, schema):
+        # The 'schema' argument is used to store the schema and view instance in the global scope,
+        # as 'schema' is a descriptor. To facilitate garbage collection of these objects,
+        # we wrap the schema in a weak reference and store it within the SchemaGenerator instance to keep it alive.
+        # Thus, the lifetime of both the view and the schema is tied to the lifetime of the SchemaGenerator instance.
+        view.schema = weakref.proxy(schema)
+        self.schemas_storage.append(schema)

drf_spectacular/hooks.py

@@ -1,5 +1,6 @@
 import re
 from collections import defaultdict
+from collections.abc import MutableMapping
 
 from inflection import camelize
 from rest_framework.settings import api_settings
@@ -66,8 +67,8 @@ def extract_hash(schema):
     for component_name, props in iter_prop_containers(schemas):
         for prop_name, prop_schema in props.items():
             if prop_schema.get('type') == 'array':
-                prop_schema = prop_schema.get('items', {})
-            if 'enum' not in prop_schema:
+                prop_schema = prop_schema.get('items')
+            if not isinstance(prop_schema, MutableMapping) or 'enum' not in prop_schema:
                 continue
 
             prop_enum_cleaned_hash = extract_hash(prop_schema)
@@ -117,9 +118,9 @@ def extract_hash(schema):
         for prop_name, prop_schema in props.items():
             is_array = prop_schema.get('type') == 'array'
             if is_array:
-                prop_schema = prop_schema.get('items', {})
+                prop_schema = prop_schema.get('items')
 
-            if 'enum' not in prop_schema:
+            if not isinstance(prop_schema, MutableMapping) or 'enum' not in prop_schema:
                 continue
 
             prop_enum_original_list = prop_schema['enum']

drf_spectacular/openapi.py

@@ -689,6 +689,8 @@ def _map_serializer_field(self, field, direction, bypass_extensions=False):
             schema = self._map_serializer_field(field.child_relation, direction)
             # remove hand-over initkwargs applying only to outer scope
             schema.pop('readOnly', None)
+            # similarly from outer scope, default value is invalid inside 'items'
+            schema.pop('default', None)
             if meta.get('description') == schema.get('description'):
                 schema.pop('description', None)
             return append_meta(build_array_type(schema), meta)
@@ -713,7 +715,7 @@ def _map_serializer_field(self, field, direction, bypass_extensions=False):
                 if isinstance(field.parent, serializers.ManyRelatedField):
                     model = field.parent.parent.Meta.model
                     source = field.parent.source.split('.')
-                elif hasattr(field.parent, 'Meta'):
+                elif hasattr(field.parent, 'Meta') and hasattr(field.parent.Meta, 'model'):
                     model = field.parent.Meta.model
                     source = field.source.split('.')
                 else:
@@ -815,14 +817,14 @@ def _map_serializer_field(self, field, direction, bypass_extensions=False):
         if isinstance(field, serializers.DecimalField):
             if getattr(field, 'coerce_to_string', api_settings.COERCE_DECIMAL_TO_STRING):
                 content = {**build_basic_type(OpenApiTypes.STR), 'format': 'decimal'}
-                if field.max_whole_digits:
+                if field.max_whole_digits is not None:
                     content['pattern'] = (
-                        fr'^-?\d{{0,{field.max_whole_digits}}}'
-                        fr'(?:\.\d{{0,{field.decimal_places}}})?$'
+                        r'^-?0?' if field.max_whole_digits == 0 else fr'^-?\d{{0,{field.max_whole_digits}}}'
                     )
+                    content['pattern'] += fr'(?:\.\d{{0,{field.decimal_places}}})?$'
             else:
                 content = build_basic_type(OpenApiTypes.DECIMAL)
-                if field.max_whole_digits:
+                if field.max_whole_digits is not None:
                     value = 10 ** field.max_whole_digits
                     content.update({
                         'maximum': value,
@@ -1076,7 +1078,7 @@ def _map_basic_serializer(self, serializer, direction):
         return build_object_type(
             properties=properties,
             required=required,
-            description=get_doc(serializer.__class__),
+            description=get_override(serializer, 'description', get_doc(serializer.__class__)),
         )
 
     def _insert_field_validators(self, field, schema):

drf_spectacular/plumbing.py

@@ -200,6 +200,7 @@ def get_lib_doc_excludes():
     return [
         object,
         dict,
+        Generic,
         views.APIView,
         *[getattr(serializers, c) for c in dir(serializers) if c.endswith('Serializer')],
         *[getattr(viewsets, c) for c in dir(viewsets) if c.endswith('ViewSet')],
@@ -939,7 +940,7 @@ def _load_enum_name_overrides(language: str):
 
 
 def list_hash(lst: Any) -> str:
-    return hashlib.sha256(json.dumps(list(lst), sort_keys=True, cls=JSONEncoder).encode()).hexdigest()[:16]
+    return hashlib.sha256(json.dumps(sorted(lst), sort_keys=True, cls=JSONEncoder).encode()).hexdigest()[:16]
 
 
 def anchor_pattern(pattern: str) -> str: