+
+ 
@@ -67,15 +67,17 @@ continued development by **[signing up for a paid plan][funding]**.
-*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), [Lights On Software](https://lightsonsoftware.com), [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship), and [bit.io](https://bit.io/jobs?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship).*
+*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=sponsorship&utm_content=developer), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), [Lights On Software](https://lightsonsoftware.com), [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship), [bit.io](https://bit.io/jobs?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), [PostHog](https://posthog.com?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), and [CryptAPI](https://cryptapi.io).*
---
@@ -83,8 +85,8 @@ continued development by **[signing up for a paid plan][funding]**.
REST framework requires the following:
-* Python (3.5, 3.6, 3.7, 3.8, 3.9)
-* Django (2.2, 3.0, 3.1)
+* Python (3.6, 3.7, 3.8, 3.9, 3.10)
+* Django (2.2, 3.0, 3.1, 3.2, 4.0)
We **highly recommend** and only officially support the latest patch release of
each Python and Django series.
@@ -186,15 +188,10 @@ Framework.
## Support
-For support please see the [REST framework discussion group][group], try the `#restframework` channel on `irc.freenode.net`, search [the IRC archives][botbot], or raise a question on [Stack Overflow][stack-overflow], making sure to include the ['django-rest-framework'][django-rest-framework-tag] tag.
+For support please see the [REST framework discussion group][group], try the `#restframework` channel on `irc.libera.chat`, or raise a question on [Stack Overflow][stack-overflow], making sure to include the ['django-rest-framework'][django-rest-framework-tag] tag.
For priority support please sign up for a [professional or premium sponsorship plan](https://fund.django-rest-framework.org/topics/funding/).
-For updates on REST framework development, you may also want to follow [the author][twitter] on Twitter.
-
-Follow @_tomchristie
-
-
## Security
If you believe you’ve found something in Django REST framework which has security implications, please **do not raise the issue in a public forum**.
@@ -262,7 +259,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[funding]: community/funding.md
[group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
-[botbot]: https://botbot.me/freenode/restframework/
[stack-overflow]: https://stackoverflow.com/
[django-rest-framework-tag]: https://stackoverflow.com/questions/tagged/django-rest-framework
[security-mail]: mailto:rest-framework-security@googlegroups.com
diff --git a/docs/topics/ajax-csrf-cors.md b/docs/topics/ajax-csrf-cors.md
index 646f3f5638..a65e3fdf8d 100644
--- a/docs/topics/ajax-csrf-cors.md
+++ b/docs/topics/ajax-csrf-cors.md
@@ -31,11 +31,11 @@ In order to make AJAX requests, you need to include CSRF token in the HTTP heade
The best way to deal with CORS in REST framework is to add the required response headers in middleware. This ensures that CORS is supported transparently, without having to change any behavior in your views.
-[Otto Yiu][ottoyiu] maintains the [django-cors-headers] package, which is known to work correctly with REST framework APIs.
+[Adam Johnson][adamchainz] maintains the [django-cors-headers] package, which is known to work correctly with REST framework APIs.
[cite]: https://blog.codinghorror.com/preventing-csrf-and-xsrf-attacks/
[csrf]: https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)
[csrf-ajax]: https://docs.djangoproject.com/en/stable/ref/csrf/#ajax
[cors]: https://www.w3.org/TR/cors/
-[ottoyiu]: https://github.com/ottoyiu/
-[django-cors-headers]: https://github.com/ottoyiu/django-cors-headers/
+[adamchainz]: https://github.com/adamchainz
+[django-cors-headers]: https://github.com/adamchainz/django-cors-headers
diff --git a/docs/topics/api-clients.md b/docs/topics/api-clients.md
index 9b61eaf427..b9f5e3ecd8 100644
--- a/docs/topics/api-clients.md
+++ b/docs/topics/api-clients.md
@@ -453,7 +453,7 @@ For example, using the "Django REST framework JWT" package
function loginUser(username, password) {
let action = ["api-token-auth", "obtain-token"];
- let params = {username: "example", email: "example@example.com"};
+ let params = {username: username, password: password};
client.action(schema, action, params).then(function(result) {
// On success, instantiate an authenticated client.
let auth = window.coreapi.auth.TokenAuthentication({
diff --git a/docs/topics/documenting-your-api.md b/docs/topics/documenting-your-api.md
index cd7e5098fe..5eabeee7bb 100644
--- a/docs/topics/documenting-your-api.md
+++ b/docs/topics/documenting-your-api.md
@@ -202,7 +202,7 @@ You can modify the response behavior to `OPTIONS` requests by overriding the `op
meta = self.metadata_class()
data = meta.determine_metadata(request, self)
data.pop('description')
- return data
+ return Response(data=data, status=status.HTTP_200_OK)
See [the Metadata docs][metadata-docs] for more details.
diff --git a/docs/topics/internationalization.md b/docs/topics/internationalization.md
index 7cfc6e247c..c20cf9e339 100644
--- a/docs/topics/internationalization.md
+++ b/docs/topics/internationalization.md
@@ -103,10 +103,10 @@ You can find more information on how the language preference is determined in th
For API clients the most appropriate of these will typically be to use the `Accept-Language` header; Sessions and cookies will not be available unless using session authentication, and generally better practice to prefer an `Accept-Language` header for API clients rather than using language URL prefixes.
[cite]: https://youtu.be/Wa0VfS2q94Y
-[django-translation]: https://docs.djangoproject.com/en/1.7/topics/i18n/translation
+[django-translation]: https://docs.djangoproject.com/en/stable/topics/i18n/translation
[custom-exception-handler]: ../api-guide/exceptions.md#custom-exception-handling
[transifex-project]: https://www.transifex.com/projects/p/django-rest-framework/
[django-po-source]: https://raw.githubusercontent.com/encode/django-rest-framework/master/rest_framework/locale/en_US/LC_MESSAGES/django.po
-[django-language-preference]: https://docs.djangoproject.com/en/1.7/topics/i18n/translation/#how-django-discovers-language-preference
-[django-locale-paths]: https://docs.djangoproject.com/en/1.7/ref/settings/#std:setting-LOCALE_PATHS
-[django-locale-name]: https://docs.djangoproject.com/en/1.7/topics/i18n/#term-locale-name
+[django-language-preference]: https://docs.djangoproject.com/en/stable/topics/i18n/translation/#how-django-discovers-language-preference
+[django-locale-paths]: https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-LOCALE_PATHS
+[django-locale-name]: https://docs.djangoproject.com/en/stable/topics/i18n/#term-locale-name
diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md
index 85d8676b1d..908b7474a0 100644
--- a/docs/tutorial/1-serialization.md
+++ b/docs/tutorial/1-serialization.md
@@ -374,5 +374,5 @@ We'll see how we can start to improve things in [part 2 of the tutorial][tut-2].
[sandbox]: https://restframework.herokuapp.com/
[venv]: https://docs.python.org/3/library/venv.html
[tut-2]: 2-requests-and-responses.md
-[httpie]: https://github.com/jakubroztocil/httpie#installation
+[httpie]: https://github.com/httpie/httpie#installation
[curl]: https://curl.haxx.se/
diff --git a/docs/tutorial/4-authentication-and-permissions.md b/docs/tutorial/4-authentication-and-permissions.md
index 79ce355c93..cb0321ea21 100644
--- a/docs/tutorial/4-authentication-and-permissions.md
+++ b/docs/tutorial/4-authentication-and-permissions.md
@@ -38,7 +38,7 @@ And now we can add a `.save()` method to our model class:
formatter = HtmlFormatter(style=self.style, linenos=linenos,
full=True, **options)
self.highlighted = highlight(self.code, lexer, formatter)
- super(Snippet, self).save(*args, **kwargs)
+ super().save(*args, **kwargs)
When that's all done we'll need to update our database tables.
Normally we'd create a database migration in order to do that, but for the purposes of this tutorial, let's just delete the database and start again.
diff --git a/docs/tutorial/5-relationships-and-hyperlinked-apis.md b/docs/tutorial/5-relationships-and-hyperlinked-apis.md
index 4cd4e9bbd5..f999fdf507 100644
--- a/docs/tutorial/5-relationships-and-hyperlinked-apis.md
+++ b/docs/tutorial/5-relationships-and-hyperlinked-apis.md
@@ -31,7 +31,6 @@ The other thing we need to consider when creating the code highlight view is tha
Instead of using a concrete generic view, we'll use the base class for representing instances, and create our own `.get()` method. In your `snippets/views.py` add:
from rest_framework import renderers
- from rest_framework.response import Response
class SnippetHighlight(generics.GenericAPIView):
queryset = Snippet.objects.all()
@@ -143,7 +142,7 @@ We can change the default list style to use pagination, by modifying our `tutori
Note that settings in REST framework are all namespaced into a single dictionary setting, named `REST_FRAMEWORK`, which helps keep them well separated from your other project settings.
-We could also customize the pagination style if we needed too, but in this case we'll just stick with the default.
+We could also customize the pagination style if we needed to, but in this case we'll just stick with the default.
## Browsing the API
diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index ee839790f1..f4dcc5606c 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -225,4 +225,4 @@ If you want to get a more in depth understanding of how REST framework fits toge
[image]: ../img/quickstart.png
[tutorial]: 1-serialization.md
[guide]: ../api-guide/requests.md
-[httpie]: https://github.com/jakubroztocil/httpie#installation
+[httpie]: https://httpie.io/docs#installation
diff --git a/docs_theme/css/default.css b/docs_theme/css/default.css
index 992bc60a42..7006f2a668 100644
--- a/docs_theme/css/default.css
+++ b/docs_theme/css/default.css
@@ -37,7 +37,7 @@ body.index-page #main-content iframe.github-star-button {
margin-right: -15px;
}
-/* Travis CI and PyPI badge */
+/* CI and PyPI badge */
body.index-page #main-content img.status-badge {
float: right;
margin-right: 8px;
diff --git a/mkdocs.yml b/mkdocs.yml
index 573898bca0..439245a8d2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -66,6 +66,7 @@ nav:
- 'Contributing to REST framework': 'community/contributing.md'
- 'Project management': 'community/project-management.md'
- 'Release Notes': 'community/release-notes.md'
+ - '3.13 Announcement': 'community/3.13-announcement.md'
- '3.12 Announcement': 'community/3.12-announcement.md'
- '3.11 Announcement': 'community/3.11-announcement.md'
- '3.10 Announcement': 'community/3.10-announcement.md'
diff --git a/requirements.txt b/requirements.txt
index b4e5ff5797..395f3b7a86 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -9,5 +9,4 @@
-r requirements/requirements-optionals.txt
-r requirements/requirements-testing.txt
-r requirements/requirements-documentation.txt
--r requirements/requirements-codestyle.txt
-r requirements/requirements-packaging.txt
diff --git a/requirements/requirements-codestyle.txt b/requirements/requirements-codestyle.txt
deleted file mode 100644
index 4f54d6e778..0000000000
--- a/requirements/requirements-codestyle.txt
+++ /dev/null
@@ -1,7 +0,0 @@
-# PEP8 code linting, which we run on all commits.
-flake8==3.8.3
-flake8-tidy-imports==4.1.0
-pycodestyle==2.6.0
-
-# Sort and lint imports
-isort==5.4.2
diff --git a/requirements/requirements-documentation.txt b/requirements/requirements-documentation.txt
index e969ff471b..ad49287304 100644
--- a/requirements/requirements-documentation.txt
+++ b/requirements/requirements-documentation.txt
@@ -1,2 +1,2 @@
# MkDocs to build our documentation.
-mkdocs==1.1
+mkdocs>=1.1.2,<1.2
diff --git a/requirements/requirements-optionals.txt b/requirements/requirements-optionals.txt
index 2b7a18a13f..75b9ab4d60 100644
--- a/requirements/requirements-optionals.txt
+++ b/requirements/requirements-optionals.txt
@@ -1,9 +1,10 @@
# Optional packages which may be used with REST framework.
-psycopg2-binary>=2.8.5, <2.9
-markdown==3.1.1
-pygments==2.4.2
-django-guardian==2.2.0
-django-filter>=2.2.0, <2.3
coreapi==2.3.1
coreschema==0.0.4
-pyyaml>=5.1
+django-filter>=2.4.0,<3.0
+django-guardian>=2.4.0,<2.5
+markdown==3.3;python_version>="3.6"
+markdown==3.2.2;python_version=="3.5"
+psycopg2-binary>=2.8.5,<2.9
+pygments>=2.7.1,<2.8
+pyyaml>=5.3.1,<5.4
diff --git a/requirements/requirements-packaging.txt b/requirements/requirements-packaging.txt
index 091622fbeb..fae03baab5 100644
--- a/requirements/requirements-packaging.txt
+++ b/requirements/requirements-packaging.txt
@@ -1,8 +1,8 @@
# Wheel for PyPI installs.
-wheel==0.34.2
+wheel>=0.35.1,<0.36
# Twine for secured PyPI uploads.
-twine==3.1.1
+twine>=3.2.0,<3.3
# Transifex client for managing translation resources.
-transifex-client==0.13.9
+transifex-client>=0.13.12,<0.14
diff --git a/requirements/requirements-testing.txt b/requirements/requirements-testing.txt
index ad246e8570..313fdedc9b 100644
--- a/requirements/requirements-testing.txt
+++ b/requirements/requirements-testing.txt
@@ -1,4 +1,4 @@
# Pytest for running the tests.
-pytest>=5.4.1,<5.5
-pytest-django>=3.9.0,<3.10
-pytest-cov>=2.7.1
+pytest>=6.1,<7.0
+pytest-cov>=2.10.1,<3.0
+pytest-django>=4.1.0,<5.0
diff --git a/rest_framework/__init__.py b/rest_framework/__init__.py
index 7ff188a5ad..88d86c03e5 100644
--- a/rest_framework/__init__.py
+++ b/rest_framework/__init__.py
@@ -10,7 +10,7 @@
import django
__title__ = 'Django REST framework'
-__version__ = '3.12.2'
+__version__ = '3.13.0'
__author__ = 'Tom Christie'
__license__ = 'BSD 3-Clause'
__copyright__ = 'Copyright 2011-2019 Encode OSS Ltd'
diff --git a/rest_framework/authentication.py b/rest_framework/authentication.py
index 9111007c09..382abf1580 100644
--- a/rest_framework/authentication.py
+++ b/rest_framework/authentication.py
@@ -227,6 +227,6 @@ class RemoteUserAuthentication(BaseAuthentication):
header = "REMOTE_USER"
def authenticate(self, request):
- user = authenticate(remote_user=request.META.get(self.header))
+ user = authenticate(request=request, remote_user=request.META.get(self.header))
if user and user.is_active:
return (user, None)
diff --git a/rest_framework/authtoken/models.py b/rest_framework/authtoken/models.py
index 540049295d..5a143d936c 100644
--- a/rest_framework/authtoken/models.py
+++ b/rest_framework/authtoken/models.py
@@ -46,7 +46,7 @@ class TokenProxy(Token):
"""
@property
def pk(self):
- return self.user.pk
+ return self.user_id
class Meta:
proxy = 'rest_framework.authtoken' in settings.INSTALLED_APPS
diff --git a/rest_framework/decorators.py b/rest_framework/decorators.py
index 30b9d84d4e..7ba43d37c8 100644
--- a/rest_framework/decorators.py
+++ b/rest_framework/decorators.py
@@ -7,6 +7,7 @@
methods on viewsets that should be included by routers.
"""
import types
+from functools import update_wrapper
from django.forms.utils import pretty_name
@@ -22,18 +23,8 @@ def api_view(http_method_names=None):
def decorator(func):
- WrappedAPIView = type(
- 'WrappedAPIView',
- (APIView,),
- {'__doc__': func.__doc__}
- )
-
- # Note, the above allows us to set the docstring.
- # It is the equivalent of:
- #
- # class WrappedAPIView(APIView):
- # pass
- # WrappedAPIView.__doc__ = func.doc <--- Not possible to do this
+ class WrappedAPIView(APIView):
+ pass
# api_view applied without (method_names)
assert not(isinstance(http_method_names, types.FunctionType)), \
@@ -52,9 +43,6 @@ def handler(self, *args, **kwargs):
for method in http_method_names:
setattr(WrappedAPIView, method.lower(), handler)
- WrappedAPIView.__name__ = func.__name__
- WrappedAPIView.__module__ = func.__module__
-
WrappedAPIView.renderer_classes = getattr(func, 'renderer_classes',
APIView.renderer_classes)
@@ -73,7 +61,7 @@ def handler(self, *args, **kwargs):
WrappedAPIView.schema = getattr(func, 'schema',
APIView.schema)
- return WrappedAPIView.as_view()
+ return update_wrapper(WrappedAPIView.as_view(), func)
return decorator
diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py
index 943dcc88c3..fee8f024f2 100644
--- a/rest_framework/exceptions.py
+++ b/rest_framework/exceptions.py
@@ -20,7 +20,7 @@ def _get_error_details(data, default_code=None):
Descend into a nested data structure, forcing any
lazy translation strings or strings into `ErrorDetail`.
"""
- if isinstance(data, list):
+ if isinstance(data, (list, tuple)):
ret = [
_get_error_details(item, default_code) for item in data
]
@@ -150,7 +150,9 @@ def __init__(self, detail=None, code=None):
# For validation failures, we may collect many errors together,
# so the details should always be coerced to a list if not already.
- if not isinstance(detail, dict) and not isinstance(detail, list):
+ if isinstance(detail, tuple):
+ detail = list(detail)
+ elif not isinstance(detail, dict) and not isinstance(detail, list):
detail = [detail]
self.detail = _get_error_details(detail, code)
diff --git a/rest_framework/fields.py b/rest_framework/fields.py
index fdfba13f26..d7e7816cee 100644
--- a/rest_framework/fields.py
+++ b/rest_framework/fields.py
@@ -320,7 +320,7 @@ class Field:
default_empty_html = empty
initial = None
- def __init__(self, read_only=False, write_only=False,
+ def __init__(self, *, read_only=False, write_only=False,
required=None, default=empty, initial=empty, source=None,
label=None, help_text=None, style=None,
error_messages=None, validators=None, allow_null=False):
@@ -704,7 +704,7 @@ class BooleanField(Field):
initial = False
TRUE_VALUES = {
't', 'T',
- 'y', 'Y', 'yes', 'YES',
+ 'y', 'Y', 'yes', 'Yes', 'YES',
'true', 'True', 'TRUE',
'on', 'On', 'ON',
'1', 1,
@@ -712,7 +712,7 @@ class BooleanField(Field):
}
FALSE_VALUES = {
'f', 'F',
- 'n', 'N', 'no', 'NO',
+ 'n', 'N', 'no', 'No', 'NO',
'false', 'False', 'FALSE',
'off', 'Off', 'OFF',
'0', 0, 0.0,
@@ -1046,6 +1046,11 @@ def __init__(self, max_digits, decimal_places, coerce_to_string=None, max_value=
'Invalid rounding option %s. Valid values for rounding are: %s' % (rounding, valid_roundings))
self.rounding = rounding
+ def validate_empty_values(self, data):
+ if smart_str(data).strip() == '' and self.allow_null:
+ return (True, None)
+ return super().validate_empty_values(data)
+
def to_internal_value(self, data):
"""
Validate that the input is a decimal number and return a Decimal
@@ -1112,6 +1117,12 @@ def validate_precision(self, value):
def to_representation(self, value):
coerce_to_string = getattr(self, 'coerce_to_string', api_settings.COERCE_DECIMAL_TO_STRING)
+ if value is None:
+ if coerce_to_string:
+ return ''
+ else:
+ return None
+
if not isinstance(value, decimal.Decimal):
value = decimal.Decimal(str(value).strip())
@@ -1152,14 +1163,14 @@ class DateTimeField(Field):
}
datetime_parser = datetime.datetime.strptime
- def __init__(self, format=empty, input_formats=None, default_timezone=None, *args, **kwargs):
+ def __init__(self, format=empty, input_formats=None, default_timezone=None, **kwargs):
if format is not empty:
self.format = format
if input_formats is not None:
self.input_formats = input_formats
if default_timezone is not None:
self.timezone = default_timezone
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
def enforce_timezone(self, value):
"""
@@ -1238,12 +1249,12 @@ class DateField(Field):
}
datetime_parser = datetime.datetime.strptime
- def __init__(self, format=empty, input_formats=None, *args, **kwargs):
+ def __init__(self, format=empty, input_formats=None, **kwargs):
if format is not empty:
self.format = format
if input_formats is not None:
self.input_formats = input_formats
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
def to_internal_value(self, value):
input_formats = getattr(self, 'input_formats', api_settings.DATE_INPUT_FORMATS)
@@ -1304,12 +1315,12 @@ class TimeField(Field):
}
datetime_parser = datetime.datetime.strptime
- def __init__(self, format=empty, input_formats=None, *args, **kwargs):
+ def __init__(self, format=empty, input_formats=None, **kwargs):
if format is not empty:
self.format = format
if input_formats is not None:
self.input_formats = input_formats
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
def to_internal_value(self, value):
input_formats = getattr(self, 'input_formats', api_settings.TIME_INPUT_FORMATS)
@@ -1459,9 +1470,9 @@ class MultipleChoiceField(ChoiceField):
}
default_empty_html = []
- def __init__(self, *args, **kwargs):
+ def __init__(self, **kwargs):
self.allow_empty = kwargs.pop('allow_empty', True)
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
def get_value(self, dictionary):
if self.field_name not in dictionary:
@@ -1480,6 +1491,8 @@ def to_internal_value(self, data):
self.fail('empty')
return {
+ # Arguments for super() are needed because of scoping inside
+ # comprehensions.
super(MultipleChoiceField, self).to_internal_value(item)
for item in data
}
@@ -1518,12 +1531,12 @@ class FileField(Field):
'max_length': _('Ensure this filename has at most {max_length} characters (it has {length}).'),
}
- def __init__(self, *args, **kwargs):
+ def __init__(self, **kwargs):
self.max_length = kwargs.pop('max_length', None)
self.allow_empty_file = kwargs.pop('allow_empty_file', False)
if 'use_url' in kwargs:
self.use_url = kwargs.pop('use_url')
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
def to_internal_value(self, data):
try:
@@ -1567,9 +1580,9 @@ class ImageField(FileField):
),
}
- def __init__(self, *args, **kwargs):
+ def __init__(self, **kwargs):
self._DjangoImageField = kwargs.pop('_DjangoImageField', DjangoImageField)
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
def to_internal_value(self, data):
# Image validation is a bit grungy, so we'll just outright
@@ -1584,8 +1597,8 @@ def to_internal_value(self, data):
# Composite field types...
class _UnvalidatedField(Field):
- def __init__(self, *args, **kwargs):
- super().__init__(*args, **kwargs)
+ def __init__(self, **kwargs):
+ super().__init__(**kwargs)
self.allow_blank = True
self.allow_null = True
@@ -1606,7 +1619,7 @@ class ListField(Field):
'max_length': _('Ensure this field has no more than {max_length} elements.')
}
- def __init__(self, *args, **kwargs):
+ def __init__(self, **kwargs):
self.child = kwargs.pop('child', copy.deepcopy(self.child))
self.allow_empty = kwargs.pop('allow_empty', True)
self.max_length = kwargs.pop('max_length', None)
@@ -1618,7 +1631,7 @@ def __init__(self, *args, **kwargs):
"Remove `source=` from the field declaration."
)
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
self.child.bind(field_name='', parent=self)
if self.max_length is not None:
message = lazy_format(self.error_messages['max_length'], max_length=self.max_length)
@@ -1683,7 +1696,7 @@ class DictField(Field):
'empty': _('This dictionary may not be empty.'),
}
- def __init__(self, *args, **kwargs):
+ def __init__(self, **kwargs):
self.child = kwargs.pop('child', copy.deepcopy(self.child))
self.allow_empty = kwargs.pop('allow_empty', True)
@@ -1693,7 +1706,7 @@ def __init__(self, *args, **kwargs):
"Remove `source=` from the field declaration."
)
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
self.child.bind(field_name='', parent=self)
def get_value(self, dictionary):
@@ -1742,8 +1755,8 @@ def run_child_validation(self, data):
class HStoreField(DictField):
child = CharField(allow_blank=True, allow_null=True)
- def __init__(self, *args, **kwargs):
- super().__init__(*args, **kwargs)
+ def __init__(self, **kwargs):
+ super().__init__(**kwargs)
assert isinstance(self.child, CharField), (
"The `child` argument must be an instance of `CharField`, "
"as the hstore extension stores values as strings."
@@ -1755,11 +1768,14 @@ class JSONField(Field):
'invalid': _('Value must be valid JSON.')
}
- def __init__(self, *args, **kwargs):
+ # Workaround for isinstance calls when importing the field isn't possible
+ _is_jsonfield = True
+
+ def __init__(self, **kwargs):
self.binary = kwargs.pop('binary', False)
self.encoder = kwargs.pop('encoder', None)
self.decoder = kwargs.pop('decoder', None)
- super().__init__(*args, **kwargs)
+ super().__init__(**kwargs)
def get_value(self, dictionary):
if html.is_html_input(dictionary) and self.field_name in dictionary:
diff --git a/rest_framework/filters.py b/rest_framework/filters.py
index 3665775195..1ffd9edc02 100644
--- a/rest_framework/filters.py
+++ b/rest_framework/filters.py
@@ -226,10 +226,20 @@ def get_default_valid_fields(self, queryset, view, context={}):
)
raise ImproperlyConfigured(msg % self.__class__.__name__)
+ model_class = queryset.model
+ model_property_names = [
+ # 'pk' is a property added in Django's Model class, however it is valid for ordering.
+ attr for attr in dir(model_class) if isinstance(getattr(model_class, attr), property) and attr != 'pk'
+ ]
+
return [
(field.source.replace('.', '__') or field_name, field.label)
for field_name, field in serializer_class(context=context).fields.items()
- if not getattr(field, 'write_only', False) and not field.source == '*'
+ if (
+ not getattr(field, 'write_only', False) and
+ not field.source == '*' and
+ field.source not in model_property_names
+ )
]
def get_valid_fields(self, queryset, view, context={}):
diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py
index 60a57c8e4a..dc120d8e86 100644
--- a/rest_framework/pagination.py
+++ b/rest_framework/pagination.py
@@ -198,9 +198,7 @@ def paginate_queryset(self, queryset, request, view=None):
return None
paginator = self.django_paginator_class(queryset, page_size)
- page_number = request.query_params.get(self.page_query_param, 1)
- if page_number in self.last_page_strings:
- page_number = paginator.num_pages
+ page_number = self.get_page_number(request, paginator)
try:
self.page = paginator.page(page_number)
@@ -217,6 +215,12 @@ def paginate_queryset(self, queryset, request, view=None):
self.request = request
return list(self.page)
+ def get_page_number(self, request, paginator):
+ page_number = request.query_params.get(self.page_query_param, 1)
+ if page_number in self.last_page_strings:
+ page_number = paginator.num_pages
+ return page_number
+
def get_paginated_response(self, data):
return Response(OrderedDict([
('count', self.page.paginator.count),
@@ -376,11 +380,11 @@ class LimitOffsetPagination(BasePagination):
template = 'rest_framework/pagination/numbers.html'
def paginate_queryset(self, queryset, request, view=None):
- self.count = self.get_count(queryset)
self.limit = self.get_limit(request)
if self.limit is None:
return None
+ self.count = self.get_count(queryset)
self.offset = self.get_offset(request)
self.request = request
if self.count > self.limit and self.template is not None:
@@ -484,8 +488,7 @@ def get_html_context(self):
_divide_with_ceil(self.offset, self.limit)
)
- if final < 1:
- final = 1
+ final = max(final, 1)
else:
current = 1
final = 1
diff --git a/rest_framework/relations.py b/rest_framework/relations.py
index eaf27e1d96..c987007842 100644
--- a/rest_framework/relations.py
+++ b/rest_framework/relations.py
@@ -104,11 +104,11 @@ def __init__(self, **kwargs):
self.html_cutoff_text or _(api_settings.HTML_SELECT_CUTOFF_TEXT)
)
if not method_overridden('get_queryset', RelatedField, self):
- assert self.queryset is not None or kwargs.get('read_only', None), (
+ assert self.queryset is not None or kwargs.get('read_only'), (
'Relational field must provide a `queryset` argument, '
'override `get_queryset`, or set read_only=`True`.'
)
- assert not (self.queryset is not None and kwargs.get('read_only', None)), (
+ assert not (self.queryset is not None and kwargs.get('read_only')), (
'Relational fields should not provide a `queryset` argument, '
'when setting read_only=`True`.'
)
@@ -259,6 +259,8 @@ def to_internal_value(self, data):
data = self.pk_field.to_internal_value(data)
queryset = self.get_queryset()
try:
+ if isinstance(data, bool):
+ raise TypeError
return queryset.get(pk=data)
except ObjectDoesNotExist:
self.fail('does_not_exist', pk_value=data)
@@ -337,7 +339,7 @@ def get_url(self, obj, view_name, request, format):
return self.reverse(view_name, kwargs=kwargs, request=request, format=format)
def to_internal_value(self, data):
- request = self.context.get('request', None)
+ request = self.context.get('request')
try:
http_prefix = data.startswith(('http:', 'https:'))
except AttributeError:
@@ -380,7 +382,7 @@ def to_representation(self, value):
)
request = self.context['request']
- format = self.context.get('format', None)
+ format = self.context.get('format')
# By default use whatever format is given for the current context
# unless the target is a different type to the source.
diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py
index 3c4be8aeb0..b0ddca2b59 100644
--- a/rest_framework/renderers.py
+++ b/rest_framework/renderers.py
@@ -1035,13 +1035,16 @@ class CoreAPIJSONOpenAPIRenderer(_BaseOpenAPIRenderer):
media_type = 'application/vnd.oai.openapi+json'
charset = None
format = 'openapi-json'
+ ensure_ascii = not api_settings.UNICODE_JSON
def __init__(self):
assert coreapi, 'Using CoreAPIJSONOpenAPIRenderer, but `coreapi` is not installed.'
def render(self, data, media_type=None, renderer_context=None):
structure = self.get_structure(data)
- return json.dumps(structure, indent=4).encode('utf-8')
+ return json.dumps(
+ structure, indent=4,
+ ensure_ascii=self.ensure_ascii).encode('utf-8')
class OpenAPIRenderer(BaseRenderer):
@@ -1063,7 +1066,11 @@ def ignore_aliases(self, data):
class JSONOpenAPIRenderer(BaseRenderer):
media_type = 'application/vnd.oai.openapi+json'
charset = None
+ encoder_class = encoders.JSONEncoder
format = 'openapi-json'
+ ensure_ascii = not api_settings.UNICODE_JSON
def render(self, data, media_type=None, renderer_context=None):
- return json.dumps(data, indent=2).encode('utf-8')
+ return json.dumps(
+ data, cls=self.encoder_class, indent=2,
+ ensure_ascii=self.ensure_ascii).encode('utf-8')
diff --git a/rest_framework/request.py b/rest_framework/request.py
index 2a007cd2bb..17ceadb08e 100644
--- a/rest_framework/request.py
+++ b/rest_framework/request.py
@@ -316,7 +316,7 @@ def _supports_form_parsing(self):
'application/x-www-form-urlencoded',
'multipart/form-data'
)
- return any([parser.media_type in form_media for parser in self.parsers])
+ return any(parser.media_type in form_media for parser in self.parsers)
def _parse(self):
"""
diff --git a/rest_framework/routers.py b/rest_framework/routers.py
index e2afa573fe..e0ae24b95c 100644
--- a/rest_framework/routers.py
+++ b/rest_framework/routers.py
@@ -290,7 +290,7 @@ def get(self, request, *args, **kwargs):
args=args,
kwargs=kwargs,
request=request,
- format=kwargs.get('format', None)
+ format=kwargs.get('format')
)
except NoReverseMatch:
# Don't bail out if eg. no list routes exist, only detail routes.
diff --git a/rest_framework/schemas/coreapi.py b/rest_framework/schemas/coreapi.py
index 75ed5671af..179f0fa3c8 100644
--- a/rest_framework/schemas/coreapi.py
+++ b/rest_framework/schemas/coreapi.py
@@ -58,7 +58,7 @@ class LinkNode(OrderedDict):
def __init__(self):
self.links = []
self.methods_counter = Counter()
- super(LinkNode, self).__init__()
+ super().__init__()
def get_available_key(self, preferred_key):
if preferred_key not in self:
@@ -120,7 +120,7 @@ def __init__(self, title=None, url=None, description=None, patterns=None, urlcon
assert coreapi, '`coreapi` must be installed for schema support.'
assert coreschema, '`coreschema` must be installed for schema support.'
- super(SchemaGenerator, self).__init__(title, url, description, patterns, urlconf)
+ super().__init__(title, url, description, patterns, urlconf)
self.coerce_method_names = api_settings.SCHEMA_COERCE_METHOD_NAMES
def get_links(self, request=None):
@@ -346,7 +346,7 @@ def __init__(self, manual_fields=None):
* `manual_fields`: list of `coreapi.Field` instances that
will be added to auto-generated fields, overwriting on `Field.name`
"""
- super(AutoSchema, self).__init__()
+ super().__init__()
if manual_fields is None:
manual_fields = []
self._manual_fields = manual_fields
@@ -587,7 +587,7 @@ def __init__(self, fields, description='', encoding=None):
* `fields`: list of `coreapi.Field` instances.
* `description`: String description for view. Optional.
"""
- super(ManualSchema, self).__init__()
+ super().__init__()
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
diff --git a/rest_framework/schemas/openapi.py b/rest_framework/schemas/openapi.py
index 4ecb7a65f1..5e9d59f8bf 100644
--- a/rest_framework/schemas/openapi.py
+++ b/rest_framework/schemas/openapi.py
@@ -192,15 +192,22 @@ def get_components(self, path, method):
if method.lower() == 'delete':
return {}
- serializer = self.get_serializer(path, method)
+ request_serializer = self.get_request_serializer(path, method)
+ response_serializer = self.get_response_serializer(path, method)
- if not isinstance(serializer, serializers.Serializer):
- return {}
+ components = {}
+
+ if isinstance(request_serializer, serializers.Serializer):
+ component_name = self.get_component_name(request_serializer)
+ content = self.map_serializer(request_serializer)
+ components.setdefault(component_name, content)
- component_name = self.get_component_name(serializer)
+ if isinstance(response_serializer, serializers.Serializer):
+ component_name = self.get_component_name(response_serializer)
+ content = self.map_serializer(response_serializer)
+ components.setdefault(component_name, content)
- content = self.map_serializer(serializer)
- return {component_name: content}
+ return components
def _to_camel_case(self, snake_str):
components = snake_str.split('_')
@@ -615,6 +622,20 @@ def get_serializer(self, path, method):
.format(view.__class__.__name__, method, path))
return None
+ def get_request_serializer(self, path, method):
+ """
+ Override this method if your view uses a different serializer for
+ handling request body.
+ """
+ return self.get_serializer(path, method)
+
+ def get_response_serializer(self, path, method):
+ """
+ Override this method if your view uses a different serializer for
+ populating response data.
+ """
+ return self.get_serializer(path, method)
+
def _get_reference(self, serializer):
return {'$ref': '#/components/schemas/{}'.format(self.get_component_name(serializer))}
@@ -624,7 +645,7 @@ def get_request_body(self, path, method):
self.request_media_types = self.map_parsers(path, method)
- serializer = self.get_serializer(path, method)
+ serializer = self.get_request_serializer(path, method)
if not isinstance(serializer, serializers.Serializer):
item_schema = {}
@@ -648,7 +669,7 @@ def get_responses(self, path, method):
self.response_media_types = self.map_renderers(path, method)
- serializer = self.get_serializer(path, method)
+ serializer = self.get_response_serializer(path, method)
if not isinstance(serializer, serializers.Serializer):
item_schema = {}
diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py
index 49eec82591..3896805177 100644
--- a/rest_framework/serializers.py
+++ b/rest_framework/serializers.py
@@ -71,7 +71,8 @@
LIST_SERIALIZER_KWARGS = (
'read_only', 'write_only', 'required', 'default', 'initial', 'source',
'label', 'help_text', 'style', 'error_messages', 'allow_empty',
- 'instance', 'data', 'partial', 'context', 'allow_null'
+ 'instance', 'data', 'partial', 'context', 'allow_null',
+ 'max_length', 'min_length'
)
ALL_FIELDS = '__all__'
@@ -143,12 +144,18 @@ def many_init(cls, *args, **kwargs):
return CustomListSerializer(*args, **kwargs)
"""
allow_empty = kwargs.pop('allow_empty', None)
+ max_length = kwargs.pop('max_length', None)
+ min_length = kwargs.pop('min_length', None)
child_serializer = cls(*args, **kwargs)
list_kwargs = {
'child': child_serializer,
}
if allow_empty is not None:
list_kwargs['allow_empty'] = allow_empty
+ if max_length is not None:
+ list_kwargs['max_length'] = max_length
+ if min_length is not None:
+ list_kwargs['min_length'] = min_length
list_kwargs.update({
key: value for key, value in kwargs.items()
if key in LIST_SERIALIZER_KWARGS
@@ -568,12 +575,16 @@ class ListSerializer(BaseSerializer):
default_error_messages = {
'not_a_list': _('Expected a list of items but got type "{input_type}".'),
- 'empty': _('This list may not be empty.')
+ 'empty': _('This list may not be empty.'),
+ 'max_length': _('Ensure this field has no more than {max_length} elements.'),
+ 'min_length': _('Ensure this field has at least {min_length} elements.')
}
def __init__(self, *args, **kwargs):
self.child = kwargs.pop('child', copy.deepcopy(self.child))
self.allow_empty = kwargs.pop('allow_empty', True)
+ self.max_length = kwargs.pop('max_length', None)
+ self.min_length = kwargs.pop('min_length', None)
assert self.child is not None, '`child` is a required argument.'
assert not inspect.isclass(self.child), '`child` has not been instantiated.'
super().__init__(*args, **kwargs)
@@ -635,6 +646,18 @@ def to_internal_value(self, data):
api_settings.NON_FIELD_ERRORS_KEY: [message]
}, code='empty')
+ if self.max_length is not None and len(data) > self.max_length:
+ message = self.error_messages['max_length'].format(max_length=self.max_length)
+ raise ValidationError({
+ api_settings.NON_FIELD_ERRORS_KEY: [message]
+ }, code='max_length')
+
+ if self.min_length is not None and len(data) < self.min_length:
+ message = self.error_messages['min_length'].format(min_length=self.min_length)
+ raise ValidationError({
+ api_settings.NON_FIELD_ERRORS_KEY: [message]
+ }, code='min_length')
+
ret = []
errors = []
@@ -1326,9 +1349,8 @@ def include_extra_kwargs(self, kwargs, extra_kwargs):
"""
if extra_kwargs.get('read_only', False):
for attr in [
- 'required', 'default', 'allow_blank', 'allow_null',
- 'min_length', 'max_length', 'min_value', 'max_value',
- 'validators', 'queryset'
+ 'required', 'default', 'allow_blank', 'min_length',
+ 'max_length', 'min_value', 'max_value', 'validators', 'queryset'
]:
kwargs.pop(attr, None)
diff --git a/rest_framework/static/rest_framework/css/default.css b/rest_framework/static/rest_framework/css/default.css
index 86fef17737..51ca3ba19e 100644
--- a/rest_framework/static/rest_framework/css/default.css
+++ b/rest_framework/static/rest_framework/css/default.css
@@ -40,7 +40,7 @@ td.nested > table {
margin: 0;
}
-form select, form input, form textarea {
+form select, form input:not([type=checkbox]), form textarea {
width: 90%;
}
diff --git a/rest_framework/static/rest_framework/docs/css/base.css b/rest_framework/static/rest_framework/docs/css/base.css
index 0be2bafa91..06b240c522 100644
--- a/rest_framework/static/rest_framework/docs/css/base.css
+++ b/rest_framework/static/rest_framework/docs/css/base.css
@@ -7,15 +7,15 @@ h1 {
}
pre.highlight code * {
- white-space: nowrap; // this sets all children inside to nowrap
+ white-space: nowrap; /* this sets all children inside to nowrap */
}
pre.highlight {
- overflow-x: auto; // this sets the scrolling in x
+ overflow-x: auto; /* this sets the scrolling in x */
}
pre.highlight code {
- white-space: pre; // forces to respect formatting
+ white-space: pre; /* forces to respect formatting */
}
.main-container {
diff --git a/rest_framework/templates/rest_framework/filters/search.html b/rest_framework/templates/rest_framework/filters/search.html
index edb28d45d8..065c3889ac 100644
--- a/rest_framework/templates/rest_framework/filters/search.html
+++ b/rest_framework/templates/rest_framework/filters/search.html
@@ -5,7 +5,7 @@ {% trans "Search" %}
-
+
diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py
index 7bfa8f5995..db0e9c95c3 100644
--- a/rest_framework/templatetags/rest_framework.py
+++ b/rest_framework/templatetags/rest_framework.py
@@ -206,7 +206,7 @@ def format_value(value):
if value is None or isinstance(value, bool):
return mark_safe('%s' % {True: 'true', False: 'false', None: 'null'}[value])
elif isinstance(value, list):
- if any([isinstance(item, (list, dict)) for item in value]):
+ if any(isinstance(item, (list, dict)) for item in value):
template = loader.get_template('rest_framework/admin/list_value.html')
else:
template = loader.get_template('rest_framework/admin/simple_list_value.html')
@@ -285,7 +285,7 @@ def schema_links(section, sec_key=None):
def add_nested_class(value):
if isinstance(value, dict):
return 'class=nested'
- if isinstance(value, list) and any([isinstance(item, (list, dict)) for item in value]):
+ if isinstance(value, list) and any(isinstance(item, (list, dict)) for item in value):
return 'class=nested'
return ''
diff --git a/rest_framework/test.py b/rest_framework/test.py
index f2581cacca..0212348ee0 100644
--- a/rest_framework/test.py
+++ b/rest_framework/test.py
@@ -3,6 +3,7 @@
import io
from importlib import import_module
+import django
from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
from django.core.handlers.wsgi import WSGIHandler
@@ -79,7 +80,7 @@ def send(self, request, *args, **kwargs):
"""
raw_kwargs = {}
- def start_response(wsgi_status, wsgi_headers):
+ def start_response(wsgi_status, wsgi_headers, exc_info=None):
status, _, reason = wsgi_status.partition(' ')
raw_kwargs['status'] = int(status)
raw_kwargs['reason'] = reason
@@ -124,7 +125,7 @@ class CoreAPIClient(coreapi.Client):
def __init__(self, *args, **kwargs):
self._session = RequestsClient()
kwargs['transports'] = [coreapi.transports.HTTPTransport(session=self.session)]
- return super().__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
@property
def session(self):
@@ -357,6 +358,13 @@ class APILiveServerTestCase(testcases.LiveServerTestCase):
client_class = APIClient
+def cleanup_url_patterns(cls):
+ if hasattr(cls, '_module_urlpatterns'):
+ cls._module.urlpatterns = cls._module_urlpatterns
+ else:
+ del cls._module.urlpatterns
+
+
class URLPatternsTestCase(testcases.SimpleTestCase):
"""
Isolate URL patterns on a per-TestCase basis. For example,
@@ -385,14 +393,20 @@ def setUpClass(cls):
cls._module.urlpatterns = cls.urlpatterns
cls._override.enable()
+
+ if django.VERSION > (4, 0):
+ cls.addClassCleanup(cls._override.disable)
+ cls.addClassCleanup(cleanup_url_patterns, cls)
+
super().setUpClass()
- @classmethod
- def tearDownClass(cls):
- super().tearDownClass()
- cls._override.disable()
+ if django.VERSION < (4, 0):
+ @classmethod
+ def tearDownClass(cls):
+ super().tearDownClass()
+ cls._override.disable()
- if hasattr(cls, '_module_urlpatterns'):
- cls._module.urlpatterns = cls._module_urlpatterns
- else:
- del cls._module.urlpatterns
+ if hasattr(cls, '_module_urlpatterns'):
+ cls._module.urlpatterns = cls._module_urlpatterns
+ else:
+ del cls._module.urlpatterns
diff --git a/rest_framework/throttling.py b/rest_framework/throttling.py
index 0ba2ba66b1..e262b886bc 100644
--- a/rest_framework/throttling.py
+++ b/rest_framework/throttling.py
@@ -52,7 +52,7 @@ class SimpleRateThrottle(BaseThrottle):
A simple cache implementation, that only requires `.get_cache_key()`
to be overridden.
- The rate (requests / seconds) is set by a `rate` attribute on the View
+ The rate (requests / seconds) is set by a `rate` attribute on the Throttle
class. The attribute is a string of the form 'number_of_requests/period'.
Period should be one of: ('s', 'sec', 'm', 'min', 'h', 'hour', 'd', 'day')
diff --git a/rest_framework/utils/serializer_helpers.py b/rest_framework/utils/serializer_helpers.py
index b18fbe0df9..4cd2ada314 100644
--- a/rest_framework/utils/serializer_helpers.py
+++ b/rest_framework/utils/serializer_helpers.py
@@ -1,5 +1,5 @@
from collections import OrderedDict
-from collections.abc import MutableMapping
+from collections.abc import Mapping, MutableMapping
from django.utils.encoding import force_str
@@ -87,7 +87,12 @@ def as_form_field(self):
# value will be a JSONString, rather than a JSON primitive.
if not getattr(value, 'is_json_string', False):
try:
- value = json.dumps(self.value, sort_keys=True, indent=4)
+ value = json.dumps(
+ self.value,
+ sort_keys=True,
+ indent=4,
+ separators=(',', ': '),
+ )
except (TypeError, ValueError):
pass
return self.__class__(self._field, value, self.errors, self._prefix)
@@ -101,7 +106,7 @@ class NestedBoundField(BoundField):
"""
def __init__(self, field, value, errors, prefix=''):
- if value is None or value == '':
+ if value is None or value == '' or not isinstance(value, Mapping):
value = {}
super().__init__(field, value, errors, prefix)
@@ -115,6 +120,8 @@ def __getitem__(self, key):
error = self.errors.get(key) if isinstance(self.errors, dict) else None
if hasattr(field, 'fields'):
return NestedBoundField(field, value, error, prefix=self.name + '.')
+ elif getattr(field, '_is_jsonfield', False):
+ return JSONBoundField(field, value, error, prefix=self.name + '.')
return BoundField(field, value, error, prefix=self.name + '.')
def as_form_field(self):
diff --git a/rest_framework/views.py b/rest_framework/views.py
index d1b5e4ed90..5b06220691 100644
--- a/rest_framework/views.py
+++ b/rest_framework/views.py
@@ -3,7 +3,7 @@
"""
from django.conf import settings
from django.core.exceptions import PermissionDenied
-from django.db import connection, models, transaction
+from django.db import connections, models
from django.http import Http404
from django.http.response import HttpResponseBase
from django.utils.cache import cc_delim_re, patch_vary_headers
@@ -63,9 +63,9 @@ def get_view_description(view, html=False):
def set_rollback():
- atomic_requests = connection.settings_dict.get('ATOMIC_REQUESTS', False)
- if atomic_requests and connection.in_atomic_block:
- transaction.set_rollback(True)
+ for db in connections.all():
+ if db.settings_dict['ATOMIC_REQUESTS'] and db.in_atomic_block:
+ db.set_rollback(True)
def exception_handler(exc, context):
diff --git a/runtests.py b/runtests.py
index 82028ea32c..98f34c0673 100755
--- a/runtests.py
+++ b/runtests.py
@@ -1,42 +1,8 @@
#! /usr/bin/env python3
-import subprocess
import sys
import pytest
-PYTEST_ARGS = {
- 'default': [],
- 'fast': ['-q'],
-}
-
-FLAKE8_ARGS = ['rest_framework', 'tests']
-
-ISORT_ARGS = ['--check-only', '--diff', 'rest_framework', 'tests']
-
-
-def exit_on_failure(ret, message=None):
- if ret:
- sys.exit(ret)
-
-
-def flake8_main(args):
- print('Running flake8 code linting')
- ret = subprocess.call(['flake8'] + args)
- print('flake8 failed' if ret else 'flake8 passed')
- return ret
-
-
-def isort_main(args):
- print('Running isort code checking')
- ret = subprocess.call(['isort'] + args)
-
- if ret:
- print('isort failed: Some modules have incorrectly ordered imports. Fix by running `isort --recursive .`')
- else:
- print('isort passed')
-
- return ret
-
def split_class_and_function(string):
class_string, function_string = string.split('.', 1)
@@ -54,31 +20,6 @@ def is_class(string):
if __name__ == "__main__":
- try:
- sys.argv.remove('--nolint')
- except ValueError:
- run_flake8 = True
- run_isort = True
- else:
- run_flake8 = False
- run_isort = False
-
- try:
- sys.argv.remove('--lintonly')
- except ValueError:
- run_tests = True
- else:
- run_tests = False
-
- try:
- sys.argv.remove('--fast')
- except ValueError:
- style = 'default'
- else:
- style = 'fast'
- run_flake8 = False
- run_isort = False
-
if len(sys.argv) > 1:
pytest_args = sys.argv[1:]
first_arg = pytest_args[0]
@@ -105,13 +46,6 @@ def is_class(string):
# `runtests.py test_function [flags]`
pytest_args = ['tests', '-k', pytest_args[0]] + pytest_args[1:]
else:
- pytest_args = PYTEST_ARGS[style]
-
- if run_tests:
- exit_on_failure(pytest.main(pytest_args))
-
- if run_flake8:
- exit_on_failure(flake8_main(FLAKE8_ARGS))
+ pytest_args = []
- if run_isort:
- exit_on_failure(isort_main(ISORT_ARGS))
+ sys.exit(pytest.main(pytest_args))
diff --git a/setup.cfg b/setup.cfg
index abb7cca908..46ffb13c52 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -2,8 +2,7 @@
license_file = LICENSE.md
[tool:pytest]
-addopts=--tb=short --strict -ra
-testspath = tests
+addopts=--tb=short --strict-markers -ra
[flake8]
ignore = E501,W504
diff --git a/setup.py b/setup.py
index e2a1c0222c..3c3761c866 100755
--- a/setup.py
+++ b/setup.py
@@ -8,7 +8,7 @@
from setuptools import find_packages, setup
CURRENT_PYTHON = sys.version_info[:2]
-REQUIRED_PYTHON = (3, 5)
+REQUIRED_PYTHON = (3, 6)
# This check and everything above must remain compatible with Python 2.7.
if CURRENT_PYTHON < REQUIRED_PYTHON:
@@ -82,8 +82,8 @@ def get_version(package):
author_email='tom@tomchristie.com', # SEE NOTE BELOW (*)
packages=find_packages(exclude=['tests*']),
include_package_data=True,
- install_requires=["django>=2.2"],
- python_requires=">=3.5",
+ install_requires=["django>=2.2", "pytz"],
+ python_requires=">=3.6",
zip_safe=False,
classifiers=[
'Development Status :: 5 - Production/Stable',
@@ -92,22 +92,25 @@ def get_version(package):
'Framework :: Django :: 2.2',
'Framework :: Django :: 3.0',
'Framework :: Django :: 3.1',
+ 'Framework :: Django :: 3.2',
+ 'Framework :: Django :: 4.0',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
- 'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
+ 'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3 :: Only',
'Topic :: Internet :: WWW/HTTP',
],
project_urls={
'Funding': 'https://fund.django-rest-framework.org/topics/funding/',
'Source': 'https://github.com/encode/django-rest-framework',
+ 'Changelog': 'https://www.django-rest-framework.org/community/release-notes/',
},
)
diff --git a/tests/authentication/test_authentication.py b/tests/authentication/test_authentication.py
index a73e0d79c7..d771aaf8b4 100644
--- a/tests/authentication/test_authentication.py
+++ b/tests/authentication/test_authentication.py
@@ -1,5 +1,6 @@
import base64
+import django
import pytest
from django.conf import settings
from django.contrib.auth.models import User
@@ -218,7 +219,16 @@ def test_post_form_session_auth_passing_csrf(self):
Ensure POSTing form over session authentication with CSRF token succeeds.
Regression test for #6088
"""
- from django.middleware.csrf import _get_new_csrf_token
+ # Remove this shim when dropping support for Django 2.2.
+ if django.VERSION < (3, 0):
+ from django.middleware.csrf import _get_new_csrf_token
+ else:
+ from django.middleware.csrf import (
+ _get_new_csrf_string, _mask_cipher_secret
+ )
+
+ def _get_new_csrf_token():
+ return _mask_cipher_secret(_get_new_csrf_string())
self.csrf_client.login(username=self.username, password=self.password)
diff --git a/tests/conftest.py b/tests/conftest.py
index ac29e4a429..79cabd5e1a 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -18,18 +18,23 @@ def pytest_addoption(parser):
def pytest_configure(config):
from django.conf import settings
+ # USE_L10N is deprecated, and will be removed in Django 5.0.
+ use_l10n = {"USE_L10N": True} if django.VERSION < (4, 0) else {}
settings.configure(
DEBUG_PROPAGATE_EXCEPTIONS=True,
DATABASES={
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': ':memory:'
+ },
+ 'secondary': {
+ 'ENGINE': 'django.db.backends.sqlite3',
+ 'NAME': ':memory:'
}
},
SITE_ID=1,
SECRET_KEY='not very secret in tests',
USE_I18N=True,
- USE_L10N=True,
STATIC_URL='/static/',
ROOT_URLCONF='tests.urls',
TEMPLATES=[
@@ -64,6 +69,7 @@ def pytest_configure(config):
PASSWORD_HASHERS=(
'django.contrib.auth.hashers.MD5PasswordHasher',
),
+ **use_l10n,
)
# guardian is optional
diff --git a/tests/schemas/test_openapi.py b/tests/schemas/test_openapi.py
index 542c377b15..daa035a3f3 100644
--- a/tests/schemas/test_openapi.py
+++ b/tests/schemas/test_openapi.py
@@ -2,6 +2,7 @@
import warnings
import pytest
+from django.db import models
from django.test import RequestFactory, TestCase, override_settings
from django.urls import path
from django.utils.translation import gettext_lazy as _
@@ -11,7 +12,8 @@
from rest_framework.compat import uritemplate
from rest_framework.parsers import JSONParser, MultiPartParser
from rest_framework.renderers import (
- BaseRenderer, BrowsableAPIRenderer, JSONRenderer, OpenAPIRenderer
+ BaseRenderer, BrowsableAPIRenderer, JSONOpenAPIRenderer, JSONRenderer,
+ OpenAPIRenderer
)
from rest_framework.request import Request
from rest_framework.schemas.openapi import AutoSchema, SchemaGenerator
@@ -109,6 +111,24 @@ class Serializer(serializers.Serializer):
assert data['properties']['default_false']['default'] is False, "default must be false"
assert 'default' not in data['properties']['without_default'], "default must not be defined"
+ def test_nullable_fields(self):
+ class Model(models.Model):
+ rw_field = models.CharField(null=True)
+ ro_field = models.CharField(null=True)
+
+ class Serializer(serializers.ModelSerializer):
+ class Meta:
+ model = Model
+ fields = ["rw_field", "ro_field"]
+ read_only_fields = ["ro_field"]
+
+ inspector = AutoSchema()
+
+ data = inspector.map_serializer(Serializer())
+ assert data['properties']['rw_field']['nullable'], "rw_field nullable must be true"
+ assert data['properties']['ro_field']['nullable'], "ro_field nullable must be true"
+ assert data['properties']['ro_field']['readOnly'], "ro_field read_only must be true"
+
@pytest.mark.skipif(uritemplate is None, reason='uritemplate not installed.')
class TestOperationIntrospection(TestCase):
@@ -711,6 +731,91 @@ def get_operation_id_base(self, path, method, action):
operationId = inspector.get_operation_id(path, method)
assert operationId == 'listItem'
+ def test_different_request_response_objects(self):
+ class RequestSerializer(serializers.Serializer):
+ text = serializers.CharField()
+
+ class ResponseSerializer(serializers.Serializer):
+ text = serializers.BooleanField()
+
+ class CustomSchema(AutoSchema):
+ def get_request_serializer(self, path, method):
+ return RequestSerializer()
+
+ def get_response_serializer(self, path, method):
+ return ResponseSerializer()
+
+ path = '/'
+ method = 'POST'
+ view = create_view(
+ views.ExampleGenericAPIView,
+ method,
+ create_request(path),
+ )
+ inspector = CustomSchema()
+ inspector.view = view
+
+ components = inspector.get_components(path, method)
+ assert components == {
+ 'Request': {
+ 'properties': {
+ 'text': {
+ 'type': 'string'
+ }
+ },
+ 'required': ['text'],
+ 'type': 'object'
+ },
+ 'Response': {
+ 'properties': {
+ 'text': {
+ 'type': 'boolean'
+ }
+ },
+ 'required': ['text'],
+ 'type': 'object'
+ }
+ }
+
+ operation = inspector.get_operation(path, method)
+ assert operation == {
+ 'operationId': 'createExample',
+ 'description': '',
+ 'parameters': [],
+ 'requestBody': {
+ 'content': {
+ 'application/json': {
+ 'schema': {
+ '$ref': '#/components/schemas/Request'
+ }
+ },
+ 'application/x-www-form-urlencoded': {
+ 'schema': {
+ '$ref': '#/components/schemas/Request'
+ }
+ },
+ 'multipart/form-data': {
+ 'schema': {
+ '$ref': '#/components/schemas/Request'
+ }
+ }
+ }
+ },
+ 'responses': {
+ '201': {
+ 'content': {
+ 'application/json': {
+ 'schema': {
+ '$ref': '#/components/schemas/Response'
+ }
+ }
+ },
+ 'description': ''
+ }
+ },
+ 'tags': ['']
+ }
+
def test_repeat_operation_ids(self):
router = routers.SimpleRouter()
router.register('account', views.ExampleGenericViewSet, basename="account")
@@ -992,6 +1097,19 @@ def test_schema_construction(self):
assert 'openapi' in schema
assert 'paths' in schema
+ def test_schema_rendering_to_json(self):
+ patterns = [
+ path('example/', views.ExampleGenericAPIView.as_view()),
+ ]
+ generator = SchemaGenerator(patterns=patterns)
+
+ request = create_request('/')
+ schema = generator.get_schema(request=request)
+ ret = JSONOpenAPIRenderer().render(schema)
+
+ assert b'"openapi": "' in ret
+ assert b'"default": "0.0"' in ret
+
def test_schema_with_no_paths(self):
patterns = []
generator = SchemaGenerator(patterns=patterns)
diff --git a/tests/schemas/views.py b/tests/schemas/views.py
index 18b3beae4e..f1ed0bd4e3 100644
--- a/tests/schemas/views.py
+++ b/tests/schemas/views.py
@@ -1,4 +1,5 @@
import uuid
+from datetime import timedelta
from django.core.validators import (
DecimalValidator, MaxLengthValidator, MaxValueValidator,
@@ -59,6 +60,7 @@ def get(self, *args, **kwargs):
class ExampleSerializer(serializers.Serializer):
date = serializers.DateField()
datetime = serializers.DateTimeField()
+ duration = serializers.DurationField(default=timedelta())
hstore = serializers.HStoreField()
uuid_field = serializers.UUIDField(default=uuid.uuid4)
diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py
index 15b41e02f4..beda5cba19 100644
--- a/tests/test_atomic_requests.py
+++ b/tests/test_atomic_requests.py
@@ -130,6 +130,41 @@ def test_api_exception_rollback_transaction(self):
assert BasicModel.objects.count() == 0
+@unittest.skipUnless(
+ connection.features.uses_savepoints,
+ "'atomic' requires transactions and savepoints."
+)
+class MultiDBTransactionAPIExceptionTests(TestCase):
+ databases = '__all__'
+
+ def setUp(self):
+ self.view = APIExceptionView.as_view()
+ connections.databases['default']['ATOMIC_REQUESTS'] = True
+ connections.databases['secondary']['ATOMIC_REQUESTS'] = True
+
+ def tearDown(self):
+ connections.databases['default']['ATOMIC_REQUESTS'] = False
+ connections.databases['secondary']['ATOMIC_REQUESTS'] = False
+
+ def test_api_exception_rollback_transaction(self):
+ """
+ Transaction is rollbacked by our transaction atomic block.
+ """
+ request = factory.post('/')
+ num_queries = 4 if connection.features.can_release_savepoints else 3
+ with self.assertNumQueries(num_queries):
+ # 1 - begin savepoint
+ # 2 - insert
+ # 3 - rollback savepoint
+ # 4 - release savepoint
+ with transaction.atomic(), transaction.atomic(using='secondary'):
+ response = self.view(request)
+ assert transaction.get_rollback()
+ assert transaction.get_rollback(using='secondary')
+ assert response.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR
+ assert BasicModel.objects.count() == 0
+
+
@unittest.skipUnless(
connection.features.uses_savepoints,
"'atomic' requires transactions and savepoints."
diff --git a/tests/test_bound_fields.py b/tests/test_bound_fields.py
index dc5ab542ff..eee7d9b852 100644
--- a/tests/test_bound_fields.py
+++ b/tests/test_bound_fields.py
@@ -91,6 +91,10 @@ class ExampleSerializer(serializers.Serializer):
assert rendered_packed == expected_packed
+class CustomJSONField(serializers.JSONField):
+ pass
+
+
class TestNestedBoundField:
def test_nested_empty_bound_field(self):
class Nested(serializers.Serializer):
@@ -117,14 +121,31 @@ def test_as_form_fields(self):
class Nested(serializers.Serializer):
bool_field = serializers.BooleanField()
null_field = serializers.IntegerField(allow_null=True)
+ json_field = serializers.JSONField()
+ custom_json_field = CustomJSONField()
class ExampleSerializer(serializers.Serializer):
nested = Nested()
- serializer = ExampleSerializer(data={'nested': {'bool_field': False, 'null_field': None}})
+ serializer = ExampleSerializer(
+ data={'nested': {
+ 'bool_field': False, 'null_field': None,
+ 'json_field': {'bool_item': True, 'number': 1, 'text_item': 'text'},
+ 'custom_json_field': {'bool_item': True, 'number': 1, 'text_item': 'text'},
+ }})
assert serializer.is_valid()
assert serializer['nested']['bool_field'].as_form_field().value == ''
assert serializer['nested']['null_field'].as_form_field().value == ''
+ assert serializer['nested']['json_field'].as_form_field().value == '''{
+ "bool_item": true,
+ "number": 1,
+ "text_item": "text"
+}'''
+ assert serializer['nested']['custom_json_field'].as_form_field().value == '''{
+ "bool_item": true,
+ "number": 1,
+ "text_item": "text"
+}'''
def test_rendering_nested_fields_with_none_value(self):
from rest_framework.renderers import HTMLFormRenderer
@@ -163,6 +184,33 @@ class ExampleSerializer(serializers.Serializer):
rendered_packed = ''.join(rendered.split())
assert rendered_packed == expected_packed
+ def test_rendering_nested_fields_with_not_mappable_value(self):
+ from rest_framework.renderers import HTMLFormRenderer
+
+ class Nested(serializers.Serializer):
+ text_field = serializers.CharField()
+
+ class ExampleSerializer(serializers.Serializer):
+ nested = Nested()
+
+ serializer = ExampleSerializer(data={'nested': 1})
+ assert not serializer.is_valid()
+ renderer = HTMLFormRenderer()
+ for field in serializer:
+ rendered = renderer.render_field(field, {})
+ expected_packed = (
+ ''
+ )
+
+ rendered_packed = ''.join(rendered.split())
+ assert rendered_packed == expected_packed
+
class TestJSONBoundField:
def test_as_form_fields(self):
diff --git a/tests/test_decorators.py b/tests/test_decorators.py
index 99ba13e60c..116d6f1be4 100644
--- a/tests/test_decorators.py
+++ b/tests/test_decorators.py
@@ -162,6 +162,16 @@ def view(request):
assert isinstance(view.cls.schema, CustomSchema)
+ def test_wrapper_assignments(self):
+ @api_view(["GET"])
+ def test_view(request):
+ """example docstring"""
+ pass
+
+ assert test_view.__name__ == "test_view"
+ assert test_view.__doc__ == "example docstring"
+ assert test_view.__qualname__ == "DecoratorTestCase.test_wrapper_assignments..test_view"
+
class ActionDecoratorTestCase(TestCase):
diff --git a/tests/test_description.py b/tests/test_description.py
index ae00fe4a97..363ad6513e 100644
--- a/tests/test_description.py
+++ b/tests/test_description.py
@@ -1,192 +1,178 @@
-from django.test import TestCase
-
-from rest_framework.compat import apply_markdown
-from rest_framework.utils.formatting import dedent
-from rest_framework.views import APIView
-
-# We check that docstrings get nicely un-indented.
-DESCRIPTION = """an example docstring
-====================
-
-* list
-* list
-
-another header
---------------
-
- code block
-
-indented
-
-# hash style header #
-
-``` json
-[{
- "alpha": 1,
- "beta: "this is a string"
-}]
-```"""
-
-
-# If markdown is installed we also test it's working
-# (and that our wrapped forces '=' to h2 and '-' to h3)
-MARKED_DOWN_HILITE = """
-[{
"alpha": 1,
\
- "beta: "this\
- is a \
-string"
}]
-
-
"""
-
-MARKED_DOWN_NOT_HILITE = """
-json
-[{
- "alpha": 1,
- "beta: "this is a string"
-}]
"""
-
-# We support markdown < 2.1 and markdown >= 2.1
-MARKED_DOWN_lt_21 = """an example docstring
-
-- list
-- list
-
-another header
-code block
-
-indented
-hash style header
%s"""
-
-MARKED_DOWN_gte_21 = """an example docstring
-
-- list
-- list
-
-another header
-code block
-
-indented
-hash style header
%s"""
-
-
-class TestViewNamesAndDescriptions(TestCase):
- def test_view_name_uses_class_name(self):
- """
- Ensure view names are based on the class name.
- """
- class MockView(APIView):
- pass
- assert MockView().get_view_name() == 'Mock'
-
- def test_view_name_uses_name_attribute(self):
- class MockView(APIView):
- name = 'Foo'
- assert MockView().get_view_name() == 'Foo'
-
- def test_view_name_uses_suffix_attribute(self):
- class MockView(APIView):
- suffix = 'List'
- assert MockView().get_view_name() == 'Mock List'
-
- def test_view_name_preferences_name_over_suffix(self):
- class MockView(APIView):
- name = 'Foo'
- suffix = 'List'
- assert MockView().get_view_name() == 'Foo'
-
- def test_view_description_uses_docstring(self):
- """Ensure view descriptions are based on the docstring."""
- class MockView(APIView):
- """an example docstring
- ====================
-
- * list
- * list
-
- another header
- --------------
-
- code block
-
- indented
-
- # hash style header #
-
- ``` json
- [{
- "alpha": 1,
- "beta: "this is a string"
- }]
- ```"""
-
- assert MockView().get_view_description() == DESCRIPTION
-
- def test_view_description_uses_description_attribute(self):
- class MockView(APIView):
- description = 'Foo'
- assert MockView().get_view_description() == 'Foo'
-
- def test_view_description_allows_empty_description(self):
- class MockView(APIView):
- """Description."""
- description = ''
- assert MockView().get_view_description() == ''
-
- def test_view_description_can_be_empty(self):
- """
- Ensure that if a view has no docstring,
- then it's description is the empty string.
- """
- class MockView(APIView):
- pass
- assert MockView().get_view_description() == ''
-
- def test_view_description_can_be_promise(self):
- """
- Ensure a view may have a docstring that is actually a lazily evaluated
- class that can be converted to a string.
-
- See: https://github.com/encode/django-rest-framework/issues/1708
- """
- # use a mock object instead of gettext_lazy to ensure that we can't end
- # up with a test case string in our l10n catalog
-
- class MockLazyStr:
- def __init__(self, string):
- self.s = string
-
- def __str__(self):
- return self.s
-
- class MockView(APIView):
- __doc__ = MockLazyStr("a gettext string")
-
- assert MockView().get_view_description() == 'a gettext string'
-
- def test_markdown(self):
- """
- Ensure markdown to HTML works as expected.
- """
- if apply_markdown:
- md_applied = apply_markdown(DESCRIPTION)
- gte_21_match = (
- md_applied == (
- MARKED_DOWN_gte_21 % MARKED_DOWN_HILITE) or
- md_applied == (
- MARKED_DOWN_gte_21 % MARKED_DOWN_NOT_HILITE))
- lt_21_match = (
- md_applied == (
- MARKED_DOWN_lt_21 % MARKED_DOWN_HILITE) or
- md_applied == (
- MARKED_DOWN_lt_21 % MARKED_DOWN_NOT_HILITE))
- assert gte_21_match or lt_21_match
-
-
-def test_dedent_tabs():
- result = 'first string\n\nsecond string'
- assert dedent(" first string\n\n second string") == result
- assert dedent("first string\n\n second string") == result
- assert dedent("\tfirst string\n\n\tsecond string") == result
- assert dedent("first string\n\n\tsecond string") == result
+import sys
+
+import pytest
+from django.test import TestCase
+
+from rest_framework.compat import apply_markdown
+from rest_framework.utils.formatting import dedent
+from rest_framework.views import APIView
+
+# We check that docstrings get nicely un-indented.
+DESCRIPTION = """an example docstring
+====================
+
+* list
+* list
+
+another header
+--------------
+
+ code block
+
+indented
+
+# hash style header #
+
+```json
+[{
+ "alpha": 1,
+ "beta": "this is a string"
+}]
+```"""
+
+
+# If markdown is installed we also test it's working
+# (and that our wrapped forces '=' to h2 and '-' to h3)
+MARKDOWN_BASE = """an example docstring
+
+- list
+- list
+
+another header
+code block
+
+indented
+hash style header
%s"""
+
+MARKDOWN_gte_33 = """
+[{
\
+ "alpha":\
+ 1,
\
+ "beta":\
+ "this is a string"
\
+}]
+
"""
+
+MARKDOWN_lt_33 = """
+[{
\
+ "alpha":\
+ 1,
\
+ "beta":\
+ "this is a string"
\
+}]
+
+
"""
+
+
+class TestViewNamesAndDescriptions(TestCase):
+ def test_view_name_uses_class_name(self):
+ """
+ Ensure view names are based on the class name.
+ """
+ class MockView(APIView):
+ pass
+ assert MockView().get_view_name() == 'Mock'
+
+ def test_view_name_uses_name_attribute(self):
+ class MockView(APIView):
+ name = 'Foo'
+ assert MockView().get_view_name() == 'Foo'
+
+ def test_view_name_uses_suffix_attribute(self):
+ class MockView(APIView):
+ suffix = 'List'
+ assert MockView().get_view_name() == 'Mock List'
+
+ def test_view_name_preferences_name_over_suffix(self):
+ class MockView(APIView):
+ name = 'Foo'
+ suffix = 'List'
+ assert MockView().get_view_name() == 'Foo'
+
+ def test_view_description_uses_docstring(self):
+ """Ensure view descriptions are based on the docstring."""
+ class MockView(APIView):
+ """an example docstring
+ ====================
+
+ * list
+ * list
+
+ another header
+ --------------
+
+ code block
+
+ indented
+
+ # hash style header #
+
+ ```json
+ [{
+ "alpha": 1,
+ "beta": "this is a string"
+ }]
+ ```"""
+
+ assert MockView().get_view_description() == DESCRIPTION
+
+ def test_view_description_uses_description_attribute(self):
+ class MockView(APIView):
+ description = 'Foo'
+ assert MockView().get_view_description() == 'Foo'
+
+ def test_view_description_allows_empty_description(self):
+ class MockView(APIView):
+ """Description."""
+ description = ''
+ assert MockView().get_view_description() == ''
+
+ def test_view_description_can_be_empty(self):
+ """
+ Ensure that if a view has no docstring,
+ then it's description is the empty string.
+ """
+ class MockView(APIView):
+ pass
+ assert MockView().get_view_description() == ''
+
+ def test_view_description_can_be_promise(self):
+ """
+ Ensure a view may have a docstring that is actually a lazily evaluated
+ class that can be converted to a string.
+
+ See: https://github.com/encode/django-rest-framework/issues/1708
+ """
+ # use a mock object instead of gettext_lazy to ensure that we can't end
+ # up with a test case string in our l10n catalog
+
+ class MockLazyStr:
+ def __init__(self, string):
+ self.s = string
+
+ def __str__(self):
+ return self.s
+
+ class MockView(APIView):
+ __doc__ = MockLazyStr("a gettext string")
+
+ assert MockView().get_view_description() == 'a gettext string'
+
+ @pytest.mark.skipif(not apply_markdown, reason="Markdown is not installed")
+ def test_markdown(self):
+ """
+ Ensure markdown to HTML works as expected.
+ """
+ # Markdown 3.3 is only supported on Python 3.6 and higher
+ if sys.version_info >= (3, 6):
+ assert apply_markdown(DESCRIPTION) == MARKDOWN_BASE % MARKDOWN_gte_33
+ else:
+ assert apply_markdown(DESCRIPTION) == MARKDOWN_BASE % MARKDOWN_lt_33
+
+
+def test_dedent_tabs():
+ result = 'first string\n\nsecond string'
+ assert dedent(" first string\n\n second string") == result
+ assert dedent("first string\n\n second string") == result
+ assert dedent("\tfirst string\n\n\tsecond string") == result
+ assert dedent("first string\n\n\tsecond string") == result
diff --git a/tests/test_fields.py b/tests/test_fields.py
index fdd570d8a6..7a5304a82a 100644
--- a/tests/test_fields.py
+++ b/tests/test_fields.py
@@ -1090,6 +1090,9 @@ class TestDecimalField(FieldValues):
'2E+1': Decimal('20'),
}
invalid_inputs = (
+ (None, ["This field may not be null."]),
+ ('', ["A valid number is required."]),
+ (' ', ["A valid number is required."]),
('abc', ["A valid number is required."]),
(Decimal('Nan'), ["A valid number is required."]),
(Decimal('Snan'), ["A valid number is required."]),
@@ -1115,6 +1118,32 @@ class TestDecimalField(FieldValues):
field = serializers.DecimalField(max_digits=3, decimal_places=1)
+class TestAllowNullDecimalField(FieldValues):
+ valid_inputs = {
+ None: None,
+ '': None,
+ ' ': None,
+ }
+ invalid_inputs = {}
+ outputs = {
+ None: '',
+ }
+ field = serializers.DecimalField(max_digits=3, decimal_places=1, allow_null=True)
+
+
+class TestAllowNullNoStringCoercionDecimalField(FieldValues):
+ valid_inputs = {
+ None: None,
+ '': None,
+ ' ': None,
+ }
+ invalid_inputs = {}
+ outputs = {
+ None: None,
+ }
+ field = serializers.DecimalField(max_digits=3, decimal_places=1, allow_null=True, coerce_to_string=False)
+
+
class TestMinMaxDecimalField(FieldValues):
"""
Valid and invalid values for `DecimalField` with min and max limits.
@@ -1134,6 +1163,30 @@ class TestMinMaxDecimalField(FieldValues):
)
+class TestAllowEmptyStrDecimalFieldWithValidators(FieldValues):
+ """
+ Check that empty string ('', ' ') is acceptable value for the DecimalField
+ if allow_null=True and there are max/min validators
+ """
+ valid_inputs = {
+ None: None,
+ '': None,
+ ' ': None,
+ ' ': None,
+ 5: Decimal('5'),
+ '0': Decimal('0'),
+ '10': Decimal('10'),
+ }
+ invalid_inputs = {
+ -1: ['Ensure this value is greater than or equal to 0.'],
+ 11: ['Ensure this value is less than or equal to 10.'],
+ }
+ outputs = {
+ None: '',
+ }
+ field = serializers.DecimalField(max_digits=3, decimal_places=1, allow_null=True, min_value=0, max_value=10)
+
+
class TestNoMaxDigitsDecimalField(FieldValues):
field = serializers.DecimalField(
max_value=100, min_value=0,
@@ -1167,12 +1220,12 @@ class TestNoStringCoercionDecimalField(FieldValues):
class TestLocalizedDecimalField(TestCase):
- @override_settings(USE_L10N=True, LANGUAGE_CODE='pl')
+ @override_settings(LANGUAGE_CODE='pl')
def test_to_internal_value(self):
field = serializers.DecimalField(max_digits=2, decimal_places=1, localize=True)
assert field.to_internal_value('1,1') == Decimal('1.1')
- @override_settings(USE_L10N=True, LANGUAGE_CODE='pl')
+ @override_settings(LANGUAGE_CODE='pl')
def test_to_representation(self):
field = serializers.DecimalField(max_digits=2, decimal_places=1, localize=True)
assert field.to_representation(Decimal('1.1')) == '1,1'
@@ -1411,15 +1464,24 @@ def setup_class(cls):
cls.field = serializers.DateTimeField()
cls.kolkata = pytz.timezone('Asia/Kolkata')
+ def assertUTC(self, tzinfo):
+ """
+ Check UTC for datetime.timezone, ZoneInfo, and pytz tzinfo instances.
+ """
+ assert (
+ tzinfo is utc or
+ (getattr(tzinfo, "key", None) or getattr(tzinfo, "zone", None)) == "UTC"
+ )
+
def test_default_timezone(self):
- assert self.field.default_timezone() == utc
+ self.assertUTC(self.field.default_timezone())
def test_current_timezone(self):
- assert self.field.default_timezone() == utc
+ self.assertUTC(self.field.default_timezone())
activate(self.kolkata)
assert self.field.default_timezone() == self.kolkata
deactivate()
- assert self.field.default_timezone() == utc
+ self.assertUTC(self.field.default_timezone())
@pytest.mark.skipif(pytz is None, reason='pytz not installed')
@@ -1456,7 +1518,7 @@ class TestNaiveDayLightSavingTimeTimeZoneDateTimeField(FieldValues):
}
outputs = {}
- class MockTimezone:
+ class MockTimezone(pytz.BaseTzInfo):
@staticmethod
def localize(value, is_dst):
raise pytz.InvalidTimeError()
@@ -1957,6 +2019,11 @@ def test_collection_types_are_invalid_input(self):
field.to_internal_value(input_value)
assert exc_info.value.detail == ['Expected a list of items but got type "dict".']
+ def test_constructor_misuse_raises(self):
+ # Test that `ListField` can only be instantiated with keyword arguments
+ with pytest.raises(TypeError):
+ serializers.ListField(serializers.CharField())
+
class TestNestedListField(FieldValues):
"""
diff --git a/tests/test_filters.py b/tests/test_filters.py
index 567e5f83fc..37ae4c7cf3 100644
--- a/tests/test_filters.py
+++ b/tests/test_filters.py
@@ -424,6 +424,10 @@ class OrderingFilterModel(models.Model):
title = models.CharField(max_length=20, verbose_name='verbose title')
text = models.CharField(max_length=100)
+ @property
+ def description(self):
+ return self.title + ": " + self.text
+
class OrderingFilterRelatedModel(models.Model):
related_object = models.ForeignKey(OrderingFilterModel, related_name="relateds", on_delete=models.CASCADE)
@@ -436,6 +440,17 @@ class Meta:
fields = '__all__'
+class OrderingFilterSerializerWithModelProperty(serializers.ModelSerializer):
+ class Meta:
+ model = OrderingFilterModel
+ fields = (
+ "id",
+ "title",
+ "text",
+ "description"
+ )
+
+
class OrderingDottedRelatedSerializer(serializers.ModelSerializer):
related_text = serializers.CharField(source='related_object.text')
related_title = serializers.CharField(source='related_object.title')
@@ -551,6 +566,42 @@ class OrderingListView(generics.ListAPIView):
{'id': 1, 'title': 'zyx', 'text': 'abc'},
]
+ def test_ordering_without_ordering_fields(self):
+ class OrderingListView(generics.ListAPIView):
+ queryset = OrderingFilterModel.objects.all()
+ serializer_class = OrderingFilterSerializerWithModelProperty
+ filter_backends = (filters.OrderingFilter,)
+ ordering = ('title',)
+
+ view = OrderingListView.as_view()
+
+ # Model field ordering works fine.
+ request = factory.get('/', {'ordering': 'text'})
+ response = view(request)
+ assert response.data == [
+ {'id': 1, 'title': 'zyx', 'text': 'abc', 'description': 'zyx: abc'},
+ {'id': 2, 'title': 'yxw', 'text': 'bcd', 'description': 'yxw: bcd'},
+ {'id': 3, 'title': 'xwv', 'text': 'cde', 'description': 'xwv: cde'},
+ ]
+
+ # `incorrectfield` ordering works fine.
+ request = factory.get('/', {'ordering': 'foobar'})
+ response = view(request)
+ assert response.data == [
+ {'id': 3, 'title': 'xwv', 'text': 'cde', 'description': 'xwv: cde'},
+ {'id': 2, 'title': 'yxw', 'text': 'bcd', 'description': 'yxw: bcd'},
+ {'id': 1, 'title': 'zyx', 'text': 'abc', 'description': 'zyx: abc'},
+ ]
+
+ # `description` is a Model property, which should be ignored.
+ request = factory.get('/', {'ordering': 'description'})
+ response = view(request)
+ assert response.data == [
+ {'id': 3, 'title': 'xwv', 'text': 'cde', 'description': 'xwv: cde'},
+ {'id': 2, 'title': 'yxw', 'text': 'bcd', 'description': 'yxw: bcd'},
+ {'id': 1, 'title': 'zyx', 'text': 'abc', 'description': 'zyx: abc'},
+ ]
+
def test_default_ordering(self):
class OrderingListView(generics.ListAPIView):
queryset = OrderingFilterModel.objects.all()
diff --git a/tests/test_relations.py b/tests/test_relations.py
index 92aeecf6c4..bb719a65a9 100644
--- a/tests/test_relations.py
+++ b/tests/test_relations.py
@@ -107,6 +107,12 @@ def test_pk_related_lookup_invalid_type(self):
msg = excinfo.value.detail[0]
assert msg == 'Incorrect type. Expected pk value, received BadType.'
+ def test_pk_related_lookup_bool(self):
+ with pytest.raises(serializers.ValidationError) as excinfo:
+ self.field.to_internal_value(True)
+ msg = excinfo.value.detail[0]
+ assert msg == 'Incorrect type. Expected pk value, received bool.'
+
def test_pk_representation(self):
representation = self.field.to_representation(self.instance)
assert representation == self.instance.pk
diff --git a/tests/test_serializer_lists.py b/tests/test_serializer_lists.py
index f35c4fcc9e..551f626662 100644
--- a/tests/test_serializer_lists.py
+++ b/tests/test_serializer_lists.py
@@ -616,3 +616,70 @@ def test_nested_serializer_with_list_multipart(self):
assert serializer.is_valid()
assert serializer.validated_data == []
+
+
+class TestMaxMinLengthListSerializer:
+ """
+ Tests the behaviour of ListSerializers when max_length and min_length are used
+ """
+
+ def setup(self):
+ class IntegerSerializer(serializers.Serializer):
+ some_int = serializers.IntegerField()
+
+ class MaxLengthSerializer(serializers.Serializer):
+ many_int = IntegerSerializer(many=True, max_length=5)
+
+ class MinLengthSerializer(serializers.Serializer):
+ many_int = IntegerSerializer(many=True, min_length=3)
+
+ class MaxMinLengthSerializer(serializers.Serializer):
+ many_int = IntegerSerializer(many=True, min_length=3, max_length=5)
+
+ self.MaxLengthSerializer = MaxLengthSerializer
+ self.MinLengthSerializer = MinLengthSerializer
+ self.MaxMinLengthSerializer = MaxMinLengthSerializer
+
+ def test_min_max_length_two_items(self):
+ input_data = {'many_int': [{'some_int': i} for i in range(2)]}
+
+ max_serializer = self.MaxLengthSerializer(data=input_data)
+ min_serializer = self.MinLengthSerializer(data=input_data)
+ max_min_serializer = self.MaxMinLengthSerializer(data=input_data)
+
+ assert max_serializer.is_valid()
+ assert max_serializer.validated_data == input_data
+
+ assert not min_serializer.is_valid()
+
+ assert not max_min_serializer.is_valid()
+
+ def test_min_max_length_four_items(self):
+ input_data = {'many_int': [{'some_int': i} for i in range(4)]}
+
+ max_serializer = self.MaxLengthSerializer(data=input_data)
+ min_serializer = self.MinLengthSerializer(data=input_data)
+ max_min_serializer = self.MaxMinLengthSerializer(data=input_data)
+
+ assert max_serializer.is_valid()
+ assert max_serializer.validated_data == input_data
+
+ assert min_serializer.is_valid()
+ assert min_serializer.validated_data == input_data
+
+ assert max_min_serializer.is_valid()
+ assert min_serializer.validated_data == input_data
+
+ def test_min_max_length_six_items(self):
+ input_data = {'many_int': [{'some_int': i} for i in range(6)]}
+
+ max_serializer = self.MaxLengthSerializer(data=input_data)
+ min_serializer = self.MinLengthSerializer(data=input_data)
+ max_min_serializer = self.MaxMinLengthSerializer(data=input_data)
+
+ assert not max_serializer.is_valid()
+
+ assert min_serializer.is_valid()
+ assert min_serializer.validated_data == input_data
+
+ assert not max_min_serializer.is_valid()
diff --git a/tests/test_status.py b/tests/test_status.py
index 07d893bee9..b10f7df994 100644
--- a/tests/test_status.py
+++ b/tests/test_status.py
@@ -1,8 +1,7 @@
from django.test import TestCase
from rest_framework.status import (
- is_client_error, is_informational, is_redirect, is_server_error,
- is_success
+ is_client_error, is_informational, is_redirect, is_server_error, is_success
)
diff --git a/tests/test_testing.py b/tests/test_testing.py
index cc60e4f003..5066ee142e 100644
--- a/tests/test_testing.py
+++ b/tests/test_testing.py
@@ -1,5 +1,6 @@
from io import BytesIO
+import django
from django.contrib.auth.models import User
from django.shortcuts import redirect
from django.test import TestCase, override_settings
@@ -282,6 +283,10 @@ def test_empty_request_content_type(self):
assert request.META['CONTENT_TYPE'] == 'application/json'
+def check_urlpatterns(cls):
+ assert urlpatterns is not cls.urlpatterns
+
+
class TestUrlPatternTestCase(URLPatternsTestCase):
urlpatterns = [
path('', view),
@@ -293,11 +298,18 @@ def setUpClass(cls):
super().setUpClass()
assert urlpatterns is cls.urlpatterns
- @classmethod
- def tearDownClass(cls):
- assert urlpatterns is cls.urlpatterns
- super().tearDownClass()
- assert urlpatterns is not cls.urlpatterns
+ if django.VERSION > (4, 0):
+ cls.addClassCleanup(
+ check_urlpatterns,
+ cls
+ )
+
+ if django.VERSION < (4, 0):
+ @classmethod
+ def tearDownClass(cls):
+ assert urlpatterns is cls.urlpatterns
+ super().tearDownClass()
+ assert urlpatterns is not cls.urlpatterns
def test_urlpatterns(self):
assert self.client.get('/').status_code == 200
diff --git a/tests/test_validation_error.py b/tests/test_validation_error.py
index 562fe37e6b..341c4342a5 100644
--- a/tests/test_validation_error.py
+++ b/tests/test_validation_error.py
@@ -2,6 +2,7 @@
from rest_framework import serializers, status
from rest_framework.decorators import api_view
+from rest_framework.exceptions import ValidationError
from rest_framework.response import Response
from rest_framework.settings import api_settings
from rest_framework.test import APIRequestFactory
@@ -99,3 +100,12 @@ def test_function_based_view_exception_handler(self):
response = view(request)
assert response.status_code == status.HTTP_400_BAD_REQUEST
assert response.data == self.expected_response_data
+
+
+class TestValidationErrorConvertsTuplesToLists(TestCase):
+ def test_validation_error_details(self):
+ error = ValidationError(detail=('message1', 'message2'))
+ assert isinstance(error.detail, list)
+ assert len(error.detail) == 2
+ assert str(error.detail[0]) == 'message1'
+ assert str(error.detail[1]) == 'message2'
diff --git a/tests/test_validators.py b/tests/test_validators.py
index 4962cf5816..bccbe1514b 100644
--- a/tests/test_validators.py
+++ b/tests/test_validators.py
@@ -7,8 +7,7 @@
from rest_framework import serializers
from rest_framework.exceptions import ValidationError
from rest_framework.validators import (
- BaseUniqueForValidator, UniqueTogetherValidator, UniqueValidator,
- qs_exists
+ BaseUniqueForValidator, UniqueTogetherValidator, UniqueValidator, qs_exists
)
diff --git a/tox.ini b/tox.ini
index df6387d5e1..a41176d72f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,29 +1,31 @@
[tox]
envlist =
- {py35,py36,py37}-django22,
- {py36,py37,py38}-django30,
+ {py36,py37,py38,py39}-django22,
{py36,py37,py38,py39}-django31,
- {py36,py37,py38,py39}-djangomaster,
- base,dist,lint,docs,
+ {py36,py37,py38,py39,py310}-django32,
+ {py38,py39,py310}-{django40,djangomain},
+ base,dist,docs,
[travis:env]
DJANGO =
2.2: django22
- 3.0: django30
3.1: django31
- master: djangomaster
+ 3.2: django32
+ 4.0: django40
+ main: djangomain
[testenv]
-commands = python -W error::DeprecationWarning -W error::PendingDeprecationWarning runtests.py --fast --coverage {posargs}
+commands = python -W error::DeprecationWarning -W error::PendingDeprecationWarning runtests.py --coverage {posargs}
envdir = {toxworkdir}/venvs/{envname}
setenv =
PYTHONDONTWRITEBYTECODE=1
PYTHONWARNINGS=once
deps =
django22: Django>=2.2,<3.0
- django30: Django>=3.0,<3.1
django31: Django>=3.1,<3.2
- djangomaster: https://github.com/django/django/archive/master.tar.gz
+ django32: Django>=3.2,<4.0
+ django40: Django>=4.0,<5.0
+ djangomain: https://github.com/django/django/archive/main.tar.gz
-rrequirements/requirements-testing.txt
-rrequirements/requirements-optionals.txt
@@ -34,21 +36,24 @@ deps =
-rrequirements/requirements-testing.txt
[testenv:dist]
-commands = ./runtests.py --fast --no-pkgroot --staticfiles {posargs}
+commands = ./runtests.py --no-pkgroot --staticfiles {posargs}
deps =
django
-rrequirements/requirements-testing.txt
-rrequirements/requirements-optionals.txt
-[testenv:lint]
-commands = ./runtests.py --lintonly
-deps =
- -rrequirements/requirements-codestyle.txt
- -rrequirements/requirements-testing.txt
-
[testenv:docs]
skip_install = true
commands = mkdocs build
deps =
-rrequirements/requirements-testing.txt
-rrequirements/requirements-documentation.txt
+
+[testenv:py38-djangomain]
+ignore_outcome = true
+
+[testenv:py39-djangomain]
+ignore_outcome = true
+
+[testenv:py310-djangomain]
+ignore_outcome = true