Merge pull request #1026 from tfranzel/fix_exclude

bugfix exclude behavior on subclassing #1025

drf_spectacular/openapi.py

@@ -58,6 +58,9 @@ def get_operation(self, path, path_regex, path_prefix, method, registry: Compone
         self.path_prefix = path_prefix
         self.method = method.upper()
 
+        if self.is_excluded():
+            return None
+
         operation = {'operationId': self.get_operation_id()}
 
         description = self.get_description()
@@ -104,6 +107,10 @@ def get_operation(self, path, path_regex, path_prefix, method, registry: Compone
 
         return operation
 
+    def is_excluded(self):
+        """ override this for custom behaviour """
+        return False
+
     def _is_list_view(self, serializer=None):
         """
         partially heuristic approach to determine if a view yields an object or a

drf_spectacular/utils.py

@@ -325,7 +325,7 @@ def extend_schema(
         deprecated: Optional[bool] = None,
         tags: Optional[Sequence[str]] = None,
         filters: Optional[bool] = None,
-        exclude: bool = False,
+        exclude: Optional[bool] = None,
         operation: Optional[Dict] = None,
         methods: Optional[Sequence[str]] = None,
         versions: Optional[Sequence[str]] = None,
@@ -417,12 +417,15 @@ class ExtendedSchema(BaseSchema):
             def get_operation(self, path, path_regex, path_prefix, method, registry):
                 self.method = method.upper()
 
-                if exclude and is_in_scope(self):
-                    return None
                 if operation is not None and is_in_scope(self):
                     return operation
                 return super().get_operation(path, path_regex, path_prefix, method, registry)
 
+            def is_excluded(self):
+                if exclude is not None and is_in_scope(self):
+                    return exclude
+                return super().is_excluded()
+
             def get_operation_id(self):
                 if operation_id and is_in_scope(self):
                     return operation_id

tests/test_regressions.py

@@ -3159,3 +3159,27 @@ def view_func(request, format=None):
             'encoding': {'field': {'style': 'form', 'explode': True}}
         }
     }
+
+
+def test_exclude_then_include_subclassed_view(no_warnings):
+    @extend_schema(exclude=True)
+    class X1ViewSet(viewsets.ReadOnlyModelViewSet):
+        serializer_class = SimpleSerializer
+        queryset = SimpleModel.objects.none()
+
+    @extend_schema(exclude=False)
+    class X2ViewSet(X1ViewSet):
+        pass
+
+    class X3ViewSet(X2ViewSet):
+        pass
+
+    router = routers.SimpleRouter()
+    router.register('x1', X1ViewSet)
+    router.register('x2', X2ViewSet)
+    router.register('x3', X3ViewSet)
+
+    schema = generate_schema(None, patterns=router.urls)
+    assert '/x1/' not in schema['paths']
+    assert '/x2/' in schema['paths']
+    assert '/x3/' in schema['paths']