Remove support for CoreAPI

Author: browniebroke

pyproject.toml

@@ -62,8 +62,6 @@ docs = [
 ]
 optional = [
   # Optional packages which may be used with REST framework.
-  "coreapi==2.3.3",
-  "coreschema==0.0.4",
   "django-filter",
   "django-guardian>=2.4.0,<3.3",
   "inflection==0.5.1",
@@ -72,8 +70,6 @@ optional = [
   "psycopg[binary]>=3.1.8",
   "pygments>=2.17,<2.20",
   "pyyaml>=5.3.1,<6.1",
-  # setuptools is needed for coreapi (imports pkg_resources)
-  "setuptools<82",
 ]
 django42 = [ "django>=4.2,<5.0" ]
 django50 = [ "django>=5.0,<5.1" ]
@@ -119,7 +115,6 @@ keep_full_version = true
 addopts = "--tb=short --strict-markers -ra"
 testpaths = [ "tests" ]
 filterwarnings = [
-  "ignore:CoreAPI compatibility is deprecated*:rest_framework.RemovedInDRF318Warning",
   "ignore:'cgi' is deprecated:DeprecationWarning",
 ]
 

rest_framework/__init__.py

@@ -22,7 +22,3 @@
 # Default datetime input and output formats
 ISO_8601 = 'iso-8601'
 DJANGO_DURATION_FORMAT = 'django'
-
-
-class RemovedInDRF318Warning(DeprecationWarning):
-    pass

rest_framework/authtoken/views.py

@@ -1,10 +1,7 @@
 from rest_framework import parsers, renderers
 from rest_framework.authtoken.models import Token
 from rest_framework.authtoken.serializers import AuthTokenSerializer
-from rest_framework.compat import coreapi, coreschema
 from rest_framework.response import Response
-from rest_framework.schemas import ManualSchema
-from rest_framework.schemas import coreapi as coreapi_schema
 from rest_framework.views import APIView
 
 
@@ -15,31 +12,6 @@ class ObtainAuthToken(APIView):
     renderer_classes = (renderers.JSONRenderer,)
     serializer_class = AuthTokenSerializer
 
-    if coreapi_schema.is_enabled():
-        schema = ManualSchema(
-            fields=[
-                coreapi.Field(
-                    name="username",
-                    required=True,
-                    location='form',
-                    schema=coreschema.String(
-                        title="Username",
-                        description="Valid username for authentication",
-                    ),
-                ),
-                coreapi.Field(
-                    name="password",
-                    required=True,
-                    location='form',
-                    schema=coreschema.String(
-                        title="Password",
-                        description="Valid password for authentication",
-                    ),
-                ),
-            ],
-            encoding="application/json",
-        )
-
     def get_serializer_context(self):
         return {
             'request': self.request,

rest_framework/compat.py

@@ -23,26 +23,13 @@ def unicode_http_header(value):
     postgres_fields = None
 
 
-# coreapi is required for CoreAPI schema generation
-try:
-    import coreapi
-except ImportError:
-    coreapi = None
-
-# uritemplate is required for OpenAPI and CoreAPI schema generation
+# uritemplate is required for OpenAPI schema generation
 try:
     import uritemplate
 except ImportError:
     uritemplate = None
 
 
-# coreschema is optional
-try:
-    import coreschema
-except ImportError:
-    coreschema = None
-
-
 # pyyaml is optional
 try:
     import yaml

rest_framework/documentation.py

@@ -3,7 +3,6 @@
 returned by list views.
 """
 import operator
-import warnings
 from functools import reduce
 
 from django.core.exceptions import FieldDoesNotExist, ImproperlyConfigured
@@ -14,8 +13,6 @@
 from django.utils.text import smart_split, unescape_string_literal
 from django.utils.translation import gettext_lazy as _
 
-from rest_framework import RemovedInDRF318Warning
-from rest_framework.compat import coreapi, coreschema
 from rest_framework.fields import CharField
 from rest_framework.settings import api_settings
 
@@ -48,13 +45,6 @@ def filter_queryset(self, request, queryset, view):
         """
         raise NotImplementedError(".filter_queryset() must be overridden.")
 
-    def get_schema_fields(self, view):
-        assert coreapi is not None, 'coreapi must be installed to use `get_schema_fields()`'
-        if coreapi is not None:
-            warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.18', RemovedInDRF318Warning)
-        assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`'
-        return []
-
     def get_schema_operation_parameters(self, view):
         return []
 
@@ -186,23 +176,6 @@ def to_html(self, request, queryset, view):
         template = loader.get_template(self.template)
         return template.render(context)
 
-    def get_schema_fields(self, view):
-        assert coreapi is not None, 'coreapi must be installed to use `get_schema_fields()`'
-        if coreapi is not None:
-            warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.18', RemovedInDRF318Warning)
-        assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`'
-        return [
-            coreapi.Field(
-                name=self.search_param,
-                required=False,
-                location='query',
-                schema=coreschema.String(
-                    title=force_str(self.search_title),
-                    description=force_str(self.search_description)
-                )
-            )
-        ]
-
     def get_schema_operation_parameters(self, view):
         return [
             {
@@ -352,23 +325,6 @@ def to_html(self, request, queryset, view):
         context = self.get_template_context(request, queryset, view)
         return template.render(context)
 
-    def get_schema_fields(self, view):
-        assert coreapi is not None, 'coreapi must be installed to use `get_schema_fields()`'
-        if coreapi is not None:
-            warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.18', RemovedInDRF318Warning)
-        assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`'
-        return [
-            coreapi.Field(
-                name=self.ordering_param,
-                required=False,
-                location='query',
-                schema=coreschema.String(
-                    title=force_str(self.ordering_title),
-                    description=force_str(self.ordering_description)
-                )
-            )
-        ]
-
     def get_schema_operation_parameters(self, view):
         return [
             {

rest_framework/filters.py

@@ -2,27 +2,17 @@
 from django.utils.module_loading import import_string
 
 from rest_framework import renderers
-from rest_framework.schemas import coreapi
 from rest_framework.schemas.openapi import SchemaGenerator
 
-OPENAPI_MODE = 'openapi'
-COREAPI_MODE = 'coreapi'
-
 
 class Command(BaseCommand):
     help = "Generates configured API schema for project."
 
-    def get_mode(self):
-        return COREAPI_MODE if coreapi.is_enabled() else OPENAPI_MODE
-
     def add_arguments(self, parser):
         parser.add_argument('--title', dest="title", default='', type=str)
         parser.add_argument('--url', dest="url", default=None, type=str)
         parser.add_argument('--description', dest="description", default=None, type=str)
-        if self.get_mode() == COREAPI_MODE:
-            parser.add_argument('--format', dest="format", choices=['openapi', 'openapi-json', 'corejson'], default='openapi', type=str)
-        else:
-            parser.add_argument('--format', dest="format", choices=['openapi', 'openapi-json'], default='openapi', type=str)
+        parser.add_argument('--format', dest="format", choices=['openapi', 'openapi-json'], default='openapi', type=str)
         parser.add_argument('--urlconf', dest="urlconf", default=None, type=str)
         parser.add_argument('--generator_class', dest="generator_class", default=None, type=str)
         parser.add_argument('--file', dest="file", default=None, type=str)
@@ -32,7 +22,7 @@ def handle(self, *args, **options):
         if options['generator_class']:
             generator_class = import_string(options['generator_class'])
         else:
-            generator_class = self.get_generator_class()
+            generator_class = SchemaGenerator
         generator = generator_class(
             url=options['url'],
             title=options['title'],
@@ -51,21 +41,8 @@ def handle(self, *args, **options):
             self.stdout.write(output.decode())
 
     def get_renderer(self, format):
-        if self.get_mode() == COREAPI_MODE:
-            renderer_cls = {
-                'corejson': renderers.CoreJSONRenderer,
-                'openapi': renderers.CoreAPIOpenAPIRenderer,
-                'openapi-json': renderers.CoreAPIJSONOpenAPIRenderer,
-            }[format]
-            return renderer_cls()
-
         renderer_cls = {
             'openapi': renderers.OpenAPIRenderer,
             'openapi-json': renderers.JSONOpenAPIRenderer,
         }[format]
         return renderer_cls()
-
-    def get_generator_class(self):
-        if self.get_mode() == COREAPI_MODE:
-            return coreapi.SchemaGenerator
-        return SchemaGenerator