From 73f3e0a6b722fc77c4b8b04daf19542a188fbbf1 Mon Sep 17 00:00:00 2001 From: David Smith Date: Sat, 10 Oct 2020 18:20:48 +0100 Subject: [PATCH] Bumped removal to DRF315 --- rest_framework/__init__.py | 4 ++++ rest_framework/filters.py | 8 ++++---- rest_framework/pagination.py | 10 +++++----- rest_framework/schemas/coreapi.py | 10 +++++----- setup.cfg | 2 +- tests/schemas/test_coreapi.py | 24 ++++++++++++------------ 6 files changed, 31 insertions(+), 27 deletions(-) diff --git a/rest_framework/__init__.py b/rest_framework/__init__.py index 05d5adc46..ec44350eb 100644 --- a/rest_framework/__init__.py +++ b/rest_framework/__init__.py @@ -35,3 +35,7 @@ class RemovedInDRF313Warning(DeprecationWarning): class RemovedInDRF314Warning(PendingDeprecationWarning): pass + + +class RemovedInDRF315Warning(PendingDeprecationWarning): + pass diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 5f9975727..6fc6a502f 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -13,7 +13,7 @@ from django.template import loader from django.utils.encoding import force_str from django.utils.translation import gettext_lazy as _ -from rest_framework import RemovedInDRF314Warning +from rest_framework import RemovedInDRF315Warning from rest_framework.compat import coreapi, coreschema, distinct from rest_framework.settings import api_settings @@ -32,7 +32,7 @@ class BaseFilterBackend: 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.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`' return [] @@ -151,7 +151,7 @@ class SearchFilter(BaseFilterBackend): 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.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`' return [ coreapi.Field( @@ -303,7 +303,7 @@ class OrderingFilter(BaseFilterBackend): 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.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`' return [ coreapi.Field( diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 9ef17489e..0b09d12e5 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -13,7 +13,7 @@ from django.template import loader from django.utils.encoding import force_str from django.utils.translation import gettext_lazy as _ -from rest_framework import RemovedInDRF314Warning +from rest_framework import RemovedInDRF315Warning from rest_framework.compat import coreapi, coreschema from rest_framework.exceptions import NotFound from rest_framework.response import Response @@ -152,7 +152,7 @@ class BasePagination: 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.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) return [] def get_schema_operation_parameters(self, view): @@ -312,7 +312,7 @@ class PageNumberPagination(BasePagination): 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.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`' fields = [ coreapi.Field( @@ -532,7 +532,7 @@ class LimitOffsetPagination(BasePagination): 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.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`' return [ coreapi.Field( @@ -933,7 +933,7 @@ class CursorPagination(BasePagination): 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.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert coreschema is not None, 'coreschema must be installed to use `get_schema_fields()`' fields = [ coreapi.Field( diff --git a/rest_framework/schemas/coreapi.py b/rest_framework/schemas/coreapi.py index d916cad7c..d8c6e55bb 100644 --- a/rest_framework/schemas/coreapi.py +++ b/rest_framework/schemas/coreapi.py @@ -5,7 +5,7 @@ from urllib import parse from django.db import models from django.utils.encoding import force_str -from rest_framework import RemovedInDRF314Warning, exceptions, serializers +from rest_framework import RemovedInDRF315Warning, exceptions, serializers from rest_framework.compat import coreapi, coreschema, uritemplate from rest_framework.settings import api_settings @@ -119,7 +119,7 @@ class SchemaGenerator(BaseSchemaGenerator): def __init__(self, title=None, url=None, description=None, patterns=None, urlconf=None, version=None): assert coreapi, '`coreapi` must be installed for schema support.' if coreapi is not None: - warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert coreschema, '`coreschema` must be installed for schema support.' super(SchemaGenerator, self).__init__(title, url, description, patterns, urlconf) @@ -350,7 +350,7 @@ class AutoSchema(ViewInspector): """ super(AutoSchema, self).__init__() if coreapi is not None: - warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) if manual_fields is None: manual_fields = [] self._manual_fields = manual_fields @@ -593,7 +593,7 @@ class ManualSchema(ViewInspector): """ super(ManualSchema, self).__init__() if coreapi is not None: - warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) assert all(isinstance(f, coreapi.Field) for f in fields), "`fields` must be a list of coreapi.Field instances" self._fields = fields self._description = description @@ -616,5 +616,5 @@ class ManualSchema(ViewInspector): def is_enabled(): """Is CoreAPI Mode enabled?""" if coreapi is not None: - warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.14', RemovedInDRF314Warning) + warnings.warn('CoreAPI compatibility is deprecated and will be removed in DRF 3.15', RemovedInDRF315Warning) return issubclass(api_settings.DEFAULT_SCHEMA_CLASS, AutoSchema) diff --git a/setup.cfg b/setup.cfg index a7f0ce83d..94d72969a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,7 +4,7 @@ license_file = LICENSE.md [tool:pytest] addopts=--tb=short --strict -ra testspath = tests -filterwarnings = ignore:CoreAPI compatibility is deprecated*:rest_framework.RemovedInDRF314Warning +filterwarnings = ignore:CoreAPI compatibility is deprecated*:rest_framework.RemovedInDRF315Warning [flake8] ignore = E501,W504 diff --git a/tests/schemas/test_coreapi.py b/tests/schemas/test_coreapi.py index fe4004b72..696f0677f 100644 --- a/tests/schemas/test_coreapi.py +++ b/tests/schemas/test_coreapi.py @@ -7,7 +7,7 @@ from django.test import TestCase, override_settings from django.urls import include, path from rest_framework import ( - RemovedInDRF314Warning, filters, generics, pagination, permissions, + RemovedInDRF315Warning, filters, generics, pagination, permissions, serializers ) from rest_framework.compat import coreapi, coreschema @@ -1384,42 +1384,42 @@ def test_schema_handles_exception(): @pytest.mark.skipif(not coreapi, reason='coreapi is not installed') def test_coreapi_deprecation(): - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): SchemaGenerator() - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): AutoSchema() - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): ManualSchema({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): deprecated_filter = OrderingFilter() deprecated_filter.get_schema_fields({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): deprecated_filter = BaseFilterBackend() deprecated_filter.get_schema_fields({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): deprecated_filter = SearchFilter() deprecated_filter.get_schema_fields({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): paginator = BasePagination() paginator.get_schema_fields({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): paginator = PageNumberPagination() paginator.get_schema_fields({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): paginator = LimitOffsetPagination() paginator.get_schema_fields({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): paginator = CursorPagination() paginator.get_schema_fields({}) - with pytest.warns(RemovedInDRF314Warning): + with pytest.warns(RemovedInDRF315Warning): is_enabled()