From 9ea615af14303663a47fd155ab541d8302d609e4 Mon Sep 17 00:00:00 2001 From: donewell Date: Tue, 10 Feb 2015 17:41:03 +0000 Subject: [PATCH 001/487] add message to custom permission change detail to message and update text --- docs/api-guide/permissions.md | 10 ++++ rest_framework/views.py | 8 +++- tests/test_permissions.py | 86 +++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+), 1 deletion(-) diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md index 743ca435..e299b418 100644 --- a/docs/api-guide/permissions.md +++ b/docs/api-guide/permissions.md @@ -205,6 +205,16 @@ If you need to test if a request is a read operation or a write operation, you s --- +Custom permissions will raise a `PermissionDenied` exception if the test fails. To change the error message associated with the exception, implement a `message` attribute directly on your custom permission. Otherwise the `default_detail` attribute from `PermissionDenied` will be used. + + from rest_framework import permissions + + class CustomerAccessPermission(permissions.BasePermission): + message = 'Adding customers not allowed.' + + def has_permission(self, request, view): + ... + ## Examples The following is an example of a permission class that checks the incoming request's IP address against a blacklist, and denies the request if the IP has been blacklisted. diff --git a/rest_framework/views.py b/rest_framework/views.py index bc870417..4fa97124 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -134,12 +134,14 @@ class APIView(View): """ raise exceptions.MethodNotAllowed(request.method) - def permission_denied(self, request): + def permission_denied(self, request, message=None): """ If request is not permitted, determine what kind of exception to raise. """ if not request.successful_authenticator: raise exceptions.NotAuthenticated() + if message is not None: + raise exceptions.PermissionDenied(message) raise exceptions.PermissionDenied() def throttled(self, request, wait): @@ -280,6 +282,8 @@ class APIView(View): """ for permission in self.get_permissions(): if not permission.has_permission(request, self): + if hasattr(permission, 'message'): + self.permission_denied(request, permission.message) self.permission_denied(request) def check_object_permissions(self, request, obj): @@ -289,6 +293,8 @@ class APIView(View): """ for permission in self.get_permissions(): if not permission.has_object_permission(request, self, obj): + if hasattr(permission, 'message'): + self.permission_denied(request, permission.message) self.permission_denied(request) def check_throttles(self, request): diff --git a/tests/test_permissions.py b/tests/test_permissions.py index 97bac33d..68d34785 100644 --- a/tests/test_permissions.py +++ b/tests/test_permissions.py @@ -310,3 +310,89 @@ class ObjectPermissionsIntegrationTests(TestCase): response = object_permissions_list_view(request) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertListEqual(response.data, []) + + +class BasicPerm(permissions.BasePermission): + def has_permission(self, request, view): + return False + + +class BasicPermWithDetail(permissions.BasePermission): + message = 'Custom: You cannot post to this resource' + + def has_permission(self, request, view): + return False + + +class BasicObjectPerm(permissions.BasePermission): + def has_object_permission(self, request, view, obj): + return False + + +class BasicObjectPermWithDetail(permissions.BasePermission): + message = 'Custom: You cannot post to this resource' + + def has_object_permission(self, request, view, obj): + return False + + +class PermissionInstanceView(generics.RetrieveUpdateDestroyAPIView): + queryset = BasicModel.objects.all() + serializer_class = BasicSerializer + + +class DeniedView(PermissionInstanceView): + permission_classes = (BasicPerm,) + + +class DeniedViewWithDetail(PermissionInstanceView): + permission_classes = (BasicPermWithDetail,) + + +class DeniedObjectView(PermissionInstanceView): + permission_classes = (BasicObjectPerm,) + + +class DeniedObjectViewWithDetail(PermissionInstanceView): + permission_classes = (BasicObjectPermWithDetail,) + +denied_view = DeniedView.as_view() + +denied_view_with_detail = DeniedViewWithDetail.as_view() + +denied_object_view = DeniedObjectView.as_view() + +denied_object_view_with_detail = DeniedObjectViewWithDetail.as_view() + + +class CustomPermissionsTests(TestCase): + def setUp(self): + BasicModel(text='foo').save() + User.objects.create_user('username', 'username@example.com', 'password') + credentials = basic_auth_header('username', 'password') + self.request = factory.get('/1', format='json', HTTP_AUTHORIZATION=credentials) + self.custom_message = 'Custom: You cannot post to this resource' + + def test_permission_denied(self): + response = denied_view(self.request, pk=1) + detail = response.data.get('detail') + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertNotEqual(detail, self.custom_message) + + def test_permission_denied_with_custom_detail(self): + response = denied_view_with_detail(self.request, pk=1) + detail = response.data.get('detail') + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(detail, self.custom_message) + + def test_permission_denied_for_object(self): + response = denied_object_view(self.request, pk=1) + detail = response.data.get('detail') + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertNotEqual(detail, self.custom_message) + + def test_permission_denied_for_object_with_custom_detail(self): + response = denied_object_view_with_detail(self.request, pk=1) + detail = response.data.get('detail') + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(detail, self.custom_message) From 9a9a00bff2f61d08573f764012e389e7f8e5c6ae Mon Sep 17 00:00:00 2001 From: donewell Date: Wed, 11 Feb 2015 11:15:01 +0000 Subject: [PATCH 002/487] simplify argument handling --- rest_framework/views.py | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/rest_framework/views.py b/rest_framework/views.py index 4fa97124..435796c4 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -140,9 +140,7 @@ class APIView(View): """ if not request.successful_authenticator: raise exceptions.NotAuthenticated() - if message is not None: - raise exceptions.PermissionDenied(message) - raise exceptions.PermissionDenied() + raise exceptions.PermissionDenied(detail=message) def throttled(self, request, wait): """ @@ -282,9 +280,9 @@ class APIView(View): """ for permission in self.get_permissions(): if not permission.has_permission(request, self): - if hasattr(permission, 'message'): - self.permission_denied(request, permission.message) - self.permission_denied(request) + self.permission_denied( + request, message=getattr(permission, 'message', None) + ) def check_object_permissions(self, request, obj): """ @@ -293,9 +291,9 @@ class APIView(View): """ for permission in self.get_permissions(): if not permission.has_object_permission(request, self, obj): - if hasattr(permission, 'message'): - self.permission_denied(request, permission.message) - self.permission_denied(request) + self.permission_denied( + request, message=getattr(permission, 'message', None) + ) def check_throttles(self, request): """ From 3d25dadbf36930439f6cb5bfa81166c0ddcf0b38 Mon Sep 17 00:00:00 2001 From: donewell Date: Wed, 11 Feb 2015 11:20:03 +0000 Subject: [PATCH 003/487] change custom message for clarity --- tests/test_permissions.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/test_permissions.py b/tests/test_permissions.py index 68d34785..2c0caa48 100644 --- a/tests/test_permissions.py +++ b/tests/test_permissions.py @@ -318,7 +318,7 @@ class BasicPerm(permissions.BasePermission): class BasicPermWithDetail(permissions.BasePermission): - message = 'Custom: You cannot post to this resource' + message = 'Custom: You cannot access this resource' def has_permission(self, request, view): return False @@ -330,7 +330,7 @@ class BasicObjectPerm(permissions.BasePermission): class BasicObjectPermWithDetail(permissions.BasePermission): - message = 'Custom: You cannot post to this resource' + message = 'Custom: You cannot access this resource' def has_object_permission(self, request, view, obj): return False @@ -371,7 +371,7 @@ class CustomPermissionsTests(TestCase): User.objects.create_user('username', 'username@example.com', 'password') credentials = basic_auth_header('username', 'password') self.request = factory.get('/1', format='json', HTTP_AUTHORIZATION=credentials) - self.custom_message = 'Custom: You cannot post to this resource' + self.custom_message = 'Custom: You cannot access this resource' def test_permission_denied(self): response = denied_view(self.request, pk=1) From c20a0250dfbcd0b86ffd23f4657cf050ce6a2a2a Mon Sep 17 00:00:00 2001 From: Aider Ibragimov Date: Tue, 3 Mar 2015 14:34:06 +0300 Subject: [PATCH 004/487] add FilePathField, update docs --- docs/api-guide/fields.md | 14 ++++++++++++++ rest_framework/fields.py | 38 ++++++++++++++++++++++++++++++++++++- rest_framework/renderers.py | 5 ++++- tests/test_fields.py | 28 +++++++++++++++++++++++---- 4 files changed, 79 insertions(+), 6 deletions(-) diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index f113bb23..1117fb8c 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -189,6 +189,20 @@ A field that ensures the input is a valid UUID string. The `to_internal_value` m "de305d54-75b4-431b-adb2-eb6b9e546013" +## FilePathField + +A field whose choices are limited to the filenames in a certain directory on the filesystem + +Corresponds to `django.forms.fields.FilePathField`. + +**Signature:** `FilePathField(path, match=None, recursive=False, allow_files=True, allow_folders=False, required=None, **kwargs)` + +- `path` - The absolute filesystem path to a directory from which this FilePathField should get its choice. +- `match` - A regular expression, as a string, that FilePathField will use to filter filenames. +- `recursive` - Specifies whether all subdirectories of path should be included. Default is `False`. +- `allow_files` - Specifies whether files in the specified location should be included. Default is `True`. Either this or `allow_folders` must be `True`. +- `allow_folders` - Specifies whether folders in the specified location should be included. Default is `False`. Either this or `allow_files` must be `True`. + --- # Numeric fields diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 13301f31..e99e6047 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -3,7 +3,9 @@ from django.conf import settings from django.core.exceptions import ObjectDoesNotExist from django.core.exceptions import ValidationError as DjangoValidationError from django.core.validators import RegexValidator -from django.forms import ImageField as DjangoImageField +from django.forms import ( + ImageField as DjangoImageField, FilePathField as DjangoFilePathField +) from django.utils import six, timezone from django.utils.dateparse import parse_date, parse_datetime, parse_time from django.utils.encoding import is_protected_type, smart_text @@ -653,6 +655,40 @@ class UUIDField(Field): return str(value) +class FilePathField(CharField): + default_error_messages = { + 'invalid_choice': _('"{input}" is not a valid path choice.') + } + + def __init__(self, path, match=None, recursive=False, allow_files=True, + allow_folders=False, required=None, **kwargs): + super(FilePathField, self).__init__(**kwargs) + # create field and get options to avoid code duplication + field = DjangoFilePathField( + path, match=match, recursive=recursive, allow_files=allow_files, + allow_folders=allow_folders, required=required + ) + + self.choices = OrderedDict(field.choices) + self.choice_strings_to_values = { + six.text_type(key): key for key in self.choices.keys() + } + + def to_internal_value(self, data): + if data == '' and self.allow_blank: + return '' + + try: + return self.choice_strings_to_values[six.text_type(data)] + except KeyError: + self.fail('invalid_choice', input=data) + + def to_representation(self, value): + if value in ('', None): + return value + return self.choice_strings_to_values[six.text_type(value)] + + # Number types... class IntegerField(Field): diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 920d2bc4..134b41b3 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -301,7 +301,10 @@ class HTMLFormRenderer(BaseRenderer): }, serializers.ListSerializer: { 'base_template': 'list_fieldset.html' - } + }, + serializers.FilePathField: { + 'base_template': 'select.html', + }, }) def render_field(self, field, parent_style): diff --git a/tests/test_fields.py b/tests/test_fields.py index 7f5f8102..3d2138a0 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1,10 +1,12 @@ -from decimal import Decimal -from django.utils import timezone -from rest_framework import serializers import datetime +import os +import uuid +from decimal import Decimal + import django import pytest -import uuid +from django.utils import timezone +from rest_framework import serializers # Tests for field keyword arguments and core functionality. @@ -518,6 +520,24 @@ class TestUUIDField(FieldValues): field = serializers.UUIDField() +class TestFilePathField(FieldValues): + """ + Valid and invalid values for `FilePathField` + """ + + valid_inputs = { + __file__: __file__, + } + invalid_inputs = { + 'wrong_path': ['"wrong_path" is not a valid path choice.'] + } + outputs = { + } + field = serializers.FilePathField( + path=os.path.abspath(os.path.dirname(__file__)) + ) + + # Number types... class TestIntegerField(FieldValues): From 04cc1964bd84b78d328ecdd2735b884ea075a877 Mon Sep 17 00:00:00 2001 From: Aider Ibragimov Date: Tue, 3 Mar 2015 16:45:20 +0300 Subject: [PATCH 005/487] remove dict compehension --- rest_framework/fields.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 63fb0ae8..b6f049ea 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -672,9 +672,9 @@ class FilePathField(CharField): ) self.choices = OrderedDict(field.choices) - self.choice_strings_to_values = { - six.text_type(key): key for key in self.choices.keys() - } + self.choice_strings_to_values = dict([ + (six.text_type(key), key) for key in self.choices.keys() + ]) def to_internal_value(self, data): if data == '' and self.allow_blank: From e5d95e319e127c1da39f7b227abd0d00654f4b72 Mon Sep 17 00:00:00 2001 From: Aider Ibragimov Date: Tue, 3 Mar 2015 16:58:04 +0300 Subject: [PATCH 006/487] fix FilePathField kwargs for django < 1.5 --- rest_framework/fields.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index b6f049ea..f2e0d9a4 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -23,6 +23,7 @@ import collections import copy import datetime import decimal +import django import inspect import re import uuid @@ -665,11 +666,18 @@ class FilePathField(CharField): def __init__(self, path, match=None, recursive=False, allow_files=True, allow_folders=False, required=None, **kwargs): super(FilePathField, self).__init__(**kwargs) + # create field and get options to avoid code duplication - field = DjangoFilePathField( - path, match=match, recursive=recursive, allow_files=allow_files, - allow_folders=allow_folders, required=required - ) + if django.VERSION < (1, 5): + # django field doesn't have allow_folders, allow_files kwargs + field = DjangoFilePathField( + path, match=match, recursive=recursive, required=required + ) + else: + field = DjangoFilePathField( + path, match=match, recursive=recursive, allow_files=allow_files, + allow_folders=allow_folders, required=required + ) self.choices = OrderedDict(field.choices) self.choice_strings_to_values = dict([ From 8ba66e2c10803fa53a6c2b3d1bae19311bb797f3 Mon Sep 17 00:00:00 2001 From: Quentin Pradet Date: Fri, 20 Mar 2015 15:06:30 +0100 Subject: [PATCH 007/487] Document per-view versioning settings That is, document the default_version, allowed_version and version_param class variables. --- docs/api-guide/versioning.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/api-guide/versioning.md b/docs/api-guide/versioning.md index a227a4a3..795b46ca 100644 --- a/docs/api-guide/versioning.md +++ b/docs/api-guide/versioning.md @@ -72,6 +72,19 @@ The following settings keys are also used to control versioning: * `ALLOWED_VERSIONS`. If set, this value will restrict the set of versions that may be returned by the versioning scheme, and will raise an error if the provided version if not in this set. Defaults to `None`. * `VERSION_PARAMETER`. The string that should used for any versioning parameters, such as in the media type or URL query parameters. Defaults to `'version'`. +You can also set your versioning class plus those three values on a per-view or a per-viewset basis by defining your own versioning scheme and using the `default_version`, `allowed_versions` and `version_param` class variables. For example, if you want to use `URLPathVersioning`: + + from rest_framework.versioning import URLPathVersioning + from rest_framework.views import APIView + + class ExampleVersioning(URLPathVersioning): + default_version = ... + allowed_versions = ... + version_param = ... + + class ExampleView(APIVIew): + versioning_class = ExampleVersioning + --- # API Reference From b95ef25cbbb4e18dd25b169f79fb282b7f895dd1 Mon Sep 17 00:00:00 2001 From: Udi Oron Date: Thu, 26 Mar 2015 20:13:35 +0200 Subject: [PATCH 008/487] Wrong error message on bad field lookup --- rest_framework/utils/field_mapping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index c97ec5d0..a3ebabfe 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -36,7 +36,7 @@ class ClassLookupDict(object): for cls in inspect.getmro(base_class): if cls in self.mapping: return self.mapping[cls] - raise KeyError('Class %s not found in lookup.', cls.__name__) + raise KeyError('Class %s not found in lookup.' % base_class.__name__) def __setitem__(self, key, value): self.mapping[key] = value From 1ee31735835a10564d33a7b9dfcf1935b9702487 Mon Sep 17 00:00:00 2001 From: Omer Katz Date: Sat, 9 May 2015 14:37:49 +0300 Subject: [PATCH 009/487] Cache fields list for to_internal_value and to_representation. --- rest_framework/serializers.py | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 8e1e50bc..dcee723c 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -14,6 +14,7 @@ from __future__ import unicode_literals from django.db import models from django.db.models.fields import FieldDoesNotExist, Field as DjangoModelField from django.db.models import query +from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from rest_framework.compat import postgres_fields, unicode_to_repr from rest_framework.utils import model_meta @@ -314,6 +315,17 @@ class Serializer(BaseSerializer): self._fields[key] = value return self._fields + @cached_property + def _to_internal_value_fields(self): + return [ + field for field in self.fields.values() + if (not field.read_only) or (field.default is not empty) + ] + + @cached_property + def _to_representation_fields(self): + return [field for field in self.fields.values() if not field.write_only] + def get_fields(self): """ Returns a dictionary of {field_name: field_instance}. @@ -388,10 +400,7 @@ class Serializer(BaseSerializer): ret = OrderedDict() errors = OrderedDict() - fields = [ - field for field in self.fields.values() - if (not field.read_only) or (field.default is not empty) - ] + fields = self._to_internal_value_fields for field in fields: validate_method = getattr(self, 'validate_' + field.field_name, None) @@ -419,7 +428,7 @@ class Serializer(BaseSerializer): Object instance -> Dict of primitive datatypes. """ ret = OrderedDict() - fields = [field for field in self.fields.values() if not field.write_only] + fields = self._to_representation_fields for field in fields: try: From 478b1dbd06d748ecc22f9a4b769e8b305ea37983 Mon Sep 17 00:00:00 2001 From: Marco Vellinga Date: Mon, 11 May 2015 15:28:10 +0200 Subject: [PATCH 010/487] Use get_queryset() for RelatedField choices property instead of self.queryset.all() --- rest_framework/relations.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 00a4a265..d4a63b83 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -109,7 +109,7 @@ class RelatedField(Field): six.text_type(self.to_representation(item)), six.text_type(item) ) - for item in self.queryset.all() + for item in self.get_queryset() ]) From 995aa475706a3df466aad7c136d715cd837a64e1 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 12 May 2015 14:49:09 +0100 Subject: [PATCH 011/487] First pass templates for admin style --- rest_framework/pagination.py | 3 + rest_framework/renderers.py | 37 +++ .../templates/rest_framework/admin.html | 212 ++++++++++++++++++ .../rest_framework/admin/detail.html | 9 + .../templates/rest_framework/admin/list.html | 20 ++ 5 files changed, 281 insertions(+) create mode 100644 rest_framework/templates/rest_framework/admin.html create mode 100644 rest_framework/templates/rest_framework/admin/detail.html create mode 100644 rest_framework/templates/rest_framework/admin/list.html diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index b6be6b7c..b1c88d8d 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -200,6 +200,9 @@ class BasePagination(object): def to_html(self): # pragma: no cover raise NotImplementedError('to_html() must be implemented to display page controls.') + def get_results(self, data): + return data['results'] + class PageNumberPagination(BasePagination): """ diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 6c7cdf53..c439b1f2 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -668,6 +668,43 @@ class BrowsableAPIRenderer(BaseRenderer): return ret +class AdminRenderer(BrowsableAPIRenderer): + template = 'rest_framework/admin.html' + format = 'admin' + + def get_context(self, data, accepted_media_type, renderer_context): + """ + Render the HTML for the browsable API representation. + """ + context = super(AdminRenderer, self).get_context( + data, accepted_media_type, renderer_context + ) + + paginator = getattr(context['view'], 'paginator', None) + try: + results = data if paginator is None else paginator.get_results(data) + except KeyError: + results = data + + if isinstance(results, list): + header = results[0] + style = 'list' + else: + header = results + style = 'detail' + + columns = [key for key in header.keys() if key != 'url'] + details = [key for key in header.keys() if key != 'url'] + linked = [columns[0]] + + context['style'] = style + context['columns'] = columns + context['details'] = details + context['linked'] = linked + context['results'] = results + return context + + class MultiPartRenderer(BaseRenderer): media_type = 'multipart/form-data; boundary=BoUnDaRyStRiNg' format = 'multipart' diff --git a/rest_framework/templates/rest_framework/admin.html b/rest_framework/templates/rest_framework/admin.html new file mode 100644 index 00000000..eec88f8a --- /dev/null +++ b/rest_framework/templates/rest_framework/admin.html @@ -0,0 +1,212 @@ +{% load url from future %} +{% load staticfiles %} +{% load rest_framework %} + + + + {% block head %} + + {% block meta %} + + + {% endblock %} + + {% block title %}Django REST framework{% endblock %} + + {% block style %} + {% block bootstrap_theme %} + + + {% endblock %} + + + {% endblock %} + + {% endblock %} + + + {% block body %} + + +
+ + {% block navbar %} +
+
+ + {% block branding %} + + Django REST framework {{ version }} + + {% endblock %} + +
    + {% block userlinks %} + {% if user.is_authenticated %} + {% optional_logout request user %} + {% else %} + {% optional_login request %} + {% endif %} + {% endblock %} +
+
+
+ {% endblock %} + +
+ {% block breadcrumbs %} + + {% endblock %} + + +
+ + {% if 'GET' in allowed_methods %} +
+
+
+ Format + + + +
+
+
+ {% endif %} + + {% if post_form %} + + {% endif %} + + {% if put_form %} + + {% endif %} + + {% if delete_form %} +
+ {% csrf_token %} + + +
+ {% endif %} + +
+
+

{{ name }}

+
+
+ {% block description %} + {{ description }} + {% endblock %} +
+ + {% if paginator %} + + {% endif %} + +
+ {% if style == 'list' %} + {% include "rest_framework/admin/list.html" %} + {% else %} + {% include "rest_framework/admin/detail.html" %} + {% endif %} +
+ + {% if paginator %} + + {% endif %} +
+ +
+ +
+
+ + + + + + + + {% block script %} + + + + + {% endblock %} + + {% endblock %} + diff --git a/rest_framework/templates/rest_framework/admin/detail.html b/rest_framework/templates/rest_framework/admin/detail.html new file mode 100644 index 00000000..705c203e --- /dev/null +++ b/rest_framework/templates/rest_framework/admin/detail.html @@ -0,0 +1,9 @@ + + + {% for key, value in results.items %} + {% if key in details %} + + {% endif %} + {% endfor %} + +
{{ key|capfirst }}{{ value }}
diff --git a/rest_framework/templates/rest_framework/admin/list.html b/rest_framework/templates/rest_framework/admin/list.html new file mode 100644 index 00000000..c48a72b0 --- /dev/null +++ b/rest_framework/templates/rest_framework/admin/list.html @@ -0,0 +1,20 @@ + + + {% for column in columns%}{% endfor %} + + + {% for row in results %} + + {% for key, value in row.items %} + {% if key in columns %} + + {% endif %} + {% endfor %} + + {% endfor %} + +
{{ column|capfirst }}
+ {% if key in linked %}{% endif %} + {{ value }} + {% if key in linked %}{% endif %} +
From 9a504efd268db1ffeab42682bc4afd43e70707dc Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 12 May 2015 15:21:49 +0100 Subject: [PATCH 012/487] Basic formatting for admin cells --- rest_framework/renderers.py | 4 ++-- .../templates/rest_framework/admin.html | 6 ++---- .../rest_framework/admin/detail.html | 3 ++- .../templates/rest_framework/admin/list.html | 3 ++- rest_framework/templatetags/rest_framework.py | 21 +++++++++++++++++++ 5 files changed, 29 insertions(+), 8 deletions(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index c439b1f2..93400c0b 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -687,7 +687,7 @@ class AdminRenderer(BrowsableAPIRenderer): results = data if isinstance(results, list): - header = results[0] + header = results[0] if results else {} style = 'list' else: header = results @@ -695,7 +695,7 @@ class AdminRenderer(BrowsableAPIRenderer): columns = [key for key in header.keys() if key != 'url'] details = [key for key in header.keys() if key != 'url'] - linked = [columns[0]] + linked = [columns[0]] if columns else [] context['style'] = style context['columns'] = columns diff --git a/rest_framework/templates/rest_framework/admin.html b/rest_framework/templates/rest_framework/admin.html index eec88f8a..336f4315 100644 --- a/rest_framework/templates/rest_framework/admin.html +++ b/rest_framework/templates/rest_framework/admin.html @@ -73,11 +73,9 @@
- Format + Format -
    diff --git a/rest_framework/templates/rest_framework/admin/detail.html b/rest_framework/templates/rest_framework/admin/detail.html index 705c203e..3014743f 100644 --- a/rest_framework/templates/rest_framework/admin/detail.html +++ b/rest_framework/templates/rest_framework/admin/detail.html @@ -1,8 +1,9 @@ +{% load rest_framework %} {% for key, value in results.items %} {% if key in details %} - + {% endif %} {% endfor %} diff --git a/rest_framework/templates/rest_framework/admin/list.html b/rest_framework/templates/rest_framework/admin/list.html index c48a72b0..6b72442c 100644 --- a/rest_framework/templates/rest_framework/admin/list.html +++ b/rest_framework/templates/rest_framework/admin/list.html @@ -1,3 +1,4 @@ +{% load rest_framework %}
    {{ key|capfirst }}{{ value }}
    {{ key|capfirst }}{{ value|format_value }}
    {% for column in columns%}{% endfor %} @@ -9,7 +10,7 @@ {% if key in columns %} {% endif %} diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index bf0dc7b8..c0431b3d 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -8,6 +8,7 @@ from django.utils.safestring import SafeData, mark_safe from django.utils.html import smart_urlquote from rest_framework.renderers import HTMLFormRenderer from rest_framework.utils.urls import replace_query_param +import decimal import re register = template.Library() @@ -104,6 +105,26 @@ def add_class(value, css_class): return value +@register.filter +def format_value(value): + if isinstance(value, (int, float, decimal.Decimal, bool, type(None))): + return mark_safe('%s' % value) + elif isinstance(value, list): + return '' + elif isinstance(value, dict): + return '' + elif isinstance(value, six.string_types): + if ( + (value.startswith('http:') or value.startswith('https:')) and not + re.search(r'\s', value) + ): + return mark_safe('{value}'.format(value=escape(value))) + elif '@' in value and not re.search(r'\s', value): + return mark_safe('{value}'.format(value=escape(value))) + return six.text_type(value) + + + # Bunch of stuff cloned from urlize TRAILING_PUNCTUATION = ['.', ',', ':', ';', '.)', '"', "']", "'}", "'"] WRAPPING_PUNCTUATION = [('(', ')'), ('<', '>'), ('[', ']'), ('<', '>'), From a1421cd4a35dc6f0e80b3c5feb19895af71fcc87 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 12 May 2015 16:18:45 +0100 Subject: [PATCH 013/487] Basic formatting for dict and list values --- .../static/rest_framework/css/default.css | 8 ++++++++ .../rest_framework/admin/dict_value.html | 0 .../templates/rest_framework/admin/list.html | 2 +- .../rest_framework/admin/list_value.html | 11 +++++++++++ rest_framework/templatetags/rest_framework.py | 15 +++++++++++++-- 5 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 rest_framework/templates/rest_framework/admin/dict_value.html create mode 100644 rest_framework/templates/rest_framework/admin/list_value.html diff --git a/rest_framework/static/rest_framework/css/default.css b/rest_framework/static/rest_framework/css/default.css index ede54bd1..7e33aee3 100644 --- a/rest_framework/static/rest_framework/css/default.css +++ b/rest_framework/static/rest_framework/css/default.css @@ -33,6 +33,14 @@ h2, h3 { margin-right: 1em; } +td.nested { + padding: 0 !important; +} + +td.nested > table { + margin: 0; +} + form select, form input, form textarea { width: 90%; } diff --git a/rest_framework/templates/rest_framework/admin/dict_value.html b/rest_framework/templates/rest_framework/admin/dict_value.html new file mode 100644 index 00000000..e69de29b diff --git a/rest_framework/templates/rest_framework/admin/list.html b/rest_framework/templates/rest_framework/admin/list.html index 6b72442c..e8c547a6 100644 --- a/rest_framework/templates/rest_framework/admin/list.html +++ b/rest_framework/templates/rest_framework/admin/list.html @@ -8,7 +8,7 @@ {% for key, value in row.items %} {% if key in columns %} - {% for key, value in results.items %} {% if key in details %} - + {% endif %} {% endfor %} From 7813d2fb35cb636116186bddcb58644684ee2723 Mon Sep 17 00:00:00 2001 From: tony Date: Thu, 14 May 2015 13:57:36 +0300 Subject: [PATCH 015/487] fix DISTINCT for Oracle databases --- rest_framework/filters.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 9a84efa2..0dea2434 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -7,6 +7,7 @@ from __future__ import unicode_literals from django.core.exceptions import ImproperlyConfigured from django.db import models from django.utils import six +from django.conf import settings from rest_framework.compat import django_filters, guardian, get_model_name from rest_framework.settings import api_settings from functools import reduce @@ -104,7 +105,9 @@ class SearchFilter(BaseFilterBackend): for search_term in self.get_search_terms(request): or_queries = [models.Q(**{orm_lookup: search_term}) for orm_lookup in orm_lookups] - queryset = queryset.filter(reduce(operator.or_, or_queries)).distinct() + queryset = queryset.filter(reduce(operator.or_, or_queries)) + if settings.DATABASES[queryset.db]["ENGINE"] != "django.db.backends.oracle": + queryset = queryset.distinct() return queryset From c47ec60ea21907a29746e310ec1bc9ab124f9d5a Mon Sep 17 00:00:00 2001 From: tony Date: Thu, 14 May 2015 17:04:22 +0300 Subject: [PATCH 016/487] no need to do distinct on every loop cycle & add analogue of distinct for oracle users --- rest_framework/filters.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 0dea2434..743469f8 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -106,9 +106,12 @@ class SearchFilter(BaseFilterBackend): or_queries = [models.Q(**{orm_lookup: search_term}) for orm_lookup in orm_lookups] queryset = queryset.filter(reduce(operator.or_, or_queries)) - if settings.DATABASES[queryset.db]["ENGINE"] != "django.db.backends.oracle": - queryset = queryset.distinct() + if settings.DATABASES[queryset.db]["ENGINE"] != "django.db.backends.oracle": + queryset = queryset.distinct() + else: + pk_list = queryset.values_list('pk', flat=True) + queryset = view.model.objects.filter(pk__in=set(pk_list)) return queryset From b4d82a0f55347e898f954830d7320f9fd8c316cb Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 15 May 2015 09:18:45 +0100 Subject: [PATCH 017/487] Preserve format query param --- rest_framework/reverse.py | 14 ++++++++++---- .../static/rest_framework/css/default.css | 2 +- rest_framework/templates/rest_framework/admin.html | 9 +++------ 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/rest_framework/reverse.py b/rest_framework/reverse.py index e6d3f563..7235ac5d 100644 --- a/rest_framework/reverse.py +++ b/rest_framework/reverse.py @@ -6,6 +6,8 @@ from django.core.urlresolvers import reverse as django_reverse from django.core.urlresolvers import NoReverseMatch from django.utils import six from django.utils.functional import lazy +from rest_framework.settings import api_settings +from rest_framework.utils.urls import replace_query_param def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra): @@ -17,14 +19,18 @@ def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra scheme = getattr(request, 'versioning_scheme', None) if scheme is not None: try: - return scheme.reverse(viewname, args, kwargs, request, format, **extra) + url = scheme.reverse(viewname, args, kwargs, request, format, **extra) except NoReverseMatch: # In case the versioning scheme reversal fails, fallback to the # default implementation - pass - - return _reverse(viewname, args, kwargs, request, format, **extra) + url = _reverse(viewname, args, kwargs, request, format, **extra) + else: + url = _reverse(viewname, args, kwargs, request, format, **extra) + FORMAT_OVERRIDE = api_settings.URL_FORMAT_OVERRIDE + if FORMAT_OVERRIDE and (FORMAT_OVERRIDE in request.query_params): + return replace_query_param(url, FORMAT_OVERRIDE, request.query_params[FORMAT_OVERRIDE]) + return url def _reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra): """ diff --git a/rest_framework/static/rest_framework/css/default.css b/rest_framework/static/rest_framework/css/default.css index 7e33aee3..f6c67546 100644 --- a/rest_framework/static/rest_framework/css/default.css +++ b/rest_framework/static/rest_framework/css/default.css @@ -3,7 +3,7 @@ content running up underneath it. */ h1 { - font-weight: 500; + font-weight: 300; } h2, h3 { diff --git a/rest_framework/templates/rest_framework/admin.html b/rest_framework/templates/rest_framework/admin.html index 336f4315..39f2127c 100644 --- a/rest_framework/templates/rest_framework/admin.html +++ b/rest_framework/templates/rest_framework/admin.html @@ -73,18 +73,15 @@
    - Format -
      {% for format in available_formats %}
    • - + rel="nofollow"> {{ format }}
      • From de95598a1ed7f1b609b9dbc6415655be65fae4a8 Mon Sep 17 00:00:00 2001 From: tony Date: Fri, 15 May 2015 13:46:56 +0300 Subject: [PATCH 018/487] removed using `view.model.objects` --- rest_framework/filters.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 743469f8..1ef4c7fa 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -101,18 +101,17 @@ class SearchFilter(BaseFilterBackend): orm_lookups = [self.construct_search(six.text_type(search_field)) for search_field in search_fields] - + and_queries = [] for search_term in self.get_search_terms(request): or_queries = [models.Q(**{orm_lookup: search_term}) for orm_lookup in orm_lookups] - queryset = queryset.filter(reduce(operator.or_, or_queries)) + and_queries.append(reduce(operator.or_, or_queries)) - if settings.DATABASES[queryset.db]["ENGINE"] != "django.db.backends.oracle": - queryset = queryset.distinct() + if settings.DATABASES[queryset.db]["ENGINE"] == "django.db.backends.oracle": + pk_list = queryset.filter(reduce(operator.and_, and_queries)).values_list('pk', flat=True) + return queryset.filter(pk__in=frozenset(pk_list)) else: - pk_list = queryset.values_list('pk', flat=True) - queryset = view.model.objects.filter(pk__in=set(pk_list)) - return queryset + return queryset.filter(reduce(operator.and_, and_queries)).distinct() class OrderingFilter(BaseFilterBackend): From 0906bf2c08e67eb43789ef976a784a4da01a08bc Mon Sep 17 00:00:00 2001 From: tony Date: Fri, 15 May 2015 16:44:12 +0300 Subject: [PATCH 019/487] fix empty and_query --- rest_framework/filters.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 1ef4c7fa..39de22fa 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -107,11 +107,13 @@ class SearchFilter(BaseFilterBackend): for orm_lookup in orm_lookups] and_queries.append(reduce(operator.or_, or_queries)) - if settings.DATABASES[queryset.db]["ENGINE"] == "django.db.backends.oracle": - pk_list = queryset.filter(reduce(operator.and_, and_queries)).values_list('pk', flat=True) - return queryset.filter(pk__in=frozenset(pk_list)) - else: - return queryset.filter(reduce(operator.and_, and_queries)).distinct() + if and_queries: + if settings.DATABASES[queryset.db]["ENGINE"] == "django.db.backends.oracle": + pk_list = queryset.filter(reduce(operator.and_, and_queries)).values_list('pk', flat=True) + return queryset.filter(pk__in=frozenset(pk_list)) + else: + return queryset.filter(reduce(operator.and_, and_queries)).distinct() + return queryset class OrderingFilter(BaseFilterBackend): From 67ff078388173820e92c5034e3a52b0a8bb4ab32 Mon Sep 17 00:00:00 2001 From: Omer Katz Date: Sun, 17 May 2015 09:54:33 +0300 Subject: [PATCH 020/487] Renamed the cached fields lists. --- rest_framework/serializers.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index dcee723c..c116cc72 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -316,14 +316,14 @@ class Serializer(BaseSerializer): return self._fields @cached_property - def _to_internal_value_fields(self): + def _writable_fields(self): return [ field for field in self.fields.values() if (not field.read_only) or (field.default is not empty) ] @cached_property - def _to_representation_fields(self): + def _readable_fields(self): return [field for field in self.fields.values() if not field.write_only] def get_fields(self): @@ -400,7 +400,7 @@ class Serializer(BaseSerializer): ret = OrderedDict() errors = OrderedDict() - fields = self._to_internal_value_fields + fields = self._writable_fields for field in fields: validate_method = getattr(self, 'validate_' + field.field_name, None) @@ -428,7 +428,7 @@ class Serializer(BaseSerializer): Object instance -> Dict of primitive datatypes. """ ret = OrderedDict() - fields = self._to_representation_fields + fields = self._readable_fields for field in fields: try: From f32fff43f0693f0fd42c6f9f3ef76d01e0285468 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 19 May 2015 11:55:13 +0100 Subject: [PATCH 021/487] Reduce font weight --- docs_theme/css/default.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_theme/css/default.css b/docs_theme/css/default.css index d998fbee..14457a69 100644 --- a/docs_theme/css/default.css +++ b/docs_theme/css/default.css @@ -182,7 +182,7 @@ body{ } #main-content h3, #main-content h4, #main-content h5 { - font-weight: 500; + font-weight: 300; margin-top: 15px } From ec8e7f27e7250b7fb93fbf3ee01e03b94643311b Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 19 May 2015 15:49:37 +0100 Subject: [PATCH 022/487] Fixes for format preservation --- rest_framework/renderers.py | 2 +- rest_framework/reverse.py | 27 +++++++++++++++++++++++---- rest_framework/utils/breadcrumbs.py | 7 ++++--- 3 files changed, 28 insertions(+), 8 deletions(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 93400c0b..bfc8bd5c 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -586,7 +586,7 @@ class BrowsableAPIRenderer(BaseRenderer): return view.get_view_description(html=True) def get_breadcrumbs(self, request): - return get_breadcrumbs(request.path) + return get_breadcrumbs(request.path, request) def get_context(self, data, accepted_media_type, renderer_context): """ diff --git a/rest_framework/reverse.py b/rest_framework/reverse.py index 7235ac5d..7cb91027 100644 --- a/rest_framework/reverse.py +++ b/rest_framework/reverse.py @@ -10,6 +10,27 @@ from rest_framework.settings import api_settings from rest_framework.utils.urls import replace_query_param +def preserve_builtin_query_params(url, request=None): + """ + Given an incoming request, and an outgoing URL representation, + append the value of any built-in query parameters. + """ + if request is None: + return url + + overrides = [ + api_settings.URL_FORMAT_OVERRIDE, + api_settings.URL_ACCEPT_OVERRIDE + ] + + for param in overrides: + if param and (param in request.GET): + value = request.GET[param] + url = replace_query_param(url, param, value) + + return url + + def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra): """ If versioning is being used then we pass any `reverse` calls through @@ -27,10 +48,8 @@ def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra else: url = _reverse(viewname, args, kwargs, request, format, **extra) - FORMAT_OVERRIDE = api_settings.URL_FORMAT_OVERRIDE - if FORMAT_OVERRIDE and (FORMAT_OVERRIDE in request.query_params): - return replace_query_param(url, FORMAT_OVERRIDE, request.query_params[FORMAT_OVERRIDE]) - return url + return preserve_builtin_query_params(url, request) + def _reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra): """ diff --git a/rest_framework/utils/breadcrumbs.py b/rest_framework/utils/breadcrumbs.py index e6690d17..b2a74376 100644 --- a/rest_framework/utils/breadcrumbs.py +++ b/rest_framework/utils/breadcrumbs.py @@ -2,12 +2,12 @@ from __future__ import unicode_literals from django.core.urlresolvers import resolve, get_script_prefix -def get_breadcrumbs(url): +def get_breadcrumbs(url, request=None): """ Given a url returns a list of breadcrumbs, which are each a tuple of (name, url). """ - + from rest_framework.reverse import preserve_builtin_query_params from rest_framework.settings import api_settings from rest_framework.views import APIView @@ -33,7 +33,8 @@ def get_breadcrumbs(url): if not seen or seen[-1] != view: suffix = getattr(view, 'suffix', None) name = view_name_func(cls, suffix) - breadcrumbs_list.insert(0, (name, prefix + url)) + insert_url = preserve_builtin_query_params(prefix + url, request) + breadcrumbs_list.insert(0, (name, insert_url)) seen.append(view) if url == '': From c916ad6315396314cff489a839ede3df35475e1f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 19 May 2015 16:30:45 +0100 Subject: [PATCH 023/487] Handle create and delete redirects --- rest_framework/renderers.py | 43 +++++++++++++++++++++++++++++++++---- 1 file changed, 39 insertions(+), 4 deletions(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index bfc8bd5c..e270c25c 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -672,6 +672,35 @@ class AdminRenderer(BrowsableAPIRenderer): template = 'rest_framework/admin.html' format = 'admin' + def render(self, data, accepted_media_type=None, renderer_context=None): + self.accepted_media_type = accepted_media_type or '' + self.renderer_context = renderer_context or {} + + template = loader.get_template(self.template) + context = self.get_context(data, accepted_media_type, renderer_context) + context = RequestContext(renderer_context['request'], context) + ret = template.render(context) + + # Creation and deletion should use redirects in the admin style. + response = renderer_context['response'] + request = renderer_context['request'] + + if (response.status_code == status.HTTP_201_CREATED) and ('Location' in response): + response.status_code = status.HTTP_302_FOUND + ret = '' + + if response.status_code == status.HTTP_204_NO_CONTENT: + response.status_code = status.HTTP_302_FOUND + try: + # Attempt to get the parent breadcrumb URL. + response['Location'] = self.get_breadcrumbs(request)[-2][1] + except KeyError: + # Otherwise reload current URL to get a 'Not Found' page. + response['Location'] = request.full_path + ret = '' + + return ret + def get_context(self, data, accepted_media_type, renderer_context): """ Render the HTML for the browsable API representation. @@ -681,12 +710,18 @@ class AdminRenderer(BrowsableAPIRenderer): ) paginator = getattr(context['view'], 'paginator', None) - try: - results = data if paginator is None else paginator.get_results(data) - except KeyError: + if (paginator is not None and data is not None): + try: + results = paginator.get_results(data) + except KeyError: + results = data + else: results = data - if isinstance(results, list): + if results is None: + header = {} + style = 'detail' + elif isinstance(results, list): header = results[0] if results else {} style = 'list' else: From 745d8d0004af56873bf18ed36a68794f738ee985 Mon Sep 17 00:00:00 2001 From: Shtarev Date: Wed, 3 Jun 2015 09:04:28 +0300 Subject: [PATCH 024/487] added comment --- rest_framework/filters.py | 1 + 1 file changed, 1 insertion(+) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 39de22fa..ff0b8e65 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -108,6 +108,7 @@ class SearchFilter(BaseFilterBackend): and_queries.append(reduce(operator.or_, or_queries)) if and_queries: + # According to Oracle DB limits there is no capability to make a DISTINT on *LOB if settings.DATABASES[queryset.db]["ENGINE"] == "django.db.backends.oracle": pk_list = queryset.filter(reduce(operator.and_, and_queries)).values_list('pk', flat=True) return queryset.filter(pk__in=frozenset(pk_list)) From 90f2e26679af8741aaa1c1d0489214062c94765e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 3 Jun 2015 11:00:38 +0100 Subject: [PATCH 025/487] Add Hyperlink and rendering in admin style renderer --- rest_framework/relations.py | 25 ++++++++++++++++++- .../rest_framework/admin/list_value.html | 4 ++- .../admin/simple_list_value.html | 1 + rest_framework/templatetags/rest_framework.py | 5 +++- 4 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 rest_framework/templates/rest_framework/admin/simple_list_value.html diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 00a4a265..93c9be8a 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -13,6 +13,20 @@ from rest_framework.reverse import reverse from rest_framework.utils import html +class Hyperlink(six.text_type): + """ + A string like object that additionally has an associated name. + We use this for hyperlinked URLs that may render as a named link + in some contexts, or render as a plain URL in others. + """ + def __new__(self, url, name): + ret = six.text_type.__new__(self, url) + ret.name = name + return ret + + is_hyperlink = True + + class PKOnlyObject(object): """ This is a mock object, used for when we only need the pk of the object @@ -203,6 +217,9 @@ class HyperlinkedRelatedField(RelatedField): kwargs = {self.lookup_url_kwarg: lookup_value} return self.reverse(view_name, kwargs=kwargs, request=request, format=format) + def get_name(self, obj): + return str(obj) + def to_internal_value(self, data): request = self.context.get('request', None) try: @@ -261,7 +278,7 @@ class HyperlinkedRelatedField(RelatedField): # Return the hyperlink, or error if incorrectly configured. try: - return self.get_url(value, self.view_name, request, format) + url = self.get_url(value, self.view_name, request, format) except NoReverseMatch: msg = ( 'Could not resolve URL for hyperlinked relationship using ' @@ -271,6 +288,12 @@ class HyperlinkedRelatedField(RelatedField): ) raise ImproperlyConfigured(msg % self.view_name) + if url is None: + return None + + name = self.get_name(value) + return Hyperlink(url, name) + class HyperlinkedIdentityField(HyperlinkedRelatedField): """ diff --git a/rest_framework/templates/rest_framework/admin/list_value.html b/rest_framework/templates/rest_framework/admin/list_value.html index 267bbaa3..cff15635 100644 --- a/rest_framework/templates/rest_framework/admin/list_value.html +++ b/rest_framework/templates/rest_framework/admin/list_value.html @@ -1,5 +1,5 @@ {% load rest_framework %} -
    {{ column|capfirst }}
    {% if key in linked %}{% endif %} - {{ value }} + {{ value|format_value }} {% if key in linked %}{% endif %}
    + {% if key in linked %}{% endif %} {{ value|format_value }} {% if key in linked %}{% endif %} diff --git a/rest_framework/templates/rest_framework/admin/list_value.html b/rest_framework/templates/rest_framework/admin/list_value.html new file mode 100644 index 00000000..267bbaa3 --- /dev/null +++ b/rest_framework/templates/rest_framework/admin/list_value.html @@ -0,0 +1,11 @@ +{% load rest_framework %} + + + {% for item in value %} + + + + + {% endfor %} + +
    {{ forloop.counter0 }}{{ item|format_value }}
    diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index c0431b3d..ef7958eb 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -1,6 +1,7 @@ from __future__ import unicode_literals, absolute_import from django import template from django.core.urlresolvers import reverse, NoReverseMatch +from django.template import loader, Context from django.utils import six from django.utils.encoding import iri_to_uri, force_text from django.utils.html import escape @@ -110,9 +111,13 @@ def format_value(value): if isinstance(value, (int, float, decimal.Decimal, bool, type(None))): return mark_safe('%s' % value) elif isinstance(value, list): - return '' + template = loader.get_template('rest_framework/admin/list_value.html') + context = Context({'value': value}) + return template.render(context) elif isinstance(value, dict): - return '' + template = loader.get_template('rest_framework/admin/dict_value.html') + context = Context({'value': value}) + return template.render(context) elif isinstance(value, six.string_types): if ( (value.startswith('http:') or value.startswith('https:')) and not @@ -124,6 +129,12 @@ def format_value(value): return six.text_type(value) +@register.filter +def add_nested_class(value): + if isinstance(value, (list, dict)): + return 'class=nested' + return '' + # Bunch of stuff cloned from urlize TRAILING_PUNCTUATION = ['.', ',', ':', ';', '.)', '"', "']", "'}", "'"] From 9424e59b9ead292fed85e8dc94524ff84d7390e2 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 12 May 2015 16:28:49 +0100 Subject: [PATCH 014/487] Styling of nested lists/objects in detail view --- rest_framework/templates/rest_framework/admin/detail.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/templates/rest_framework/admin/detail.html b/rest_framework/templates/rest_framework/admin/detail.html index 3014743f..beac0a70 100644 --- a/rest_framework/templates/rest_framework/admin/detail.html +++ b/rest_framework/templates/rest_framework/admin/detail.html @@ -3,7 +3,7 @@
    {{ key|capfirst }}{{ value|format_value }}
    {{ key|capfirst }}{{ value|format_value }}
    + +{% for item in value %}{% if not forloop.first%}, {% endif %}{{item.name}}{% endfor %} diff --git a/rest_framework/templates/rest_framework/admin/simple_list_value.html b/rest_framework/templates/rest_framework/admin/simple_list_value.html new file mode 100644 index 00000000..2dcaeb62 --- /dev/null +++ b/rest_framework/templates/rest_framework/admin/simple_list_value.html @@ -0,0 +1 @@ +{% for item in value %}{% if not forloop.first%},{% endif %} {% if item.is_hyperlink %}{{item.name}}{% else %}{{ item }}{% endif %}{% endfor %} diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index ef7958eb..bfbf4c44 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -111,7 +111,10 @@ def format_value(value): if isinstance(value, (int, float, decimal.Decimal, bool, type(None))): return mark_safe('%s' % value) elif isinstance(value, list): - template = loader.get_template('rest_framework/admin/list_value.html') + 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') context = Context({'value': value}) return template.render(context) elif isinstance(value, dict): From 25bb3b1502b18b3d90620674085f8ec03fa4c1f9 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 3 Jun 2015 11:15:54 +0100 Subject: [PATCH 026/487] Use chevron control for row linking, rather than hyperlinking first item --- rest_framework/renderers.py | 2 -- rest_framework/templates/rest_framework/admin/list.html | 6 +++--- rest_framework/templatetags/rest_framework.py | 4 +++- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index e270c25c..8d4a7356 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -730,12 +730,10 @@ class AdminRenderer(BrowsableAPIRenderer): columns = [key for key in header.keys() if key != 'url'] details = [key for key in header.keys() if key != 'url'] - linked = [columns[0]] if columns else [] context['style'] = style context['columns'] = columns context['details'] = details - context['linked'] = linked context['results'] = results return context diff --git a/rest_framework/templates/rest_framework/admin/list.html b/rest_framework/templates/rest_framework/admin/list.html index e8c547a6..a3ec21af 100644 --- a/rest_framework/templates/rest_framework/admin/list.html +++ b/rest_framework/templates/rest_framework/admin/list.html @@ -1,7 +1,7 @@ {% load rest_framework %}
    - {% for column in columns%}{% endfor %} + {% for column in columns%}{% endfor %} {% for row in results %} @@ -9,12 +9,12 @@ {% for key, value in row.items %} {% if key in columns %} {% endif %} {% endfor %} + {% endfor %} diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index bfbf4c44..10ad658b 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -134,7 +134,9 @@ def format_value(value): @register.filter def add_nested_class(value): - if isinstance(value, (list, dict)): + if isinstance(value, dict): + return 'class=nested' + if isinstance(value, list) and any([isinstance(item, (list, dict)) for item in value]): return 'class=nested' return '' From ae704eec58defa40e0d8373f8817a03a35007ccc Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 3 Jun 2015 11:35:03 +0100 Subject: [PATCH 027/487] Fix issue with pagination control always displaying --- rest_framework/pagination.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index b1c88d8d..ffc0cae2 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -306,7 +306,7 @@ class PageNumberPagination(BasePagination): ) raise NotFound(msg) - if paginator.count > 1 and self.template is not None: + if paginator.num_pages > 1 and self.template is not None: # The browsable API should display pagination controls. self.display_page_controls = True From 99e97fa9d3dc60038572f7fccfa69496f47ef5e2 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 3 Jun 2015 11:47:33 +0100 Subject: [PATCH 028/487] Cleanup hyperlink rendering implementation --- rest_framework/templates/rest_framework/admin/list_value.html | 4 +--- .../templates/rest_framework/admin/simple_list_value.html | 3 ++- rest_framework/templatetags/rest_framework.py | 4 +++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/rest_framework/templates/rest_framework/admin/list_value.html b/rest_framework/templates/rest_framework/admin/list_value.html index cff15635..267bbaa3 100644 --- a/rest_framework/templates/rest_framework/admin/list_value.html +++ b/rest_framework/templates/rest_framework/admin/list_value.html @@ -1,5 +1,5 @@ {% load rest_framework %} - -{% for item in value %}{% if not forloop.first%}, {% endif %}{{item.name}}{% endfor %} diff --git a/rest_framework/templates/rest_framework/admin/simple_list_value.html b/rest_framework/templates/rest_framework/admin/simple_list_value.html index 2dcaeb62..e378a36b 100644 --- a/rest_framework/templates/rest_framework/admin/simple_list_value.html +++ b/rest_framework/templates/rest_framework/admin/simple_list_value.html @@ -1 +1,2 @@ -{% for item in value %}{% if not forloop.first%},{% endif %} {% if item.is_hyperlink %}{{item.name}}{% else %}{{ item }}{% endif %}{% endfor %} +{% load rest_framework %} +{% for item in value %}{% if not forloop.first%},{% endif %} {{item|format_value}}{% endfor %} diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index 10ad658b..d8b906eb 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -108,8 +108,10 @@ def add_class(value, css_class): @register.filter def format_value(value): + if getattr(value, 'is_hyperlink', False): + return mark_safe('%s' % (value, escape(value.name))) if isinstance(value, (int, float, decimal.Decimal, bool, type(None))): - return mark_safe('%s' % value) + return mark_safe('%s' % escape(value)) elif isinstance(value, list): if any([isinstance(item, (list, dict)) for item in value]): template = loader.get_template('rest_framework/admin/list_value.html') From b1b47036d756475faad8e03f7eb2f3f93aac2107 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 3 Jun 2015 11:53:27 +0100 Subject: [PATCH 029/487] Use six.text_type for hyperlink names --- rest_framework/relations.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 93c9be8a..451f2d11 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -218,7 +218,7 @@ class HyperlinkedRelatedField(RelatedField): return self.reverse(view_name, kwargs=kwargs, request=request, format=format) def get_name(self, obj): - return str(obj) + return six.text_type(obj) def to_internal_value(self, data): request = self.context.get('request', None) From 7ae71deb845e0cbe020a4054ba46ab4bed44d6e3 Mon Sep 17 00:00:00 2001 From: Osvaldo Santana Neto Date: Wed, 3 Jun 2015 14:55:34 -0300 Subject: [PATCH 030/487] Handle invalid characters in headers --- rest_framework/authentication.py | 8 +++++++- tests/test_authentication.py | 8 ++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/rest_framework/authentication.py b/rest_framework/authentication.py index 8b5c2009..598c7278 100644 --- a/rest_framework/authentication.py +++ b/rest_framework/authentication.py @@ -170,7 +170,13 @@ class TokenAuthentication(BaseAuthentication): msg = _('Invalid token header. Token string should not contain spaces.') raise exceptions.AuthenticationFailed(msg) - return self.authenticate_credentials(auth[1]) + try: + token = auth[1].decode() + except UnicodeError: + msg = _('Invalid token header. Token string should not contain invalid characters.') + raise exceptions.AuthenticationFailed(msg) + + return self.authenticate_credentials(token) def authenticate_credentials(self, key): try: diff --git a/tests/test_authentication.py b/tests/test_authentication.py index 91e49f9d..0307d998 100644 --- a/tests/test_authentication.py +++ b/tests/test_authentication.py @@ -1,3 +1,5 @@ +# coding: utf-8 + from __future__ import unicode_literals from django.conf.urls import patterns, url, include from django.contrib.auth.models import User @@ -162,6 +164,12 @@ class TokenAuthTests(TestCase): response = self.csrf_client.post('/token/', {'example': 'example'}, HTTP_AUTHORIZATION=auth) self.assertEqual(response.status_code, status.HTTP_200_OK) + def test_fail_post_form_passing_invalid_token_auth(self): + # add an 'invalid' unicode character + auth = 'Token ' + self.key + "¸" + response = self.csrf_client.post('/token/', {'example': 'example'}, HTTP_AUTHORIZATION=auth) + self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + def test_post_json_passing_token_auth(self): """Ensure POSTing form over token auth with correct credentials passes and does not require CSRF""" auth = "Token " + self.key From 2b2fbbd29973caa635d8e6704793b1396205e644 Mon Sep 17 00:00:00 2001 From: Jared Petersen Date: Thu, 4 Jun 2015 21:28:21 -0700 Subject: [PATCH 031/487] Update browsable-api.md The Bootstrap Customizer has been discontinued and is no longer available (http://getbootstrap.com/2.3.2/customize.html), so I removed the reference to it in the page. --- docs/topics/browsable-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/browsable-api.md b/docs/topics/browsable-api.md index 2879db74..bdc5b19c 100644 --- a/docs/topics/browsable-api.md +++ b/docs/topics/browsable-api.md @@ -35,7 +35,7 @@ To replace the default theme, add a `bootstrap_theme` block to your `api.html` a {% endblock %} -A suitable replacement theme can be generated using Bootstrap's [Customize Tool][bcustomize]. There are also pre-made themes available at [Bootswatch][bswatch]. To use any of the Bootswatch themes, simply download the theme's `bootstrap.min.css` file, add it to your project, and replace the default one as described above. +Suitable pre-made replacement themes are available at [Bootswatch][bswatch]. To use any of the Bootswatch themes, simply download the theme's `bootstrap.min.css` file, add it to your project, and replace the default one as described above. You can also change the navbar variant, which by default is `navbar-inverse`, using the `bootstrap_navbar_variant` block. The empty `{% block bootstrap_navbar_variant %}{% endblock %}` will use the original Bootstrap navbar style. From b0752217ae61d7d22ba1bdc68662e64d02950c42 Mon Sep 17 00:00:00 2001 From: Jannon Frank Date: Fri, 5 Jun 2015 02:21:13 -0700 Subject: [PATCH 032/487] only include 'allow_blank' on CharField --- rest_framework/utils/field_mapping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index c97ec5d0..32bc54e1 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -102,7 +102,7 @@ def get_field_kwargs(field_name, model_field): if model_field.null and not isinstance(model_field, models.NullBooleanField): kwargs['allow_null'] = True - if model_field.blank: + if model_field.blank and isinstance(model_field, models.CharField): kwargs['allow_blank'] = True if model_field.flatchoices: From 4a2bad03c5ee56955b30fea09ad7dbd7c2818aec Mon Sep 17 00:00:00 2001 From: malinich Date: Fri, 5 Jun 2015 15:40:13 +0300 Subject: [PATCH 033/487] outdated method 'get_filter_backends' has been deleted from the documentation --- docs/api-guide/generic-views.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md index cb31f5f7..54d7cd96 100644 --- a/docs/api-guide/generic-views.md +++ b/docs/api-guide/generic-views.md @@ -124,22 +124,6 @@ For example: Note that if your API doesn't include any object level permissions, you may optionally exclude the `self.check_object_permissions`, and simply return the object from the `get_object_or_404` lookup. -#### `get_filter_backends(self)` - -Returns the classes that should be used to filter the queryset. Defaults to returning the `filter_backends` attribute. - -May be overridden to provide more complex behavior with filters, such as using different (or even exclusive) lists of filter_backends depending on different criteria. - -For example: - - def get_filter_backends(self): - if "geo_route" in self.request.query_params: - return (GeoRouteFilter, CategoryFilter) - elif "geo_point" in self.request.query_params: - return (GeoPointFilter, CategoryFilter) - - return (CategoryFilter,) - #### `get_serializer_class(self)` Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute. From 35c28a2a718748578b68c82c4fe28245e831c3e9 Mon Sep 17 00:00:00 2001 From: Ash Hoover Date: Fri, 5 Jun 2015 02:26:19 -0700 Subject: [PATCH 034/487] Include correct limits in LimitOffsetPagination link urls --- rest_framework/pagination.py | 3 +++ tests/test_pagination.py | 26 ++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index b6be6b7c..5938063a 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -431,6 +431,8 @@ class LimitOffsetPagination(BasePagination): return None url = self.request.build_absolute_uri() + url = replace_query_param(url, self.limit_query_param, self.limit) + offset = self.offset + self.limit return replace_query_param(url, self.offset_query_param, offset) @@ -439,6 +441,7 @@ class LimitOffsetPagination(BasePagination): return None url = self.request.build_absolute_uri() + url = replace_query_param(url, self.limit_query_param, self.limit) if self.offset - self.limit <= 0: return remove_query_param(url, self.offset_query_param) diff --git a/tests/test_pagination.py b/tests/test_pagination.py index 6b39a6f2..c67550c8 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -287,6 +287,8 @@ class TestLimitOffset: def setup(self): class ExamplePagination(pagination.LimitOffsetPagination): default_limit = 10 + max_limit = 15 + self.pagination = ExamplePagination() self.queryset = range(1, 101) @@ -442,7 +444,31 @@ class TestLimitOffset: """ request = Request(factory.get('/', {'limit': 'invalid', 'offset': 0})) queryset = self.paginate_queryset(request) + content = self.get_paginated_content(queryset) + next_limit = self.pagination.default_limit + next_offset = self.pagination.default_limit + next_url = 'http://testserver/?limit={0}&offset={1}'.format(next_limit, next_offset) assert queryset == [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] + assert content.get('next') == next_url + + def test_max_limit(self): + """ + The limit defaults to the max_limit when there is a max_limit and the + requested limit is greater than the max_limit + """ + offset = 50 + request = Request(factory.get('/', {'limit': '11235', 'offset': offset})) + queryset = self.paginate_queryset(request) + content = self.get_paginated_content(queryset) + max_limit = self.pagination.max_limit + next_offset = offset + max_limit + prev_offset = offset - max_limit + base_url = 'http://testserver/?limit={0}'.format(max_limit) + next_url = base_url + '&offset={0}'.format(next_offset) + prev_url = base_url + '&offset={0}'.format(prev_offset) + assert queryset == list(range(51, 66)) + assert content.get('next') == next_url + assert content.get('previous') == prev_url class TestCursorPagination: From c292b3d1324eafd791290a61fd4883c9edd0b0cb Mon Sep 17 00:00:00 2001 From: hellysmile Date: Mon, 8 Jun 2015 07:10:57 +0300 Subject: [PATCH 035/487] Fix set_rollback on @transaction.non_atomic_requests. --- rest_framework/compat.py | 3 ++- tests/test_atomic_requests.py | 34 +++++++++++++++++++++++++++++++++- 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 139d085d..8555c21b 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -274,7 +274,8 @@ def set_rollback(): if connection.settings_dict.get('ATOMIC_REQUESTS', False): # If running in >=1.6 then mark a rollback as required, # and allow it to be handled by Django. - transaction.set_rollback(True) + if connection.in_atomic_block: + transaction.set_rollback(True) elif transaction.is_managed(): # Otherwise handle it explicitly if in managed mode. if transaction.is_dirty(): diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index 9410fea5..b4b27cec 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -2,9 +2,10 @@ from __future__ import unicode_literals from django.db import connection, connections, transaction from django.test import TestCase +from django.utils.decorators import method_decorator from django.utils.unittest import skipUnless from rest_framework import status -from rest_framework.exceptions import APIException +from rest_framework.exceptions import APIException, PermissionDenied from rest_framework.response import Response from rest_framework.test import APIRequestFactory from rest_framework.views import APIView @@ -32,6 +33,16 @@ class APIExceptionView(APIView): raise APIException +class NonAtomicAPIExceptionView(APIView): + @method_decorator(transaction.non_atomic_requests) + def dispatch(self, *args, **kwargs): + return super(NonAtomicAPIExceptionView, self).dispatch(*args, **kwargs) + + def post(self, request, *args, **kwargs): + BasicModel.objects.create() + raise PermissionDenied + + @skipUnless(connection.features.uses_savepoints, "'atomic' requires transactions and savepoints.") class DBTransactionTests(TestCase): @@ -108,3 +119,24 @@ class DBTransactionAPIExceptionTests(TestCase): self.assertEqual(response.status_code, status.HTTP_500_INTERNAL_SERVER_ERROR) assert BasicModel.objects.count() == 0 + + +@skipUnless(connection.features.uses_savepoints, + "'atomic' requires transactions and savepoints.") +class NonAtomicDBTransactionAPIExceptionTests(TestCase): + def setUp(self): + self.view = NonAtomicAPIExceptionView.as_view() + connections.databases['default']['ATOMIC_REQUESTS'] = True + + def tearDown(self): + connections.databases['default']['ATOMIC_REQUESTS'] = False + + def test_api_exception_rollback_transaction_non_atomic_view(self): + request = factory.post('/') + + response = self.view(request) + + # without checking connection.in_atomic_block view raises 500 + # due attempt to rollback without transaction + self.assertEqual(response.status_code, + status.HTTP_403_FORBIDDEN) From b015ae99e69c1bf8525a6163008a7a760b22c5bf Mon Sep 17 00:00:00 2001 From: hellysmile Date: Mon, 8 Jun 2015 07:39:08 +0300 Subject: [PATCH 036/487] Inline @transaction.non_atomic_requests for Django<1.6. --- tests/test_atomic_requests.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index b4b27cec..75001e9b 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -33,16 +33,6 @@ class APIExceptionView(APIView): raise APIException -class NonAtomicAPIExceptionView(APIView): - @method_decorator(transaction.non_atomic_requests) - def dispatch(self, *args, **kwargs): - return super(NonAtomicAPIExceptionView, self).dispatch(*args, **kwargs) - - def post(self, request, *args, **kwargs): - BasicModel.objects.create() - raise PermissionDenied - - @skipUnless(connection.features.uses_savepoints, "'atomic' requires transactions and savepoints.") class DBTransactionTests(TestCase): @@ -125,6 +115,16 @@ class DBTransactionAPIExceptionTests(TestCase): "'atomic' requires transactions and savepoints.") class NonAtomicDBTransactionAPIExceptionTests(TestCase): def setUp(self): + # only Django >= 1.6 provides @transaction.non_atomic_requests + class NonAtomicAPIExceptionView(APIView): + @method_decorator(transaction.non_atomic_requests) + def dispatch(self, *args, **kwargs): + return super(NonAtomicAPIExceptionView, self).dispatch(*args, **kwargs) + + def post(self, request, *args, **kwargs): + BasicModel.objects.create() + raise PermissionDenied + self.view = NonAtomicAPIExceptionView.as_view() connections.databases['default']['ATOMIC_REQUESTS'] = True From 325789db956b1df41bdf18b5689a44d628896ee5 Mon Sep 17 00:00:00 2001 From: Nico Mandery Date: Mon, 8 Jun 2015 15:18:30 +0200 Subject: [PATCH 037/487] set the filter_backends class variable in the DjangoFilterBackend documentation for clearness --- docs/api-guide/filtering.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md index cd017341..c1311c35 100644 --- a/docs/api-guide/filtering.md +++ b/docs/api-guide/filtering.md @@ -149,6 +149,7 @@ If all you need is simple equality-based filtering, you can set a `filter_fields class ProductList(generics.ListAPIView): queryset = Product.objects.all() serializer_class = ProductSerializer + filter_backends = (filters.DjangoFilterBackend,) filter_fields = ('category', 'in_stock') This will automatically create a `FilterSet` class for the given fields, and will allow you to make requests such as: @@ -174,6 +175,7 @@ For more advanced filtering requirements you can specify a `FilterSet` class tha class ProductList(generics.ListAPIView): queryset = Product.objects.all() serializer_class = ProductSerializer + filter_backends = (filters.DjangoFilterBackend,) filter_class = ProductFilter From cbfce931292cff23ba77f6e665ee06ba6c5af8c8 Mon Sep 17 00:00:00 2001 From: hellysmile Date: Mon, 8 Jun 2015 18:15:31 +0300 Subject: [PATCH 038/487] Fitx TestCase due Django interals. --- tests/test_atomic_requests.py | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index 75001e9b..b74f2179 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -1,11 +1,13 @@ from __future__ import unicode_literals +from django.conf.urls import patterns, url from django.db import connection, connections, transaction -from django.test import TestCase +from django.test import TestCase, TransactionTestCase +from django.http import Http404 from django.utils.decorators import method_decorator from django.utils.unittest import skipUnless from rest_framework import status -from rest_framework.exceptions import APIException, PermissionDenied +from rest_framework.exceptions import APIException from rest_framework.response import Response from rest_framework.test import APIRequestFactory from rest_framework.views import APIView @@ -113,30 +115,33 @@ class DBTransactionAPIExceptionTests(TestCase): @skipUnless(connection.features.uses_savepoints, "'atomic' requires transactions and savepoints.") -class NonAtomicDBTransactionAPIExceptionTests(TestCase): - def setUp(self): - # only Django >= 1.6 provides @transaction.non_atomic_requests +class NonAtomicDBTransactionAPIExceptionTests(TransactionTestCase): + @property + def urls(self): class NonAtomicAPIExceptionView(APIView): @method_decorator(transaction.non_atomic_requests) def dispatch(self, *args, **kwargs): return super(NonAtomicAPIExceptionView, self).dispatch(*args, **kwargs) - def post(self, request, *args, **kwargs): - BasicModel.objects.create() - raise PermissionDenied + def get(self, request, *args, **kwargs): + BasicModel.objects.all() + raise Http404 - self.view = NonAtomicAPIExceptionView.as_view() + return patterns( + '', + url(r'^$', NonAtomicAPIExceptionView.as_view()) + ) + + def setUp(self): connections.databases['default']['ATOMIC_REQUESTS'] = True def tearDown(self): connections.databases['default']['ATOMIC_REQUESTS'] = False def test_api_exception_rollback_transaction_non_atomic_view(self): - request = factory.post('/') - - response = self.view(request) + response = self.client.get('/') # without checking connection.in_atomic_block view raises 500 # due attempt to rollback without transaction self.assertEqual(response.status_code, - status.HTTP_403_FORBIDDEN) + status.HTTP_404_NOT_FOUND) From e095b91f60549cf05734e37098633832286e6071 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Mon, 8 Jun 2015 21:42:42 +0200 Subject: [PATCH 039/487] Bump the django-guardian & django-filter to latests versions. --- requirements/requirements-optionals.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements/requirements-optionals.txt b/requirements/requirements-optionals.txt index af9937cf..551985e8 100644 --- a/requirements/requirements-optionals.txt +++ b/requirements/requirements-optionals.txt @@ -1,4 +1,4 @@ # Optional packages which may be used with REST framework. markdown==2.5.2 -django-guardian==1.2.5 -django-filter==0.9.2 +django-guardian==1.3 +django-filter==0.10.0 From ca0a7ee1dedd9afd376558c861a375d3e9c18fa5 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Mon, 8 Jun 2015 21:48:05 +0200 Subject: [PATCH 040/487] Revert "Bump the django-guardian & django-filter to latests versions." This reverts commit e095b91f60549cf05734e37098633832286e6071. --- requirements/requirements-optionals.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements/requirements-optionals.txt b/requirements/requirements-optionals.txt index 551985e8..af9937cf 100644 --- a/requirements/requirements-optionals.txt +++ b/requirements/requirements-optionals.txt @@ -1,4 +1,4 @@ # Optional packages which may be used with REST framework. markdown==2.5.2 -django-guardian==1.3 -django-filter==0.10.0 +django-guardian==1.2.5 +django-filter==0.9.2 From c80796ec040440edd92de9bd958c37cfd412067a Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Wed, 10 Jun 2015 23:32:52 +0200 Subject: [PATCH 041/487] Mention `filter_queryset` as an alternative to former `get_filter_backends` --- docs/api-guide/generic-views.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md index 54d7cd96..ac27c132 100644 --- a/docs/api-guide/generic-views.md +++ b/docs/api-guide/generic-views.md @@ -124,6 +124,25 @@ For example: Note that if your API doesn't include any object level permissions, you may optionally exclude the `self.check_object_permissions`, and simply return the object from the `get_object_or_404` lookup. +#### `filter_queryset(self, queryset)` + +Given a queryset, filter it with whichever filter backends are in use, returning a new queryset. + +For example: + + def filter_queryset(self, queryset): + filter_backends = (CategoryFilter,) + + if 'geo_route' in self.request.query_params: + filter_backends = (GeoRouteFilter, CategoryFilter) + elif 'geo_point' in self.request.query_params: + filter_backends = (GeoPointFilter, CategoryFilter) + + for backend in list(filter_backends): + queryset = backend().filter_queryset(self.request, queryset, view=self) + + return queryset + #### `get_serializer_class(self)` Returns the class that should be used for the serializer. Defaults to returning the `serializer_class` attribute. From e7e5946c2ec65fd9e50053ed427cc7b938917785 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Thu, 11 Jun 2015 00:32:05 +0200 Subject: [PATCH 042/487] `format_suffix_patterns` is applied before the trailing slash. --- rest_framework/urlpatterns.py | 6 ++--- tests/test_urlpatterns.py | 50 ++++++++++++++++++++++++++--------- 2 files changed, 40 insertions(+), 16 deletions(-) diff --git a/rest_framework/urlpatterns.py b/rest_framework/urlpatterns.py index 038e9ee3..2e4369f7 100644 --- a/rest_framework/urlpatterns.py +++ b/rest_framework/urlpatterns.py @@ -21,7 +21,7 @@ def apply_suffix_patterns(urlpatterns, suffix_pattern, suffix_required): else: # Regular URL pattern - regex = urlpattern.regex.pattern.rstrip('$') + suffix_pattern + regex = urlpattern.regex.pattern.rstrip('$').rstrip('/') + suffix_pattern view = urlpattern._callback or urlpattern._callback_str kwargs = urlpattern.default_args name = urlpattern.name @@ -55,8 +55,8 @@ def format_suffix_patterns(urlpatterns, suffix_required=False, allowed=None): allowed_pattern = allowed[0] else: allowed_pattern = '(%s)' % '|'.join(allowed) - suffix_pattern = r'\.(?P<%s>%s)$' % (suffix_kwarg, allowed_pattern) + suffix_pattern = r'\.(?P<%s>%s)/?$' % (suffix_kwarg, allowed_pattern) else: - suffix_pattern = r'\.(?P<%s>[a-z0-9]+)$' % suffix_kwarg + suffix_pattern = r'\.(?P<%s>[a-z0-9]+)/?$' % suffix_kwarg return apply_suffix_patterns(urlpatterns, suffix_pattern, suffix_required) diff --git a/tests/test_urlpatterns.py b/tests/test_urlpatterns.py index e0060e69..898acd35 100644 --- a/tests/test_urlpatterns.py +++ b/tests/test_urlpatterns.py @@ -17,7 +17,8 @@ def dummy_view(request, *args, **kwargs): class FormatSuffixTests(TestCase): """ - Tests `format_suffix_patterns` against different URLPatterns to ensure the URLs still resolve properly, including any captured parameters. + Tests `format_suffix_patterns` against different URLPatterns to ensure the + URLs still resolve properly, including any captured parameters. """ def _resolve_urlpatterns(self, urlpatterns, test_paths): factory = APIRequestFactory() @@ -35,11 +36,37 @@ class FormatSuffixTests(TestCase): self.assertEqual(callback_args, test_path.args) self.assertEqual(callback_kwargs, test_path.kwargs) + def test_trailing_slash(self): + factory = APIRequestFactory() + urlpatterns = format_suffix_patterns([ + url(r'^test/$', dummy_view), + ]) + resolver = urlresolvers.RegexURLResolver(r'^/', urlpatterns) + + test_paths = [ + (URLTestPath('/test.api', (), {'format': 'api'}), True), + (URLTestPath('/test/.api', (), {'format': 'api'}), False), + (URLTestPath('/test.api/', (), {'format': 'api'}), True), + ] + + for test_path, expected_resolved in test_paths: + request = factory.get(test_path.path) + try: + callback, callback_args, callback_kwargs = resolver.resolve(request.path_info) + except urlresolvers.Resolver404: + callback, callback_args, callback_kwargs = (None, None, None) + if not expected_resolved: + assert callback is None + continue + + print(test_path, callback, callback_args, callback_kwargs) + assert callback_args == test_path.args + assert callback_kwargs == test_path.kwargs + def test_format_suffix(self): - urlpatterns = patterns( - '', + urlpatterns = [ url(r'^test$', dummy_view), - ) + ] test_paths = [ URLTestPath('/test', (), {}), URLTestPath('/test.api', (), {'format': 'api'}), @@ -48,10 +75,9 @@ class FormatSuffixTests(TestCase): self._resolve_urlpatterns(urlpatterns, test_paths) def test_default_args(self): - urlpatterns = patterns( - '', + urlpatterns = [ url(r'^test$', dummy_view, {'foo': 'bar'}), - ) + ] test_paths = [ URLTestPath('/test', (), {'foo': 'bar', }), URLTestPath('/test.api', (), {'foo': 'bar', 'format': 'api'}), @@ -60,14 +86,12 @@ class FormatSuffixTests(TestCase): self._resolve_urlpatterns(urlpatterns, test_paths) def test_included_urls(self): - nested_patterns = patterns( - '', + nested_patterns = [ url(r'^path$', dummy_view) - ) - urlpatterns = patterns( - '', + ] + urlpatterns = [ url(r'^test/', include(nested_patterns), {'foo': 'bar'}), - ) + ] test_paths = [ URLTestPath('/test/path', (), {'foo': 'bar', }), URLTestPath('/test/path.api', (), {'foo': 'bar', 'format': 'api'}), From fb2c09f6ae0d1b2d44f4fb8444fbbb80e69b6a48 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Thu, 11 Jun 2015 00:36:37 +0200 Subject: [PATCH 043/487] Remove unused patterns import. --- tests/test_urlpatterns.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_urlpatterns.py b/tests/test_urlpatterns.py index 898acd35..f58388c5 100644 --- a/tests/test_urlpatterns.py +++ b/tests/test_urlpatterns.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals from collections import namedtuple -from django.conf.urls import patterns, url, include +from django.conf.urls import url, include from django.core import urlresolvers from django.test import TestCase from rest_framework.test import APIRequestFactory From 1e51230f1b697b42c2c4fc24ebcab8eabdaaa4e9 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Thu, 11 Jun 2015 00:45:23 +0200 Subject: [PATCH 044/487] Remove `django.conf.urls.pattern` as it'll be removed in Django 2.0 --- rest_framework/routers.py | 4 ++-- rest_framework/urls.py | 13 ++++++------- tests/browsable_api/auth_urls.py | 7 +++---- tests/browsable_api/no_auth_urls.py | 6 ++---- tests/test_authentication.py | 7 +++---- tests/test_filters.py | 7 +++---- tests/test_htmlrenderer.py | 7 +++---- tests/test_middleware.py | 7 +++---- tests/test_renderers.py | 5 ++--- tests/test_request.py | 6 ++---- tests/test_response.py | 7 +++---- tests/test_reverse.py | 7 +++---- tests/test_testing.py | 5 ++--- tests/test_urlpatterns.py | 22 +++++++++------------- tests/test_utils.py | 5 ++--- tests/urls.py | 4 +--- 16 files changed, 49 insertions(+), 70 deletions(-) diff --git a/rest_framework/routers.py b/rest_framework/routers.py index 4df852bf..2792795a 100644 --- a/rest_framework/routers.py +++ b/rest_framework/routers.py @@ -17,7 +17,7 @@ from __future__ import unicode_literals import itertools from collections import namedtuple -from django.conf.urls import patterns, url +from django.conf.urls import url from django.core.exceptions import ImproperlyConfigured from django.core.urlresolvers import NoReverseMatch from rest_framework import views @@ -76,7 +76,7 @@ class BaseRouter(object): @property def urls(self): if not hasattr(self, '_urls'): - self._urls = patterns('', *self.get_urls()) + self._urls = self.get_urls() return self._urls diff --git a/rest_framework/urls.py b/rest_framework/urls.py index cfcee534..ee37eb20 100644 --- a/rest_framework/urls.py +++ b/rest_framework/urls.py @@ -4,23 +4,22 @@ Login and logout views for the browsable API. Add these to your root URLconf if you're using the browsable API and your API requires authentication: - urlpatterns = patterns('', + urlpatterns = [ ... url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')) - ) + ] The urls must be namespaced as 'rest_framework', and you should make sure your authentication settings include `SessionAuthentication`. """ from __future__ import unicode_literals -from django.conf.urls import patterns, url +from django.conf.urls import url from django.contrib.auth import views template_name = {'template_name': 'rest_framework/login.html'} -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^login/$', views.login, template_name, name='login'), - url(r'^logout/$', views.logout, template_name, name='logout') -) + url(r'^logout/$', views.logout, template_name, name='logout'), +] diff --git a/tests/browsable_api/auth_urls.py b/tests/browsable_api/auth_urls.py index 97bc1036..32246266 100644 --- a/tests/browsable_api/auth_urls.py +++ b/tests/browsable_api/auth_urls.py @@ -1,11 +1,10 @@ from __future__ import unicode_literals -from django.conf.urls import patterns, url, include +from django.conf.urls import url, include from .views import MockView -urlpatterns = patterns( - '', +urlpatterns = [ (r'^$', MockView.as_view()), url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')), -) +] diff --git a/tests/browsable_api/no_auth_urls.py b/tests/browsable_api/no_auth_urls.py index 5e3604a6..be728422 100644 --- a/tests/browsable_api/no_auth_urls.py +++ b/tests/browsable_api/no_auth_urls.py @@ -1,9 +1,7 @@ from __future__ import unicode_literals -from django.conf.urls import patterns from .views import MockView -urlpatterns = patterns( - '', +urlpatterns = [ (r'^$', MockView.as_view()), -) +] diff --git a/tests/test_authentication.py b/tests/test_authentication.py index 91e49f9d..32a50ef5 100644 --- a/tests/test_authentication.py +++ b/tests/test_authentication.py @@ -1,5 +1,5 @@ from __future__ import unicode_literals -from django.conf.urls import patterns, url, include +from django.conf.urls import url, include from django.contrib.auth.models import User from django.http import HttpResponse from django.test import TestCase @@ -37,14 +37,13 @@ class MockView(APIView): return HttpResponse({'a': 1, 'b': 2, 'c': 3}) -urlpatterns = patterns( - '', +urlpatterns = [ (r'^session/$', MockView.as_view(authentication_classes=[SessionAuthentication])), (r'^basic/$', MockView.as_view(authentication_classes=[BasicAuthentication])), (r'^token/$', MockView.as_view(authentication_classes=[TokenAuthentication])), (r'^auth-token/$', 'rest_framework.authtoken.views.obtain_auth_token'), url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')) -) +] class BasicAuthTests(TestCase): diff --git a/tests/test_filters.py b/tests/test_filters.py index e7cb0c79..c06160f9 100644 --- a/tests/test_filters.py +++ b/tests/test_filters.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals import datetime from decimal import Decimal from django.db import models -from django.conf.urls import patterns, url +from django.conf.urls import url from django.core.urlresolvers import reverse from django.test import TestCase from django.test.utils import override_settings @@ -94,13 +94,12 @@ if django_filters: def get_queryset(self): return FilterableItem.objects.all() - urlpatterns = patterns( - '', + urlpatterns = [ url(r'^(?P\d+)/$', FilterClassDetailView.as_view(), name='detail-view'), url(r'^$', FilterClassRootView.as_view(), name='root-view'), url(r'^get-queryset/$', GetQuerysetView.as_view(), name='get-queryset-view'), - ) + ] class CommonFilteringTestCase(TestCase): diff --git a/tests/test_htmlrenderer.py b/tests/test_htmlrenderer.py index a33b832f..1a4a62b2 100644 --- a/tests/test_htmlrenderer.py +++ b/tests/test_htmlrenderer.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals from django.core.exceptions import PermissionDenied -from django.conf.urls import patterns, url +from django.conf.urls import url from django.http import Http404 from django.test import TestCase from django.template import TemplateDoesNotExist, Template @@ -34,12 +34,11 @@ def not_found(request): raise Http404() -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^$', example), url(r'^permission_denied$', permission_denied), url(r'^not_found$', not_found), -) +] class TemplateHTMLRendererTests(TestCase): diff --git a/tests/test_middleware.py b/tests/test_middleware.py index 4c099fca..36688be4 100644 --- a/tests/test_middleware.py +++ b/tests/test_middleware.py @@ -1,5 +1,5 @@ -from django.conf.urls import patterns, url +from django.conf.urls import url from django.contrib.auth.models import User from rest_framework.authentication import TokenAuthentication from rest_framework.authtoken.models import Token @@ -7,10 +7,9 @@ from rest_framework.test import APITestCase from rest_framework.views import APIView -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^$', APIView.as_view(authentication_classes=(TokenAuthentication,))), -) +] class MyMiddleware(object): diff --git a/tests/test_renderers.py b/tests/test_renderers.py index cb76f683..fcd3476f 100644 --- a/tests/test_renderers.py +++ b/tests/test_renderers.py @@ -103,8 +103,7 @@ class HTMLView1(APIView): def get(self, request, **kwargs): return Response('text') -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^.*\.(?P.+)$', MockView.as_view(renderer_classes=[RendererA, RendererB])), url(r'^$', MockView.as_view(renderer_classes=[RendererA, RendererB])), url(r'^cache$', MockGETView.as_view()), @@ -113,7 +112,7 @@ urlpatterns = patterns( url(r'^html1$', HTMLView1.as_view()), url(r'^empty$', EmptyGETView.as_view()), url(r'^api', include('rest_framework.urls', namespace='rest_framework')) -) +] class POSTDeniedPermission(permissions.BasePermission): diff --git a/tests/test_request.py b/tests/test_request.py index c274ab69..35a3369d 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -2,7 +2,6 @@ Tests for content parsing, and form-overloaded content parsing. """ from __future__ import unicode_literals -from django.conf.urls import patterns from django.contrib.auth.models import User from django.contrib.auth import authenticate, login, logout from django.contrib.sessions.middleware import SessionMiddleware @@ -189,10 +188,9 @@ class MockView(APIView): return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR) -urlpatterns = patterns( - '', +urlpatterns = [ (r'^$', MockView.as_view()), -) +] class TestContentParsingWithAuthentication(TestCase): diff --git a/tests/test_response.py b/tests/test_response.py index 4a9deaa2..864478a8 100644 --- a/tests/test_response.py +++ b/tests/test_response.py @@ -1,5 +1,5 @@ from __future__ import unicode_literals -from django.conf.urls import patterns, url, include +from django.conf.urls import url, include from django.test import TestCase from django.utils import six from tests.models import BasicModel @@ -113,8 +113,7 @@ new_model_viewset_router = routers.DefaultRouter() new_model_viewset_router.register(r'', HTMLNewModelViewSet) -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^setbyview$', MockViewSettingContentType.as_view(renderer_classes=[RendererA, RendererB, RendererC])), url(r'^.*\.(?P.+)$', MockView.as_view(renderer_classes=[RendererA, RendererB, RendererC])), url(r'^$', MockView.as_view(renderer_classes=[RendererA, RendererB, RendererC])), @@ -123,7 +122,7 @@ urlpatterns = patterns( url(r'^html_new_model$', HTMLNewModelView.as_view()), url(r'^html_new_model_viewset', include(new_model_viewset_router.urls)), url(r'^restframework', include('rest_framework.urls', namespace='rest_framework')) -) +] # TODO: Clean tests bellow - remove duplicates with above, better unit testing, ... diff --git a/tests/test_reverse.py b/tests/test_reverse.py index 08c27023..bf94f9ee 100644 --- a/tests/test_reverse.py +++ b/tests/test_reverse.py @@ -1,5 +1,5 @@ from __future__ import unicode_literals -from django.conf.urls import patterns, url +from django.conf.urls import url from django.core.urlresolvers import NoReverseMatch from django.test import TestCase from rest_framework.reverse import reverse @@ -11,10 +11,9 @@ factory = APIRequestFactory() def null_view(request): pass -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^view$', null_view, name='view'), -) +] class MockVersioningScheme(object): diff --git a/tests/test_testing.py b/tests/test_testing.py index 87d2b61f..68b6ee6e 100644 --- a/tests/test_testing.py +++ b/tests/test_testing.py @@ -32,12 +32,11 @@ def redirect_view(request): return redirect('/view/') -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^view/$', view), url(r'^session-view/$', session_view), url(r'^redirect-view/$', redirect_view), -) +] class TestAPITestClient(TestCase): diff --git a/tests/test_urlpatterns.py b/tests/test_urlpatterns.py index e0060e69..708dc994 100644 --- a/tests/test_urlpatterns.py +++ b/tests/test_urlpatterns.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals from collections import namedtuple -from django.conf.urls import patterns, url, include +from django.conf.urls import url, include from django.core import urlresolvers from django.test import TestCase from rest_framework.test import APIRequestFactory @@ -36,10 +36,9 @@ class FormatSuffixTests(TestCase): self.assertEqual(callback_kwargs, test_path.kwargs) def test_format_suffix(self): - urlpatterns = patterns( - '', + urlpatterns = [ url(r'^test$', dummy_view), - ) + ] test_paths = [ URLTestPath('/test', (), {}), URLTestPath('/test.api', (), {'format': 'api'}), @@ -48,10 +47,9 @@ class FormatSuffixTests(TestCase): self._resolve_urlpatterns(urlpatterns, test_paths) def test_default_args(self): - urlpatterns = patterns( - '', + urlpatterns = [ url(r'^test$', dummy_view, {'foo': 'bar'}), - ) + ] test_paths = [ URLTestPath('/test', (), {'foo': 'bar', }), URLTestPath('/test.api', (), {'foo': 'bar', 'format': 'api'}), @@ -60,14 +58,12 @@ class FormatSuffixTests(TestCase): self._resolve_urlpatterns(urlpatterns, test_paths) def test_included_urls(self): - nested_patterns = patterns( - '', + nested_patterns = [ url(r'^path$', dummy_view) - ) - urlpatterns = patterns( - '', + ] + urlpatterns = [ url(r'^test/', include(nested_patterns), {'foo': 'bar'}), - ) + ] test_paths = [ URLTestPath('/test/path', (), {'foo': 'bar', }), URLTestPath('/test/path.api', (), {'foo': 'bar', 'format': 'api'}), diff --git a/tests/test_utils.py b/tests/test_utils.py index 8c286ea4..a8421fb7 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -31,14 +31,13 @@ class NestedResourceInstance(APIView): pass -urlpatterns = patterns( - '', +urlpatterns = [ url(r'^$', Root.as_view()), url(r'^resource/$', ResourceRoot.as_view()), url(r'^resource/(?P[0-9]+)$', ResourceInstance.as_view()), url(r'^resource/(?P[0-9]+)/$', NestedResourceRoot.as_view()), url(r'^resource/(?P[0-9]+)/(?P[A-Za-z]+)$', NestedResourceInstance.as_view()), -) +] class BreadcrumbTests(TestCase): diff --git a/tests/urls.py b/tests/urls.py index 41f527df..f5a26177 100644 --- a/tests/urls.py +++ b/tests/urls.py @@ -1,6 +1,4 @@ """ Blank URLConf just to keep the test suite happy """ -from django.conf.urls import patterns - -urlpatterns = patterns('') +urlpatterns = [] From 9f1805f2f04f51a533a4a0ab7a598e5a364ab6da Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Thu, 11 Jun 2015 00:51:33 +0200 Subject: [PATCH 045/487] Removed unused imports. --- tests/test_renderers.py | 2 +- tests/test_testing.py | 2 +- tests/test_utils.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/test_renderers.py b/tests/test_renderers.py index fcd3476f..85c6258d 100644 --- a/tests/test_renderers.py +++ b/tests/test_renderers.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.conf.urls import patterns, url, include +from django.conf.urls import url, include from django.core.cache import cache from django.db import models from django.test import TestCase diff --git a/tests/test_testing.py b/tests/test_testing.py index 68b6ee6e..b42c0875 100644 --- a/tests/test_testing.py +++ b/tests/test_testing.py @@ -1,6 +1,6 @@ # encoding: utf-8 from __future__ import unicode_literals -from django.conf.urls import patterns, url +from django.conf.urls import url from django.contrib.auth.models import User from django.shortcuts import redirect from django.test import TestCase diff --git a/tests/test_utils.py b/tests/test_utils.py index a8421fb7..a2551842 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals from django.core.exceptions import ImproperlyConfigured -from django.conf.urls import patterns, url +from django.conf.urls import url from django.test import TestCase from django.utils import six from rest_framework.utils.model_meta import _resolve_model From bfd7219352213c47299dd560b302c88f87825769 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Thu, 11 Jun 2015 01:01:47 +0200 Subject: [PATCH 046/487] Define the `urlpatterns` as a list of `url().... --- tests/browsable_api/auth_urls.py | 2 +- tests/browsable_api/no_auth_urls.py | 3 ++- tests/test_authentication.py | 10 +++++----- tests/test_request.py | 3 ++- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/tests/browsable_api/auth_urls.py b/tests/browsable_api/auth_urls.py index 32246266..aa3958b0 100644 --- a/tests/browsable_api/auth_urls.py +++ b/tests/browsable_api/auth_urls.py @@ -5,6 +5,6 @@ from .views import MockView urlpatterns = [ - (r'^$', MockView.as_view()), + url(r'^$', MockView.as_view()), url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')), ] diff --git a/tests/browsable_api/no_auth_urls.py b/tests/browsable_api/no_auth_urls.py index be728422..ec273f91 100644 --- a/tests/browsable_api/no_auth_urls.py +++ b/tests/browsable_api/no_auth_urls.py @@ -1,7 +1,8 @@ from __future__ import unicode_literals +from django.conf.urls import url from .views import MockView urlpatterns = [ - (r'^$', MockView.as_view()), + url(r'^$', MockView.as_view()), ] diff --git a/tests/test_authentication.py b/tests/test_authentication.py index 32a50ef5..146daf61 100644 --- a/tests/test_authentication.py +++ b/tests/test_authentication.py @@ -38,11 +38,11 @@ class MockView(APIView): urlpatterns = [ - (r'^session/$', MockView.as_view(authentication_classes=[SessionAuthentication])), - (r'^basic/$', MockView.as_view(authentication_classes=[BasicAuthentication])), - (r'^token/$', MockView.as_view(authentication_classes=[TokenAuthentication])), - (r'^auth-token/$', 'rest_framework.authtoken.views.obtain_auth_token'), - url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')) + url(r'^session/$', MockView.as_view(authentication_classes=[SessionAuthentication])), + url(r'^basic/$', MockView.as_view(authentication_classes=[BasicAuthentication])), + url(r'^token/$', MockView.as_view(authentication_classes=[TokenAuthentication])), + url(r'^auth-token/$', 'rest_framework.authtoken.views.obtain_auth_token'), + url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')), ] diff --git a/tests/test_request.py b/tests/test_request.py index 35a3369d..ebf94530 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -2,6 +2,7 @@ Tests for content parsing, and form-overloaded content parsing. """ from __future__ import unicode_literals +from django.conf.urls import url from django.contrib.auth.models import User from django.contrib.auth import authenticate, login, logout from django.contrib.sessions.middleware import SessionMiddleware @@ -189,7 +190,7 @@ class MockView(APIView): return Response(status=status.HTTP_500_INTERNAL_SERVER_ERROR) urlpatterns = [ - (r'^$', MockView.as_view()), + url(r'^$', MockView.as_view()), ] From a1e0bae9da7d69967b6bf2340aeb448ce154d2c7 Mon Sep 17 00:00:00 2001 From: Thomas Stephenson Date: Thu, 2 Apr 2015 15:45:12 +1100 Subject: [PATCH 047/487] Custom serialization of PrimaryKeyRelatedField values Adds a 'pk_field' parameter which can be used to proxy serialization and deserialization of arbitrary primary key values. --- docs/api-guide/relations.md | 2 ++ rest_framework/relations.py | 8 ++++++++ tests/test_relations.py | 29 +++++++++++++++++++++++++++++ 3 files changed, 39 insertions(+) diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md index 741943de..8a810edb 100644 --- a/docs/api-guide/relations.md +++ b/docs/api-guide/relations.md @@ -116,6 +116,8 @@ By default this field is read-write, although you can change this behavior using * `queryset` - The queryset used for model instance lookups when validating the field input. Relationships must either set a queryset explicitly, or set `read_only=True`. * `many` - If applied to a to-many relationship, you should set this argument to `True`. * `allow_null` - If set to `True`, the field will accept values of `None` or the empty string for nullable relationships. Defaults to `False`. +* `pk_field` - Set to a field to control serialization/deserialization of the primary key's value. For example, `pk_field=UUIDField(format='hex')` would serialize a UUID primary key into its compact hex representation. + ## HyperlinkedRelatedField diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 00a4a265..4f81dde3 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -134,10 +134,16 @@ class PrimaryKeyRelatedField(RelatedField): 'incorrect_type': _('Incorrect type. Expected pk value, received {data_type}.'), } + def __init__(self, **kwargs): + self.pk_field = kwargs.pop('pk_field', None) + super(PrimaryKeyRelatedField, self).__init__(**kwargs) + def use_pk_only_optimization(self): return True def to_internal_value(self, data): + if self.pk_field is not None: + data = self.pk_field.to_internal_value(data) try: return self.get_queryset().get(pk=data) except ObjectDoesNotExist: @@ -146,6 +152,8 @@ class PrimaryKeyRelatedField(RelatedField): self.fail('incorrect_type', data_type=type(data).__name__) def to_representation(self, value): + if self.pk_field is not None: + return self.pk_field.to_representation(value.pk) return value.pk diff --git a/tests/test_relations.py b/tests/test_relations.py index fbe176e2..a4815a06 100644 --- a/tests/test_relations.py +++ b/tests/test_relations.py @@ -1,3 +1,4 @@ +import uuid from .utils import mock_reverse, fail_reverse, BadType, MockObject, MockQueryset from django.core.exceptions import ImproperlyConfigured from django.utils.datastructures import MultiValueDict @@ -48,6 +49,34 @@ class TestPrimaryKeyRelatedField(APISimpleTestCase): assert representation == self.instance.pk +class TestProxiedPrimaryKeyRelatedField(APISimpleTestCase): + def setUp(self): + self.queryset = MockQueryset([ + MockObject(pk=uuid.UUID(int=0), name='foo'), + MockObject(pk=uuid.UUID(int=1), name='bar'), + MockObject(pk=uuid.UUID(int=2), name='baz') + ]) + self.instance = self.queryset.items[2] + self.field = serializers.PrimaryKeyRelatedField( + queryset=self.queryset, + pk_field=serializers.UUIDField(format='int') + ) + + def test_pk_related_lookup_exists(self): + instance = self.field.to_internal_value(self.instance.pk.int) + assert instance is self.instance + + def test_pk_related_lookup_does_not_exist(self): + with pytest.raises(serializers.ValidationError) as excinfo: + self.field.to_internal_value(4) + msg = excinfo.value.detail[0] + assert msg == 'Invalid pk "00000000-0000-0000-0000-000000000004" - object does not exist.' + + def test_pk_representation(self): + representation = self.field.to_representation(self.instance) + assert representation == self.instance.pk.int + + class TestHyperlinkedIdentityField(APISimpleTestCase): def setUp(self): self.instance = MockObject(pk=1, name='foo') From 0be6d87fac8956f42871a0df198e5ba79d78379d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Mon, 15 Jun 2015 16:51:37 -0400 Subject: [PATCH 048/487] Fix versioning urls --- docs/api-guide/versioning.md | 6 +++--- rest_framework/versioning.py | 4 ++-- tests/test_versioning.py | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api-guide/versioning.md b/docs/api-guide/versioning.md index 846698fc..351e3bff 100644 --- a/docs/api-guide/versioning.md +++ b/docs/api-guide/versioning.md @@ -3,7 +3,7 @@ source: versioning.py # Versioning > Versioning an interface is just a "polite" way to kill deployed clients. -> +> > — [Roy Fielding][cite]. API versioning allows you to alter behavior between different clients. REST framework provides for a number of different versioning schemes. @@ -117,12 +117,12 @@ Your URL conf must include a pattern that matches the version with a `'version'` urlpatterns = [ url( - r'^(?P{v1,v2})/bookings/$', + r'^(?P[v1|v2]+)/bookings/$', bookings_list, name='bookings-list' ), url( - r'^(?P{v1,v2})/bookings/(?P[0-9]+)/$', + r'^(?P[v1|v2]+)/bookings/(?P[0-9]+)/$', bookings_detail, name='bookings-detail' ) diff --git a/rest_framework/versioning.py b/rest_framework/versioning.py index 51b886f3..27c2d879 100644 --- a/rest_framework/versioning.py +++ b/rest_framework/versioning.py @@ -59,8 +59,8 @@ class URLPathVersioning(BaseVersioning): An example URL conf for two views that accept two different versions. urlpatterns = [ - url(r'^(?P{v1,v2})/users/$', users_list, name='users-list'), - url(r'^(?P{v1,v2})/users/(?P[0-9]+)/$', users_detail, name='users-detail') + url(r'^(?P[v1|v2]+)/users/$', users_list, name='users-list'), + url(r'^(?P[v1|v2]+)/users/(?P[0-9]+)/$', users_detail, name='users-detail') ] GET /1.0/something/ HTTP/1.1 diff --git a/tests/test_versioning.py b/tests/test_versioning.py index 065385ad..000762b0 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -128,7 +128,7 @@ class TestURLReversing(UsingURLPatterns, APITestCase): urlpatterns = [ url(r'^v1/', include(included, namespace='v1')), url(r'^another/$', dummy_view, name='another'), - url(r'^(?P[^/]+)/another/$', dummy_view, name='another'), + url(r'^(?P[v1|v2]+)/another/$', dummy_view, name='another'), ] def test_reverse_unversioned(self): From 33a08928d72ebc94effe96eb9dfffcd930be60f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Mon, 15 Jun 2015 21:46:08 -0400 Subject: [PATCH 049/487] Set dynamic maximum height for dropdown widgets --- docs_theme/base.html | 8 ++++---- docs_theme/css/default.css | 5 +++-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs_theme/base.html b/docs_theme/base.html index 4ec726b0..7374babd 100644 --- a/docs_theme/base.html +++ b/docs_theme/base.html @@ -172,10 +172,10 @@ diff --git a/docs_theme/css/default.css b/docs_theme/css/default.css index c3b9e0f1..fdb77007 100644 --- a/docs_theme/css/default.css +++ b/docs_theme/css/default.css @@ -5,11 +5,12 @@ pre { } .dropdown .dropdown-menu { - display: none; + display: none; + overflow-y: scroll; } .dropdown.open .dropdown-menu { - display: block; + display: block; } @media (max-width: 480px) { From deb2c9eb872f2b601d6e8e04bf47452c61393552 Mon Sep 17 00:00:00 2001 From: Alexandre Cordeiro Date: Tue, 16 Jun 2015 17:36:11 -0300 Subject: [PATCH 050/487] Fixed minor typo on viewsets.md I'm not sure how the contribution policy for the docs is, but I thought it'd be faster to issue a pull request than reaching out to you guys/creating an issue for something so simple. Hope it's not a problem :) --- docs/api-guide/viewsets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/viewsets.md b/docs/api-guide/viewsets.md index 0ada0eb5..0452a0f7 100644 --- a/docs/api-guide/viewsets.md +++ b/docs/api-guide/viewsets.md @@ -27,7 +27,7 @@ Let's define a simple viewset that can be used to list or retrieve all the users class UserViewSet(viewsets.ViewSet): """ - A simple ViewSet that for listing or retrieving users. + A simple ViewSet for listing or retrieving users. """ def list(self, request): queryset = User.objects.all() From 2c415d7e0369e42c8bcf831bd5a79e5f77d4e23d Mon Sep 17 00:00:00 2001 From: Jannon Frank Date: Tue, 16 Jun 2015 14:05:19 -0700 Subject: [PATCH 051/487] models.TextFields get mapped to serializers.CharField too --- rest_framework/utils/field_mapping.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index 32bc54e1..32e2fe34 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -102,7 +102,8 @@ def get_field_kwargs(field_name, model_field): if model_field.null and not isinstance(model_field, models.NullBooleanField): kwargs['allow_null'] = True - if model_field.blank and isinstance(model_field, models.CharField): + if model_field.blank and (isinstance(model_field, models.CharField) or + isinstance(model_field, models.TextField)): kwargs['allow_blank'] = True if model_field.flatchoices: From 79736e516a68f567c16e33e03f4e4f90f1029da0 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Wed, 17 Jun 2015 13:18:50 -0400 Subject: [PATCH 052/487] Added failing test case Adding failing test case when many=false is explicitly defined https://github.com/tomchristie/django-rest-framework/issues/3042 --- tests/test_relations.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/test_relations.py b/tests/test_relations.py index a4815a06..6c654315 100644 --- a/tests/test_relations.py +++ b/tests/test_relations.py @@ -48,6 +48,11 @@ class TestPrimaryKeyRelatedField(APISimpleTestCase): representation = self.field.to_representation(self.instance) assert representation == self.instance.pk + def test_explicit_many_false(self): + field = serializers.PrimaryKeyRelatedField(queryset=self.queryset, many=False) + instance = field.to_internal_value(self.instance.pk) + assert instance is self.instance + class TestProxiedPrimaryKeyRelatedField(APISimpleTestCase): def setUp(self): From d24990ece26a51c65703c820d18897f7a4acfc23 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Wed, 17 Jun 2015 13:43:35 -0400 Subject: [PATCH 053/487] Fixed many=False issue in related fields Added check to pop many from kwargs before passing to __init__ Fixed my lint issue from the previous commit --- rest_framework/relations.py | 2 ++ tests/test_relations.py | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 4f81dde3..e56fef5d 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -42,6 +42,8 @@ class RelatedField(Field): 'Relational fields should not provide a `queryset` argument, ' 'when setting read_only=`True`.' ) + if 'many' in kwargs: + kwargs.pop('many') super(RelatedField, self).__init__(**kwargs) def __new__(cls, *args, **kwargs): diff --git a/tests/test_relations.py b/tests/test_relations.py index 6c654315..25a53f27 100644 --- a/tests/test_relations.py +++ b/tests/test_relations.py @@ -52,7 +52,7 @@ class TestPrimaryKeyRelatedField(APISimpleTestCase): field = serializers.PrimaryKeyRelatedField(queryset=self.queryset, many=False) instance = field.to_internal_value(self.instance.pk) assert instance is self.instance - + class TestProxiedPrimaryKeyRelatedField(APISimpleTestCase): def setUp(self): From 5e917789ecc8a90ab64baa1531b2645c6f6ce4cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jose=CC=81=20Padilla?= Date: Thu, 18 Jun 2015 08:57:40 -0400 Subject: [PATCH 054/487] Consistent 2 space tabbing and formatting --- docs_theme/base.html | 45 +- .../templates/rest_framework/api_form.html | 6 +- .../templates/rest_framework/base.html | 453 +++++++++--------- .../rest_framework/horizontal/checkbox.html | 30 +- .../horizontal/checkbox_multiple.html | 57 ++- .../rest_framework/horizontal/fieldset.html | 21 +- .../rest_framework/horizontal/form.html | 23 +- .../rest_framework/horizontal/input.html | 29 +- .../horizontal/list_fieldset.html | 23 +- .../rest_framework/horizontal/radio.html | 74 +-- .../rest_framework/horizontal/select.html | 43 +- .../horizontal/select_multiple.html | 41 +- .../rest_framework/horizontal/textarea.html | 29 +- .../rest_framework/inline/checkbox.html | 12 +- .../inline/checkbox_multiple.html | 19 +- .../rest_framework/inline/fieldset.html | 6 +- .../templates/rest_framework/inline/form.html | 16 +- .../rest_framework/inline/input.html | 11 +- .../rest_framework/inline/radio.html | 42 +- .../rest_framework/inline/select.html | 24 +- .../inline/select_multiple.html | 23 +- .../rest_framework/inline/textarea.html | 11 +- .../templates/rest_framework/login_base.html | 123 +++-- .../rest_framework/pagination/numbers.html | 64 ++- .../pagination/previous_and_next.html | 29 +- .../rest_framework/raw_data_form.html | 12 +- .../rest_framework/vertical/checkbox.html | 30 +- .../vertical/checkbox_multiple.html | 61 +-- .../rest_framework/vertical/fieldset.html | 18 +- .../rest_framework/vertical/form.html | 17 +- .../rest_framework/vertical/input.html | 27 +- .../vertical/list_fieldset.html | 9 +- .../rest_framework/vertical/radio.html | 71 +-- .../rest_framework/vertical/select.html | 40 +- .../vertical/select_multiple.html | 29 +- .../rest_framework/vertical/textarea.html | 25 +- 36 files changed, 853 insertions(+), 740 deletions(-) diff --git a/docs_theme/base.html b/docs_theme/base.html index 4ec726b0..46992f5d 100644 --- a/docs_theme/base.html +++ b/docs_theme/base.html @@ -57,12 +57,10 @@
    - {% include "nav.html" %}
    - - -
    - +
    +
    + +
    - - +

    Documentation built with MkDocs. diff --git a/rest_framework/templates/rest_framework/api_form.html b/rest_framework/templates/rest_framework/api_form.html index 96f924ed..16698832 100644 --- a/rest_framework/templates/rest_framework/api_form.html +++ b/rest_framework/templates/rest_framework/api_form.html @@ -1,8 +1,8 @@ {% load rest_framework %} {% csrf_token %} {% for field in form %} - {% if not field.read_only %} - {% render_field field style=style %} - {% endif %} + {% if not field.read_only %} + {% render_field field style=style %} + {% endif %} {% endfor %} diff --git a/rest_framework/templates/rest_framework/base.html b/rest_framework/templates/rest_framework/base.html index 877387f2..f644e6ec 100644 --- a/rest_framework/templates/rest_framework/base.html +++ b/rest_framework/templates/rest_framework/base.html @@ -3,257 +3,242 @@ {% load rest_framework %} - - {% block head %} + + {% block head %} - {% block meta %} - - + {% block meta %} + + + {% endblock %} + + {% block title %}Django REST framework{% endblock %} + + {% block style %} + {% block bootstrap_theme %} + + + {% endblock %} + + + + {% endblock %} + + {% endblock %} + + +{% block body %} + + +

    + {% block navbar %} +
    +
    + + {% block branding %} + + Django REST framework {{ version }} + {% endblock %} - - {% block title %}Django REST framework{% endblock %} - - {% block style %} - {% block bootstrap_theme %} - - - {% endblock %} - - + +
      + {% block userlinks %} + {% if user.is_authenticated %} + {% optional_logout request user %} + {% else %} + {% optional_login request %} + {% endif %} {% endblock %} +
    +
    +
    + {% endblock %} - {% endblock %} - +
    + {% block breadcrumbs %} + + {% endblock %} - {% block body %} - + +
    -
    + {% if 'GET' in allowed_methods %} + +
    +
    + GET - {% block navbar %} -
    -
    - - {% block branding %} - - Django REST framework {{ version }} - - {% endblock %} - -
      - {% block userlinks %} - {% if user.is_authenticated %} - {% optional_logout request user %} - {% else %} - {% optional_login request %} - {% endif %} - {% endblock %} -
    -
    -
    - {% endblock %} - -
    - {% block breadcrumbs %} -
      - {% for breadcrumb_name, breadcrumb_url in breadcrumblist %} - {% if forloop.last %} -
    • {{ breadcrumb_name }}
      • - {% else %} -
    • {{ breadcrumb_name }}
      • - {% endif %} - {% endfor %} + +
        + {% for format in available_formats %} +
      • + {{ format }} +
        • + {% endfor %}
      - {% endblock %} +
    +
    + + {% endif %} - -
    + {% if options_form %} +
    + {% csrf_token %} + + + + {% endif %} - {% if 'GET' in allowed_methods %} -
    -
    -
    - GET + {% if delete_form %} + + {% csrf_token %} + + + + {% endif %} - - -
    -
    - - {% endif %} +
    +
    +

    {{ name }}

    +
    +
    + {% block description %} + {{ description }} + {% endblock %} +
    - {% if options_form %} -
    - {% csrf_token %} - - - - {% endif %} + {% if paginator %} + + {% endif %} - {% if delete_form %} -
    - {% csrf_token %} - - - - {% endif %} +
    + 
    {{ request.method }} {{ request.get_full_path }}
    +
    -
    -
    -

    {{ name }}

    -
    -
    - {% block description %} - {{ description }} - {% endblock %} -
    - - {% if paginator %} - - {% endif %} - -
    - 
    {{ request.method }} {{ request.get_full_path }}
    -
    -
    - 
    HTTP {{ response.status_code }} {{ response.status_text }}{% autoescape off %}
+            
    
+              
    HTTP {{ response.status_code }} {{ response.status_text }}{% autoescape off %}
 {% for key, val in response_headers.items %}{{ key }}: {{ val|break_long_headers|urlize_quoted_links }}
 {% endfor %}
 {{ content|urlize_quoted_links }}
    {% endautoescape %}
-                    
    
-
    - - {% if display_edit_forms %} - - {% if post_form or raw_data_post_form %} -
    - {% if post_form %} - - {% endif %} -
    - {% if post_form %} -
    - {% with form=post_form %} -
    -
    - {{ post_form }} -
    - -
    -
    - - {% endwith %} -
    - {% endif %} -
    - {% with form=raw_data_post_form %} -
    -
    - {% include "rest_framework/raw_data_form.html" %} -
    - -
    -
    - - {% endwith %} -
    -
    -
    - {% endif %} - - {% if put_form or raw_data_put_form or raw_data_patch_form %} -
    - {% if put_form %} - - {% endif %} -
    - {% if put_form %} -
    -
    -
    - {{ put_form }} -
    - -
    -
    - -
    - {% endif %} -
    - {% with form=raw_data_put_or_patch_form %} -
    -
    - {% include "rest_framework/raw_data_form.html" %} -
    - {% if raw_data_put_form %} - - {% endif %} - {% if raw_data_patch_form %} - - {% endif %} -
    -
    - - {% endwith %} -
    -
    -
    - {% endif %} - {% endif %}
    - -
    -
    +
    - {% block script %} - - - - - {% endblock %} - - {% endblock %} + {% if display_edit_forms %} + + {% if post_form or raw_data_post_form %} +
    + {% if post_form %} + + {% endif %} + +
    + {% if post_form %} +
    + {% with form=post_form %} +
    +
    + {{ post_form }} +
    + +
    +
    + + {% endwith %} +
    + {% endif %} + +
    + {% with form=raw_data_post_form %} +
    +
    + {% include "rest_framework/raw_data_form.html" %} +
    + +
    +
    + + {% endwith %} +
    +
    +
    + {% endif %} + + {% if put_form or raw_data_put_form or raw_data_patch_form %} +
    + {% if put_form %} + + {% endif %} + +
    + {% if put_form %} +
    +
    +
    + {{ put_form }} +
    + +
    +
    + +
    + {% endif %} + +
    + {% with form=raw_data_put_or_patch_form %} +
    +
    + {% include "rest_framework/raw_data_form.html" %} +
    + {% if raw_data_put_form %} + + {% endif %} + {% if raw_data_patch_form %} + + {% endif %} +
    +
    + + {% endwith %} +
    +
    +
    + {% endif %} + {% endif %} +
    +
    +
    + + {% block script %} + + + + + {% endblock %} + +{% endblock %} diff --git a/rest_framework/templates/rest_framework/horizontal/checkbox.html b/rest_framework/templates/rest_framework/horizontal/checkbox.html index 07a7308f..1047de85 100644 --- a/rest_framework/templates/rest_framework/horizontal/checkbox.html +++ b/rest_framework/templates/rest_framework/horizontal/checkbox.html @@ -1,16 +1,20 @@
    -
    -
    - -
    - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} +
    +
    +
    + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} + {% endif %} + + {% if field.help_text %} + {{ field.help_text }} + {% endif %} +
    diff --git a/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html b/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html index ec7d5935..59a9acd8 100644 --- a/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html +++ b/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html @@ -1,30 +1,37 @@
    - {% if field.label %} - - {% endif %} -
    + {% if field.label %} + + {% endif %} + +
    {% if style.inline %} - {% for key, text in field.choices.items %} - - {% endfor %} + {% for key, text in field.choices.items %} + + {% endfor %} {% else %} - {% for key, text in field.choices.items %} -
    - -
    - {% endfor %} + {% for key, text in field.choices.items %} +
    + +
    + {% endfor %} {% endif %} - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} -
    + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} + {% endif %} + + {% if field.help_text %} + {{ field.help_text }} + {% endif %} +
    diff --git a/rest_framework/templates/rest_framework/horizontal/fieldset.html b/rest_framework/templates/rest_framework/horizontal/fieldset.html index ba3e3aba..1747d255 100644 --- a/rest_framework/templates/rest_framework/horizontal/fieldset.html +++ b/rest_framework/templates/rest_framework/horizontal/fieldset.html @@ -1,13 +1,16 @@ {% load rest_framework %}
    - {% if field.label %} -
    - {{ field.label }} -
    + {% if field.label %} +
    + + {{ field.label }} + +
    + {% endif %} + + {% for nested_field in field %} + {% if not nested_field.read_only %} + {% render_field nested_field style=style %} {% endif %} - {% for nested_field in field %} - {% if not nested_field.read_only %} - {% render_field nested_field style=style %} - {% endif %} - {% endfor %} + {% endfor %}
    diff --git a/rest_framework/templates/rest_framework/horizontal/form.html b/rest_framework/templates/rest_framework/horizontal/form.html index fd15b626..af16a0eb 100644 --- a/rest_framework/templates/rest_framework/horizontal/form.html +++ b/rest_framework/templates/rest_framework/horizontal/form.html @@ -1,15 +1,16 @@ {% load rest_framework %} +
    - {% csrf_token %} - {% for field in form %} - {% if not field.read_only %} - {% render_field field style=style %} - {% endif %} - {% endfor %} - -
    -
    - -
    + {% csrf_token %} + {% for field in form %} + {% if not field.read_only %} + {% render_field field style=style %} + {% endif %} + {% endfor %} + +
    +
    +
    +
    diff --git a/rest_framework/templates/rest_framework/horizontal/input.html b/rest_framework/templates/rest_framework/horizontal/input.html index c41cd523..82e6dc67 100644 --- a/rest_framework/templates/rest_framework/horizontal/input.html +++ b/rest_framework/templates/rest_framework/horizontal/input.html @@ -1,14 +1,21 @@
    - {% if field.label %} - + {% if field.label %} + + {% endif %} + +
    + + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} {% endif %} -
    - - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} -
    + + {% if field.help_text %} + {{ field.help_text }} + {% endif %} +
    diff --git a/rest_framework/templates/rest_framework/horizontal/list_fieldset.html b/rest_framework/templates/rest_framework/horizontal/list_fieldset.html index a9ff04a6..962c333c 100644 --- a/rest_framework/templates/rest_framework/horizontal/list_fieldset.html +++ b/rest_framework/templates/rest_framework/horizontal/list_fieldset.html @@ -1,16 +1,13 @@ {% load rest_framework %} +
    - {% if field.label %} -
    - {{ field.label }} -
    - {% endif %} - -

    Lists are not currently supported in HTML input.

    + {% if field.label %} +
    + + {{ field.label }} + +
    + {% endif %} + +

    Lists are not currently supported in HTML input.

    diff --git a/rest_framework/templates/rest_framework/horizontal/radio.html b/rest_framework/templates/rest_framework/horizontal/radio.html index cabd09d2..0b494854 100644 --- a/rest_framework/templates/rest_framework/horizontal/radio.html +++ b/rest_framework/templates/rest_framework/horizontal/radio.html @@ -2,46 +2,54 @@ {% trans "None" as none_choice %}
    - {% if field.label %} - - {% endif %} -
    + {% if field.label %} + + {% endif %} + +
    {% if style.inline %} - {% if field.allow_null or field.allow_blank %} - - {% endif %} - {% for key, text in field.choices.items %} - - {% endfor %} + {% if field.allow_null or field.allow_blank %} + + {% endif %} + + {% for key, text in field.choices.items %} + + {% endfor %} {% else %} - {% if field.allow_null or field.allow_blank %} -
    - -
    - {% endif %} + {% if field.allow_null or field.allow_blank %} +
    + +
    + {% endif %} {% for key, text in field.choices.items %} -
    - -
    +
    + +
    {% endfor %} {% endif %} + {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} + {% for error in field.errors %} + {{ error }} + {% endfor %} {% endif %} + {% if field.help_text %} - {{ field.help_text }} + {{ field.help_text }} {% endif %} -
    +
    diff --git a/rest_framework/templates/rest_framework/horizontal/select.html b/rest_framework/templates/rest_framework/horizontal/select.html index 8a7fca37..8957eef9 100644 --- a/rest_framework/templates/rest_framework/horizontal/select.html +++ b/rest_framework/templates/rest_framework/horizontal/select.html @@ -1,21 +1,28 @@
    - {% if field.label %} - + {% if field.label %} + + {% endif %} + +
    + + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} {% endif %} -
    - - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} -
    + + {% if field.help_text %} + {{ field.help_text }} + {% endif %} +
    diff --git a/rest_framework/templates/rest_framework/horizontal/select_multiple.html b/rest_framework/templates/rest_framework/horizontal/select_multiple.html index 0735f280..407b356f 100644 --- a/rest_framework/templates/rest_framework/horizontal/select_multiple.html +++ b/rest_framework/templates/rest_framework/horizontal/select_multiple.html @@ -2,22 +2,29 @@ {% trans "No items to select." as no_items %}
    - {% if field.label %} - + {% if field.label %} + + {% endif %} + +
    + + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} {% endif %} -
    - - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} -
    + + {% if field.help_text %} + {{ field.help_text }} + {% endif %} +
    diff --git a/rest_framework/templates/rest_framework/horizontal/textarea.html b/rest_framework/templates/rest_framework/horizontal/textarea.html index ec107549..ab083807 100644 --- a/rest_framework/templates/rest_framework/horizontal/textarea.html +++ b/rest_framework/templates/rest_framework/horizontal/textarea.html @@ -1,14 +1,21 @@
    - {% if field.label %} - + {% if field.label %} + + {% endif %} + +
    + + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} {% endif %} -
    - - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} -
    + + {% if field.help_text %} + {{ field.help_text }} + {% endif %} +
    diff --git a/rest_framework/templates/rest_framework/inline/checkbox.html b/rest_framework/templates/rest_framework/inline/checkbox.html index 71737f15..665249a5 100644 --- a/rest_framework/templates/rest_framework/inline/checkbox.html +++ b/rest_framework/templates/rest_framework/inline/checkbox.html @@ -1,8 +1,8 @@
    -
    - -
    +
    + +
    diff --git a/rest_framework/templates/rest_framework/inline/checkbox_multiple.html b/rest_framework/templates/rest_framework/inline/checkbox_multiple.html index 09349686..b02425a6 100644 --- a/rest_framework/templates/rest_framework/inline/checkbox_multiple.html +++ b/rest_framework/templates/rest_framework/inline/checkbox_multiple.html @@ -1,13 +1,14 @@
    - {% if field.label %} - - {% endif %} - {% for key, text in field.choices.items %} + {% if field.label %} + + {% endif %} + + {% for key, text in field.choices.items %}
    - +
    - {% endfor %} + {% endfor %}
    diff --git a/rest_framework/templates/rest_framework/inline/fieldset.html b/rest_framework/templates/rest_framework/inline/fieldset.html index e49b42fd..44feef88 100644 --- a/rest_framework/templates/rest_framework/inline/fieldset.html +++ b/rest_framework/templates/rest_framework/inline/fieldset.html @@ -1,6 +1,6 @@ {% load rest_framework %} {% for nested_field in field %} - {% if not nested_field.read_only %} - {% render_field nested_field style=style %} - {% endif %} + {% if not nested_field.read_only %} + {% render_field nested_field style=style %} + {% endif %} {% endfor %} diff --git a/rest_framework/templates/rest_framework/inline/form.html b/rest_framework/templates/rest_framework/inline/form.html index 6a0ea81d..e56e4312 100644 --- a/rest_framework/templates/rest_framework/inline/form.html +++ b/rest_framework/templates/rest_framework/inline/form.html @@ -1,11 +1,13 @@ {% load rest_framework %} +
    - {% csrf_token %} - {% for field in form %} - {% if not field.read_only %} - {% render_field field style=style %} - {% endif %} - {% endfor %} - + {% csrf_token %} + + {% for field in form %} + {% if not field.read_only %} + {% render_field field style=style %} + {% endif %} + {% endfor %} + diff --git a/rest_framework/templates/rest_framework/inline/input.html b/rest_framework/templates/rest_framework/inline/input.html index de85ba48..f28e8f11 100644 --- a/rest_framework/templates/rest_framework/inline/input.html +++ b/rest_framework/templates/rest_framework/inline/input.html @@ -1,6 +1,9 @@
    - {% if field.label %} - - {% endif %} - + {% if field.label %} + + {% endif %} + +
    diff --git a/rest_framework/templates/rest_framework/inline/radio.html b/rest_framework/templates/rest_framework/inline/radio.html index b6501671..efaef6c9 100644 --- a/rest_framework/templates/rest_framework/inline/radio.html +++ b/rest_framework/templates/rest_framework/inline/radio.html @@ -2,23 +2,27 @@ {% trans "None" as none_choice %}
    - {% if field.label %} - - {% endif %} - {% if field.allow_null or field.allow_blank %} -
    - -
    - {% endif %} - {% for key, text in field.choices.items %} -
    - -
    - {% endfor %} + {% if field.label %} + + {% endif %} + + {% if field.allow_null or field.allow_blank %} +
    + +
    + {% endif %} + + {% for key, text in field.choices.items %} +
    + +
    + {% endfor %}
    diff --git a/rest_framework/templates/rest_framework/inline/select.html b/rest_framework/templates/rest_framework/inline/select.html index 6b30e4d6..c3b2923a 100644 --- a/rest_framework/templates/rest_framework/inline/select.html +++ b/rest_framework/templates/rest_framework/inline/select.html @@ -1,13 +1,17 @@
    - {% if field.label %} - + {% if field.label %} + + {% endif %} + + - {% if field.allow_null or field.allow_blank %} - - {% endif %} - {% for key, text in field.choices.items %} - - {% endfor %} - + + {% for key, text in field.choices.items %} + + {% endfor %} +
    diff --git a/rest_framework/templates/rest_framework/inline/select_multiple.html b/rest_framework/templates/rest_framework/inline/select_multiple.html index 5a8b2494..b9b8bb4e 100644 --- a/rest_framework/templates/rest_framework/inline/select_multiple.html +++ b/rest_framework/templates/rest_framework/inline/select_multiple.html @@ -2,14 +2,17 @@ {% trans "No items to select." as no_items %}
    - {% if field.label %} - - {% endif %} - + {% if field.label %} + + {% endif %} + +
    diff --git a/rest_framework/templates/rest_framework/inline/textarea.html b/rest_framework/templates/rest_framework/inline/textarea.html index 0766a01c..bce427fa 100644 --- a/rest_framework/templates/rest_framework/inline/textarea.html +++ b/rest_framework/templates/rest_framework/inline/textarea.html @@ -1,6 +1,9 @@
    - {% if field.label %} - - {% endif %} - + {% if field.label %} + + {% endif %} + +
    diff --git a/rest_framework/templates/rest_framework/login_base.html b/rest_framework/templates/rest_framework/login_base.html index 8e6240a6..9ac80308 100644 --- a/rest_framework/templates/rest_framework/login_base.html +++ b/rest_framework/templates/rest_framework/login_base.html @@ -3,66 +3,65 @@ {% load staticfiles %} {% load rest_framework %} - {% block body %} - +{% block body %} + +
    +
    +
    +
    +
    + {% block branding %}

    Django REST framework

    {% endblock %} +
    +
    -
    -
    -
    -
    -
    - {% block branding %}

    Django REST framework

    {% endblock %} -
    -
    - -
    -
    -
    - {% csrf_token %} -
    -
    - - - {% if form.username.errors %} -

    - {{ form.username.errors|striptags }} -

    - {% endif %} -
    -
    -
    -
    - - - {% if form.password.errors %} -

    - {{ form.password.errors|striptags }} -

    - {% endif %} -
    -
    - - {% if form.non_field_errors %} - {% for error in form.non_field_errors %} -
    {{ error }}
    - {% endfor %} - {% endif %} -
    - -
    - -
    -
    -
    -
    -
    - - {% endblock %} +
    +
    +
    + {% csrf_token %} + + +
    +
    + + + {% if form.username.errors %} +

    + {{ form.username.errors|striptags }} +

    + {% endif %} +
    +
    + +
    +
    + + + {% if form.password.errors %} +

    + {{ form.password.errors|striptags }} +

    + {% endif %} +
    +
    + + {% if form.non_field_errors %} + {% for error in form.non_field_errors %} +
    {{ error }}
    + {% endfor %} + {% endif %} + +
    + +
    + +
    +
    +
    +
    +
    + +{% endblock %} diff --git a/rest_framework/templates/rest_framework/pagination/numbers.html b/rest_framework/templates/rest_framework/pagination/numbers.html index 04045810..4ff9385f 100644 --- a/rest_framework/templates/rest_framework/pagination/numbers.html +++ b/rest_framework/templates/rest_framework/pagination/numbers.html @@ -1,27 +1,47 @@
      - {% if previous_url %} -
      • - {% else %} -
      • - {% endif %} + {% if previous_url %} +
    • + + + +
      • + {% else %} +
    • + + + +
      • + {% endif %} - {% for page_link in page_links %} - {% if page_link.is_break %} -
    • - -
      • - {% else %} - {% if page_link.is_active %} -
    • {{ page_link.number }}
      • - {% else %} -
    • {{ page_link.number }}
      • - {% endif %} - {% endif %} - {% endfor %} - - {% if next_url %} -
      • + {% for page_link in page_links %} + {% if page_link.is_break %} +
    • + +
      • {% else %} -
      • + {% if page_link.is_active %} +
    • + {{ page_link.number }} +
      • + {% else %} +
    • + {{ page_link.number }} +
      • + {% endif %} {% endif %} + {% endfor %} + + {% if next_url %} +
    • + + + +
      • + {% else %} +
    • + + + +
      • + {% endif %}
    diff --git a/rest_framework/templates/rest_framework/pagination/previous_and_next.html b/rest_framework/templates/rest_framework/pagination/previous_and_next.html index 08c17709..5563c4b6 100644 --- a/rest_framework/templates/rest_framework/pagination/previous_and_next.html +++ b/rest_framework/templates/rest_framework/pagination/previous_and_next.html @@ -1,12 +1,21 @@ diff --git a/rest_framework/templates/rest_framework/raw_data_form.html b/rest_framework/templates/rest_framework/raw_data_form.html index b4c9f1a1..2aa0beec 100644 --- a/rest_framework/templates/rest_framework/raw_data_form.html +++ b/rest_framework/templates/rest_framework/raw_data_form.html @@ -2,11 +2,11 @@ {% csrf_token %} {{ form.non_field_errors }} {% for field in form %} -
    - {{ field.label_tag|add_class:"col-sm-2 control-label" }} -
    - {{ field|add_class:"form-control" }} - {{ field.help_text }} -
    +
    + {{ field.label_tag|add_class:"col-sm-2 control-label" }} +
    + {{ field|add_class:"form-control" }} + {{ field.help_text }}
    +
    {% endfor %} diff --git a/rest_framework/templates/rest_framework/vertical/checkbox.html b/rest_framework/templates/rest_framework/vertical/checkbox.html index e21a8e90..69f19dfb 100644 --- a/rest_framework/templates/rest_framework/vertical/checkbox.html +++ b/rest_framework/templates/rest_framework/vertical/checkbox.html @@ -1,14 +1,18 @@
    -
    - -
    - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} -
    \ No newline at end of file +
    + +
    + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} + {% endif %} + + {% if field.help_text %} + {{ field.help_text }} + {% endif %} +
    diff --git a/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html b/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html index 134cca66..a3a3a08a 100644 --- a/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html +++ b/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html @@ -1,30 +1,35 @@
    - {% if field.label %} - - {% endif %} - {% if style.inline %} -
    - {% for key, text in field.choices.items %} - - {% endfor %} -
    - {% else %} - {% for key, text in field.choices.items %} -
    - -
    - {% endfor %} - {% endif %} - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} + {% if field.label %} + + {% endif %} + + {% if style.inline %} +
    + {% for key, text in field.choices.items %} + + {% endfor %} +
    + {% else %} + {% for key, text in field.choices.items %} +
    + +
    + {% endfor %} + {% endif %} + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} + {% endif %} + + {% if field.help_text %} + {{ field.help_text }} + {% endif %}
    diff --git a/rest_framework/templates/rest_framework/vertical/fieldset.html b/rest_framework/templates/rest_framework/vertical/fieldset.html index 3eb5191c..4ec2a5d4 100644 --- a/rest_framework/templates/rest_framework/vertical/fieldset.html +++ b/rest_framework/templates/rest_framework/vertical/fieldset.html @@ -1,9 +1,15 @@ {% load rest_framework %} +
    - {% if field.label %}{{ field.label }}{% endif %} - {% for nested_field in field %} - {% if not nested_field.read_only %} - {% render_field nested_field style=style %} - {% endif %} - {% endfor %} + {% if field.label %} + + {{ field.label }} + + {% endif %} + + {% for nested_field in field %} + {% if not nested_field.read_only %} + {% render_field nested_field style=style %} + {% endif %} + {% endfor %}
    diff --git a/rest_framework/templates/rest_framework/vertical/form.html b/rest_framework/templates/rest_framework/vertical/form.html index e68835c0..bd57ca19 100644 --- a/rest_framework/templates/rest_framework/vertical/form.html +++ b/rest_framework/templates/rest_framework/vertical/form.html @@ -1,11 +1,12 @@ {% load rest_framework %} +
    - {% csrf_token %} - {% for field in form %} - {% if not field.read_only %} - {% render_field field style=style %} - {% endif %} - {% endfor %} - - + {% csrf_token %} + {% for field in form %} + {% if not field.read_only %} + {% render_field field style=style %} + {% endif %} + {% endfor %} + + diff --git a/rest_framework/templates/rest_framework/vertical/input.html b/rest_framework/templates/rest_framework/vertical/input.html index 43cccd3e..71e132fe 100644 --- a/rest_framework/templates/rest_framework/vertical/input.html +++ b/rest_framework/templates/rest_framework/vertical/input.html @@ -1,12 +1,17 @@ -
    - {% if field.label %} - - {% endif %} - - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} +
    + {% if field.label %} + + {% endif %} + + + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} + {% endif %} + + {% if field.help_text %} + {{ field.help_text }} + {% endif %}
    diff --git a/rest_framework/templates/rest_framework/vertical/list_fieldset.html b/rest_framework/templates/rest_framework/vertical/list_fieldset.html index 82d7b5f4..f2b615fe 100644 --- a/rest_framework/templates/rest_framework/vertical/list_fieldset.html +++ b/rest_framework/templates/rest_framework/vertical/list_fieldset.html @@ -1,4 +1,9 @@
    - {% if field.label %}{{ field.label }}{% endif %} -

    Lists are not currently supported in HTML input.

    + {% if field.label %} + + {{ field.label }} + + {% endif %} + +

    Lists are not currently supported in HTML input.

    diff --git a/rest_framework/templates/rest_framework/vertical/radio.html b/rest_framework/templates/rest_framework/vertical/radio.html index dea03e54..bfee4e92 100644 --- a/rest_framework/templates/rest_framework/vertical/radio.html +++ b/rest_framework/templates/rest_framework/vertical/radio.html @@ -2,46 +2,55 @@ {% trans "None" as none_choice %}
    - {% if field.label %} - - {% endif %} + {% if field.label %} + + {% endif %} + {% if style.inline %} -
    +
    {% if field.allow_null or field.allow_blank %} - + {% endif %} + {% for key, text in field.choices.items %} - + {% endfor %} -
    +
    {% else %} - {% if field.allow_null or field.allow_blank %} -
    - -
    - {% endif %} - {% for key, text in field.choices.items %} -
    - -
    - {% endfor %} + {% if field.allow_null or field.allow_blank %} +
    + +
    + {% endif %} + + {% for key, text in field.choices.items %} +
    + +
    + {% endfor %} {% endif %} + {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} + {% for error in field.errors %} + {{ error }} + {% endfor %} {% endif %} + {% if field.help_text %} - {{ field.help_text }} + {{ field.help_text }} {% endif %}
    diff --git a/rest_framework/templates/rest_framework/vertical/select.html b/rest_framework/templates/rest_framework/vertical/select.html index 1d1109f6..dc32d39d 100644 --- a/rest_framework/templates/rest_framework/vertical/select.html +++ b/rest_framework/templates/rest_framework/vertical/select.html @@ -1,19 +1,27 @@
    - {% if field.label %} - - {% endif %} - - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} + {% if field.label %} + + {% endif %} + + + + {% if field.errors %} + {% for error in field.errors %} + {{ error }} + {% endfor %} + {% endif %} + + {% if field.help_text %} + {{ field.help_text }} + {% endif %}
    diff --git a/rest_framework/templates/rest_framework/vertical/select_multiple.html b/rest_framework/templates/rest_framework/vertical/select_multiple.html index 81b25c2a..2bb3d5ae 100644 --- a/rest_framework/templates/rest_framework/vertical/select_multiple.html +++ b/rest_framework/templates/rest_framework/vertical/select_multiple.html @@ -2,20 +2,25 @@ {% trans "No items to select." as no_items %}
    - {% if field.label %} - - {% endif %} - + {% if field.label %} + + {% endif %} + + + {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} + {% for error in field.errors %}{{ error }}{% endfor %} {% endif %} + {% if field.help_text %} - {{ field.help_text }} + {{ field.help_text }} {% endif %}
    diff --git a/rest_framework/templates/rest_framework/vertical/textarea.html b/rest_framework/templates/rest_framework/vertical/textarea.html index 840ea853..93a27f92 100644 --- a/rest_framework/templates/rest_framework/vertical/textarea.html +++ b/rest_framework/templates/rest_framework/vertical/textarea.html @@ -1,12 +1,17 @@
    - {% if field.label %} - - {% endif %} - - {% if field.errors %} - {% for error in field.errors %}{{ error }}{% endfor %} - {% endif %} - {% if field.help_text %} - {{ field.help_text }} - {% endif %} + {% if field.label %} + + {% endif %} + + + + {% if field.errors %} + {% for error in field.errors %}{{ error }}{% endfor %} + {% endif %} + + {% if field.help_text %} + {{ field.help_text }} + {% endif %}
    From 51cda112f584746fd1bedc4395df4754d2f82253 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Fri, 19 Jun 2015 09:21:35 -0400 Subject: [PATCH 055/487] Simplified if statement to one line solution Based on feedback on the pull request, changed solution to be simpler for issue 3042 --- rest_framework/relations.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index e56fef5d..3024bccb 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -42,8 +42,7 @@ class RelatedField(Field): 'Relational fields should not provide a `queryset` argument, ' 'when setting read_only=`True`.' ) - if 'many' in kwargs: - kwargs.pop('many') + kwargs.pop('many', None) super(RelatedField, self).__init__(**kwargs) def __new__(cls, *args, **kwargs): From 1701ddae35436c146897aa5fa1738a6550c19c61 Mon Sep 17 00:00:00 2001 From: Omer Katz Date: Sat, 20 Jun 2015 08:51:03 +0300 Subject: [PATCH 056/487] Fixed formatting of _readable_fields list comprehension to match the formatting of the _writable_fields list comprehension. --- rest_framework/serializers.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index c116cc72..a404d4e0 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -324,7 +324,10 @@ class Serializer(BaseSerializer): @cached_property def _readable_fields(self): - return [field for field in self.fields.values() if not field.write_only] + return [ + field for field in self.fields.values() + if not field.write_only + ] def get_fields(self): """ From d86e494e8679d85b12925a19ebc04e4dc0ab3afd Mon Sep 17 00:00:00 2001 From: Markus Korn Date: Mon, 22 Jun 2015 14:04:46 +0200 Subject: [PATCH 057/487] test_quests: added TestSecure for the emulation of secure connections in test cases --- tests/test_request.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/tests/test_request.py b/tests/test_request.py index ebf94530..aaa14eaf 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -275,3 +275,14 @@ class TestAuthSetter(TestCase): request = Request(factory.get('/')) request.auth = 'DUMMY' self.assertEqual(request.auth, 'DUMMY') + + +class TestSecure(TestCase): + + def test_default_secure_false(self): + request = Request(factory.get('/', secure=False)) + self.assertEqual(request.scheme, 'http') + + def test_default_secure_true(self): + request = Request(factory.get('/', secure=True)) + self.assertEqual(request.scheme, 'https') From 06c61fc51176f8145819ef4f0ac33eea827d0658 Mon Sep 17 00:00:00 2001 From: Markus Korn Date: Mon, 22 Jun 2015 14:05:56 +0200 Subject: [PATCH 058/487] compat: only add compat implementation of RequestFactory.generic() if not provided by django --- rest_framework/compat.py | 44 ++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 8555c21b..498eb8e5 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -199,8 +199,6 @@ if 'patch' not in View.http_method_names: View.http_method_names = View.http_method_names + ['patch'] -# RequestFactory only provides `generic` from 1.5 onwards -from django.test.client import RequestFactory as DjangoRequestFactory from django.test.client import FakePayload try: @@ -211,24 +209,30 @@ except ImportError: from django.utils.encoding import smart_str as force_bytes_or_smart_bytes -class RequestFactory(DjangoRequestFactory): - def generic(self, method, path, - data='', content_type='application/octet-stream', **extra): - parsed = _urlparse(path) - data = force_bytes_or_smart_bytes(data, settings.DEFAULT_CHARSET) - r = { - 'PATH_INFO': self._get_path(parsed), - 'QUERY_STRING': force_text(parsed[4]), - 'REQUEST_METHOD': six.text_type(method), - } - if data: - r.update({ - 'CONTENT_LENGTH': len(data), - 'CONTENT_TYPE': six.text_type(content_type), - 'wsgi.input': FakePayload(data), - }) - r.update(extra) - return self.request(**r) +# RequestFactory only provides `generic` from 1.5 onwards +if django.VERSION < (1, 5): + from django.test.client import RequestFactory as DjangoRequestFactory + + class RequestFactory(DjangoRequestFactory): + def generic(self, method, path, + data='', content_type='application/octet-stream', **extra): + parsed = _urlparse(path) + data = force_bytes_or_smart_bytes(data, settings.DEFAULT_CHARSET) + r = { + 'PATH_INFO': self._get_path(parsed), + 'QUERY_STRING': force_text(parsed[4]), + 'REQUEST_METHOD': six.text_type(method), + } + if data: + r.update({ + 'CONTENT_LENGTH': len(data), + 'CONTENT_TYPE': six.text_type(content_type), + 'wsgi.input': FakePayload(data), + }) + r.update(extra) + return self.request(**r) +else: + from django.test.client import RequestFactory # Markdown is optional From aa1ad4fb64b38b77b6a3937756c9cd956de5c7e4 Mon Sep 17 00:00:00 2001 From: Markus Korn Date: Mon, 22 Jun 2015 14:28:09 +0200 Subject: [PATCH 059/487] test_requests TestSecure: skip tests for django versions where the secure argument is not available --- tests/test_request.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tests/test_request.py b/tests/test_request.py index aaa14eaf..03d9f8e4 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -24,6 +24,8 @@ from rest_framework.test import APIRequestFactory, APIClient from rest_framework.views import APIView from io import BytesIO import json +import django +import pytest factory = APIRequestFactory() @@ -277,6 +279,8 @@ class TestAuthSetter(TestCase): self.assertEqual(request.auth, 'DUMMY') +@pytest.mark.skipif(django.VERSION < (1, 7), + reason='secure argument is only available for django1.7+') class TestSecure(TestCase): def test_default_secure_false(self): From b42b16d0e66394c78b19f16f102187e55211622e Mon Sep 17 00:00:00 2001 From: Markus Korn Date: Mon, 22 Jun 2015 16:13:42 +0200 Subject: [PATCH 060/487] compat: invert logic for checking the django version when implementing RequestFactory.generic() --- rest_framework/compat.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 498eb8e5..e7a73add 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -210,7 +210,9 @@ except ImportError: # RequestFactory only provides `generic` from 1.5 onwards -if django.VERSION < (1, 5): +if django.VERSION >= (1, 5): + from django.test.client import RequestFactory +else: from django.test.client import RequestFactory as DjangoRequestFactory class RequestFactory(DjangoRequestFactory): @@ -231,8 +233,6 @@ if django.VERSION < (1, 5): }) r.update(extra) return self.request(**r) -else: - from django.test.client import RequestFactory # Markdown is optional From b519407b573ee7429ce63d81a0de6bf908d2bc62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Mon, 22 Jun 2015 15:48:40 -0400 Subject: [PATCH 061/487] Track maximum supported 1.7 and 1.8 versions --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 9ffbcedc..f77ba8f8 100644 --- a/tox.ini +++ b/tox.ini @@ -16,8 +16,8 @@ deps = django14: Django==1.4.11 # Should track minimum supported django15: Django==1.5.6 # Should track minimum supported django16: Django==1.6.3 # Should track minimum supported - django17: Django==1.7.2 # Should track maximum supported - django18: Django==1.8 # Should track maximum supported + django17: Django==1.7.8 # Should track maximum supported + django18: Django==1.8.2 # Should track maximum supported djangomaster: https://github.com/django/django/archive/master.tar.gz -rrequirements/requirements-testing.txt -rrequirements/requirements-optionals.txt From 8554980c867d0edef2712ce095decb3786985874 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jose=CC=81=20Padilla?= Date: Tue, 23 Jun 2015 06:19:00 -0400 Subject: [PATCH 062/487] Add PyPI version badge to docs. Closes #3023 --- docs/index.md | 16 ++++++++++------ docs_theme/css/default.css | 4 ++-- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index a8da1946..e48b648e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,16 @@

    - + - - + + - + + + + + + +

    --- @@ -248,8 +254,6 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -[travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master -[travis-build-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.png?branch=master [mozilla]: http://www.mozilla.org/en-US/about/ [eventbrite]: https://www.eventbrite.co.uk/about/ [markdown]: http://pypi.python.org/pypi/Markdown/ diff --git a/docs_theme/css/default.css b/docs_theme/css/default.css index fdb77007..bcba6b0e 100644 --- a/docs_theme/css/default.css +++ b/docs_theme/css/default.css @@ -44,8 +44,8 @@ body.index-page #main-content iframe.twitter-share-button { margin-right: 8px; } -/* Travis CI badge */ -body.index-page #main-content img.travis-build-image { +/* Travis CI and PyPI badge */ +body.index-page #main-content img.status-badge { float: right; margin-right: 8px; margin-top: -11px; From 9bdf9a510e48f8edd549951b454cb78ed27d391e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Tue, 23 Jun 2015 07:17:12 -0400 Subject: [PATCH 063/487] Remove Twitter button for mobile rendering --- docs/index.md | 3 --- docs_theme/css/default.css | 7 ------- 2 files changed, 10 deletions(-) diff --git a/docs/index.md b/docs/index.md index e48b648e..27c50fee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,6 @@

    - - - diff --git a/docs_theme/css/default.css b/docs_theme/css/default.css index bcba6b0e..6c33b486 100644 --- a/docs_theme/css/default.css +++ b/docs_theme/css/default.css @@ -37,13 +37,6 @@ body.index-page #main-content iframe.github-star-button { margin-right: -15px; } -/* Tweet button */ -body.index-page #main-content iframe.twitter-share-button { - float: right; - margin-top: -12px; - margin-right: 8px; -} - /* Travis CI and PyPI badge */ body.index-page #main-content img.status-badge { float: right; From 83ef64dbf5a46f7d5ee269dbf82f194dc60b023a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jose=CC=81=20Padilla?= Date: Tue, 23 Jun 2015 06:35:09 -0400 Subject: [PATCH 064/487] Document setting URL_FORMAT_OVERRIDE to None This also hides the format dropdown from the Browsable API if URL_FORMAT_OVERRIDE is disabled. Closes #3057 --- docs/api-guide/settings.md | 2 ++ .../templates/rest_framework/base.html | 30 +++++++++++-------- 2 files changed, 19 insertions(+), 13 deletions(-) diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 5af429d1..6fdb77c8 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -273,6 +273,8 @@ Default: `'accept'` The name of a URL parameter that may be used to override the default `Accept` header based content negotiation. +If the value of this setting is `None` then URL format overloading will be disabled. + Default: `'format'` --- diff --git a/rest_framework/templates/rest_framework/base.html b/rest_framework/templates/rest_framework/base.html index f644e6ec..449cd380 100644 --- a/rest_framework/templates/rest_framework/base.html +++ b/rest_framework/templates/rest_framework/base.html @@ -72,20 +72,24 @@ {% if 'GET' in allowed_methods %}

    -
    - GET + {% if api_settings.URL_FORMAT_OVERRIDE %} +
    + GET - -
      - {% for format in available_formats %} -
    • - {{ format }} -
      • - {% endfor %} -
    -
    + +
      + {% for format in available_formats %} +
    • + {{ format }} +
      • + {% endfor %} +
    +
    + {% else %} + GET + {% endif %}
    {% endif %} From ab03729b584c2af8b3d8b9b0be1355c80b411df8 Mon Sep 17 00:00:00 2001 From: homm Date: Fri, 12 Jun 2015 19:21:57 +0300 Subject: [PATCH 065/487] allow cursor format customization --- rest_framework/pagination.py | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 5938063a..2fd37550 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -503,15 +503,10 @@ class CursorPagination(BasePagination): self.base_url = request.build_absolute_uri() self.ordering = self.get_ordering(request, queryset, view) - # Determine if we have a cursor, and if so then decode it. - encoded = request.query_params.get(self.cursor_query_param) - if encoded is None: - self.cursor = None + self.cursor = self.decode_cursor(request) + if self.cursor is None: (offset, reverse, current_position) = (0, False, None) else: - self.cursor = _decode_cursor(encoded) - if self.cursor is None: - raise NotFound(self.invalid_cursor_message) (offset, reverse, current_position) = self.cursor # Cursor pagination always enforces an ordering. @@ -623,8 +618,7 @@ class CursorPagination(BasePagination): position = self.previous_position cursor = Cursor(offset=offset, reverse=False, position=position) - encoded = _encode_cursor(cursor) - return replace_query_param(self.base_url, self.cursor_query_param, encoded) + return self.encode_cursor(cursor) def get_previous_link(self): if not self.has_previous: @@ -672,8 +666,7 @@ class CursorPagination(BasePagination): position = self.next_position cursor = Cursor(offset=offset, reverse=True, position=position) - encoded = _encode_cursor(cursor) - return replace_query_param(self.base_url, self.cursor_query_param, encoded) + return self.encode_cursor(cursor) def get_ordering(self, request, queryset, view): """ @@ -715,6 +708,19 @@ class CursorPagination(BasePagination): return (ordering,) return tuple(ordering) + def decode_cursor(self, request): + # Determine if we have a cursor, and if so then decode it. + encoded = request.query_params.get(self.cursor_query_param) + if encoded is not None: + cursor = _decode_cursor(encoded) + if cursor is None: + raise NotFound(self.invalid_cursor_message) + return cursor + + def encode_cursor(self, cursor): + encoded = _encode_cursor(cursor) + return replace_query_param(self.base_url, self.cursor_query_param, encoded) + def _get_position_from_instance(self, instance, ordering): attr = getattr(instance, ordering[0].lstrip('-')) return six.text_type(attr) From b3716ccb91997cb12ab659a49eb1166d0e2d97f7 Mon Sep 17 00:00:00 2001 From: homm Date: Sun, 14 Jun 2015 01:52:30 +0300 Subject: [PATCH 066/487] make MockObject, MockQuerySet and ExamplePagination visible outside of setup --- tests/test_pagination.py | 64 ++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/tests/test_pagination.py b/tests/test_pagination.py index c67550c8..56dedcae 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -186,6 +186,7 @@ class TestPageNumberPagination: def setup(self): class ExamplePagination(pagination.PageNumberPagination): page_size = 5 + self.pagination = ExamplePagination() self.queryset = range(1, 101) @@ -475,52 +476,51 @@ class TestCursorPagination: """ Unit tests for `pagination.CursorPagination`. """ + class MockObject(object): + def __init__(self, idx): + self.created = idx - def setup(self): - class MockObject(object): - def __init__(self, idx): - self.created = idx + class MockQuerySet(object): + def __init__(self, items): + self.items = list(items) - class MockQuerySet(object): - def __init__(self, items): - self.items = items - - def filter(self, created__gt=None, created__lt=None): - if created__gt is not None: - return MockQuerySet([ - item for item in self.items - if item.created > int(created__gt) - ]) - - assert created__lt is not None - return MockQuerySet([ + def filter(self, created__gt=None, created__lt=None): + if created__gt is not None: + return type(self)([ item for item in self.items - if item.created < int(created__lt) + if item.created > int(created__gt) ]) - def order_by(self, *ordering): - if ordering[0].startswith('-'): - return MockQuerySet(list(reversed(self.items))) - return self + assert created__lt is not None + return type(self)([ + item for item in self.items + if item.created < int(created__lt) + ]) - def __getitem__(self, sliced): - return self.items[sliced] + def order_by(self, *ordering): + if ordering[0].startswith('-'): + return type(self)(list(reversed(self.items))) + return self - class ExamplePagination(pagination.CursorPagination): - page_size = 5 - ordering = 'created' + def __getitem__(self, sliced): + return self.items[sliced] - self.pagination = ExamplePagination() - self.queryset = MockQuerySet([ - MockObject(idx) for idx in [ + class ExamplePagination(pagination.CursorPagination): + page_size = 5 + ordering = 'created' + + def setup(self): + self.pagination = self.ExamplePagination() + self.queryset = self.MockQuerySet( + map(self.MockObject, [ 1, 1, 1, 1, 1, 1, 2, 3, 4, 4, 4, 4, 5, 6, 7, 7, 7, 7, 7, 7, 7, 7, 7, 8, 9, 9, 9, 9, 9, 9 - ] - ]) + ]) + ) def get_pages(self, url): """ From b01e91eb71b20911c09fe4ea8126c0d24301c023 Mon Sep 17 00:00:00 2001 From: homm Date: Sun, 14 Jun 2015 01:53:11 +0300 Subject: [PATCH 067/487] test custom cursor format --- tests/test_pagination.py | 87 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 86 insertions(+), 1 deletion(-) diff --git a/tests/test_pagination.py b/tests/test_pagination.py index 56dedcae..fab61781 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -2,8 +2,9 @@ from __future__ import unicode_literals from rest_framework import exceptions, generics, pagination, serializers, status, filters from rest_framework.request import Request -from rest_framework.pagination import PageLink, PAGE_BREAK +from rest_framework.pagination import PageLink, PAGE_BREAK, Cursor from rest_framework.test import APIRequestFactory +from rest_framework.utils.urls import replace_query_param, remove_query_param import pytest factory = APIRequestFactory() @@ -509,6 +510,30 @@ class TestCursorPagination: page_size = 5 ordering = 'created' + class CustomCursorPagination(ExamplePagination): + cursor_query_param = 'since' + reverse_query_param = 'before' + + def decode_cursor(self, request): + rev = False + if self.reverse_query_param in request.query_params: + rev = True + query_param = self.reverse_query_param + elif self.cursor_query_param in request.query_params: + query_param = self.cursor_query_param + else: + return + return Cursor(0, rev, request.query_params[query_param]) + + def encode_cursor(self, cursor): + if cursor.reverse: + query_param = self.reverse_query_param + base_url = remove_query_param(self.base_url, self.cursor_query_param) + else: + query_param = self.cursor_query_param + base_url = remove_query_param(self.base_url, self.reverse_query_param) + return replace_query_param(base_url, query_param, cursor.position) + def setup(self): self.pagination = self.ExamplePagination() self.queryset = self.MockQuerySet( @@ -643,6 +668,66 @@ class TestCursorPagination: assert isinstance(self.pagination.to_html(), type('')) + def test_custom_cursor_format(self): + # setup + self.pagination = self.CustomCursorPagination() + # The CustomCursorPagination expects unique keys + self.queryset = self.MockQuerySet( + map(self.MockObject, [ + 1, 2, 4, 8, 10, + 11, 12, 13, 14, 15, + 18, 33, 35, 36, 37, + 38, 39, 40, 41, + ]) + ) + + # actual test + (previous, current, next, previous_url, next_url) = self.get_pages('/') + + assert previous is None + assert current == [1, 2, 4, 8, 10] + assert next == [11, 12, 13, 14, 15] + assert previous_url is None + assert 'since=10' in next_url + + (previous, current, next, previous_url, next_url) = self.get_pages(next_url) + + assert previous == [1, 2, 4, 8, 10] + assert current == [11, 12, 13, 14, 15] + assert next == [18, 33, 35, 36, 37] + assert 'before=11' in previous_url + assert 'since' not in previous_url + assert 'since=15' in next_url + + (previous, current, next, previous_url, next_url) = self.get_pages(next_url) + (previous, current, next, previous_url, next_url) = self.get_pages(next_url) + + assert previous == [18, 33, 35, 36, 37] + assert current == [38, 39, 40, 41] + assert next is None + assert 'before=38' in previous_url + assert 'since' not in previous_url + assert next_url is None + + (previous, current, next, previous_url, next_url) = self.get_pages(previous_url) + + assert previous == [11, 12, 13, 14, 15] + assert current == [18, 33, 35, 36, 37] + assert next == [38, 39, 40, 41] + assert 'before=18' in previous_url + assert 'since=37' in next_url + assert 'before' not in next_url + + (previous, current, next, previous_url, next_url) = self.get_pages(previous_url) + (previous, current, next, previous_url, next_url) = self.get_pages(previous_url) + + assert previous is None + assert current == [1, 2, 4, 8, 10] + assert next == [11, 12, 13, 14, 15] + assert previous_url is None + assert 'since=10' in next_url + assert 'before' not in next_url + def test_get_displayed_page_numbers(): """ From 9a5373d41c4d7f2c295edb381562c1011ed52e12 Mon Sep 17 00:00:00 2001 From: homm Date: Fri, 12 Jun 2015 18:23:12 +0300 Subject: [PATCH 068/487] make PageSizePaginationMixin from all this page_size stuff --- rest_framework/pagination.py | 53 +++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 5938063a..2b4a14a2 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -201,7 +201,34 @@ class BasePagination(object): raise NotImplementedError('to_html() must be implemented to display page controls.') -class PageNumberPagination(BasePagination): +class BasePageSizePagination(BasePagination): + # The default page size. + # Defaults to `None`, meaning pagination is disabled. + page_size = api_settings.PAGE_SIZE + + # Set to an integer to limit the maximum page size the client may request. + # Only relevant if 'page_size_query_param' has also been set. + max_page_size = None + + # Client can control the page size using this query parameter. + # Default is 'None'. Set to eg 'page_size' to enable usage. + page_size_query_param = None + + def get_page_size(self, request): + if self.page_size_query_param: + try: + return _positive_int( + request.query_params[self.page_size_query_param], + strict=True, + cutoff=self.max_page_size + ) + except (KeyError, ValueError): + pass + + return self.page_size + + +class PageNumberPagination(BasePageSizePagination): """ A simple page number based style that supports page numbers as query parameters. For example: @@ -209,21 +236,10 @@ class PageNumberPagination(BasePagination): http://api.example.org/accounts/?page=4 http://api.example.org/accounts/?page=4&page_size=100 """ - # The default page size. - # Defaults to `None`, meaning pagination is disabled. - page_size = api_settings.PAGE_SIZE # Client can control the page using this query parameter. page_query_param = 'page' - # Client can control the page size using this query parameter. - # Default is 'None'. Set to eg 'page_size' to enable usage. - page_size_query_param = None - - # Set to an integer to limit the maximum page size the client may request. - # Only relevant if 'page_size_query_param' has also been set. - max_page_size = None - last_page_strings = ('last',) template = 'rest_framework/pagination/numbers.html' @@ -318,19 +334,6 @@ class PageNumberPagination(BasePagination): ('results', data) ])) - def get_page_size(self, request): - if self.page_size_query_param: - try: - return _positive_int( - request.query_params[self.page_size_query_param], - strict=True, - cutoff=self.max_page_size - ) - except (KeyError, ValueError): - pass - - return self.page_size - def get_next_link(self): if not self.page.has_next(): return None From 60656e918266d2f564698d280ffdcc9f75bf2092 Mon Sep 17 00:00:00 2001 From: homm Date: Tue, 23 Jun 2015 19:00:42 +0300 Subject: [PATCH 069/487] merge `CursorPagination.decode_cursor` and `_decode_cursor` merge `CursorPagination.encode_cursor` and `_encode_cursor` --- rest_framework/pagination.py | 90 ++++++++++++++++-------------------- 1 file changed, 40 insertions(+), 50 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 2fd37550..78576830 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -127,50 +127,6 @@ def _get_page_links(page_numbers, current, url_func): return page_links -def _decode_cursor(encoded): - """ - Given a string representing an encoded cursor, return a `Cursor` instance. - """ - - # The offset in the cursor is used in situations where we have a - # nearly-unique index. (Eg millisecond precision creation timestamps) - # We guard against malicious users attempting to cause expensive database - # queries, by having a hard cap on the maximum possible size of the offset. - OFFSET_CUTOFF = 1000 - - try: - querystring = b64decode(encoded.encode('ascii')).decode('ascii') - tokens = urlparse.parse_qs(querystring, keep_blank_values=True) - - offset = tokens.get('o', ['0'])[0] - offset = _positive_int(offset, cutoff=OFFSET_CUTOFF) - - reverse = tokens.get('r', ['0'])[0] - reverse = bool(int(reverse)) - - position = tokens.get('p', [None])[0] - except (TypeError, ValueError): - return None - - return Cursor(offset=offset, reverse=reverse, position=position) - - -def _encode_cursor(cursor): - """ - Given a Cursor instance, return an encoded string representation. - """ - tokens = {} - if cursor.offset != 0: - tokens['o'] = str(cursor.offset) - if cursor.reverse: - tokens['r'] = '1' - if cursor.position is not None: - tokens['p'] = cursor.position - - querystring = urlparse.urlencode(tokens, doseq=True) - return b64encode(querystring.encode('ascii')).decode('ascii') - - def _reverse_ordering(ordering_tuple): """ Given an order_by tuple such as `('-created', 'uuid')` reverse the @@ -709,16 +665,50 @@ class CursorPagination(BasePagination): return tuple(ordering) def decode_cursor(self, request): + """ + Given a request with a cursor, return a `Cursor` instance. + """ # Determine if we have a cursor, and if so then decode it. encoded = request.query_params.get(self.cursor_query_param) - if encoded is not None: - cursor = _decode_cursor(encoded) - if cursor is None: - raise NotFound(self.invalid_cursor_message) - return cursor + if encoded is None: + return None + + # The offset in the cursor is used in situations where we have a + # nearly-unique index. (Eg millisecond precision creation timestamps) + # We guard against malicious users attempting to cause expensive database + # queries, by having a hard cap on the maximum possible size of the offset. + OFFSET_CUTOFF = 1000 + + try: + querystring = b64decode(encoded.encode('ascii')).decode('ascii') + tokens = urlparse.parse_qs(querystring, keep_blank_values=True) + + offset = tokens.get('o', ['0'])[0] + offset = _positive_int(offset, cutoff=OFFSET_CUTOFF) + + reverse = tokens.get('r', ['0'])[0] + reverse = bool(int(reverse)) + + position = tokens.get('p', [None])[0] + except (TypeError, ValueError): + raise NotFound(self.invalid_cursor_message) + + return Cursor(offset=offset, reverse=reverse, position=position) def encode_cursor(self, cursor): - encoded = _encode_cursor(cursor) + """ + Given a Cursor instance, return an url with encoded cursor. + """ + tokens = {} + if cursor.offset != 0: + tokens['o'] = str(cursor.offset) + if cursor.reverse: + tokens['r'] = '1' + if cursor.position is not None: + tokens['p'] = cursor.position + + querystring = urlparse.urlencode(tokens, doseq=True) + encoded = b64encode(querystring.encode('ascii')).decode('ascii') return replace_query_param(self.base_url, self.cursor_query_param, encoded) def _get_position_from_instance(self, instance, ordering): From 9bc0319ff4bdcead181efff3f9dde4df2285d3bc Mon Sep 17 00:00:00 2001 From: homm Date: Tue, 23 Jun 2015 19:01:13 +0300 Subject: [PATCH 070/487] Revert tests --- tests/test_pagination.py | 162 ++++++++++----------------------------- 1 file changed, 39 insertions(+), 123 deletions(-) diff --git a/tests/test_pagination.py b/tests/test_pagination.py index fab61781..eb3c78cc 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -2,9 +2,8 @@ from __future__ import unicode_literals from rest_framework import exceptions, generics, pagination, serializers, status, filters from rest_framework.request import Request -from rest_framework.pagination import PageLink, PAGE_BREAK, Cursor +from rest_framework.pagination import PageLink, PAGE_BREAK from rest_framework.test import APIRequestFactory -from rest_framework.utils.urls import replace_query_param, remove_query_param import pytest factory = APIRequestFactory() @@ -477,75 +476,52 @@ class TestCursorPagination: """ Unit tests for `pagination.CursorPagination`. """ - class MockObject(object): - def __init__(self, idx): - self.created = idx - - class MockQuerySet(object): - def __init__(self, items): - self.items = list(items) - - def filter(self, created__gt=None, created__lt=None): - if created__gt is not None: - return type(self)([ - item for item in self.items - if item.created > int(created__gt) - ]) - - assert created__lt is not None - return type(self)([ - item for item in self.items - if item.created < int(created__lt) - ]) - - def order_by(self, *ordering): - if ordering[0].startswith('-'): - return type(self)(list(reversed(self.items))) - return self - - def __getitem__(self, sliced): - return self.items[sliced] - - class ExamplePagination(pagination.CursorPagination): - page_size = 5 - ordering = 'created' - - class CustomCursorPagination(ExamplePagination): - cursor_query_param = 'since' - reverse_query_param = 'before' - - def decode_cursor(self, request): - rev = False - if self.reverse_query_param in request.query_params: - rev = True - query_param = self.reverse_query_param - elif self.cursor_query_param in request.query_params: - query_param = self.cursor_query_param - else: - return - return Cursor(0, rev, request.query_params[query_param]) - - def encode_cursor(self, cursor): - if cursor.reverse: - query_param = self.reverse_query_param - base_url = remove_query_param(self.base_url, self.cursor_query_param) - else: - query_param = self.cursor_query_param - base_url = remove_query_param(self.base_url, self.reverse_query_param) - return replace_query_param(base_url, query_param, cursor.position) def setup(self): - self.pagination = self.ExamplePagination() - self.queryset = self.MockQuerySet( - map(self.MockObject, [ + class MockObject(object): + def __init__(self, idx): + self.created = idx + + class MockQuerySet(object): + def __init__(self, items): + self.items = items + + def filter(self, created__gt=None, created__lt=None): + if created__gt is not None: + return MockQuerySet([ + item for item in self.items + if item.created > int(created__gt) + ]) + + assert created__lt is not None + return MockQuerySet([ + item for item in self.items + if item.created < int(created__lt) + ]) + + def order_by(self, *ordering): + if ordering[0].startswith('-'): + return MockQuerySet(list(reversed(self.items))) + return self + + def __getitem__(self, sliced): + return self.items[sliced] + + class ExamplePagination(pagination.CursorPagination): + page_size = 5 + ordering = 'created' + + self.pagination = ExamplePagination() + self.queryset = MockQuerySet([ + MockObject(idx) for idx in [ 1, 1, 1, 1, 1, 1, 2, 3, 4, 4, 4, 4, 5, 6, 7, 7, 7, 7, 7, 7, 7, 7, 7, 8, 9, 9, 9, 9, 9, 9 - ]) - ) + ] + ]) def get_pages(self, url): """ @@ -668,66 +644,6 @@ class TestCursorPagination: assert isinstance(self.pagination.to_html(), type('')) - def test_custom_cursor_format(self): - # setup - self.pagination = self.CustomCursorPagination() - # The CustomCursorPagination expects unique keys - self.queryset = self.MockQuerySet( - map(self.MockObject, [ - 1, 2, 4, 8, 10, - 11, 12, 13, 14, 15, - 18, 33, 35, 36, 37, - 38, 39, 40, 41, - ]) - ) - - # actual test - (previous, current, next, previous_url, next_url) = self.get_pages('/') - - assert previous is None - assert current == [1, 2, 4, 8, 10] - assert next == [11, 12, 13, 14, 15] - assert previous_url is None - assert 'since=10' in next_url - - (previous, current, next, previous_url, next_url) = self.get_pages(next_url) - - assert previous == [1, 2, 4, 8, 10] - assert current == [11, 12, 13, 14, 15] - assert next == [18, 33, 35, 36, 37] - assert 'before=11' in previous_url - assert 'since' not in previous_url - assert 'since=15' in next_url - - (previous, current, next, previous_url, next_url) = self.get_pages(next_url) - (previous, current, next, previous_url, next_url) = self.get_pages(next_url) - - assert previous == [18, 33, 35, 36, 37] - assert current == [38, 39, 40, 41] - assert next is None - assert 'before=38' in previous_url - assert 'since' not in previous_url - assert next_url is None - - (previous, current, next, previous_url, next_url) = self.get_pages(previous_url) - - assert previous == [11, 12, 13, 14, 15] - assert current == [18, 33, 35, 36, 37] - assert next == [38, 39, 40, 41] - assert 'before=18' in previous_url - assert 'since=37' in next_url - assert 'before' not in next_url - - (previous, current, next, previous_url, next_url) = self.get_pages(previous_url) - (previous, current, next, previous_url, next_url) = self.get_pages(previous_url) - - assert previous is None - assert current == [1, 2, 4, 8, 10] - assert next == [11, 12, 13, 14, 15] - assert previous_url is None - assert 'since=10' in next_url - assert 'before' not in next_url - def test_get_displayed_page_numbers(): """ From 30b36a594f3f262ca5fcab49ac03d29cab9f2f09 Mon Sep 17 00:00:00 2001 From: homm Date: Fri, 12 Jun 2015 18:57:46 +0300 Subject: [PATCH 071/487] use PageSizePaginationMixin for CursorPagination tests for custom page_size in CursorPagination --- rest_framework/pagination.py | 6 +++--- tests/test_pagination.py | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 2b4a14a2..5d0dc70d 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -487,20 +487,20 @@ class LimitOffsetPagination(BasePagination): return template.render(context) -class CursorPagination(BasePagination): +class CursorPagination(BasePageSizePagination): """ The cursor pagination implementation is neccessarily complex. For an overview of the position/offset style we use, see this post: http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api/ """ cursor_query_param = 'cursor' - page_size = api_settings.PAGE_SIZE invalid_cursor_message = _('Invalid cursor') ordering = '-created' template = 'rest_framework/pagination/previous_and_next.html' def paginate_queryset(self, queryset, request, view=None): - if self.page_size is None: + self.page_size = self.get_page_size(request) + if not self.page_size: return None self.base_url = request.build_absolute_uri() diff --git a/tests/test_pagination.py b/tests/test_pagination.py index c67550c8..1c23c91b 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -508,6 +508,8 @@ class TestCursorPagination: class ExamplePagination(pagination.CursorPagination): page_size = 5 + page_size_query_param = 'page_size' + max_page_size = 20 ordering = 'created' self.pagination = ExamplePagination() @@ -643,6 +645,24 @@ class TestCursorPagination: assert isinstance(self.pagination.to_html(), type('')) + def test_page_size(self): + (previous, current, next, previous_url, next_url) = \ + self.get_pages('/?page_size=10') + + assert previous is None + assert current == [1, 1, 1, 1, 1, 1, 2, 3, 4, 4] + assert next == [4, 4, 5, 6, 7, 7, 7, 7, 7, 7] + assert 'page_size=10' in next_url + + (previous, current, next, previous_url, next_url) = \ + self.get_pages(next_url.replace('page_size=10', 'page_size=4')) + + assert previous == [2, 3, 4, 4] + assert current == [4, 4, 5, 6] + assert next == [7, 7, 7, 7] + assert 'page_size=4' in previous_url + assert 'page_size=4' in next_url + def test_get_displayed_page_numbers(): """ From 47acec0f9dfa56edc261b43f26b0811434cf4390 Mon Sep 17 00:00:00 2001 From: Anton Chaporgin Date: Wed, 24 Jun 2015 11:59:49 +0300 Subject: [PATCH 072/487] Made exception message more verbose This exception helps you to upgrade from 2 -> 3 and since a lot of fields may be in 2 using serializers.Field as parent class, this message should contain at least name of upgraded field to help user to grep and fix the codebase faster. --- rest_framework/fields.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index d9322ec2..df28abec 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -417,10 +417,11 @@ class Field(object): Transform the *outgoing* native value into primitive data. """ raise NotImplementedError( - '{cls}.to_representation() must be implemented.\n' + '{cls}.to_representation() must be implemented for field {field_name}.\n' 'If you are upgrading from REST framework version 2 ' 'you might want `ReadOnlyField`.'.format( - cls=self.__class__.__name__ + cls=self.__class__.__name__, + field_name=self.field_name, ) ) From 632fc98f7787316f23e27d5fccebc9e8cc77dfb7 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 24 Jun 2015 12:57:23 +0100 Subject: [PATCH 073/487] Fix link headers in examples, as per RFC5988. --- docs/api-guide/pagination.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api-guide/pagination.md b/docs/api-guide/pagination.md index 687e4dc4..15ebc622 100644 --- a/docs/api-guide/pagination.md +++ b/docs/api-guide/pagination.md @@ -246,11 +246,11 @@ Let's modify the built-in `PageNumberPagination` style, so that instead of inclu previous_url = self.get_previous_link() if next_url is not None and previous_url is not None: - link = '<{next_url}; rel="next">, <{previous_url}; rel="prev">' + link = '<{next_url}>; rel="next", <{previous_url}>; rel="prev"' elif next_url is not None: - link = '<{next_url}; rel="next">' + link = '<{next_url}>; rel="next"' elif previous_url is not None: - link = '<{previous_url}; rel="prev">' + link = '<{previous_url}>; rel="prev"' else: link = '' From 39ece9bee02d043c5c29668f3e43130e934eb148 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 24 Jun 2015 13:32:54 +0100 Subject: [PATCH 074/487] Support allow_blank=False with trim_whitespace=True. --- rest_framework/fields.py | 2 +- tests/test_fields.py | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index d9322ec2..ff6db703 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -580,7 +580,7 @@ class CharField(Field): # Test for the empty string here so that it does not get validated, # and so that subclasses do not need to handle it explicitly # inside the `to_internal_value()` method. - if data == '': + if data == '' or (self.trim_whitespace and six.text_type(data).strip() == ''): if not self.allow_blank: self.fail('blank') return '' diff --git a/tests/test_fields.py b/tests/test_fields.py index fd2e1466..1c4228d3 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -461,6 +461,13 @@ class TestCharField(FieldValues): field = serializers.CharField(trim_whitespace=False) assert field.to_internal_value(' abc ') == ' abc ' + def test_disallow_blank_with_trim_whitespace(self): + field = serializers.CharField(allow_blank=False, trim_whitespace=True) + + with pytest.raises(serializers.ValidationError) as exc_info: + field.run_validation(' ') + assert exc_info.value.detail == ['This field may not be blank.'] + class TestEmailField(FieldValues): """ From 321133242f40e18b3d7564a43a3b515c17f3e40c Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 24 Jun 2015 14:24:19 +0100 Subject: [PATCH 075/487] Unsaved file objects may not have an associated URL. --- rest_framework/fields.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index ff6db703..275c7a9a 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1198,8 +1198,12 @@ class FileField(Field): return data def to_representation(self, value): + if not value: + return None + if self.use_url: - if not value: + if not getattr(value, 'url', None): + # If the file has not been saved it may not have a URL. return None url = value.url request = self.context.get('request', None) From d6e30c75ff1de968c15cba1516dedb226eea97b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jose=CC=81=20Padilla?= Date: Wed, 24 Jun 2015 22:02:28 -0400 Subject: [PATCH 076/487] Add test and fix for #2704 --- rest_framework/serializers.py | 4 ++-- tests/test_model_serializer.py | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 67c3569f..9e4fff44 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -13,7 +13,6 @@ response content is handled by parsers and renderers. from __future__ import unicode_literals from django.db import models from django.db.models.fields import FieldDoesNotExist, Field as DjangoModelField -from django.db.models import query from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from rest_framework.compat import ( @@ -579,7 +578,8 @@ class ListSerializer(BaseSerializer): """ # Dealing with nested relationships, data can be a Manager, # so, first get a queryset from the Manager if needed - iterable = data.all() if isinstance(data, (models.Manager, query.QuerySet)) else data + iterable = data.all() if isinstance(data, models.Manager) else data + return [ self.child.to_representation(item) for item in iterable ] diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index a1d83190..35fa0e25 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -721,3 +721,28 @@ class TestSerializerMetaClass(TestCase): str(exception), "Cannot set both 'fields' and 'exclude' options on serializer ExampleSerializer." ) + + +class Issue2704TestCase(TestCase): + def test_queryset_all(self): + class TestSerializer(serializers.ModelSerializer): + additional_attr = serializers.CharField() + + class Meta: + model = OneFieldModel + fields = ('char_field', 'additional_attr') + + OneFieldModel.objects.create(char_field='abc') + qs = OneFieldModel.objects.all() + + for o in qs: + o.additional_attr = '123' + + serializer = TestSerializer(instance=qs, many=True) + + expected = [{ + 'char_field': 'abc', + 'additional_attr': '123', + }] + + assert serializer.data == expected From e8b23c47890d110071c2d26105596db6e9b94ac8 Mon Sep 17 00:00:00 2001 From: Shtarev Date: Thu, 25 Jun 2015 21:14:00 +0300 Subject: [PATCH 077/487] thin logic --- rest_framework/filters.py | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index ff0b8e65..06dbba17 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -58,6 +58,7 @@ class DjangoFilterBackend(BaseFilterBackend): class Meta: model = queryset.model fields = filter_fields + return AutoFilterSet return None @@ -98,22 +99,24 @@ class SearchFilter(BaseFilterBackend): if not search_fields: return queryset - + if settings.DATABASES[queryset.db]["ENGINE"] == "django.db.backends.oracle": + # Remember queryset for Oracle db users + original_queryset = queryset orm_lookups = [self.construct_search(six.text_type(search_field)) for search_field in search_fields] - and_queries = [] + for search_term in self.get_search_terms(request): or_queries = [models.Q(**{orm_lookup: search_term}) for orm_lookup in orm_lookups] - and_queries.append(reduce(operator.or_, or_queries)) + queryset = queryset.filter(reduce(operator.or_, or_queries)) + if settings.DATABASES[queryset.db]["ENGINE"] != "django.db.backends.oracle": + # Oracle db don't support distinct on *LOB fields + queryset = queryset.distinct() + + if settings.DATABASES[queryset.db]["ENGINE"] == "django.db.backends.oracle": + # distinct analogue for Oracle users + queryset = original_queryset.filter(pk__in=set(queryset.values_list('pk', flat=True))) - if and_queries: - # According to Oracle DB limits there is no capability to make a DISTINT on *LOB - if settings.DATABASES[queryset.db]["ENGINE"] == "django.db.backends.oracle": - pk_list = queryset.filter(reduce(operator.and_, and_queries)).values_list('pk', flat=True) - return queryset.filter(pk__in=frozenset(pk_list)) - else: - return queryset.filter(reduce(operator.and_, and_queries)).distinct() return queryset @@ -160,7 +163,7 @@ class OrderingFilter(BaseFilterBackend): field.source or field_name for field_name, field in serializer_class().fields.items() if not getattr(field, 'write_only', False) - ] + ] elif valid_fields == '__all__': # View explicitly allows filtering on any model field valid_fields = [field.name for field in queryset.model._meta.fields] @@ -182,6 +185,7 @@ class DjangoObjectPermissionsFilter(BaseFilterBackend): A filter backend that limits results to those where the requesting user has read object level permissions. """ + def __init__(self): assert guardian, 'Using DjangoObjectPermissionsFilter, but django-guardian is not installed' From 83c9136c9013c1ae5d484739b9648c2cd4d8469b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Thu, 18 Jun 2015 09:38:29 -0400 Subject: [PATCH 078/487] Cleanup import following PEP 8 style guide --- rest_framework/authentication.py | 7 +++- rest_framework/authtoken/admin.py | 1 + rest_framework/authtoken/models.py | 4 +- rest_framework/authtoken/views.py | 3 +- rest_framework/compat.py | 11 ++++-- rest_framework/decorators.py | 7 +++- rest_framework/exceptions.py | 5 ++- rest_framework/fields.py | 38 ++++++++++--------- rest_framework/filters.py | 15 +++++--- rest_framework/generics.py | 4 +- rest_framework/metadata.py | 3 +- rest_framework/mixins.py | 1 + rest_framework/negotiation.py | 7 +++- rest_framework/pagination.py | 13 ++++--- rest_framework/parsers.py | 24 +++++++----- rest_framework/permissions.py | 3 ++ rest_framework/relations.py | 16 +++++--- rest_framework/renderers.py | 22 ++++++----- rest_framework/request.py | 12 +++--- rest_framework/response.py | 3 +- rest_framework/reverse.py | 4 +- rest_framework/routers.py | 8 ++-- rest_framework/serializers.py | 22 ++++++----- rest_framework/settings.py | 7 +++- rest_framework/templatetags/rest_framework.py | 12 ++++-- rest_framework/test.py | 14 ++++--- rest_framework/throttling.py | 5 ++- rest_framework/urlpatterns.py | 2 + rest_framework/urls.py | 1 + rest_framework/utils/breadcrumbs.py | 1 + rest_framework/utils/encoders.py | 19 ++++++---- rest_framework/utils/field_mapping.py | 6 ++- rest_framework/utils/formatting.py | 5 ++- rest_framework/utils/html.py | 1 + rest_framework/utils/mediatypes.py | 2 + rest_framework/utils/model_meta.py | 12 +++--- rest_framework/utils/representation.py | 11 ++++-- rest_framework/utils/serializer_helpers.py | 2 + rest_framework/validators.py | 2 + rest_framework/versioning.py | 9 +++-- rest_framework/views.py | 27 +++++++------ rest_framework/viewsets.py | 2 + setup.py | 4 +- tests/models.py | 1 + 44 files changed, 236 insertions(+), 142 deletions(-) diff --git a/rest_framework/authentication.py b/rest_framework/authentication.py index 598c7278..74c6b342 100644 --- a/rest_framework/authentication.py +++ b/rest_framework/authentication.py @@ -2,13 +2,16 @@ Provides various authentication policies. """ from __future__ import unicode_literals + import base64 + from django.contrib.auth import authenticate from django.middleware.csrf import CsrfViewMiddleware from django.utils.translation import ugettext_lazy as _ -from rest_framework import exceptions, HTTP_HEADER_ENCODING -from rest_framework.authtoken.models import Token + from rest_framework.compat import get_user_model +from rest_framework.authtoken.models import Token +from rest_framework import exceptions, HTTP_HEADER_ENCODING def get_authorization_header(request): diff --git a/rest_framework/authtoken/admin.py b/rest_framework/authtoken/admin.py index ec28eb1c..1a507249 100644 --- a/rest_framework/authtoken/admin.py +++ b/rest_framework/authtoken/admin.py @@ -1,4 +1,5 @@ from django.contrib import admin + from rest_framework.authtoken.models import Token diff --git a/rest_framework/authtoken/models.py b/rest_framework/authtoken/models.py index a1a9315f..f3e01a4b 100644 --- a/rest_framework/authtoken/models.py +++ b/rest_framework/authtoken/models.py @@ -1,8 +1,8 @@ -import binascii import os +import binascii -from django.conf import settings from django.db import models +from django.conf import settings from django.utils.encoding import python_2_unicode_compatible diff --git a/rest_framework/authtoken/views.py b/rest_framework/authtoken/views.py index 66bbc49b..26df9e11 100644 --- a/rest_framework/authtoken/views.py +++ b/rest_framework/authtoken/views.py @@ -1,6 +1,5 @@ +from rest_framework import parsers, renderers from rest_framework.views import APIView -from rest_framework import parsers -from rest_framework import renderers from rest_framework.response import Response from rest_framework.authtoken.models import Token from rest_framework.authtoken.serializers import AuthTokenSerializer diff --git a/rest_framework/compat.py b/rest_framework/compat.py index e7a73add..28e72cfe 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -5,14 +5,17 @@ versions of django/python, and compatibility wrappers around optional packages. # flake8: noqa from __future__ import unicode_literals -from django.core.exceptions import ImproperlyConfigured + +import inspect + +import django +from django.utils import six from django.conf import settings from django.db import connection, transaction from django.utils.encoding import force_text +from django.core.exceptions import ImproperlyConfigured from django.utils.six.moves.urllib.parse import urlparse as _urlparse -from django.utils import six -import django -import inspect + try: import importlib except ImportError: diff --git a/rest_framework/decorators.py b/rest_framework/decorators.py index 21de1acf..4c8bda39 100644 --- a/rest_framework/decorators.py +++ b/rest_framework/decorators.py @@ -7,10 +7,13 @@ based views, as well as the `@detail_route` and `@list_route` decorators, which used to annotate methods on viewsets that should be included by routers. """ from __future__ import unicode_literals -from django.utils import six -from rest_framework.views import APIView + import types +from django.utils import six + +from rest_framework.views import APIView + def api_view(http_method_names=None): diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py index f954c13e..9a467f98 100644 --- a/rest_framework/exceptions.py +++ b/rest_framework/exceptions.py @@ -5,11 +5,14 @@ In addition Django's built in 403 and 404 exceptions are handled. (`django.http.Http404` and `django.core.exceptions.PermissionDenied`) """ from __future__ import unicode_literals + +import math + from django.utils import six from django.utils.encoding import force_text from django.utils.translation import ugettext_lazy as _, ungettext + from rest_framework import status -import math def _force_text_recursive(data): diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 275c7a9a..3794329b 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1,30 +1,34 @@ from __future__ import unicode_literals + +import re +import copy +import uuid +import decimal +import inspect +import datetime +import collections + from django.conf import settings -from django.core.exceptions import ObjectDoesNotExist -from django.core.exceptions import ValidationError as DjangoValidationError -from django.core.validators import RegexValidator, ip_address_validators -from django.forms import ImageField as DjangoImageField from django.utils import six, timezone -from django.utils.dateparse import parse_date, parse_datetime, parse_time -from django.utils.encoding import is_protected_type, smart_text -from django.utils.translation import ugettext_lazy as _ from django.utils.ipv6 import clean_ipv6_address +from django.utils.translation import ugettext_lazy as _ +from django.forms import ImageField as DjangoImageField +from django.utils.encoding import is_protected_type, smart_text +from django.core.validators import RegexValidator, ip_address_validators +from django.utils.dateparse import parse_date, parse_datetime, parse_time +from django.core.exceptions import ( + ObjectDoesNotExist, ValidationError as DjangoValidationError +) + from rest_framework import ISO_8601 +from rest_framework.settings import api_settings +from rest_framework.exceptions import ValidationError +from rest_framework.utils import html, representation, humanize_datetime from rest_framework.compat import ( EmailValidator, MinValueValidator, MaxValueValidator, MinLengthValidator, MaxLengthValidator, URLValidator, OrderedDict, unicode_repr, unicode_to_repr, parse_duration, duration_string, ) -from rest_framework.exceptions import ValidationError -from rest_framework.settings import api_settings -from rest_framework.utils import html, representation, humanize_datetime -import collections -import copy -import datetime -import decimal -import inspect -import re -import uuid class empty: diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 9a84efa2..7976d06d 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -4,13 +4,16 @@ returned by list views. """ from __future__ import unicode_literals -from django.core.exceptions import ImproperlyConfigured -from django.db import models -from django.utils import six -from rest_framework.compat import django_filters, guardian, get_model_name -from rest_framework.settings import api_settings -from functools import reduce import operator +from functools import reduce + +from django.utils import six +from django.db import models +from django.core.exceptions import ImproperlyConfigured + +from rest_framework.settings import api_settings +from rest_framework.compat import django_filters, guardian, get_model_name + FilterSet = django_filters and django_filters.FilterSet or None diff --git a/rest_framework/generics.py b/rest_framework/generics.py index 61dcb84a..20eb120c 100644 --- a/rest_framework/generics.py +++ b/rest_framework/generics.py @@ -2,9 +2,11 @@ Generic views that provide commonly needed behaviour. """ from __future__ import unicode_literals -from django.db.models.query import QuerySet + from django.http import Http404 +from django.db.models.query import QuerySet from django.shortcuts import get_object_or_404 as _get_object_or_404 + from rest_framework import views, mixins from rest_framework.settings import api_settings diff --git a/rest_framework/metadata.py b/rest_framework/metadata.py index 45f5b766..df2c9d55 100644 --- a/rest_framework/metadata.py +++ b/rest_framework/metadata.py @@ -8,9 +8,10 @@ to return this information in a more standardized way. """ from __future__ import unicode_literals -from django.core.exceptions import PermissionDenied from django.http import Http404 from django.utils.encoding import force_text +from django.core.exceptions import PermissionDenied + from rest_framework import exceptions, serializers from rest_framework.compat import OrderedDict from rest_framework.request import clone_request diff --git a/rest_framework/mixins.py b/rest_framework/mixins.py index c34cfcee..1104aa29 100644 --- a/rest_framework/mixins.py +++ b/rest_framework/mixins.py @@ -5,6 +5,7 @@ We don't bind behaviour to http method handlers yet, which allows mixin classes to be composed in interesting ways. """ from __future__ import unicode_literals + from rest_framework import status from rest_framework.response import Response from rest_framework.settings import api_settings diff --git a/rest_framework/negotiation.py b/rest_framework/negotiation.py index 663ec4c8..0ec1936c 100644 --- a/rest_framework/negotiation.py +++ b/rest_framework/negotiation.py @@ -3,11 +3,14 @@ Content negotiation deals with selecting an appropriate renderer given the incoming request. Typically this will be based on the request's Accept header. """ from __future__ import unicode_literals + from django.http import Http404 + from rest_framework import HTTP_HEADER_ENCODING, exceptions from rest_framework.settings import api_settings -from rest_framework.utils.mediatypes import order_by_precedence, media_type_matches -from rest_framework.utils.mediatypes import _MediaType +from rest_framework.utils.mediatypes import ( + _MediaType, order_by_precedence, media_type_matches +) class BaseContentNegotiation(object): diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 78576830..8e45e9e6 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -4,21 +4,24 @@ Pagination serializers determine the structure of the output that should be used for paginated responses. """ from __future__ import unicode_literals + +import warnings from base64 import b64encode, b64decode from collections import namedtuple -from django.core.paginator import InvalidPage, Paginator as DjangoPaginator -from django.template import Context, loader + from django.utils import six -from django.utils.six.moves.urllib import parse as urlparse +from django.template import Context, loader from django.utils.translation import ugettext_lazy as _ +from django.utils.six.moves.urllib import parse as urlparse +from django.core.paginator import InvalidPage, Paginator as DjangoPaginator + +from rest_framework.response import Response from rest_framework.compat import OrderedDict from rest_framework.exceptions import NotFound -from rest_framework.response import Response from rest_framework.settings import api_settings from rest_framework.utils.urls import ( replace_query_param, remove_query_param ) -import warnings def _positive_int(integer_string, strict=False, cutoff=None): diff --git a/rest_framework/parsers.py b/rest_framework/parsers.py index 437d1339..3cc82085 100644 --- a/rest_framework/parsers.py +++ b/rest_framework/parsers.py @@ -6,18 +6,22 @@ on the request, such as form content or json encoded data. """ from __future__ import unicode_literals -from django.conf import settings -from django.core.files.uploadhandler import StopFutureHandlers -from django.http import QueryDict -from django.http.multipartparser import MultiPartParser as DjangoMultiPartParser -from django.http.multipartparser import MultiPartParserError, parse_header, ChunkIter -from django.utils import six -from django.utils.six.moves.urllib import parse as urlparse -from django.utils.encoding import force_text -from rest_framework.exceptions import ParseError -from rest_framework import renderers import json +from django.utils import six +from django.conf import settings +from django.http import QueryDict +from django.utils.encoding import force_text +from django.utils.six.moves.urllib import parse as urlparse +from django.core.files.uploadhandler import StopFutureHandlers +from django.http.multipartparser import ( + MultiPartParserError, parse_header, ChunkIter, + MultiPartParser as DjangoMultiPartParser +) + +from rest_framework import renderers +from rest_framework.exceptions import ParseError + class DataAndFiles(object): def __init__(self, data, files): diff --git a/rest_framework/permissions.py b/rest_framework/permissions.py index 6ded6bbb..84df7814 100644 --- a/rest_framework/permissions.py +++ b/rest_framework/permissions.py @@ -2,9 +2,12 @@ Provides a set of pluggable permission policies. """ from __future__ import unicode_literals + from django.http import Http404 + from rest_framework.compat import get_model_name + SAFE_METHODS = ('GET', 'HEAD', 'OPTIONS') diff --git a/rest_framework/relations.py b/rest_framework/relations.py index e428c7d0..36e9cf71 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -1,16 +1,20 @@ # coding: utf-8 from __future__ import unicode_literals -from django.core.exceptions import ObjectDoesNotExist, ImproperlyConfigured -from django.core.urlresolvers import get_script_prefix, resolve, NoReverseMatch, Resolver404 -from django.db.models.query import QuerySet + from django.utils import six +from django.db.models.query import QuerySet from django.utils.encoding import smart_text -from django.utils.six.moves.urllib import parse as urlparse from django.utils.translation import ugettext_lazy as _ +from django.utils.six.moves.urllib import parse as urlparse +from django.core.exceptions import ObjectDoesNotExist, ImproperlyConfigured +from django.core.urlresolvers import ( + get_script_prefix, resolve, NoReverseMatch, Resolver404 +) + +from rest_framework.utils import html +from rest_framework.reverse import reverse from rest_framework.compat import OrderedDict from rest_framework.fields import get_attribute, empty, Field -from rest_framework.reverse import reverse -from rest_framework.utils import html class PKOnlyObject(object): diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 6c7cdf53..5fca5c12 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -9,22 +9,26 @@ REST framework also provides an HTML renderer the renders the browsable API. from __future__ import unicode_literals import json + import django from django import forms -from django.core.exceptions import ImproperlyConfigured -from django.core.paginator import Page -from django.http.multipartparser import parse_header -from django.template import Context, RequestContext, loader, Template -from django.test.client import encode_multipart from django.utils import six -from rest_framework import exceptions, serializers, status, VERSION -from rest_framework.compat import SHORT_SEPARATORS, LONG_SEPARATORS, INDENT_SEPARATORS +from django.core.paginator import Page +from django.test.client import encode_multipart +from django.http.multipartparser import parse_header +from django.core.exceptions import ImproperlyConfigured +from django.template import Context, RequestContext, loader, Template + +from rest_framework.utils import encoders from rest_framework.exceptions import ParseError from rest_framework.settings import api_settings -from rest_framework.request import is_form_media_type, override_method -from rest_framework.utils import encoders from rest_framework.utils.breadcrumbs import get_breadcrumbs from rest_framework.utils.field_mapping import ClassLookupDict +from rest_framework import exceptions, serializers, status, VERSION +from rest_framework.request import is_form_media_type, override_method +from rest_framework.compat import ( + SHORT_SEPARATORS, LONG_SEPARATORS, INDENT_SEPARATORS +) def zero_as_none(value): diff --git a/rest_framework/request.py b/rest_framework/request.py index 174a9de5..614b73ab 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -9,16 +9,18 @@ The wrapped request then offers a richer API, in particular : - form overloading of HTTP method, content type and content """ from __future__ import unicode_literals + +import sys +import warnings + +from django.utils import six from django.conf import settings from django.http import QueryDict from django.http.multipartparser import parse_header -from django.utils import six from django.utils.datastructures import MultiValueDict -from rest_framework import HTTP_HEADER_ENCODING -from rest_framework import exceptions + +from rest_framework import exceptions, HTTP_HEADER_ENCODING from rest_framework.settings import api_settings -import sys -import warnings def is_form_media_type(media_type): diff --git a/rest_framework/response.py b/rest_framework/response.py index 9319e708..e7f4cd3d 100644 --- a/rest_framework/response.py +++ b/rest_framework/response.py @@ -5,9 +5,10 @@ it is initialized with unrendered data, instead of a pre-rendered string. The appropriate renderer is called during Django's template response rendering. """ from __future__ import unicode_literals + +from django.utils import six from django.utils.six.moves.http_client import responses from django.template.response import SimpleTemplateResponse -from django.utils import six class Response(SimpleTemplateResponse): diff --git a/rest_framework/reverse.py b/rest_framework/reverse.py index e6d3f563..c13b4819 100644 --- a/rest_framework/reverse.py +++ b/rest_framework/reverse.py @@ -2,10 +2,10 @@ Provide urlresolver functions that return fully qualified URLs or view names """ from __future__ import unicode_literals -from django.core.urlresolvers import reverse as django_reverse -from django.core.urlresolvers import NoReverseMatch + from django.utils import six from django.utils.functional import lazy +from django.core.urlresolvers import NoReverseMatch, reverse as django_reverse def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra): diff --git a/rest_framework/routers.py b/rest_framework/routers.py index 2792795a..f92cca00 100644 --- a/rest_framework/routers.py +++ b/rest_framework/routers.py @@ -17,13 +17,15 @@ from __future__ import unicode_literals import itertools from collections import namedtuple + from django.conf.urls import url -from django.core.exceptions import ImproperlyConfigured from django.core.urlresolvers import NoReverseMatch +from django.core.exceptions import ImproperlyConfigured + from rest_framework import views -from rest_framework.compat import get_resolver_match, OrderedDict -from rest_framework.response import Response from rest_framework.reverse import reverse +from rest_framework.response import Response +from rest_framework.compat import get_resolver_match, OrderedDict from rest_framework.urlpatterns import format_suffix_patterns diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 9e4fff44..d4a26750 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -11,29 +11,31 @@ python primitives. response content is handled by parsers and renderers. """ from __future__ import unicode_literals + +import warnings + from django.db import models -from django.db.models.fields import FieldDoesNotExist, Field as DjangoModelField from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ -from rest_framework.compat import ( - postgres_fields, - unicode_to_repr, - DurationField as ModelDurationField, +from django.db.models.fields import ( + FieldDoesNotExist, Field as DjangoModelField ) + from rest_framework.utils import model_meta -from rest_framework.utils.field_mapping import ( - get_url_kwargs, get_field_kwargs, - get_relation_kwargs, get_nested_relation_kwargs, - ClassLookupDict +from rest_framework.compat import ( + postgres_fields, unicode_to_repr, DurationField as ModelDurationField, ) from rest_framework.utils.serializer_helpers import ( ReturnDict, ReturnList, BoundField, NestedBoundField, BindingDict ) +from rest_framework.utils.field_mapping import ( + get_url_kwargs, get_field_kwargs, get_relation_kwargs, + get_nested_relation_kwargs, ClassLookupDict +) from rest_framework.validators import ( UniqueForDateValidator, UniqueForMonthValidator, UniqueForYearValidator, UniqueTogetherValidator ) -import warnings # Note: We do the following so that users of the framework can use this style: diff --git a/rest_framework/settings.py b/rest_framework/settings.py index a3e9f590..515e4aec 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -18,12 +18,15 @@ REST framework settings, checking for user settings first, then falling back to the defaults. """ from __future__ import unicode_literals -from django.test.signals import setting_changed -from django.conf import settings + from django.utils import six +from django.conf import settings +from django.test.signals import setting_changed + from rest_framework import ISO_8601 from rest_framework.compat import importlib + USER_SETTINGS = getattr(settings, 'REST_FRAMEWORK', None) DEFAULTS = { diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index bf0dc7b8..7e9110d8 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -1,14 +1,18 @@ from __future__ import unicode_literals, absolute_import + +import re + from django import template -from django.core.urlresolvers import reverse, NoReverseMatch from django.utils import six -from django.utils.encoding import iri_to_uri, force_text from django.utils.html import escape -from django.utils.safestring import SafeData, mark_safe from django.utils.html import smart_urlquote +from django.utils.safestring import SafeData, mark_safe +from django.utils.encoding import iri_to_uri, force_text +from django.core.urlresolvers import reverse, NoReverseMatch + from rest_framework.renderers import HTMLFormRenderer from rest_framework.utils.urls import replace_query_param -import re + register = template.Library() diff --git a/rest_framework/test.py b/rest_framework/test.py index a83d082a..60c69781 100644 --- a/rest_framework/test.py +++ b/rest_framework/test.py @@ -3,16 +3,18 @@ # Note that we import as `DjangoRequestFactory` and `DjangoClient` in order # to make it harder for the user to import the wrong thing without realizing. from __future__ import unicode_literals + import django -from django.conf import settings -from django.test.client import Client as DjangoClient -from django.test.client import ClientHandler -from django.test import testcases from django.utils import six +from django.conf import settings +from django.test import testcases from django.utils.http import urlencode +from django.test.client import ClientHandler, Client as DjangoClient + from rest_framework.settings import api_settings -from rest_framework.compat import RequestFactory as DjangoRequestFactory -from rest_framework.compat import force_bytes_or_smart_bytes +from rest_framework.compat import ( + force_bytes_or_smart_bytes, RequestFactory as DjangoRequestFactory +) def force_authenticate(request, user=None, token=None): diff --git a/rest_framework/throttling.py b/rest_framework/throttling.py index 261fc246..abb35346 100644 --- a/rest_framework/throttling.py +++ b/rest_framework/throttling.py @@ -2,10 +2,13 @@ Provides various throttling policies. """ from __future__ import unicode_literals + +import time + from django.core.cache import cache as default_cache from django.core.exceptions import ImproperlyConfigured + from rest_framework.settings import api_settings -import time class BaseThrottle(object): diff --git a/rest_framework/urlpatterns.py b/rest_framework/urlpatterns.py index 2e4369f7..7b151626 100644 --- a/rest_framework/urlpatterns.py +++ b/rest_framework/urlpatterns.py @@ -1,6 +1,8 @@ from __future__ import unicode_literals + from django.conf.urls import url, include from django.core.urlresolvers import RegexURLResolver + from rest_framework.settings import api_settings diff --git a/rest_framework/urls.py b/rest_framework/urls.py index ee37eb20..11152423 100644 --- a/rest_framework/urls.py +++ b/rest_framework/urls.py @@ -13,6 +13,7 @@ The urls must be namespaced as 'rest_framework', and you should make sure your authentication settings include `SessionAuthentication`. """ from __future__ import unicode_literals + from django.conf.urls import url from django.contrib.auth import views diff --git a/rest_framework/utils/breadcrumbs.py b/rest_framework/utils/breadcrumbs.py index e6690d17..af786810 100644 --- a/rest_framework/utils/breadcrumbs.py +++ b/rest_framework/utils/breadcrumbs.py @@ -1,4 +1,5 @@ from __future__ import unicode_literals + from django.core.urlresolvers import resolve, get_script_prefix diff --git a/rest_framework/utils/encoders.py b/rest_framework/utils/encoders.py index 2160d18b..62bbfaff 100644 --- a/rest_framework/utils/encoders.py +++ b/rest_framework/utils/encoders.py @@ -2,15 +2,18 @@ Helper classes for parsers. """ from __future__ import unicode_literals -from django.db.models.query import QuerySet -from django.utils import six, timezone -from django.utils.encoding import force_text -from django.utils.functional import Promise -from rest_framework.compat import total_seconds -import datetime -import decimal -import json + import uuid +import json +import decimal +import datetime + +from django.utils import six, timezone +from django.db.models.query import QuerySet +from django.utils.functional import Promise +from django.utils.encoding import force_text + +from rest_framework.compat import total_seconds class JSONEncoder(json.JSONEncoder): diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index f20628be..8fcb8c33 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -2,12 +2,14 @@ Helper functions for mapping model fields to a dictionary of default keyword arguments that should be used for their equivelent serializer fields. """ -from django.core import validators +import inspect + from django.db import models +from django.core import validators from django.utils.text import capfirst + from rest_framework.compat import clean_manytomany_helptext from rest_framework.validators import UniqueValidator -import inspect NUMERIC_FIELD_TYPES = ( diff --git a/rest_framework/utils/formatting.py b/rest_framework/utils/formatting.py index 8b6f005e..5ad974e7 100644 --- a/rest_framework/utils/formatting.py +++ b/rest_framework/utils/formatting.py @@ -2,10 +2,13 @@ Utility functions to return a formatted name and description for a given view. """ from __future__ import unicode_literals + +import re + from django.utils.html import escape from django.utils.safestring import mark_safe + from rest_framework.compat import apply_markdown, force_text -import re def remove_trailing_string(content, trailing): diff --git a/rest_framework/utils/html.py b/rest_framework/utils/html.py index d773952d..341f7bcd 100644 --- a/rest_framework/utils/html.py +++ b/rest_framework/utils/html.py @@ -2,6 +2,7 @@ Helpers for dealing with HTML input. """ import re + from django.utils.datastructures import MultiValueDict diff --git a/rest_framework/utils/mediatypes.py b/rest_framework/utils/mediatypes.py index de2931c2..def4b964 100644 --- a/rest_framework/utils/mediatypes.py +++ b/rest_framework/utils/mediatypes.py @@ -4,8 +4,10 @@ Handling of media types, as found in HTTP Content-Type and Accept headers. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7 """ from __future__ import unicode_literals + from django.http.multipartparser import parse_header from django.utils.encoding import python_2_unicode_compatible + from rest_framework import HTTP_HEADER_ENCODING diff --git a/rest_framework/utils/model_meta.py b/rest_framework/utils/model_meta.py index 19f751b0..9fe2e706 100644 --- a/rest_framework/utils/model_meta.py +++ b/rest_framework/utils/model_meta.py @@ -5,12 +5,14 @@ relationships and their associated metadata. Usage: `get_field_info(model)` returns a `FieldInfo` instance. """ -from collections import namedtuple -from django.core.exceptions import ImproperlyConfigured -from django.db import models -from django.utils import six -from rest_framework.compat import OrderedDict import inspect +from collections import namedtuple + +from django.utils import six +from django.db import models +from django.core.exceptions import ImproperlyConfigured + +from rest_framework.compat import OrderedDict FieldInfo = namedtuple('FieldResult', [ diff --git a/rest_framework/utils/representation.py b/rest_framework/utils/representation.py index 1bfc64c1..1bd579f6 100644 --- a/rest_framework/utils/representation.py +++ b/rest_framework/utils/representation.py @@ -3,12 +3,15 @@ Helper functions for creating user-friendly representations of serializer classes and serializer fields. """ from __future__ import unicode_literals -from django.db import models -from django.utils.encoding import force_text -from django.utils.functional import Promise -from rest_framework.compat import unicode_repr + import re +from django.db import models +from django.utils.functional import Promise +from django.utils.encoding import force_text + +from rest_framework.compat import unicode_repr + def manager_repr(value): model = value.model diff --git a/rest_framework/utils/serializer_helpers.py b/rest_framework/utils/serializer_helpers.py index 87bb3ac0..b751a358 100644 --- a/rest_framework/utils/serializer_helpers.py +++ b/rest_framework/utils/serializer_helpers.py @@ -1,5 +1,7 @@ from __future__ import unicode_literals + import collections + from rest_framework.compat import OrderedDict, unicode_to_repr diff --git a/rest_framework/validators.py b/rest_framework/validators.py index 6ae80b89..a1771a92 100644 --- a/rest_framework/validators.py +++ b/rest_framework/validators.py @@ -7,7 +7,9 @@ object creation, and makes it possible to switch between using the implicit `ModelSerializer` class and an equivalent explicit `Serializer` class. """ from __future__ import unicode_literals + from django.utils.translation import ugettext_lazy as _ + from rest_framework.compat import unicode_to_repr from rest_framework.exceptions import ValidationError from rest_framework.utils.representation import smart_repr diff --git a/rest_framework/versioning.py b/rest_framework/versioning.py index 27c2d879..4ee6e254 100644 --- a/rest_framework/versioning.py +++ b/rest_framework/versioning.py @@ -1,13 +1,16 @@ # coding: utf-8 from __future__ import unicode_literals + +import re + from django.utils.translation import ugettext_lazy as _ + from rest_framework import exceptions -from rest_framework.compat import unicode_http_header from rest_framework.reverse import _reverse from rest_framework.settings import api_settings -from rest_framework.templatetags.rest_framework import replace_query_param +from rest_framework.compat import unicode_http_header from rest_framework.utils.mediatypes import _MediaType -import re +from rest_framework.templatetags.rest_framework import replace_query_param class BaseVersioning(object): diff --git a/rest_framework/views.py b/rest_framework/views.py index 55fb8979..2230c6dc 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -2,21 +2,24 @@ Provides an APIView class that is the base of all views in REST framework. """ from __future__ import unicode_literals -from django.core.exceptions import PermissionDenied -from django.http import Http404 -from django.utils import six -from django.utils.encoding import smart_text -from django.utils.translation import ugettext_lazy as _ -from django.views.decorators.csrf import csrf_exempt -from rest_framework import status, exceptions -from rest_framework.compat import HttpResponseBase, View, set_rollback -from rest_framework.request import Request -from rest_framework.response import Response -from rest_framework.settings import api_settings -from rest_framework.utils import formatting + import inspect import warnings +from django.utils import six +from django.http import Http404 +from django.utils.encoding import smart_text +from django.core.exceptions import PermissionDenied +from django.views.decorators.csrf import csrf_exempt +from django.utils.translation import ugettext_lazy as _ + +from rest_framework import status, exceptions +from rest_framework.request import Request +from rest_framework.utils import formatting +from rest_framework.response import Response +from rest_framework.settings import api_settings +from rest_framework.compat import HttpResponseBase, View, set_rollback + def get_view_name(view_cls, suffix=None): """ diff --git a/rest_framework/viewsets.py b/rest_framework/viewsets.py index 88c763da..e9fa41fb 100644 --- a/rest_framework/viewsets.py +++ b/rest_framework/viewsets.py @@ -19,8 +19,10 @@ automatically. from __future__ import unicode_literals from functools import update_wrapper + from django.utils.decorators import classonlymethod from django.views.decorators.csrf import csrf_exempt + from rest_framework import views, generics, mixins diff --git a/setup.py b/setup.py index 4cdcfa86..ca802774 100755 --- a/setup.py +++ b/setup.py @@ -1,11 +1,9 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- - -from setuptools import setup -from setuptools.command.test import test as TestCommand import re import os import sys +from setuptools import setup def get_version(package): diff --git a/tests/models.py b/tests/models.py index 456b0a0b..c265182b 100644 --- a/tests/models.py +++ b/tests/models.py @@ -1,4 +1,5 @@ from __future__ import unicode_literals + from django.db import models from django.utils.translation import ugettext_lazy as _ From 7351a3f6ca7028868a79a6f2dae36ccb2fc7dd65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Thu, 25 Jun 2015 16:55:51 -0400 Subject: [PATCH 079/487] Sort imports with isort --- rest_framework/authentication.py | 4 +-- .../authtoken/migrations/0001_initial.py | 2 +- rest_framework/authtoken/models.py | 5 ++- rest_framework/authtoken/views.py | 4 +-- rest_framework/compat.py | 8 ++--- rest_framework/exceptions.py | 3 +- rest_framework/fields.py | 33 +++++++++---------- rest_framework/filters.py | 7 ++-- rest_framework/generics.py | 4 +-- rest_framework/metadata.py | 2 +- rest_framework/negotiation.py | 2 +- rest_framework/pagination.py | 15 ++++----- rest_framework/parsers.py | 13 ++++---- rest_framework/permissions.py | 1 - rest_framework/relations.py | 20 +++++------ rest_framework/renderers.py | 22 ++++++------- rest_framework/request.py | 4 +-- rest_framework/response.py | 2 +- rest_framework/reverse.py | 3 +- rest_framework/routers.py | 7 ++-- rest_framework/serializers.py | 24 ++++++-------- rest_framework/settings.py | 3 +- rest_framework/templatetags/rest_framework.py | 10 +++--- rest_framework/test.py | 10 +++--- rest_framework/urlpatterns.py | 2 +- rest_framework/urls.py | 1 - rest_framework/utils/breadcrumbs.py | 2 +- rest_framework/utils/encoders.py | 10 +++--- rest_framework/utils/field_mapping.py | 3 +- rest_framework/utils/model_meta.py | 5 ++- rest_framework/utils/representation.py | 2 +- rest_framework/versioning.py | 4 +-- rest_framework/views.py | 14 ++++---- rest_framework/viewsets.py | 2 +- setup.py | 3 +- tests/browsable_api/auth_urls.py | 4 +-- tests/browsable_api/no_auth_urls.py | 1 + tests/browsable_api/test_browsable_api.py | 1 + tests/browsable_api/views.py | 5 ++- tests/description.py | 1 - tests/test_atomic_requests.py | 4 +-- tests/test_authentication.py | 25 +++++++------- tests/test_decorators.py | 16 ++++----- tests/test_description.py | 9 +++-- tests/test_fields.py | 12 ++++--- tests/test_filters.py | 9 +++-- tests/test_generics.py | 7 ++-- tests/test_htmlrenderer.py | 8 +++-- tests/test_metadata.py | 10 ++++-- tests/test_middleware.py | 2 +- tests/test_model_serializer.py | 11 +++++-- tests/test_multitable_inheritance.py | 2 ++ tests/test_negotiation.py | 11 ++++--- tests/test_pagination.py | 12 ++++--- tests/test_parsers.py | 4 ++- tests/test_permissions.py | 16 ++++++--- tests/test_relations.py | 9 +++-- tests/test_relations_generic.py | 6 +++- tests/test_relations_hyperlink.py | 6 ++-- tests/test_relations_pk.py | 6 ++-- tests/test_relations_slug.py | 5 ++- tests/test_renderers.py | 21 ++++++------ tests/test_request.py | 23 +++++++------ tests/test_response.py | 20 +++++------ tests/test_reverse.py | 2 ++ tests/test_routers.py | 13 +++++--- tests/test_serializer.py | 10 ++++-- tests/test_serializer_bulk_update.py | 2 ++ tests/test_serializer_lists.py | 3 +- tests/test_settings.py | 2 ++ tests/test_status.py | 5 ++- tests/test_templatetags.py | 9 +++-- tests/test_testing.py | 9 +++-- tests/test_throttling.py | 10 ++++-- tests/test_urlpatterns.py | 6 ++-- tests/test_utils.py | 11 ++++--- tests/test_validation.py | 7 ++-- tests/test_validators.py | 4 ++- tests/test_versioning.py | 11 ++++--- tests/test_views.py | 4 ++- tests/test_viewsets.py | 2 +- tests/test_write_only_fields.py | 1 + 82 files changed, 355 insertions(+), 278 deletions(-) diff --git a/rest_framework/authentication.py b/rest_framework/authentication.py index 74c6b342..088eac4c 100644 --- a/rest_framework/authentication.py +++ b/rest_framework/authentication.py @@ -9,9 +9,9 @@ from django.contrib.auth import authenticate from django.middleware.csrf import CsrfViewMiddleware from django.utils.translation import ugettext_lazy as _ -from rest_framework.compat import get_user_model +from rest_framework import HTTP_HEADER_ENCODING, exceptions from rest_framework.authtoken.models import Token -from rest_framework import exceptions, HTTP_HEADER_ENCODING +from rest_framework.compat import get_user_model def get_authorization_header(request): diff --git a/rest_framework/authtoken/migrations/0001_initial.py b/rest_framework/authtoken/migrations/0001_initial.py index 769f6202..0eb9fbcb 100644 --- a/rest_framework/authtoken/migrations/0001_initial.py +++ b/rest_framework/authtoken/migrations/0001_initial.py @@ -1,8 +1,8 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.db import models, migrations from django.conf import settings +from django.db import migrations, models class Migration(migrations.Migration): diff --git a/rest_framework/authtoken/models.py b/rest_framework/authtoken/models.py index f3e01a4b..b329ee65 100644 --- a/rest_framework/authtoken/models.py +++ b/rest_framework/authtoken/models.py @@ -1,11 +1,10 @@ -import os import binascii +import os -from django.db import models from django.conf import settings +from django.db import models from django.utils.encoding import python_2_unicode_compatible - # Prior to Django 1.5, the AUTH_USER_MODEL setting does not exist. # Note that we don't perform this code in the compat module due to # bug report #1297 diff --git a/rest_framework/authtoken/views.py b/rest_framework/authtoken/views.py index 26df9e11..74368405 100644 --- a/rest_framework/authtoken/views.py +++ b/rest_framework/authtoken/views.py @@ -1,8 +1,8 @@ from rest_framework import parsers, renderers -from rest_framework.views import APIView -from rest_framework.response import Response from rest_framework.authtoken.models import Token from rest_framework.authtoken.serializers import AuthTokenSerializer +from rest_framework.response import Response +from rest_framework.views import APIView class ObtainAuthToken(APIView): diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 28e72cfe..d11c6809 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -9,11 +9,12 @@ from __future__ import unicode_literals import inspect import django -from django.utils import six from django.conf import settings -from django.db import connection, transaction -from django.utils.encoding import force_text from django.core.exceptions import ImproperlyConfigured +from django.db import connection, transaction +from django.test.client import FakePayload +from django.utils import six +from django.utils.encoding import force_text from django.utils.six.moves.urllib.parse import urlparse as _urlparse try: @@ -202,7 +203,6 @@ if 'patch' not in View.http_method_names: View.http_method_names = View.http_method_names + ['patch'] -from django.test.client import FakePayload try: # In 1.5 the test client uses force_bytes diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py index 9a467f98..f587d10f 100644 --- a/rest_framework/exceptions.py +++ b/rest_framework/exceptions.py @@ -10,7 +10,8 @@ import math from django.utils import six from django.utils.encoding import force_text -from django.utils.translation import ugettext_lazy as _, ungettext +from django.utils.translation import ugettext_lazy as _ +from django.utils.translation import ungettext from rest_framework import status diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 3794329b..7960295b 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1,34 +1,33 @@ from __future__ import unicode_literals -import re +import collections import copy -import uuid +import datetime import decimal import inspect -import datetime -import collections +import re +import uuid from django.conf import settings +from django.core.exceptions import ValidationError as DjangoValidationError +from django.core.exceptions import ObjectDoesNotExist +from django.core.validators import RegexValidator, ip_address_validators +from django.forms import ImageField as DjangoImageField from django.utils import six, timezone +from django.utils.dateparse import parse_date, parse_datetime, parse_time +from django.utils.encoding import is_protected_type, smart_text from django.utils.ipv6 import clean_ipv6_address from django.utils.translation import ugettext_lazy as _ -from django.forms import ImageField as DjangoImageField -from django.utils.encoding import is_protected_type, smart_text -from django.core.validators import RegexValidator, ip_address_validators -from django.utils.dateparse import parse_date, parse_datetime, parse_time -from django.core.exceptions import ( - ObjectDoesNotExist, ValidationError as DjangoValidationError -) from rest_framework import ISO_8601 -from rest_framework.settings import api_settings -from rest_framework.exceptions import ValidationError -from rest_framework.utils import html, representation, humanize_datetime from rest_framework.compat import ( - EmailValidator, MinValueValidator, MaxValueValidator, - MinLengthValidator, MaxLengthValidator, URLValidator, OrderedDict, - unicode_repr, unicode_to_repr, parse_duration, duration_string, + EmailValidator, MaxLengthValidator, MaxValueValidator, MinLengthValidator, + MinValueValidator, OrderedDict, URLValidator, duration_string, + parse_duration, unicode_repr, unicode_to_repr ) +from rest_framework.exceptions import ValidationError +from rest_framework.settings import api_settings +from rest_framework.utils import html, humanize_datetime, representation class empty: diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 7976d06d..294d1b22 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -7,13 +7,12 @@ from __future__ import unicode_literals import operator from functools import reduce -from django.utils import six -from django.db import models from django.core.exceptions import ImproperlyConfigured +from django.db import models +from django.utils import six +from rest_framework.compat import django_filters, get_model_name, guardian from rest_framework.settings import api_settings -from rest_framework.compat import django_filters, guardian, get_model_name - FilterSet = django_filters and django_filters.FilterSet or None diff --git a/rest_framework/generics.py b/rest_framework/generics.py index 20eb120c..88438e8c 100644 --- a/rest_framework/generics.py +++ b/rest_framework/generics.py @@ -3,11 +3,11 @@ Generic views that provide commonly needed behaviour. """ from __future__ import unicode_literals -from django.http import Http404 from django.db.models.query import QuerySet +from django.http import Http404 from django.shortcuts import get_object_or_404 as _get_object_or_404 -from rest_framework import views, mixins +from rest_framework import mixins, views from rest_framework.settings import api_settings diff --git a/rest_framework/metadata.py b/rest_framework/metadata.py index df2c9d55..3c7b3d2a 100644 --- a/rest_framework/metadata.py +++ b/rest_framework/metadata.py @@ -8,9 +8,9 @@ to return this information in a more standardized way. """ from __future__ import unicode_literals +from django.core.exceptions import PermissionDenied from django.http import Http404 from django.utils.encoding import force_text -from django.core.exceptions import PermissionDenied from rest_framework import exceptions, serializers from rest_framework.compat import OrderedDict diff --git a/rest_framework/negotiation.py b/rest_framework/negotiation.py index 0ec1936c..b9263c44 100644 --- a/rest_framework/negotiation.py +++ b/rest_framework/negotiation.py @@ -9,7 +9,7 @@ from django.http import Http404 from rest_framework import HTTP_HEADER_ENCODING, exceptions from rest_framework.settings import api_settings from rest_framework.utils.mediatypes import ( - _MediaType, order_by_precedence, media_type_matches + _MediaType, media_type_matches, order_by_precedence ) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 8e45e9e6..bea10d03 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -6,22 +6,21 @@ be used for paginated responses. from __future__ import unicode_literals import warnings -from base64 import b64encode, b64decode +from base64 import b64decode, b64encode from collections import namedtuple -from django.utils import six +from django.core.paginator import Paginator as DjangoPaginator +from django.core.paginator import InvalidPage from django.template import Context, loader -from django.utils.translation import ugettext_lazy as _ +from django.utils import six from django.utils.six.moves.urllib import parse as urlparse -from django.core.paginator import InvalidPage, Paginator as DjangoPaginator +from django.utils.translation import ugettext_lazy as _ -from rest_framework.response import Response from rest_framework.compat import OrderedDict from rest_framework.exceptions import NotFound +from rest_framework.response import Response from rest_framework.settings import api_settings -from rest_framework.utils.urls import ( - replace_query_param, remove_query_param -) +from rest_framework.utils.urls import remove_query_param, replace_query_param def _positive_int(integer_string, strict=False, cutoff=None): diff --git a/rest_framework/parsers.py b/rest_framework/parsers.py index 3cc82085..2dc808f1 100644 --- a/rest_framework/parsers.py +++ b/rest_framework/parsers.py @@ -8,16 +8,17 @@ from __future__ import unicode_literals import json -from django.utils import six from django.conf import settings +from django.core.files.uploadhandler import StopFutureHandlers from django.http import QueryDict +from django.http.multipartparser import \ + MultiPartParser as DjangoMultiPartParser +from django.http.multipartparser import ( + ChunkIter, MultiPartParserError, parse_header +) +from django.utils import six from django.utils.encoding import force_text from django.utils.six.moves.urllib import parse as urlparse -from django.core.files.uploadhandler import StopFutureHandlers -from django.http.multipartparser import ( - MultiPartParserError, parse_header, ChunkIter, - MultiPartParser as DjangoMultiPartParser -) from rest_framework import renderers from rest_framework.exceptions import ParseError diff --git a/rest_framework/permissions.py b/rest_framework/permissions.py index 84df7814..62853890 100644 --- a/rest_framework/permissions.py +++ b/rest_framework/permissions.py @@ -7,7 +7,6 @@ from django.http import Http404 from rest_framework.compat import get_model_name - SAFE_METHODS = ('GET', 'HEAD', 'OPTIONS') diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 36e9cf71..ca39dbad 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -1,20 +1,20 @@ # coding: utf-8 from __future__ import unicode_literals -from django.utils import six -from django.db.models.query import QuerySet -from django.utils.encoding import smart_text -from django.utils.translation import ugettext_lazy as _ -from django.utils.six.moves.urllib import parse as urlparse -from django.core.exceptions import ObjectDoesNotExist, ImproperlyConfigured +from django.core.exceptions import ImproperlyConfigured, ObjectDoesNotExist from django.core.urlresolvers import ( - get_script_prefix, resolve, NoReverseMatch, Resolver404 + NoReverseMatch, Resolver404, get_script_prefix, resolve ) +from django.db.models.query import QuerySet +from django.utils import six +from django.utils.encoding import smart_text +from django.utils.six.moves.urllib import parse as urlparse +from django.utils.translation import ugettext_lazy as _ -from rest_framework.utils import html -from rest_framework.reverse import reverse from rest_framework.compat import OrderedDict -from rest_framework.fields import get_attribute, empty, Field +from rest_framework.fields import Field, empty, get_attribute +from rest_framework.reverse import reverse +from rest_framework.utils import html class PKOnlyObject(object): diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 5fca5c12..6e1370b7 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -12,23 +12,23 @@ import json import django from django import forms -from django.utils import six -from django.core.paginator import Page -from django.test.client import encode_multipart -from django.http.multipartparser import parse_header from django.core.exceptions import ImproperlyConfigured -from django.template import Context, RequestContext, loader, Template +from django.core.paginator import Page +from django.http.multipartparser import parse_header +from django.template import Context, RequestContext, Template, loader +from django.test.client import encode_multipart +from django.utils import six -from rest_framework.utils import encoders +from rest_framework import VERSION, exceptions, serializers, status +from rest_framework.compat import ( + INDENT_SEPARATORS, LONG_SEPARATORS, SHORT_SEPARATORS +) from rest_framework.exceptions import ParseError +from rest_framework.request import is_form_media_type, override_method from rest_framework.settings import api_settings +from rest_framework.utils import encoders from rest_framework.utils.breadcrumbs import get_breadcrumbs from rest_framework.utils.field_mapping import ClassLookupDict -from rest_framework import exceptions, serializers, status, VERSION -from rest_framework.request import is_form_media_type, override_method -from rest_framework.compat import ( - SHORT_SEPARATORS, LONG_SEPARATORS, INDENT_SEPARATORS -) def zero_as_none(value): diff --git a/rest_framework/request.py b/rest_framework/request.py index 614b73ab..568ba1b5 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -13,13 +13,13 @@ from __future__ import unicode_literals import sys import warnings -from django.utils import six from django.conf import settings from django.http import QueryDict from django.http.multipartparser import parse_header +from django.utils import six from django.utils.datastructures import MultiValueDict -from rest_framework import exceptions, HTTP_HEADER_ENCODING +from rest_framework import HTTP_HEADER_ENCODING, exceptions from rest_framework.settings import api_settings diff --git a/rest_framework/response.py b/rest_framework/response.py index e7f4cd3d..47d94765 100644 --- a/rest_framework/response.py +++ b/rest_framework/response.py @@ -6,9 +6,9 @@ The appropriate renderer is called during Django's template response rendering. """ from __future__ import unicode_literals +from django.template.response import SimpleTemplateResponse from django.utils import six from django.utils.six.moves.http_client import responses -from django.template.response import SimpleTemplateResponse class Response(SimpleTemplateResponse): diff --git a/rest_framework/reverse.py b/rest_framework/reverse.py index c13b4819..dae4b821 100644 --- a/rest_framework/reverse.py +++ b/rest_framework/reverse.py @@ -3,9 +3,10 @@ Provide urlresolver functions that return fully qualified URLs or view names """ from __future__ import unicode_literals +from django.core.urlresolvers import reverse as django_reverse +from django.core.urlresolvers import NoReverseMatch from django.utils import six from django.utils.functional import lazy -from django.core.urlresolvers import NoReverseMatch, reverse as django_reverse def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra): diff --git a/rest_framework/routers.py b/rest_framework/routers.py index f92cca00..380f3bb4 100644 --- a/rest_framework/routers.py +++ b/rest_framework/routers.py @@ -19,16 +19,15 @@ import itertools from collections import namedtuple from django.conf.urls import url -from django.core.urlresolvers import NoReverseMatch from django.core.exceptions import ImproperlyConfigured +from django.core.urlresolvers import NoReverseMatch from rest_framework import views -from rest_framework.reverse import reverse +from rest_framework.compat import OrderedDict, get_resolver_match from rest_framework.response import Response -from rest_framework.compat import get_resolver_match, OrderedDict +from rest_framework.reverse import reverse from rest_framework.urlpatterns import format_suffix_patterns - Route = namedtuple('Route', ['url', 'mapping', 'name', 'initkwargs']) DynamicDetailRoute = namedtuple('DynamicDetailRoute', ['url', 'name', 'initkwargs']) DynamicListRoute = namedtuple('DynamicListRoute', ['url', 'name', 'initkwargs']) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index d4a26750..3a452bcc 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -15,29 +15,26 @@ from __future__ import unicode_literals import warnings from django.db import models +from django.db.models.fields import Field as DjangoModelField +from django.db.models.fields import FieldDoesNotExist from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ -from django.db.models.fields import ( - FieldDoesNotExist, Field as DjangoModelField -) +from rest_framework.compat import DurationField as ModelDurationField +from rest_framework.compat import postgres_fields, unicode_to_repr from rest_framework.utils import model_meta -from rest_framework.compat import ( - postgres_fields, unicode_to_repr, DurationField as ModelDurationField, +from rest_framework.utils.field_mapping import ( + ClassLookupDict, get_field_kwargs, get_nested_relation_kwargs, + get_relation_kwargs, get_url_kwargs ) from rest_framework.utils.serializer_helpers import ( - ReturnDict, ReturnList, BoundField, NestedBoundField, BindingDict -) -from rest_framework.utils.field_mapping import ( - get_url_kwargs, get_field_kwargs, get_relation_kwargs, - get_nested_relation_kwargs, ClassLookupDict + BindingDict, BoundField, NestedBoundField, ReturnDict, ReturnList ) from rest_framework.validators import ( UniqueForDateValidator, UniqueForMonthValidator, UniqueForYearValidator, UniqueTogetherValidator ) - # Note: We do the following so that users of the framework can use this style: # # example_field = serializers.CharField(...) @@ -45,9 +42,8 @@ from rest_framework.validators import ( # This helps keep the separation between model fields, form fields, and # serializer fields more explicit. -from rest_framework.relations import * # NOQA -from rest_framework.fields import * # NOQA - +from rest_framework.fields import * # NOQA # isort:skip +from rest_framework.relations import * # NOQA # isort:skip # We assume that 'validators' are intended for the child serializer, # rather than the parent serializer. diff --git a/rest_framework/settings.py b/rest_framework/settings.py index 515e4aec..4c46a483 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -19,14 +19,13 @@ back to the defaults. """ from __future__ import unicode_literals -from django.utils import six from django.conf import settings from django.test.signals import setting_changed +from django.utils import six from rest_framework import ISO_8601 from rest_framework.compat import importlib - USER_SETTINGS = getattr(settings, 'REST_FRAMEWORK', None) DEFAULTS = { diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index 7e9110d8..3018489f 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -1,19 +1,17 @@ -from __future__ import unicode_literals, absolute_import +from __future__ import absolute_import, unicode_literals import re from django import template +from django.core.urlresolvers import NoReverseMatch, reverse from django.utils import six -from django.utils.html import escape -from django.utils.html import smart_urlquote +from django.utils.encoding import force_text, iri_to_uri +from django.utils.html import escape, smart_urlquote from django.utils.safestring import SafeData, mark_safe -from django.utils.encoding import iri_to_uri, force_text -from django.core.urlresolvers import reverse, NoReverseMatch from rest_framework.renderers import HTMLFormRenderer from rest_framework.utils.urls import replace_query_param - register = template.Library() # Regex for adding classes to html snippets diff --git a/rest_framework/test.py b/rest_framework/test.py index 60c69781..92ac09f5 100644 --- a/rest_framework/test.py +++ b/rest_framework/test.py @@ -5,16 +5,16 @@ from __future__ import unicode_literals import django -from django.utils import six from django.conf import settings from django.test import testcases +from django.test.client import Client as DjangoClient +from django.test.client import ClientHandler +from django.utils import six from django.utils.http import urlencode -from django.test.client import ClientHandler, Client as DjangoClient +from rest_framework.compat import RequestFactory as DjangoRequestFactory +from rest_framework.compat import force_bytes_or_smart_bytes from rest_framework.settings import api_settings -from rest_framework.compat import ( - force_bytes_or_smart_bytes, RequestFactory as DjangoRequestFactory -) def force_authenticate(request, user=None, token=None): diff --git a/rest_framework/urlpatterns.py b/rest_framework/urlpatterns.py index 7b151626..5347b3bc 100644 --- a/rest_framework/urlpatterns.py +++ b/rest_framework/urlpatterns.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.conf.urls import url, include +from django.conf.urls import include, url from django.core.urlresolvers import RegexURLResolver from rest_framework.settings import api_settings diff --git a/rest_framework/urls.py b/rest_framework/urls.py index 11152423..d88ee8db 100644 --- a/rest_framework/urls.py +++ b/rest_framework/urls.py @@ -17,7 +17,6 @@ from __future__ import unicode_literals from django.conf.urls import url from django.contrib.auth import views - template_name = {'template_name': 'rest_framework/login.html'} urlpatterns = [ diff --git a/rest_framework/utils/breadcrumbs.py b/rest_framework/utils/breadcrumbs.py index af786810..65daea08 100644 --- a/rest_framework/utils/breadcrumbs.py +++ b/rest_framework/utils/breadcrumbs.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.core.urlresolvers import resolve, get_script_prefix +from django.core.urlresolvers import get_script_prefix, resolve def get_breadcrumbs(url): diff --git a/rest_framework/utils/encoders.py b/rest_framework/utils/encoders.py index 62bbfaff..949c99ed 100644 --- a/rest_framework/utils/encoders.py +++ b/rest_framework/utils/encoders.py @@ -3,15 +3,15 @@ Helper classes for parsers. """ from __future__ import unicode_literals -import uuid -import json -import decimal import datetime +import decimal +import json +import uuid -from django.utils import six, timezone from django.db.models.query import QuerySet -from django.utils.functional import Promise +from django.utils import six, timezone from django.utils.encoding import force_text +from django.utils.functional import Promise from rest_framework.compat import total_seconds diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index 8fcb8c33..38c43315 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -4,14 +4,13 @@ keyword arguments that should be used for their equivelent serializer fields. """ import inspect -from django.db import models from django.core import validators +from django.db import models from django.utils.text import capfirst from rest_framework.compat import clean_manytomany_helptext from rest_framework.validators import UniqueValidator - NUMERIC_FIELD_TYPES = ( models.IntegerField, models.FloatField, models.DecimalField ) diff --git a/rest_framework/utils/model_meta.py b/rest_framework/utils/model_meta.py index 9fe2e706..3bcd9049 100644 --- a/rest_framework/utils/model_meta.py +++ b/rest_framework/utils/model_meta.py @@ -8,13 +8,12 @@ Usage: `get_field_info(model)` returns a `FieldInfo` instance. import inspect from collections import namedtuple -from django.utils import six -from django.db import models from django.core.exceptions import ImproperlyConfigured +from django.db import models +from django.utils import six from rest_framework.compat import OrderedDict - FieldInfo = namedtuple('FieldResult', [ 'pk', # Model field instance 'fields', # Dict of field name -> model field instance diff --git a/rest_framework/utils/representation.py b/rest_framework/utils/representation.py index 1bd579f6..92075171 100644 --- a/rest_framework/utils/representation.py +++ b/rest_framework/utils/representation.py @@ -7,8 +7,8 @@ from __future__ import unicode_literals import re from django.db import models -from django.utils.functional import Promise from django.utils.encoding import force_text +from django.utils.functional import Promise from rest_framework.compat import unicode_repr diff --git a/rest_framework/versioning.py b/rest_framework/versioning.py index 4ee6e254..7b1422c9 100644 --- a/rest_framework/versioning.py +++ b/rest_framework/versioning.py @@ -6,11 +6,11 @@ import re from django.utils.translation import ugettext_lazy as _ from rest_framework import exceptions +from rest_framework.compat import unicode_http_header from rest_framework.reverse import _reverse from rest_framework.settings import api_settings -from rest_framework.compat import unicode_http_header -from rest_framework.utils.mediatypes import _MediaType from rest_framework.templatetags.rest_framework import replace_query_param +from rest_framework.utils.mediatypes import _MediaType class BaseVersioning(object): diff --git a/rest_framework/views.py b/rest_framework/views.py index 2230c6dc..a709c2f6 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -6,19 +6,19 @@ from __future__ import unicode_literals import inspect import warnings -from django.utils import six -from django.http import Http404 -from django.utils.encoding import smart_text from django.core.exceptions import PermissionDenied -from django.views.decorators.csrf import csrf_exempt +from django.http import Http404 +from django.utils import six +from django.utils.encoding import smart_text from django.utils.translation import ugettext_lazy as _ +from django.views.decorators.csrf import csrf_exempt -from rest_framework import status, exceptions +from rest_framework import exceptions, status +from rest_framework.compat import HttpResponseBase, View, set_rollback from rest_framework.request import Request -from rest_framework.utils import formatting from rest_framework.response import Response from rest_framework.settings import api_settings -from rest_framework.compat import HttpResponseBase, View, set_rollback +from rest_framework.utils import formatting def get_view_name(view_cls, suffix=None): diff --git a/rest_framework/viewsets.py b/rest_framework/viewsets.py index e9fa41fb..e1c5e17f 100644 --- a/rest_framework/viewsets.py +++ b/rest_framework/viewsets.py @@ -23,7 +23,7 @@ from functools import update_wrapper from django.utils.decorators import classonlymethod from django.views.decorators.csrf import csrf_exempt -from rest_framework import views, generics, mixins +from rest_framework import generics, mixins, views class ViewSetMixin(object): diff --git a/setup.py b/setup.py index ca802774..2dfcbc5b 100755 --- a/setup.py +++ b/setup.py @@ -1,8 +1,9 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- -import re import os +import re import sys + from setuptools import setup diff --git a/tests/browsable_api/auth_urls.py b/tests/browsable_api/auth_urls.py index aa3958b0..0e937971 100644 --- a/tests/browsable_api/auth_urls.py +++ b/tests/browsable_api/auth_urls.py @@ -1,9 +1,9 @@ from __future__ import unicode_literals -from django.conf.urls import url, include + +from django.conf.urls import include, url from .views import MockView - urlpatterns = [ url(r'^$', MockView.as_view()), url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')), diff --git a/tests/browsable_api/no_auth_urls.py b/tests/browsable_api/no_auth_urls.py index ec273f91..5fc95c72 100644 --- a/tests/browsable_api/no_auth_urls.py +++ b/tests/browsable_api/no_auth_urls.py @@ -1,6 +1,7 @@ from __future__ import unicode_literals from django.conf.urls import url + from .views import MockView urlpatterns = [ diff --git a/tests/browsable_api/test_browsable_api.py b/tests/browsable_api/test_browsable_api.py index 5f264783..a9e14f67 100644 --- a/tests/browsable_api/test_browsable_api.py +++ b/tests/browsable_api/test_browsable_api.py @@ -1,4 +1,5 @@ from __future__ import unicode_literals + from django.contrib.auth.models import User from django.test import TestCase diff --git a/tests/browsable_api/views.py b/tests/browsable_api/views.py index 000f4e80..cd020cd3 100644 --- a/tests/browsable_api/views.py +++ b/tests/browsable_api/views.py @@ -1,9 +1,8 @@ from __future__ import unicode_literals -from rest_framework.views import APIView -from rest_framework import authentication -from rest_framework import renderers +from rest_framework import authentication, renderers from rest_framework.response import Response +from rest_framework.views import APIView class MockView(APIView): diff --git a/tests/description.py b/tests/description.py index b46d7f54..55a55a9f 100644 --- a/tests/description.py +++ b/tests/description.py @@ -8,7 +8,6 @@ from rest_framework.views import APIView - # test strings snatched from http://www.columbia.edu/~fdc/utf8/, # http://winrus.com/utf8-jap.htm and memory UTF8_TEST_DOCSTRING = ( diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index b74f2179..d0d088f5 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -2,10 +2,11 @@ from __future__ import unicode_literals from django.conf.urls import patterns, url from django.db import connection, connections, transaction -from django.test import TestCase, TransactionTestCase from django.http import Http404 +from django.test import TestCase, TransactionTestCase from django.utils.decorators import method_decorator from django.utils.unittest import skipUnless + from rest_framework import status from rest_framework.exceptions import APIException from rest_framework.response import Response @@ -13,7 +14,6 @@ from rest_framework.test import APIRequestFactory from rest_framework.views import APIView from tests.models import BasicModel - factory = APIRequestFactory() diff --git a/tests/test_authentication.py b/tests/test_authentication.py index f5d91da3..91434124 100644 --- a/tests/test_authentication.py +++ b/tests/test_authentication.py @@ -1,27 +1,26 @@ # coding: utf-8 from __future__ import unicode_literals -from django.conf.urls import url, include + +import base64 + +from django.conf.urls import include, url from django.contrib.auth.models import User from django.http import HttpResponse from django.test import TestCase from django.utils import six -from rest_framework import HTTP_HEADER_ENCODING -from rest_framework import exceptions -from rest_framework import permissions -from rest_framework import renderers -from rest_framework.response import Response -from rest_framework import status + +from rest_framework import ( + HTTP_HEADER_ENCODING, exceptions, permissions, renderers, status +) from rest_framework.authentication import ( - BaseAuthentication, - TokenAuthentication, - BasicAuthentication, - SessionAuthentication, + BaseAuthentication, BasicAuthentication, SessionAuthentication, + TokenAuthentication ) from rest_framework.authtoken.models import Token -from rest_framework.test import APIRequestFactory, APIClient +from rest_framework.response import Response +from rest_framework.test import APIClient, APIRequestFactory from rest_framework.views import APIView -import base64 factory = APIRequestFactory() diff --git a/tests/test_decorators.py b/tests/test_decorators.py index 195f0ba3..46e4a6ad 100644 --- a/tests/test_decorators.py +++ b/tests/test_decorators.py @@ -1,22 +1,20 @@ from __future__ import unicode_literals + from django.test import TestCase + from rest_framework import status from rest_framework.authentication import BasicAuthentication +from rest_framework.decorators import ( + api_view, authentication_classes, parser_classes, permission_classes, + renderer_classes, throttle_classes +) from rest_framework.parsers import JSONParser from rest_framework.permissions import IsAuthenticated -from rest_framework.response import Response from rest_framework.renderers import JSONRenderer +from rest_framework.response import Response from rest_framework.test import APIRequestFactory from rest_framework.throttling import UserRateThrottle from rest_framework.views import APIView -from rest_framework.decorators import ( - api_view, - renderer_classes, - parser_classes, - authentication_classes, - throttle_classes, - permission_classes, -) class DecoratorTestCase(TestCase): diff --git a/tests/test_description.py b/tests/test_description.py index 78ce2350..d0ca4076 100644 --- a/tests/test_description.py +++ b/tests/test_description.py @@ -1,12 +1,17 @@ # -- coding: utf-8 -- from __future__ import unicode_literals + from django.test import TestCase from django.utils.encoding import python_2_unicode_compatible, smart_text + from rest_framework.compat import apply_markdown from rest_framework.views import APIView -from .description import ViewWithNonASCIICharactersInDocstring -from .description import UTF8_TEST_DOCSTRING + +from .description import ( + UTF8_TEST_DOCSTRING, ViewWithNonASCIICharactersInDocstring +) + # We check that docstrings get nicely un-indented. DESCRIPTION = """an example docstring diff --git a/tests/test_fields.py b/tests/test_fields.py index 1c4228d3..76e6d9d6 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1,11 +1,13 @@ -from decimal import Decimal -from django.utils import timezone -from rest_framework import serializers -import rest_framework import datetime +import uuid +from decimal import Decimal + import django import pytest -import uuid +from django.utils import timezone + +import rest_framework +from rest_framework import serializers # Tests for field keyword arguments and core functionality. diff --git a/tests/test_filters.py b/tests/test_filters.py index c06160f9..9db685c2 100644 --- a/tests/test_filters.py +++ b/tests/test_filters.py @@ -1,19 +1,22 @@ from __future__ import unicode_literals + import datetime from decimal import Decimal -from django.db import models + from django.conf.urls import url from django.core.urlresolvers import reverse +from django.db import models from django.test import TestCase from django.test.utils import override_settings from django.utils import unittest from django.utils.dateparse import parse_date from django.utils.six.moves import reload_module -from rest_framework import generics, serializers, status, filters + +from rest_framework import filters, generics, serializers, status from rest_framework.compat import django_filters from rest_framework.test import APIRequestFactory -from .models import BaseFilterableItem, FilterableItem, BasicModel +from .models import BaseFilterableItem, BasicModel, FilterableItem factory = APIRequestFactory() diff --git a/tests/test_generics.py b/tests/test_generics.py index 88e792ce..0647119b 100644 --- a/tests/test_generics.py +++ b/tests/test_generics.py @@ -1,13 +1,16 @@ from __future__ import unicode_literals + import django from django.db import models from django.shortcuts import get_object_or_404 from django.test import TestCase from django.utils import six + from rest_framework import generics, renderers, serializers, status from rest_framework.test import APIRequestFactory -from tests.models import BasicModel, RESTFrameworkModel -from tests.models import ForeignKeySource, ForeignKeyTarget +from tests.models import ( + BasicModel, ForeignKeySource, ForeignKeyTarget, RESTFrameworkModel +) factory = APIRequestFactory() diff --git a/tests/test_htmlrenderer.py b/tests/test_htmlrenderer.py index 1a4a62b2..01ef46d3 100644 --- a/tests/test_htmlrenderer.py +++ b/tests/test_htmlrenderer.py @@ -1,15 +1,17 @@ from __future__ import unicode_literals -from django.core.exceptions import PermissionDenied + +import django.template.loader from django.conf.urls import url +from django.core.exceptions import PermissionDenied from django.http import Http404 +from django.template import Template, TemplateDoesNotExist from django.test import TestCase -from django.template import TemplateDoesNotExist, Template from django.utils import six + from rest_framework import status from rest_framework.decorators import api_view, renderer_classes from rest_framework.renderers import TemplateHTMLRenderer from rest_framework.response import Response -import django.template.loader @api_view(('GET',)) diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 04f4284d..6510a707 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -1,10 +1,14 @@ from __future__ import unicode_literals + +from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models from django.test import TestCase -from django.core.validators import MinValueValidator, MaxValueValidator -from rest_framework import exceptions, metadata, serializers, status, views, versioning -from rest_framework.request import Request + +from rest_framework import ( + exceptions, metadata, serializers, status, versioning, views +) from rest_framework.renderers import BrowsableAPIRenderer +from rest_framework.request import Request from rest_framework.test import APIRequestFactory request = Request(APIRequestFactory().options('/')) diff --git a/tests/test_middleware.py b/tests/test_middleware.py index 36688be4..49124da6 100644 --- a/tests/test_middleware.py +++ b/tests/test_middleware.py @@ -1,12 +1,12 @@ from django.conf.urls import url from django.contrib.auth.models import User + from rest_framework.authentication import TokenAuthentication from rest_framework.authtoken.models import Token from rest_framework.test import APITestCase from rest_framework.views import APIView - urlpatterns = [ url(r'^$', APIView.as_view(authentication_classes=(TokenAuthentication,))), ] diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index 35fa0e25..28173b68 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -6,15 +6,20 @@ These tests deal with ensuring that we correctly map the model fields onto an appropriate set of serializer fields for each case. """ from __future__ import unicode_literals + import django +import pytest from django.core.exceptions import ImproperlyConfigured -from django.core.validators import MaxValueValidator, MinValueValidator, MinLengthValidator +from django.core.validators import ( + MaxValueValidator, MinLengthValidator, MinValueValidator +) from django.db import models from django.test import TestCase from django.utils import six -import pytest + from rest_framework import serializers -from rest_framework.compat import unicode_repr, DurationField as ModelDurationField +from rest_framework.compat import DurationField as ModelDurationField +from rest_framework.compat import unicode_repr def dedent(blocktext): diff --git a/tests/test_multitable_inheritance.py b/tests/test_multitable_inheritance.py index 15627e1d..340d4966 100644 --- a/tests/test_multitable_inheritance.py +++ b/tests/test_multitable_inheritance.py @@ -1,6 +1,8 @@ from __future__ import unicode_literals + from django.db import models from django.test import TestCase + from rest_framework import serializers from tests.models import RESTFrameworkModel diff --git a/tests/test_negotiation.py b/tests/test_negotiation.py index 04b89eb6..434fba49 100644 --- a/tests/test_negotiation.py +++ b/tests/test_negotiation.py @@ -1,10 +1,11 @@ from __future__ import unicode_literals -from django.test import TestCase -from rest_framework.negotiation import DefaultContentNegotiation -from rest_framework.request import Request -from rest_framework.renderers import BaseRenderer -from rest_framework.test import APIRequestFactory +from django.test import TestCase + +from rest_framework.negotiation import DefaultContentNegotiation +from rest_framework.renderers import BaseRenderer +from rest_framework.request import Request +from rest_framework.test import APIRequestFactory factory = APIRequestFactory() diff --git a/tests/test_pagination.py b/tests/test_pagination.py index eb3c78cc..03c4fdf4 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -1,11 +1,15 @@ # coding: utf-8 from __future__ import unicode_literals -from rest_framework import exceptions, generics, pagination, serializers, status, filters -from rest_framework.request import Request -from rest_framework.pagination import PageLink, PAGE_BREAK -from rest_framework.test import APIRequestFactory + import pytest +from rest_framework import ( + exceptions, filters, generics, pagination, serializers, status +) +from rest_framework.pagination import PAGE_BREAK, PageLink +from rest_framework.request import Request +from rest_framework.test import APIRequestFactory + factory = APIRequestFactory() diff --git a/tests/test_parsers.py b/tests/test_parsers.py index fe6aec19..1e0f2e17 100644 --- a/tests/test_parsers.py +++ b/tests/test_parsers.py @@ -1,12 +1,14 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals + from django import forms from django.core.files.uploadhandler import MemoryFileUploadHandler from django.test import TestCase from django.utils.six.moves import StringIO + from rest_framework.exceptions import ParseError -from rest_framework.parsers import FormParser, FileUploadParser +from rest_framework.parsers import FileUploadParser, FormParser class Form(forms.Form): diff --git a/tests/test_permissions.py b/tests/test_permissions.py index 59a85845..39802000 100644 --- a/tests/test_permissions.py +++ b/tests/test_permissions.py @@ -1,16 +1,22 @@ from __future__ import unicode_literals -from django.contrib.auth.models import User, Permission, Group + +import base64 + +from django.contrib.auth.models import Group, Permission, User +from django.core.urlresolvers import ResolverMatch from django.db import models from django.test import TestCase from django.utils import unittest -from rest_framework import generics, serializers, status, permissions, authentication, HTTP_HEADER_ENCODING -from rest_framework.compat import guardian, get_model_name -from django.core.urlresolvers import ResolverMatch + +from rest_framework import ( + HTTP_HEADER_ENCODING, authentication, generics, permissions, serializers, + status +) +from rest_framework.compat import get_model_name, guardian from rest_framework.filters import DjangoObjectPermissionsFilter from rest_framework.routers import DefaultRouter from rest_framework.test import APIRequestFactory from tests.models import BasicModel -import base64 factory = APIRequestFactory() diff --git a/tests/test_relations.py b/tests/test_relations.py index 25a53f27..fd37e63e 100644 --- a/tests/test_relations.py +++ b/tests/test_relations.py @@ -1,11 +1,16 @@ import uuid -from .utils import mock_reverse, fail_reverse, BadType, MockObject, MockQueryset + +import pytest from django.core.exceptions import ImproperlyConfigured from django.utils.datastructures import MultiValueDict + from rest_framework import serializers from rest_framework.fields import empty from rest_framework.test import APISimpleTestCase -import pytest + +from .utils import ( + BadType, MockObject, MockQueryset, fail_reverse, mock_reverse +) class TestStringRelatedField(APISimpleTestCase): diff --git a/tests/test_relations_generic.py b/tests/test_relations_generic.py index b600b333..96285736 100644 --- a/tests/test_relations_generic.py +++ b/tests/test_relations_generic.py @@ -1,9 +1,13 @@ from __future__ import unicode_literals + +from django.contrib.contenttypes.generic import ( + GenericForeignKey, GenericRelation +) from django.contrib.contenttypes.models import ContentType -from django.contrib.contenttypes.generic import GenericRelation, GenericForeignKey from django.db import models from django.test import TestCase from django.utils.encoding import python_2_unicode_compatible + from rest_framework import serializers diff --git a/tests/test_relations_hyperlink.py b/tests/test_relations_hyperlink.py index 33b09713..c0642eda 100644 --- a/tests/test_relations_hyperlink.py +++ b/tests/test_relations_hyperlink.py @@ -1,11 +1,13 @@ from __future__ import unicode_literals + from django.conf.urls import url from django.test import TestCase + from rest_framework import serializers from rest_framework.test import APIRequestFactory from tests.models import ( - ManyToManyTarget, ManyToManySource, ForeignKeyTarget, ForeignKeySource, - NullableForeignKeySource, OneToOneTarget, NullableOneToOneSource + ForeignKeySource, ForeignKeyTarget, ManyToManySource, ManyToManyTarget, + NullableForeignKeySource, NullableOneToOneSource, OneToOneTarget ) factory = APIRequestFactory() diff --git a/tests/test_relations_pk.py b/tests/test_relations_pk.py index ca43272b..169f7d9c 100644 --- a/tests/test_relations_pk.py +++ b/tests/test_relations_pk.py @@ -1,10 +1,12 @@ from __future__ import unicode_literals + from django.test import TestCase from django.utils import six + from rest_framework import serializers from tests.models import ( - ManyToManyTarget, ManyToManySource, ForeignKeyTarget, ForeignKeySource, - NullableForeignKeySource, OneToOneTarget, NullableOneToOneSource, + ForeignKeySource, ForeignKeyTarget, ManyToManySource, ManyToManyTarget, + NullableForeignKeySource, NullableOneToOneSource, OneToOneTarget ) diff --git a/tests/test_relations_slug.py b/tests/test_relations_slug.py index cd2cb1ed..680aee41 100644 --- a/tests/test_relations_slug.py +++ b/tests/test_relations_slug.py @@ -1,6 +1,9 @@ from django.test import TestCase + from rest_framework import serializers -from tests.models import NullableForeignKeySource, ForeignKeySource, ForeignKeyTarget +from tests.models import ( + ForeignKeySource, ForeignKeyTarget, NullableForeignKeySource +) class ForeignKeyTargetSerializer(serializers.ModelSerializer): diff --git a/tests/test_renderers.py b/tests/test_renderers.py index 85c6258d..113c1b66 100644 --- a/tests/test_renderers.py +++ b/tests/test_renderers.py @@ -1,25 +1,26 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.conf.urls import url, include + +import json +import re +from collections import MutableMapping + +from django.conf.urls import include, url from django.core.cache import cache from django.db import models from django.test import TestCase from django.utils import six from django.utils.translation import ugettext_lazy as _ -from rest_framework import status, permissions + +from rest_framework import permissions, serializers, status from rest_framework.compat import OrderedDict -from rest_framework.response import Response -from rest_framework.views import APIView -from rest_framework import serializers from rest_framework.renderers import ( - BaseRenderer, JSONRenderer, BrowsableAPIRenderer, HTMLFormRenderer + BaseRenderer, BrowsableAPIRenderer, HTMLFormRenderer, JSONRenderer ) +from rest_framework.response import Response from rest_framework.settings import api_settings from rest_framework.test import APIRequestFactory -from collections import MutableMapping -import json -import re - +from rest_framework.views import APIView DUMMYSTATUS = status.HTTP_200_OK DUMMYCONTENT = 'dummycontent' diff --git a/tests/test_request.py b/tests/test_request.py index 03d9f8e4..7c62c90a 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -2,31 +2,30 @@ Tests for content parsing, and form-overloaded content parsing. """ from __future__ import unicode_literals + +import json +from io import BytesIO + +import django +import pytest from django.conf.urls import url -from django.contrib.auth.models import User from django.contrib.auth import authenticate, login, logout +from django.contrib.auth.models import User from django.contrib.sessions.middleware import SessionMiddleware from django.core.handlers.wsgi import WSGIRequest from django.test import TestCase from django.utils import six + from rest_framework import status from rest_framework.authentication import SessionAuthentication from rest_framework.parsers import ( - BaseParser, - FormParser, - MultiPartParser, - JSONParser + BaseParser, FormParser, JSONParser, MultiPartParser ) -from rest_framework.request import Request, Empty +from rest_framework.request import Empty, Request from rest_framework.response import Response from rest_framework.settings import api_settings -from rest_framework.test import APIRequestFactory, APIClient +from rest_framework.test import APIClient, APIRequestFactory from rest_framework.views import APIView -from io import BytesIO -import json -import django -import pytest - factory = APIRequestFactory() diff --git a/tests/test_response.py b/tests/test_response.py index 864478a8..1dd5d5ea 100644 --- a/tests/test_response.py +++ b/tests/test_response.py @@ -1,21 +1,17 @@ from __future__ import unicode_literals -from django.conf.urls import url, include + +from django.conf.urls import include, url from django.test import TestCase from django.utils import six -from tests.models import BasicModel -from rest_framework.response import Response -from rest_framework.views import APIView -from rest_framework import generics -from rest_framework import routers -from rest_framework import serializers -from rest_framework import status + +from rest_framework import generics, routers, serializers, status, viewsets from rest_framework.renderers import ( - BaseRenderer, - JSONRenderer, - BrowsableAPIRenderer + BaseRenderer, BrowsableAPIRenderer, JSONRenderer ) -from rest_framework import viewsets +from rest_framework.response import Response from rest_framework.settings import api_settings +from rest_framework.views import APIView +from tests.models import BasicModel # Serializer used to test BasicModel diff --git a/tests/test_reverse.py b/tests/test_reverse.py index bf94f9ee..c5486e5d 100644 --- a/tests/test_reverse.py +++ b/tests/test_reverse.py @@ -1,7 +1,9 @@ from __future__ import unicode_literals + from django.conf.urls import url from django.core.urlresolvers import NoReverseMatch from django.test import TestCase + from rest_framework.reverse import reverse from rest_framework.test import APIRequestFactory diff --git a/tests/test_routers.py b/tests/test_routers.py index 19eeb868..ae2639bf 100644 --- a/tests/test_routers.py +++ b/tests/test_routers.py @@ -1,14 +1,17 @@ from __future__ import unicode_literals -from django.conf.urls import url, include + +from collections import namedtuple + +from django.conf.urls import include, url +from django.core.exceptions import ImproperlyConfigured from django.db import models from django.test import TestCase -from django.core.exceptions import ImproperlyConfigured -from rest_framework import serializers, viewsets, permissions + +from rest_framework import permissions, serializers, viewsets from rest_framework.decorators import detail_route, list_route from rest_framework.response import Response -from rest_framework.routers import SimpleRouter, DefaultRouter +from rest_framework.routers import DefaultRouter, SimpleRouter from rest_framework.test import APIRequestFactory -from collections import namedtuple factory = APIRequestFactory() diff --git a/tests/test_serializer.py b/tests/test_serializer.py index b7a0484b..c18cbb58 100644 --- a/tests/test_serializer.py +++ b/tests/test_serializer.py @@ -1,10 +1,14 @@ # coding: utf-8 from __future__ import unicode_literals -from .utils import MockObject + +import pickle + +import pytest + from rest_framework import serializers from rest_framework.compat import unicode_repr -import pickle -import pytest + +from .utils import MockObject # Tests for core functionality. diff --git a/tests/test_serializer_bulk_update.py b/tests/test_serializer_bulk_update.py index bc955b2e..8d7240a7 100644 --- a/tests/test_serializer_bulk_update.py +++ b/tests/test_serializer_bulk_update.py @@ -2,8 +2,10 @@ Tests to cover bulk create and update using serializers. """ from __future__ import unicode_literals + from django.test import TestCase from django.utils import six + from rest_framework import serializers diff --git a/tests/test_serializer_lists.py b/tests/test_serializer_lists.py index 35b68ae7..e9234d8f 100644 --- a/tests/test_serializer_lists.py +++ b/tests/test_serializer_lists.py @@ -1,6 +1,7 @@ -from rest_framework import serializers from django.utils.datastructures import MultiValueDict +from rest_framework import serializers + class BasicObject: """ diff --git a/tests/test_settings.py b/tests/test_settings.py index f2ff4ca1..85c36c1f 100644 --- a/tests/test_settings.py +++ b/tests/test_settings.py @@ -1,5 +1,7 @@ from __future__ import unicode_literals + from django.test import TestCase + from rest_framework.settings import APISettings diff --git a/tests/test_status.py b/tests/test_status.py index 721a6e30..1cd6e229 100644 --- a/tests/test_status.py +++ b/tests/test_status.py @@ -1,7 +1,10 @@ from __future__ import unicode_literals + from django.test import TestCase + from rest_framework.status import ( - is_informational, is_success, is_redirect, is_client_error, is_server_error + is_client_error, is_informational, is_redirect, is_server_error, + is_success ) diff --git a/tests/test_templatetags.py b/tests/test_templatetags.py index 0cee91f1..746f51b7 100644 --- a/tests/test_templatetags.py +++ b/tests/test_templatetags.py @@ -1,9 +1,12 @@ # encoding: utf-8 from __future__ import unicode_literals -from django.test import TestCase -from rest_framework.test import APIRequestFactory -from rest_framework.templatetags.rest_framework import add_query_param, urlize_quoted_links +from django.test import TestCase + +from rest_framework.templatetags.rest_framework import ( + add_query_param, urlize_quoted_links +) +from rest_framework.test import APIRequestFactory factory = APIRequestFactory() diff --git a/tests/test_testing.py b/tests/test_testing.py index b42c0875..70c83f8d 100644 --- a/tests/test_testing.py +++ b/tests/test_testing.py @@ -1,13 +1,18 @@ # encoding: utf-8 from __future__ import unicode_literals + +from io import BytesIO + from django.conf.urls import url from django.contrib.auth.models import User from django.shortcuts import redirect from django.test import TestCase + from rest_framework.decorators import api_view from rest_framework.response import Response -from rest_framework.test import APIClient, APIRequestFactory, force_authenticate -from io import BytesIO +from rest_framework.test import ( + APIClient, APIRequestFactory, force_authenticate +) @api_view(['GET', 'POST']) diff --git a/tests/test_throttling.py b/tests/test_throttling.py index 50a53b3e..6d8d05a3 100644 --- a/tests/test_throttling.py +++ b/tests/test_throttling.py @@ -2,14 +2,18 @@ Tests for the throttling implementations in the permissions module. """ from __future__ import unicode_literals -from django.test import TestCase + from django.contrib.auth.models import User from django.core.cache import cache +from django.test import TestCase + +from rest_framework.response import Response from rest_framework.settings import api_settings from rest_framework.test import APIRequestFactory +from rest_framework.throttling import ( + BaseThrottle, ScopedRateThrottle, UserRateThrottle +) from rest_framework.views import APIView -from rest_framework.throttling import BaseThrottle, UserRateThrottle, ScopedRateThrottle -from rest_framework.response import Response class User3SecRateThrottle(UserRateThrottle): diff --git a/tests/test_urlpatterns.py b/tests/test_urlpatterns.py index f58388c5..fee96878 100644 --- a/tests/test_urlpatterns.py +++ b/tests/test_urlpatterns.py @@ -1,12 +1,14 @@ from __future__ import unicode_literals + from collections import namedtuple -from django.conf.urls import url, include + +from django.conf.urls import include, url from django.core import urlresolvers from django.test import TestCase + from rest_framework.test import APIRequestFactory from rest_framework.urlpatterns import format_suffix_patterns - # A container class for test paths for the test case URLTestPath = namedtuple('URLTestPath', ['path', 'args', 'kwargs']) diff --git a/tests/test_utils.py b/tests/test_utils.py index a2551842..062f78e1 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -1,14 +1,15 @@ from __future__ import unicode_literals -from django.core.exceptions import ImproperlyConfigured + from django.conf.urls import url +from django.core.exceptions import ImproperlyConfigured from django.test import TestCase from django.utils import six -from rest_framework.utils.model_meta import _resolve_model -from rest_framework.utils.breadcrumbs import get_breadcrumbs -from rest_framework.views import APIView -from tests.models import BasicModel import rest_framework.utils.model_meta +from rest_framework.utils.breadcrumbs import get_breadcrumbs +from rest_framework.utils.model_meta import _resolve_model +from rest_framework.views import APIView +from tests.models import BasicModel class Root(APIView): diff --git a/tests/test_validation.py b/tests/test_validation.py index 4234efd3..46e36f5d 100644 --- a/tests/test_validation.py +++ b/tests/test_validation.py @@ -1,10 +1,13 @@ from __future__ import unicode_literals -from django.core.validators import RegexValidator, MaxValueValidator + +import re + +from django.core.validators import MaxValueValidator, RegexValidator from django.db import models from django.test import TestCase + from rest_framework import generics, serializers, status from rest_framework.test import APIRequestFactory -import re factory = APIRequestFactory() diff --git a/tests/test_validators.py b/tests/test_validators.py index 127ec6f8..206e882a 100644 --- a/tests/test_validators.py +++ b/tests/test_validators.py @@ -1,7 +1,9 @@ +import datetime + from django.db import models from django.test import TestCase + from rest_framework import serializers -import datetime def dedent(blocktext): diff --git a/tests/test_versioning.py b/tests/test_versioning.py index 000762b0..4029e0e4 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -1,14 +1,15 @@ -from .utils import UsingURLPatterns +import pytest from django.conf.urls import include, url -from rest_framework import serializers -from rest_framework import status, versioning + +from rest_framework import serializers, status, versioning from rest_framework.decorators import APIView +from rest_framework.relations import PKOnlyObject from rest_framework.response import Response from rest_framework.reverse import reverse from rest_framework.test import APIRequestFactory, APITestCase from rest_framework.versioning import NamespaceVersioning -from rest_framework.relations import PKOnlyObject -import pytest + +from .utils import UsingURLPatterns class RequestVersionView(APIView): diff --git a/tests/test_views.py b/tests/test_views.py index 77b113ee..65024609 100644 --- a/tests/test_views.py +++ b/tests/test_views.py @@ -1,8 +1,10 @@ from __future__ import unicode_literals -import sys import copy +import sys + from django.test import TestCase + from rest_framework import status from rest_framework.decorators import api_view from rest_framework.response import Response diff --git a/tests/test_viewsets.py b/tests/test_viewsets.py index 4d18a955..0d9b6b31 100644 --- a/tests/test_viewsets.py +++ b/tests/test_viewsets.py @@ -1,10 +1,10 @@ from django.test import TestCase + from rest_framework import status from rest_framework.response import Response from rest_framework.test import APIRequestFactory from rest_framework.viewsets import GenericViewSet - factory = APIRequestFactory() diff --git a/tests/test_write_only_fields.py b/tests/test_write_only_fields.py index dd3bbd6e..83ef366a 100644 --- a/tests/test_write_only_fields.py +++ b/tests/test_write_only_fields.py @@ -1,4 +1,5 @@ from django.test import TestCase + from rest_framework import serializers From b4ba8ef4d7cb9f0fd5f64303b609603a7f7e1753 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jose=CC=81=20Padilla?= Date: Thu, 25 Jun 2015 16:58:24 -0400 Subject: [PATCH 080/487] Setup isort for code style linting --- .gitignore | 1 + .isort.cfg | 6 ++++++ .travis.yml | 2 +- requirements/requirements-codestyle.txt | 3 +++ runtests.py | 21 ++++++++++++++++++--- tox.ini | 8 ++++---- 6 files changed, 33 insertions(+), 8 deletions(-) create mode 100644 .isort.cfg diff --git a/.gitignore b/.gitignore index 3d5f1043..e9222c2d 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ MANIFEST !.gitignore !.travis.yml +!.isort.cfg diff --git a/.isort.cfg b/.isort.cfg new file mode 100644 index 00000000..bd5648e0 --- /dev/null +++ b/.isort.cfg @@ -0,0 +1,6 @@ +[settings] +skip=.tox +atomic=true +multi_line_output=5 +known_third_party=pytest,django +known_first_party=rest_framework diff --git a/.travis.yml b/.travis.yml index 2134a144..50dc368e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,7 +3,7 @@ language: python sudo: false env: - - TOX_ENV=py27-flake8 + - TOX_ENV=py27-lint - TOX_ENV=py27-docs - TOX_ENV=py34-django18 - TOX_ENV=py33-django18 diff --git a/requirements/requirements-codestyle.txt b/requirements/requirements-codestyle.txt index 88f61fdf..1412a4d8 100644 --- a/requirements/requirements-codestyle.txt +++ b/requirements/requirements-codestyle.txt @@ -1,3 +1,6 @@ # PEP8 code linting, which we run on all commits. flake8==2.4.0 pep8==1.5.7 + +# Sort and lint imports +isort==3.9.6 diff --git a/runtests.py b/runtests.py index 0008bfae..777f996a 100755 --- a/runtests.py +++ b/runtests.py @@ -1,11 +1,11 @@ #! /usr/bin/env python from __future__ import print_function -import pytest -import sys import os import subprocess +import sys +import pytest PYTEST_ARGS = { 'default': ['tests', '--tb=short'], @@ -14,6 +14,7 @@ PYTEST_ARGS = { FLAKE8_ARGS = ['rest_framework', 'tests', '--ignore=E501'] +ISORT_ARGS = ['--recursive', '--check-only', '.'] sys.path.append(os.path.dirname(__file__)) @@ -30,6 +31,13 @@ def flake8_main(args): return ret +def isort_main(args): + print('Running isort code checking') + ret = subprocess.call(['isort'] + args) + print('isort failed' if ret else 'isort passed') + return ret + + def split_class_and_function(string): class_string, function_string = string.split('.', 1) return "%s and %s" % (class_string, function_string) @@ -50,8 +58,10 @@ if __name__ == "__main__": sys.argv.remove('--nolint') except ValueError: run_flake8 = True + run_isort = True else: run_flake8 = False + run_isort = False try: sys.argv.remove('--lintonly') @@ -67,6 +77,7 @@ if __name__ == "__main__": else: style = 'fast' run_flake8 = False + run_isort = False if len(sys.argv) > 1: pytest_args = sys.argv[1:] @@ -79,7 +90,7 @@ if __name__ == "__main__": expression = split_class_and_function(first_arg) pytest_args = ['tests', '-k', expression] + pytest_args[1:] elif is_class(first_arg) or is_function(first_arg): - # `runtests.py TestCase [flags]` + # `runtests.py TestCase [flags]` # `runtests.py test_function [flags]` pytest_args = ['tests', '-k', pytest_args[0]] + pytest_args[1:] else: @@ -87,5 +98,9 @@ if __name__ == "__main__": if run_tests: exit_on_failure(pytest.main(pytest_args)) + if run_flake8: exit_on_failure(flake8_main(FLAKE8_ARGS)) + + if run_isort: + exit_on_failure(isort_main(ISORT_ARGS)) diff --git a/tox.ini b/tox.ini index f77ba8f8..d941b6d7 100644 --- a/tox.ini +++ b/tox.ini @@ -3,7 +3,7 @@ addopts=--tb=short [tox] envlist = - py27-{flake8,docs}, + py27-{lint,docs}, {py26,py27}-django14, {py26,py27,py32,py33,py34}-django{15,16}, {py27,py32,py33,py34}-django{17,18,master} @@ -22,14 +22,14 @@ deps = -rrequirements/requirements-testing.txt -rrequirements/requirements-optionals.txt -[testenv:py27-flake8] +[testenv:py27-lint] +commands = ./runtests.py --lintonly deps = -rrequirements/requirements-codestyle.txt -rrequirements/requirements-testing.txt -commands = ./runtests.py --lintonly [testenv:py27-docs] +commands = mkdocs build deps = -rrequirements/requirements-testing.txt -rrequirements/requirements-documentation.txt -commands = mkdocs build From 0f1d9217f03c263ea9e29c0b1c5c1b846be793a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Sat, 27 Jun 2015 16:06:53 -0400 Subject: [PATCH 081/487] Print helpful command if isort fails --- runtests.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/runtests.py b/runtests.py index 777f996a..491d1cc5 100755 --- a/runtests.py +++ b/runtests.py @@ -34,7 +34,12 @@ def flake8_main(args): def isort_main(args): print('Running isort code checking') ret = subprocess.call(['isort'] + args) - print('isort failed' if ret else 'isort passed') + + if ret: + print('isort failed: Fix by running `isort --recursive .`') + else: + print('isort passed') + return ret From 36e4f2011195994bd14712c0141a4ef50edea770 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 29 Jun 2015 09:39:27 +0100 Subject: [PATCH 082/487] Update runtests.py --- runtests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runtests.py b/runtests.py index 491d1cc5..4adb40cc 100755 --- a/runtests.py +++ b/runtests.py @@ -36,7 +36,7 @@ def isort_main(args): ret = subprocess.call(['isort'] + args) if ret: - print('isort failed: Fix by running `isort --recursive .`') + print('isort failed: Some modules have incorrectly ordered imports. Fix by running `isort --recursive .`') else: print('isort passed') From c3c9a712fa6c8fae6d795b9874e101d15b444b15 Mon Sep 17 00:00:00 2001 From: Venelin Stoykov Date: Mon, 29 Jun 2015 15:35:55 +0300 Subject: [PATCH 083/487] Fix ManyRelatedField.choices Use choices from self.child_relation. We don't need to repeat ourself because can get out of sync. --- rest_framework/relations.py | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index ca39dbad..549aa85c 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -388,16 +388,4 @@ class ManyRelatedField(Field): @property def choices(self): - queryset = self.child_relation.queryset - iterable = queryset.all() if (hasattr(queryset, 'all')) else queryset - items_and_representations = [ - (item, self.child_relation.to_representation(item)) - for item in iterable - ] - return OrderedDict([ - ( - six.text_type(item_representation), - six.text_type(item) + ' - ' + six.text_type(item_representation) - ) - for item, item_representation in items_and_representations - ]) + return self.child_relation.choices From f0bced64134b10c2cafbb206c04fe0fa774d205d Mon Sep 17 00:00:00 2001 From: Laszlo Marai Date: Tue, 30 Jun 2015 05:49:44 +0200 Subject: [PATCH 084/487] Handle AttributeError as well (when the imported module exists but the specified function/class does not). --- rest_framework/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/settings.py b/rest_framework/settings.py index 4c46a483..a7b63721 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -171,7 +171,7 @@ def import_from_string(val, setting_name): module_path, class_name = '.'.join(parts[:-1]), parts[-1] module = importlib.import_module(module_path) return getattr(module, class_name) - except ImportError as e: + except (ImportError, AttributeError) as e: msg = "Could not import '%s' for API setting '%s'. %s: %s." % (val, setting_name, e.__class__.__name__, e) raise ImportError(msg) From 061cc5a42b3ab02ed62c79e81a37483412402b19 Mon Sep 17 00:00:00 2001 From: Alasdair Nicol Date: Tue, 30 Jun 2015 16:33:01 +0100 Subject: [PATCH 085/487] Fixed #2900 -- Made example validator class in docs inherit from object --- docs/api-guide/validators.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/validators.md b/docs/api-guide/validators.md index 69408c4a..e54ebfc3 100644 --- a/docs/api-guide/validators.md +++ b/docs/api-guide/validators.md @@ -204,7 +204,7 @@ A validator may be any callable that raises a `serializers.ValidationError` on f To write a class based validator, use the `__call__` method. Class based validators are useful as they allow you to parameterize and reuse behavior. - class MultipleOf: + class MultipleOf(object): def __init__(self, base): self.base = base From 5f40ab53dedb8dbf7e8b6cd9eefb71cfb5bf5279 Mon Sep 17 00:00:00 2001 From: Michael Bacon Date: Tue, 30 Jun 2015 14:51:47 -0400 Subject: [PATCH 086/487] Ability to customize DateTimeField with a custom datetime_parser --- rest_framework/fields.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 7960295b..5450de19 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -888,11 +888,13 @@ class DateTimeField(Field): format = api_settings.DATETIME_FORMAT input_formats = api_settings.DATETIME_INPUT_FORMATS default_timezone = timezone.get_default_timezone() if settings.USE_TZ else None + datetime_parser = datetime.datetime.strptime - def __init__(self, format=empty, input_formats=None, default_timezone=None, *args, **kwargs): + def __init__(self, format=empty, datetime_parser=None, input_formats=None, default_timezone=None, *args, **kwargs): self.format = format if format is not empty else self.format self.input_formats = input_formats if input_formats is not None else self.input_formats self.default_timezone = default_timezone if default_timezone is not None else self.default_timezone + self.datetime_parser = datetime_parser if datetime_parser is not None else self.datetime_parser super(DateTimeField, self).__init__(*args, **kwargs) def enforce_timezone(self, value): @@ -924,7 +926,7 @@ class DateTimeField(Field): return self.enforce_timezone(parsed) else: try: - parsed = datetime.datetime.strptime(value, format) + parsed = self.datetime_parser(value, format) except (ValueError, TypeError): pass else: From b6e46a6483dfef6411160a2840e1031df6b4512c Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Wed, 1 Jul 2015 00:26:54 +0200 Subject: [PATCH 087/487] Update `get_serializer` signature - remove the `files` and `allow_add_remove` arguments that were part of the 2.x API. --- docs/api-guide/generic-views.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md index ac27c132..7da9d587 100644 --- a/docs/api-guide/generic-views.md +++ b/docs/api-guide/generic-views.md @@ -195,7 +195,7 @@ These override points are also particularly useful for adding behavior that occu You won't typically need to override the following methods, although you might need to call into them if you're writing custom views using `GenericAPIView`. * `get_serializer_context(self)` - Returns a dictionary containing any extra context that should be supplied to the serializer. Defaults to including `'request'`, `'view'` and `'format'` keys. -* `get_serializer(self, instance=None, data=None, files=None, many=False, partial=False, allow_add_remove=False)` - Returns a serializer instance. +* `get_serializer(self, instance=None, data=None, many=False, partial=False)` - Returns a serializer instance. * `get_paginated_response(self, data)` - Returns a paginated style `Response` object. * `paginate_queryset(self, queryset)` - Paginate a queryset if required, either returning a page object, or `None` if pagination is not configured for this view. * `filter_queryset(self, queryset)` - Given a queryset, filter it with whichever filter backends are in use, returning a new queryset. From af08c7024299e837a4b52edfd03f0d675f453a47 Mon Sep 17 00:00:00 2001 From: Tyler Redzko Date: Wed, 1 Jul 2015 10:10:18 -0400 Subject: [PATCH 088/487] Update extra_kwargs on model serializer Ensures that the 'read_only' and 'required' keys from `extra_kwargs` are retained when present. Closes #3091. --- rest_framework/serializers.py | 4 ++-- tests/test_model_serializer.py | 17 +++++++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 3a452bcc..7afddfd8 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -1105,8 +1105,8 @@ class ModelSerializer(Serializer): if extra_kwargs.get('default') and kwargs.get('required') is False: kwargs.pop('required') - if kwargs.get('read_only', False): - extra_kwargs.pop('required', None) + if extra_kwargs.get('read_only', kwargs.get('read_only', False)): + extra_kwargs.pop('required', None) # Read only fields should always omit the 'required' argument. kwargs.update(extra_kwargs) diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index 28173b68..76c281fc 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -235,6 +235,23 @@ class TestRegularFieldMappings(TestCase): """) self.assertEqual(repr(TestSerializer()), expected) + def test_extra_field_kwargs_required(self): + """ + Ensure `extra_kwargs` are passed to generated fields. + """ + class TestSerializer(serializers.ModelSerializer): + class Meta: + model = RegularFieldsModel + fields = ('auto_field', 'char_field') + extra_kwargs = {'auto_field': {'required': False, 'read_only': False}} + + expected = dedent(""" + TestSerializer(): + auto_field = IntegerField(read_only=False, required=False) + char_field = CharField(max_length=100) + """) + self.assertEqual(repr(TestSerializer()), expected) + def test_invalid_field(self): """ Field names that do not map to a model field or relationship should From b7438184308aac6a5c208a16e11bdeca12b4ae52 Mon Sep 17 00:00:00 2001 From: Mark Skipper Date: Wed, 1 Jul 2015 20:39:05 +0100 Subject: [PATCH 089/487] Remove unused import from docs example --- docs/tutorial/2-requests-and-responses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/2-requests-and-responses.md b/docs/tutorial/2-requests-and-responses.md index 2cad1e5d..51cea4f1 100644 --- a/docs/tutorial/2-requests-and-responses.md +++ b/docs/tutorial/2-requests-and-responses.md @@ -108,7 +108,7 @@ and Now update the `urls.py` file slightly, to append a set of `format_suffix_patterns` in addition to the existing URLs. - from django.conf.urls import patterns, url + from django.conf.urls import url from rest_framework.urlpatterns import format_suffix_patterns from snippets import views From 4b5f18d2934b5eedc2591e477b5e4c3acf693945 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Wed, 1 Jul 2015 23:19:50 +0200 Subject: [PATCH 090/487] Upgrade django-filter to 0.10.0 --- requirements/requirements-optionals.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements-optionals.txt b/requirements/requirements-optionals.txt index af9937cf..411ca0aa 100644 --- a/requirements/requirements-optionals.txt +++ b/requirements/requirements-optionals.txt @@ -1,4 +1,4 @@ # Optional packages which may be used with REST framework. markdown==2.5.2 django-guardian==1.2.5 -django-filter==0.9.2 +django-filter==0.10.0 From d979dc652248635bc0341af337d6c07afd438289 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 10:16:43 +0100 Subject: [PATCH 091/487] Tweak exception message --- rest_framework/fields.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index e8854631..3c4e4475 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -420,9 +420,9 @@ class Field(object): Transform the *outgoing* native value into primitive data. """ raise NotImplementedError( - '{cls}.to_representation() must be implemented for field {field_name}.\n' - 'If you are upgrading from REST framework version 2 ' - 'you might want `ReadOnlyField`.'.format( + '{cls}.to_representation() must be implemented for field ' + '{field_name}. If you do not need to support write operations ' + 'you probably want to subclass `ReadOnlyField` instead.'.format( cls=self.__class__.__name__, field_name=self.field_name, ) From a03b89f326ba2b0b00317c7832e1f2796cfd37f9 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 10:18:08 +0100 Subject: [PATCH 092/487] Restrict isort to rest_framework and tests directories --- runtests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runtests.py b/runtests.py index 4adb40cc..7982ee2e 100755 --- a/runtests.py +++ b/runtests.py @@ -14,7 +14,7 @@ PYTEST_ARGS = { FLAKE8_ARGS = ['rest_framework', 'tests', '--ignore=E501'] -ISORT_ARGS = ['--recursive', '--check-only', '.'] +ISORT_ARGS = ['--recursive', '--check-only', 'rest_framework', 'tests'] sys.path.append(os.path.dirname(__file__)) From fb4233736f3eb780b48f124a42df571902d16c56 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 10:28:46 +0100 Subject: [PATCH 093/487] Empty settings should also be coerced to lists. Closes #3087. --- rest_framework/settings.py | 2 +- tests/test_settings.py | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/rest_framework/settings.py b/rest_framework/settings.py index a7b63721..e20e5128 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -204,7 +204,7 @@ class APISettings(object): val = self.defaults[attr] # Coerce import strings into classes - if val and attr in self.import_strings: + if attr in self.import_strings: val = perform_import(val, attr) # Cache the result diff --git a/tests/test_settings.py b/tests/test_settings.py index 85c36c1f..cc8d0d51 100644 --- a/tests/test_settings.py +++ b/tests/test_settings.py @@ -17,3 +17,16 @@ class TestSettings(TestCase): }) with self.assertRaises(ImportError): settings.DEFAULT_RENDERER_CLASSES + + +class TestSettingTypes(TestCase): + def test_settings_consistently_coerced_to_list(self): + settings = APISettings({ + 'DEFAULT_THROTTLE_CLASSES': ('rest_framework.throttling.BaseThrottle',) + }) + self.assertTrue(isinstance(settings.DEFAULT_THROTTLE_CLASSES, list)) + + settings = APISettings({ + 'DEFAULT_THROTTLE_CLASSES': () + }) + self.assertTrue(isinstance(settings.DEFAULT_THROTTLE_CLASSES, list)) From 6ce9e3baf04eb8587e53ae05979c3c198cd51110 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 11:22:18 +0100 Subject: [PATCH 094/487] Remove datetime_parser argument from DateTimeField --- rest_framework/fields.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index c8c98f77..2eebf7b7 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -891,11 +891,10 @@ class DateTimeField(Field): default_timezone = timezone.get_default_timezone() if settings.USE_TZ else None datetime_parser = datetime.datetime.strptime - def __init__(self, format=empty, datetime_parser=None, input_formats=None, default_timezone=None, *args, **kwargs): + def __init__(self, format=empty, input_formats=None, default_timezone=None, *args, **kwargs): self.format = format if format is not empty else self.format self.input_formats = input_formats if input_formats is not None else self.input_formats self.default_timezone = default_timezone if default_timezone is not None else self.default_timezone - self.datetime_parser = datetime_parser if datetime_parser is not None else self.datetime_parser super(DateTimeField, self).__init__(*args, **kwargs) def enforce_timezone(self, value): From c4f908d4ee2975b8c27aaf986a473a464998c0db Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 11:23:52 +0100 Subject: [PATCH 095/487] Introduce datetime_parser as class level attribute on all date/time fields. Refs #3093. --- rest_framework/fields.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 2eebf7b7..3ca7d682 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -954,6 +954,7 @@ class DateField(Field): } format = api_settings.DATE_FORMAT input_formats = api_settings.DATE_INPUT_FORMATS + datetime_parser = datetime.datetime.strptime def __init__(self, format=empty, input_formats=None, *args, **kwargs): self.format = format if format is not empty else self.format @@ -978,7 +979,7 @@ class DateField(Field): return parsed else: try: - parsed = datetime.datetime.strptime(value, format) + parsed = self.datetime_parser(value, format) except (ValueError, TypeError): pass else: @@ -1017,6 +1018,7 @@ class TimeField(Field): } format = api_settings.TIME_FORMAT input_formats = api_settings.TIME_INPUT_FORMATS + datetime_parser = datetime.datetime.strptime def __init__(self, format=empty, input_formats=None, *args, **kwargs): self.format = format if format is not empty else self.format @@ -1038,7 +1040,7 @@ class TimeField(Field): return parsed else: try: - parsed = datetime.datetime.strptime(value, format) + parsed = self.datetime_parser(value, format) except (ValueError, TypeError): pass else: From 055986b5b09573758d32637adf627f737e50edb2 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 11:36:14 +0100 Subject: [PATCH 096/487] More helpful exception when URL cannot reverse and field value was empty. Closes #2698. --- rest_framework/relations.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 549aa85c..c5cbfebc 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -282,6 +282,13 @@ class HyperlinkedRelatedField(RelatedField): 'model in your API, or incorrectly configured the ' '`lookup_field` attribute on this field.' ) + if value in ('', None): + value_string = {'': 'the empty string', None: 'None'}[value] + msg += ( + " WARNING: The value of the field on the model instance " + "was %s, which may be why it didn't match any " + "entries in your URL conf." % value_string + ) raise ImproperlyConfigured(msg % self.view_name) From e6ca0fcb4c610dcf4cac291b3b3ace1a5b3f2d90 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 11:53:05 +0100 Subject: [PATCH 097/487] Remove erronous newline --- rest_framework/filters.py | 1 - 1 file changed, 1 deletion(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 2b277425..36ce0047 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -185,7 +185,6 @@ class DjangoObjectPermissionsFilter(BaseFilterBackend): A filter backend that limits results to those where the requesting user has read object level permissions. """ - def __init__(self): assert guardian, 'Using DjangoObjectPermissionsFilter, but django-guardian is not installed' From 8d69c4c068a11d8b6ce1003d21e4640d5432b047 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 2 Jul 2015 12:55:42 +0100 Subject: [PATCH 098/487] Improve OPTIONS descriptions for lists dicts and nested serializers --- rest_framework/metadata.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/rest_framework/metadata.py b/rest_framework/metadata.py index 3c7b3d2a..14d41b97 100644 --- a/rest_framework/metadata.py +++ b/rest_framework/metadata.py @@ -53,6 +53,9 @@ class SimpleMetadata(BaseMetadata): serializers.MultipleChoiceField: 'multiple choice', serializers.FileField: 'file upload', serializers.ImageField: 'image upload', + serializers.ListField: 'list', + serializers.DictField: 'nested object', + serializers.Serializer: 'nested object', }) def determine_metadata(self, request, view): From 2b979d43566311d9dc0411957565966e0a17238d Mon Sep 17 00:00:00 2001 From: Julien Syx Date: Thu, 2 Jul 2015 14:15:43 +0200 Subject: [PATCH 099/487] Adding recursion on child of List Field --- rest_framework/metadata.py | 3 +++ tests/test_metadata.py | 21 +++++++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/rest_framework/metadata.py b/rest_framework/metadata.py index 14d41b97..6bc18b3a 100644 --- a/rest_framework/metadata.py +++ b/rest_framework/metadata.py @@ -131,6 +131,9 @@ class SimpleMetadata(BaseMetadata): if value is not None and value != '': field_info[attr] = force_text(value, strings_only=True) + if getattr(field, 'child', None): + field_info['child'] = self.get_field_info(field.child) + if not field_info.get('read_only') and hasattr(field, 'choices'): field_info['choices'] = [ { diff --git a/tests/test_metadata.py b/tests/test_metadata.py index 6510a707..f7aab897 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -67,6 +67,11 @@ class TestMetadata: char_field = serializers.CharField( required=False, min_length=3, max_length=40 ) + list_field = serializers.ListField( + child=serializers.ListField( + child=serializers.IntegerField() + ) + ) class ExampleView(views.APIView): """Example view.""" @@ -119,6 +124,22 @@ class TestMetadata: 'label': 'Char field', 'min_length': 3, 'max_length': 40 + }, + 'list_field': { + 'type': 'list', + 'required': True, + 'read_only': False, + 'label': 'List field', + 'child': { + 'type': 'list', + 'required': True, + 'read_only': False, + 'child': { + 'type': 'integer', + 'required': True, + 'read_only': False + } + } } } } From 9e58bf650055f53f58d5d5f11f9de7447ce5801b Mon Sep 17 00:00:00 2001 From: Matt Broach Date: Thu, 2 Jul 2015 17:20:41 -0400 Subject: [PATCH 100/487] added link to Django Rest Multiple Models to Third Party Packages --- docs/api-guide/generic-views.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md index 7da9d587..d219afa1 100644 --- a/docs/api-guide/generic-views.md +++ b/docs/api-guide/generic-views.md @@ -394,6 +394,10 @@ The following third party packages provide additional generic view implementatio The [django-rest-framework-bulk package][django-rest-framework-bulk] implements generic view mixins as well as some common concrete generic views to allow to apply bulk operations via API requests. +## Django Rest Multiple Models + +[Django Rest Multiple Models][django-rest-multiple-models] provides a generic view (and mixin) for sending multiple serialized models and/or querysets via a single API request. + [cite]: https://docs.djangoproject.com/en/dev/ref/class-based-views/#base-vs-generic-views [GenericAPIView]: #genericapiview @@ -403,3 +407,6 @@ The [django-rest-framework-bulk package][django-rest-framework-bulk] implements [UpdateModelMixin]: #updatemodelmixin [DestroyModelMixin]: #destroymodelmixin [django-rest-framework-bulk]: https://github.com/miki725/django-rest-framework-bulk +[django-rest-multiple-models]: https://github.com/Axiologue/DjangoRestMultipleModels + + From b9e09e2f9014b8d1a79a775aea8a2faf978ee085 Mon Sep 17 00:00:00 2001 From: Matt Broach Date: Thu, 2 Jul 2015 18:18:30 -0400 Subject: [PATCH 101/487] Added django-rest-multiple-models link to general Third Party resources page as well --- docs/topics/third-party-resources.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/topics/third-party-resources.md b/docs/topics/third-party-resources.md index a024ddfc..9d394aa2 100644 --- a/docs/topics/third-party-resources.md +++ b/docs/topics/third-party-resources.md @@ -211,6 +211,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque ### Views * [djangorestframework-bulk][djangorestframework-bulk] - Implements generic view mixins as well as some common concrete generic views to allow to apply bulk operations via API requests. +* [django-rest-multiple-models][django-rest-multiple-models] - Provides a generic view (and mixin) for sending multiple serialized models and/or querysets via a single API request. ### Routers @@ -303,6 +304,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque [drf-compound-fields]: https://github.com/estebistec/drf-compound-fields [django-extra-fields]: https://github.com/Hipo/drf-extra-fields [djangorestframework-bulk]: https://github.com/miki725/django-rest-framework-bulk +[django-rest-multiple-models]: https://github.com/Axiologue/DjangoRestMultipleModels [drf-nested-routers]: https://github.com/alanjds/drf-nested-routers [wq.db.rest]: http://wq.io/docs/about-rest [djangorestframework-msgpack]: https://github.com/juanriaza/django-rest-framework-msgpack From 56b3f196057732ec441fe0f5982538431f1b069f Mon Sep 17 00:00:00 2001 From: Max Peterson Date: Fri, 3 Jul 2015 12:16:51 +0100 Subject: [PATCH 102/487] Add support for grouped choices. This also adds support for mixing single and paired choices: ``` [ ('poor', 'Poor quality'), 'medium', ('good', 'Good quality'), ] ``` --- rest_framework/fields.py | 38 +++++++++++++++++-------- tests/test_fields.py | 60 ++++++++++++++++++++++++++++++++++++++++ tests/test_validation.py | 46 ++++++++++++++++++++++++++++++ 3 files changed, 133 insertions(+), 11 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 3ca7d682..812a35ac 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -5,6 +5,7 @@ import copy import datetime import decimal import inspect +import itertools import re import uuid @@ -1098,17 +1099,8 @@ class ChoiceField(Field): } def __init__(self, choices, **kwargs): - # Allow either single or paired choices style: - # choices = [1, 2, 3] - # choices = [(1, 'First'), (2, 'Second'), (3, 'Third')] - pairs = [ - isinstance(item, (list, tuple)) and len(item) == 2 - for item in choices - ] - if all(pairs): - self.choices = OrderedDict([(key, display_value) for key, display_value in choices]) - else: - self.choices = OrderedDict([(item, item) for item in choices]) + flat_choices = [self.flatten_choice(c) for c in choices] + self.choices = OrderedDict(itertools.chain(*flat_choices)) # Map the string representation of choices to the underlying value. # Allows us to deal with eg. integer choices while supporting either @@ -1121,6 +1113,30 @@ class ChoiceField(Field): super(ChoiceField, self).__init__(**kwargs) + def flatten_choice(self, choice): + """ + Convert a choices choice into a flat list of choices. + + Returns a list of choices. + """ + + # Allow single, paired or grouped choices style: + # choices = [1, 2, 3] + # choices = [(1, 'First'), (2, 'Second'), (3, 'Third')] + # choices = [('Category', ((1, 'First'), (2, 'Second'))), (3, 'Third')] + if (not isinstance(choice, (list, tuple))): + # single choice + return [(choice, choice)] + else: + key, display_value = choice + if isinstance(display_value, (list, tuple)): + # grouped choices + sub_choices = [self.flatten_choice(c) for c in display_value] + return list(itertools.chain(*sub_choices)) + else: + # paired choice + return [(key, display_value)] + def to_internal_value(self, data): if data == '' and self.allow_blank: return '' diff --git a/tests/test_fields.py b/tests/test_fields.py index 76e6d9d6..3bd4afc6 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1091,6 +1091,66 @@ class TestChoiceFieldWithListChoices(FieldValues): field = serializers.ChoiceField(choices=('poor', 'medium', 'good')) +class TestChoiceFieldWithGroupedChoices(FieldValues): + """ + Valid and invalid values for a `Choice` field that uses a grouped list for the + choices, rather than a list of pairs of (`value`, `description`). + """ + valid_inputs = { + 'poor': 'poor', + 'medium': 'medium', + 'good': 'good', + } + invalid_inputs = { + 'awful': ['"awful" is not a valid choice.'] + } + outputs = { + 'good': 'good' + } + field = serializers.ChoiceField( + choices=[ + ( + 'Category', + ( + ('poor', 'Poor quality'), + ('medium', 'Medium quality'), + ), + ), + ('good', 'Good quality'), + ] + ) + + +class TestChoiceFieldWithMixedChoices(FieldValues): + """ + Valid and invalid values for a `Choice` field that uses a single paired or + grouped. + """ + valid_inputs = { + 'poor': 'poor', + 'medium': 'medium', + 'good': 'good', + } + invalid_inputs = { + 'awful': ['"awful" is not a valid choice.'] + } + outputs = { + 'good': 'good' + } + field = serializers.ChoiceField( + choices=[ + ( + 'Category', + ( + ('poor', 'Poor quality'), + ), + ), + 'medium', + ('good', 'Good quality'), + ] + ) + + class TestMultipleChoiceField(FieldValues): """ Valid and invalid values for `MultipleChoiceField`. diff --git a/tests/test_validation.py b/tests/test_validation.py index 46e36f5d..855ff20e 100644 --- a/tests/test_validation.py +++ b/tests/test_validation.py @@ -141,6 +141,8 @@ class TestMaxValueValidatorValidation(TestCase): self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) +# regression tests for issue: 1533 + class TestChoiceFieldChoicesValidate(TestCase): CHOICES = [ (0, 'Small'), @@ -148,6 +150,8 @@ class TestChoiceFieldChoicesValidate(TestCase): (2, 'Large'), ] + SINGLE_CHOICES = [0, 1, 2] + CHOICES_NESTED = [ ('Category', ( (1, 'First'), @@ -157,6 +161,15 @@ class TestChoiceFieldChoicesValidate(TestCase): (4, 'Fourth'), ] + MIXED_CHOICES = [ + ('Category', ( + (1, 'First'), + (2, 'Second'), + )), + 3, + (4, 'Fourth'), + ] + def test_choices(self): """ Make sure a value for choices works as expected. @@ -168,6 +181,39 @@ class TestChoiceFieldChoicesValidate(TestCase): except serializers.ValidationError: self.fail("Value %s does not validate" % str(value)) + def test_single_choices(self): + """ + Make sure a single value for choices works as expected. + """ + f = serializers.ChoiceField(choices=self.SINGLE_CHOICES) + value = self.SINGLE_CHOICES[0] + try: + f.to_internal_value(value) + except serializers.ValidationError: + self.fail("Value %s does not validate" % str(value)) + + def test_nested_choices(self): + """ + Make sure a nested value for choices works as expected. + """ + f = serializers.ChoiceField(choices=self.CHOICES_NESTED) + value = self.CHOICES_NESTED[0][1][0][0] + try: + f.to_internal_value(value) + except serializers.ValidationError: + self.fail("Value %s does not validate" % str(value)) + + def test_mixed_choices(self): + """ + Make sure mixed values for choices works as expected. + """ + f = serializers.ChoiceField(choices=self.MIXED_CHOICES) + value = self.MIXED_CHOICES[1] + try: + f.to_internal_value(value) + except serializers.ValidationError: + self.fail("Value %s does not validate" % str(value)) + class RegexSerializer(serializers.Serializer): pin = serializers.CharField( From ee2afb83e2e531922a5fc10c236f8b17b30fae82 Mon Sep 17 00:00:00 2001 From: Max Peterson Date: Fri, 3 Jul 2015 13:56:49 +0100 Subject: [PATCH 103/487] Fix 1.4 tests and make flatten_choice a utility. --- rest_framework/fields.py | 56 +++++++++++++++++++++------------------- 1 file changed, 30 insertions(+), 26 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 812a35ac..9ef30274 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -108,6 +108,34 @@ def set_value(dictionary, keys, value): dictionary[keys[-1]] = value +def flatten_choice(choice): + """ + Convert a single choices choice into a flat list of choices. + + Returns a list of choices pairs. + + flatten_choice(1) -> [(1, 1)] + flatten_choice((1, '1st')) -> [(1, '1st')] + flatten_choice(('Grp', ((1, '1st'), (2, '2nd')))) -> [(1, '1st'), (2, '2nd')] + """ + # Allow single, paired or grouped choices style: + # choices = [1, 2, 3] + # choices = [(1, 'First'), (2, 'Second'), (3, 'Third')] + # choices = [('Category', ((1, 'First'), (2, 'Second'))), (3, 'Third')] + if (not isinstance(choice, (list, tuple))): + # single choice + return [(choice, choice)] + else: + key, display_value = choice + if isinstance(display_value, (list, tuple)): + # grouped choices + sub_choices = [flatten_choice(c) for c in display_value] + return list(itertools.chain(*sub_choices)) + else: + # paired choice + return [(key, display_value)] + + class CreateOnlyDefault(object): """ This class may be used to provide default values that are only used @@ -1099,8 +1127,8 @@ class ChoiceField(Field): } def __init__(self, choices, **kwargs): - flat_choices = [self.flatten_choice(c) for c in choices] - self.choices = OrderedDict(itertools.chain(*flat_choices)) + flat_choices = [flatten_choice(c) for c in choices] + self.choices = OrderedDict(list(itertools.chain(*flat_choices))) # Map the string representation of choices to the underlying value. # Allows us to deal with eg. integer choices while supporting either @@ -1113,30 +1141,6 @@ class ChoiceField(Field): super(ChoiceField, self).__init__(**kwargs) - def flatten_choice(self, choice): - """ - Convert a choices choice into a flat list of choices. - - Returns a list of choices. - """ - - # Allow single, paired or grouped choices style: - # choices = [1, 2, 3] - # choices = [(1, 'First'), (2, 'Second'), (3, 'Third')] - # choices = [('Category', ((1, 'First'), (2, 'Second'))), (3, 'Third')] - if (not isinstance(choice, (list, tuple))): - # single choice - return [(choice, choice)] - else: - key, display_value = choice - if isinstance(display_value, (list, tuple)): - # grouped choices - sub_choices = [self.flatten_choice(c) for c in display_value] - return list(itertools.chain(*sub_choices)) - else: - # paired choice - return [(key, display_value)] - def to_internal_value(self, data): if data == '' and self.allow_blank: return '' From b0c5f9db2f28324d77a841f504a24a5b51935552 Mon Sep 17 00:00:00 2001 From: Juan Gutierrez Date: Fri, 3 Jul 2015 12:28:48 -0400 Subject: [PATCH 104/487] allow a non-required nested serializer to validate correctly when receiving multipart data --- rest_framework/serializers.py | 2 +- tests/test_serializer_nested.py | 43 +++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 7afddfd8..80b7c6d6 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -367,7 +367,7 @@ class Serializer(BaseSerializer): # We override the default field access in order to support # nested HTML forms. if html.is_html_input(dictionary): - return html.parse_html_dict(dictionary, prefix=self.field_name) + return html.parse_html_dict(dictionary, prefix=self.field_name) or empty return dictionary.get(self.field_name, empty) def run_validation(self, data=empty): diff --git a/tests/test_serializer_nested.py b/tests/test_serializer_nested.py index f5e4b26a..24415db6 100644 --- a/tests/test_serializer_nested.py +++ b/tests/test_serializer_nested.py @@ -38,3 +38,46 @@ class TestNestedSerializer: } serializer = self.Serializer() assert serializer.data == expected_data + + +class TestNotRequiredNestedSerializer: + def setup(self): + class NestedSerializer(serializers.Serializer): + one = serializers.IntegerField(max_value=10) + + class TestSerializer(serializers.Serializer): + nested = NestedSerializer(required=False) + + self.Serializer = TestSerializer + + class FakeMultiDict(dict): + """ + Use this to fake a `format="multipart"` request, because + `utils.is_html_input()` returns `True` when the dict object has + an attribute of "getlist". + """ + def getlist(self, value, default=None): + if value in self: + return [self[value]] + else: + return [] if default is None else default + + self.FakeMultiDict = FakeMultiDict + + def test_json_validate(self): + input_data = {} + serializer = self.Serializer(data=input_data) + assert serializer.is_valid() + + input_data = {'nested': {'one': '1'}} + serializer = self.Serializer(data=input_data) + assert serializer.is_valid() + + def test_multipart_validate(self): + input_data = self.FakeMultiDict() + serializer = self.Serializer(data=input_data) + assert serializer.is_valid() + + input_data = self.FakeMultiDict(**{'nested.one': '1'}) + serializer = self.Serializer(data=input_data) + assert serializer.is_valid() From f161241e077b4a19e79be6b4b01b8cc26a9a54e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jose=CC=81=20Padilla?= Date: Sun, 5 Jul 2015 16:47:02 -0400 Subject: [PATCH 105/487] Fix custom parser example --- docs/api-guide/parsers.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md index c242f878..d5975abd 100644 --- a/docs/api-guide/parsers.md +++ b/docs/api-guide/parsers.md @@ -144,17 +144,16 @@ By default this will include the following keys: `view`, `request`, `args`, `kwa The following is an example plaintext parser that will populate the `request.data` property with a string representing the body of the request. class PlainTextParser(BaseParser): - """ - Plain text parser. - """ - - media_type = 'text/plain' - - def parse(self, stream, media_type=None, parser_context=None): """ - Simply return a string representing the body of the request. + Plain text parser. """ - return stream.read() + media_type = 'text/plain' + + def parse(self, stream, media_type=None, parser_context=None): + """ + Simply return a string representing the body of the request. + """ + return stream.read() --- From 3bb9e251d71a858aef7158cdc2da9e5fe172d2ec Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Mon, 6 Jul 2015 17:35:21 -0400 Subject: [PATCH 106/487] added django-rest-framework-braces in Misc list of 3rd party tools --- docs/topics/third-party-resources.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/topics/third-party-resources.md b/docs/topics/third-party-resources.md index 9d394aa2..ae2ae3bc 100644 --- a/docs/topics/third-party-resources.md +++ b/docs/topics/third-party-resources.md @@ -238,11 +238,12 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque * [djangorestrelationalhyperlink][djangorestrelationalhyperlink] - A hyperlinked serialiser that can can be used to alter relationships via hyperlinks, but otherwise like a hyperlink model serializer. * [django-rest-swagger][django-rest-swagger] - An API documentation generator for Swagger UI. * [django-rest-framework-proxy][django-rest-framework-proxy] - Proxy to redirect incoming request to another API server. -* [gaiarestframework][gaiarestframework] - Utils for django-rest-framewok +* [gaiarestframework][gaiarestframework] - Utils for django-rest-framework * [drf-extensions][drf-extensions] - A collection of custom extensions * [ember-django-adapter][ember-django-adapter] - An adapter for working with Ember.js * [django-versatileimagefield][django-versatileimagefield] - Provides a drop-in replacement for Django's stock `ImageField` that makes it easy to serve images in multiple sizes/renditions from a single field. For DRF-specific implementation docs, [click here][django-versatileimagefield-drf-docs]. * [drf-tracking][drf-tracking] - Utilities to track requests to DRF API views. +* [django-rest-framework-braces][django-rest-framework-braces] - Collection of utilities for working with Django Rest Framework. The most notable ones are [FormSerializer](https://django-rest-framework-braces.readthedocs.org/en/latest/overview.html#formserializer) and [SerializerForm](https://django-rest-framework-braces.readthedocs.org/en/latest/overview.html#serializerform), which are adapters between DRF serializers and Django forms. ## Other Resources @@ -338,3 +339,4 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque [django-versatileimagefield-drf-docs]:http://django-versatileimagefield.readthedocs.org/en/latest/drf_integration.html [cdrf.co]:http://www.cdrf.co [drf-tracking]: https://github.com/aschn/drf-tracking +[django-rest-framework-braces]: https://github.com/dealertrack/django-rest-framework-braces From 35db2b142ff49c0ea648921244d16976e0d5d41e Mon Sep 17 00:00:00 2001 From: Juan Gutierrez Date: Wed, 8 Jul 2015 08:19:42 -0400 Subject: [PATCH 107/487] remove FakeMultiDict definition in nested serializer tests and replace with django QueryDict --- tests/test_serializer_nested.py | 20 ++++---------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/tests/test_serializer_nested.py b/tests/test_serializer_nested.py index 24415db6..99f60c2a 100644 --- a/tests/test_serializer_nested.py +++ b/tests/test_serializer_nested.py @@ -1,3 +1,5 @@ +from django.http import QueryDict + from rest_framework import serializers @@ -50,20 +52,6 @@ class TestNotRequiredNestedSerializer: self.Serializer = TestSerializer - class FakeMultiDict(dict): - """ - Use this to fake a `format="multipart"` request, because - `utils.is_html_input()` returns `True` when the dict object has - an attribute of "getlist". - """ - def getlist(self, value, default=None): - if value in self: - return [self[value]] - else: - return [] if default is None else default - - self.FakeMultiDict = FakeMultiDict - def test_json_validate(self): input_data = {} serializer = self.Serializer(data=input_data) @@ -74,10 +62,10 @@ class TestNotRequiredNestedSerializer: assert serializer.is_valid() def test_multipart_validate(self): - input_data = self.FakeMultiDict() + input_data = QueryDict() serializer = self.Serializer(data=input_data) assert serializer.is_valid() - input_data = self.FakeMultiDict(**{'nested.one': '1'}) + input_data = QueryDict('nested[one]=1') serializer = self.Serializer(data=input_data) assert serializer.is_valid() From 2887fc4a0bc587f548d90dd07efa5eb8146b3f8e Mon Sep 17 00:00:00 2001 From: Juan Gutierrez Date: Wed, 8 Jul 2015 08:25:12 -0400 Subject: [PATCH 108/487] update QueryDict initialization to satisfy older versions of Django --- tests/test_serializer_nested.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_serializer_nested.py b/tests/test_serializer_nested.py index 99f60c2a..b14a58c9 100644 --- a/tests/test_serializer_nested.py +++ b/tests/test_serializer_nested.py @@ -62,7 +62,7 @@ class TestNotRequiredNestedSerializer: assert serializer.is_valid() def test_multipart_validate(self): - input_data = QueryDict() + input_data = QueryDict('') serializer = self.Serializer(data=input_data) assert serializer.is_valid() From c04c8808c66cd04ce181653e0a247c5a5509e193 Mon Sep 17 00:00:00 2001 From: Yuri Hernani Heupa Date: Thu, 9 Jul 2015 22:41:53 -0300 Subject: [PATCH 109/487] Changed typo in Renderer docs The BrowsableAPIRenderer was misspelled with an extra 'e' letter --- docs/api-guide/renderers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index 744b4064..70672f0c 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -181,7 +181,7 @@ Renders data into HTML for the Browsable API. This renderer will determine whic #### Customizing BrowsableAPIRenderer -By default the response content will be rendered with the highest priority renderer apart from `BrowseableAPIRenderer`. If you need to customize this behavior, for example to use HTML as the default return format, but use JSON in the browsable API, you can do so by overriding the `get_default_renderer()` method. For example: +By default the response content will be rendered with the highest priority renderer apart from `BrowsableAPIRenderer`. If you need to customize this behavior, for example to use HTML as the default return format, but use JSON in the browsable API, you can do so by overriding the `get_default_renderer()` method. For example: class CustomBrowsableAPIRenderer(BrowsableAPIRenderer): def get_default_renderer(self, view): From 387dfd5dc3e4d1ba484e059a6df23395b664d541 Mon Sep 17 00:00:00 2001 From: Derek Pauley Date: Sat, 11 Jul 2015 13:23:57 -0500 Subject: [PATCH 110/487] Update rest-hypermedia-hateoas.md There was a typo under ## What REST framework doesn't provide. Original: What REST framework doesn't do is give you is machine readable hypermedia formats such as [HAL][hal], Fixed: What REST framework doesn't do is give you machine readable hypermedia formats such as [HAL][hal], --- docs/topics/rest-hypermedia-hateoas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/rest-hypermedia-hateoas.md b/docs/topics/rest-hypermedia-hateoas.md index 7e6d2408..5517b150 100644 --- a/docs/topics/rest-hypermedia-hateoas.md +++ b/docs/topics/rest-hypermedia-hateoas.md @@ -32,7 +32,7 @@ REST framework also includes [serialization] and [parser]/[renderer] components ## What REST framework doesn't provide. -What REST framework doesn't do is give you is machine readable hypermedia formats such as [HAL][hal], [Collection+JSON][collection], [JSON API][json-api] or HTML [microformats] by default, or the ability to auto-magically create fully HATEOAS style APIs that include hypermedia-based form descriptions and semantically labelled hyperlinks. Doing so would involve making opinionated choices about API design that should really remain outside of the framework's scope. +What REST framework doesn't do is give you machine readable hypermedia formats such as [HAL][hal], [Collection+JSON][collection], [JSON API][json-api] or HTML [microformats] by default, or the ability to auto-magically create fully HATEOAS style APIs that include hypermedia-based form descriptions and semantically labelled hyperlinks. Doing so would involve making opinionated choices about API design that should really remain outside of the framework's scope. [cite]: http://vimeo.com/channels/restfest/page:2 [dissertation]: http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm From 59905e933541d182617a84545280fbf2890cf5b8 Mon Sep 17 00:00:00 2001 From: homm Date: Mon, 13 Jul 2015 14:36:47 +0300 Subject: [PATCH 111/487] revert BasePageSizePagination class and CursorPagination inheritance --- rest_framework/pagination.py | 59 +++++++++++++++++------------------- 1 file changed, 28 insertions(+), 31 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 5d0dc70d..5938063a 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -201,34 +201,7 @@ class BasePagination(object): raise NotImplementedError('to_html() must be implemented to display page controls.') -class BasePageSizePagination(BasePagination): - # The default page size. - # Defaults to `None`, meaning pagination is disabled. - page_size = api_settings.PAGE_SIZE - - # Set to an integer to limit the maximum page size the client may request. - # Only relevant if 'page_size_query_param' has also been set. - max_page_size = None - - # Client can control the page size using this query parameter. - # Default is 'None'. Set to eg 'page_size' to enable usage. - page_size_query_param = None - - def get_page_size(self, request): - if self.page_size_query_param: - try: - return _positive_int( - request.query_params[self.page_size_query_param], - strict=True, - cutoff=self.max_page_size - ) - except (KeyError, ValueError): - pass - - return self.page_size - - -class PageNumberPagination(BasePageSizePagination): +class PageNumberPagination(BasePagination): """ A simple page number based style that supports page numbers as query parameters. For example: @@ -236,10 +209,21 @@ class PageNumberPagination(BasePageSizePagination): http://api.example.org/accounts/?page=4 http://api.example.org/accounts/?page=4&page_size=100 """ + # The default page size. + # Defaults to `None`, meaning pagination is disabled. + page_size = api_settings.PAGE_SIZE # Client can control the page using this query parameter. page_query_param = 'page' + # Client can control the page size using this query parameter. + # Default is 'None'. Set to eg 'page_size' to enable usage. + page_size_query_param = None + + # Set to an integer to limit the maximum page size the client may request. + # Only relevant if 'page_size_query_param' has also been set. + max_page_size = None + last_page_strings = ('last',) template = 'rest_framework/pagination/numbers.html' @@ -334,6 +318,19 @@ class PageNumberPagination(BasePageSizePagination): ('results', data) ])) + def get_page_size(self, request): + if self.page_size_query_param: + try: + return _positive_int( + request.query_params[self.page_size_query_param], + strict=True, + cutoff=self.max_page_size + ) + except (KeyError, ValueError): + pass + + return self.page_size + def get_next_link(self): if not self.page.has_next(): return None @@ -487,20 +484,20 @@ class LimitOffsetPagination(BasePagination): return template.render(context) -class CursorPagination(BasePageSizePagination): +class CursorPagination(BasePagination): """ The cursor pagination implementation is neccessarily complex. For an overview of the position/offset style we use, see this post: http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api/ """ cursor_query_param = 'cursor' + page_size = api_settings.PAGE_SIZE invalid_cursor_message = _('Invalid cursor') ordering = '-created' template = 'rest_framework/pagination/previous_and_next.html' def paginate_queryset(self, queryset, request, view=None): - self.page_size = self.get_page_size(request) - if not self.page_size: + if self.page_size is None: return None self.base_url = request.build_absolute_uri() From a3afcfb6d3ff454860cd1d39082bd1788fd98d58 Mon Sep 17 00:00:00 2001 From: homm Date: Mon, 13 Jul 2015 14:44:48 +0300 Subject: [PATCH 112/487] duplicate `get_page_size` and related properties from PageNumberPagination --- rest_framework/pagination.py | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 5938063a..f70a6eda 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -491,13 +491,26 @@ class CursorPagination(BasePagination): http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api/ """ cursor_query_param = 'cursor' + + # The default page size. + # Defaults to `None`, meaning pagination is disabled. page_size = api_settings.PAGE_SIZE + + # Client can control the page size using this query parameter. + # Default is 'None'. Set to eg 'page_size' to enable usage. + page_size_query_param = None + + # Set to an integer to limit the maximum page size the client may request. + # Only relevant if 'page_size_query_param' has also been set. + max_page_size = None + invalid_cursor_message = _('Invalid cursor') ordering = '-created' template = 'rest_framework/pagination/previous_and_next.html' def paginate_queryset(self, queryset, request, view=None): - if self.page_size is None: + self.page_size = self.get_page_size(request) + if not self.page_size: return None self.base_url = request.build_absolute_uri() @@ -577,6 +590,19 @@ class CursorPagination(BasePagination): return self.page + def get_page_size(self, request): + if self.page_size_query_param: + try: + return _positive_int( + request.query_params[self.page_size_query_param], + strict=True, + cutoff=self.max_page_size + ) + except (KeyError, ValueError): + pass + + return self.page_size + def get_next_link(self): if not self.has_next: return None From 6d4ae2c40f6ee38f30d8773a8073273497fa7788 Mon Sep 17 00:00:00 2001 From: Alexander Pitkin Date: Mon, 13 Jul 2015 16:46:14 +0300 Subject: [PATCH 113/487] Fixed type in docs Fixed typo in Miscellaneous notes of 3.0 release announcement docs --- docs/topics/3.0-announcement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/3.0-announcement.md b/docs/topics/3.0-announcement.md index 59fe779c..89f9e800 100644 --- a/docs/topics/3.0-announcement.md +++ b/docs/topics/3.0-announcement.md @@ -940,7 +940,7 @@ The default JSON renderer will return float objects for un-coerced `Decimal` ins * The serializer `ChoiceField` does not currently display nested choices, as was the case in 2.4. This will be address as part of 3.1. * Due to the new templated form rendering, the 'widget' option is no longer valid. This means there's no easy way of using third party "autocomplete" widgets for rendering select inputs that contain a large number of choices. You'll either need to use a regular select or a plain text input. We may consider addressing this in 3.1 or 3.2 if there's sufficient demand. * Some of the default validation error messages were rewritten and might no longer be pre-translated. You can still [create language files with Django][django-localization] if you wish to localize them. -* `APIException` subclasses could previously take could previously take any arbitrary type in the `detail` argument. These exceptions now use translatable text strings, and as a result call `force_text` on the `detail` argument, which *must be a string*. If you need complex arguments to an `APIException` class, you should subclass it and override the `__init__()` method. Typically you'll instead want to use a custom exception handler to provide for non-standard error responses. +* `APIException` subclasses could previously take any arbitrary type in the `detail` argument. These exceptions now use translatable text strings, and as a result call `force_text` on the `detail` argument, which *must be a string*. If you need complex arguments to an `APIException` class, you should subclass it and override the `__init__()` method. Typically you'll instead want to use a custom exception handler to provide for non-standard error responses. --- From 538ffaf6c71944aa4f0d77f1167c2cef570dabe1 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 11:13:26 +0100 Subject: [PATCH 114/487] Store self.action='metadata' for OPTIONS requests on viewsets. Closes #3115. --- rest_framework/viewsets.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/rest_framework/viewsets.py b/rest_framework/viewsets.py index e1c5e17f..819deb43 100644 --- a/rest_framework/viewsets.py +++ b/rest_framework/viewsets.py @@ -83,6 +83,12 @@ class ViewSetMixin(object): if hasattr(self, 'get') and not hasattr(self, 'head'): self.head = self.get + # Explicitly map `options` requests to an (implicit) action named + # 'metadata'. This action doesn't actually exist as a named method, + # because, unlike other methods, we always route to it. + if hasattr(self, 'options'): + self.action_map['options'] = 'metadata' + # And continue as usual return self.dispatch(request, *args, **kwargs) From 209bcb90879c7373787fb1201854e06adb3cc729 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 11:21:33 +0100 Subject: [PATCH 115/487] Added url_field_name class attribute to ModelSerializer. Closes #3106. --- rest_framework/serializers.py | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 80b7c6d6..1792ae2c 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -752,8 +752,16 @@ class ModelSerializer(Serializer): serializer_url_field = HyperlinkedIdentityField serializer_choice_field = ChoiceField - # Default `create` and `update` behavior... + # The field name for hyperlinked identity fields. Defaults to 'url'. + # You can modify this using the API setting. + # + # Note that if you instead need modify this on a per-serializer basis, + # you'll also need to ensure you update the `create` method on any generic + # views, to correctly handle the 'Location' response header for + # "HTTP 201 Created" responses. + url_field_name = api_settings.URL_FIELD_NAME + # Default `create` and `update` behavior... def create(self, validated_data): """ We have a bit of extra checking around this in order to provide @@ -995,7 +1003,7 @@ class ModelSerializer(Serializer): elif hasattr(model_class, field_name): return self.build_property_field(field_name, model_class) - elif field_name == api_settings.URL_FIELD_NAME: + elif field_name == self.url_field_name: return self.build_url_field(field_name, model_class) return self.build_unknown_field(field_name, model_class) @@ -1150,9 +1158,9 @@ class ModelSerializer(Serializer): DeprecationWarning, stacklevel=3 ) - kwargs = extra_kwargs.get(api_settings.URL_FIELD_NAME, {}) + kwargs = extra_kwargs.get(self.url_field_name, {}) kwargs['view_name'] = view_name - extra_kwargs[api_settings.URL_FIELD_NAME] = kwargs + extra_kwargs[self.url_field_name] = kwargs lookup_field = getattr(self.Meta, 'lookup_field', None) if lookup_field is not None: @@ -1162,9 +1170,9 @@ class ModelSerializer(Serializer): DeprecationWarning, stacklevel=3 ) - kwargs = extra_kwargs.get(api_settings.URL_FIELD_NAME, {}) + kwargs = extra_kwargs.get(self.url_field_name, {}) kwargs['lookup_field'] = lookup_field - extra_kwargs[api_settings.URL_FIELD_NAME] = kwargs + extra_kwargs[self.url_field_name] = kwargs return extra_kwargs @@ -1399,7 +1407,7 @@ class HyperlinkedModelSerializer(ModelSerializer): `Meta.fields` option is not specified. """ return ( - [api_settings.URL_FIELD_NAME] + + [self.url_field_name] + list(declared_fields.keys()) + list(model_info.fields.keys()) + list(model_info.forward_relations.keys()) From 14a32ae32d6b4605b41b0929bab98ecb9e1f67c0 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 11:40:15 +0100 Subject: [PATCH 116/487] Add get_page_size hook to CursorPagination. Closes #3068. --- rest_framework/pagination.py | 18 ------------------ tests/test_pagination.py | 20 -------------------- 2 files changed, 38 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 081760e1..3536f793 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -454,14 +454,6 @@ class CursorPagination(BasePagination): # Defaults to `None`, meaning pagination is disabled. page_size = api_settings.PAGE_SIZE - # Client can control the page size using this query parameter. - # Default is 'None'. Set to eg 'page_size' to enable usage. - page_size_query_param = None - - # Set to an integer to limit the maximum page size the client may request. - # Only relevant if 'page_size_query_param' has also been set. - max_page_size = None - invalid_cursor_message = _('Invalid cursor') ordering = '-created' template = 'rest_framework/pagination/previous_and_next.html' @@ -544,16 +536,6 @@ class CursorPagination(BasePagination): return self.page def get_page_size(self, request): - if self.page_size_query_param: - try: - return _positive_int( - request.query_params[self.page_size_query_param], - strict=True, - cutoff=self.max_page_size - ) - except (KeyError, ValueError): - pass - return self.page_size def get_next_link(self): diff --git a/tests/test_pagination.py b/tests/test_pagination.py index 0ab149d0..03c4fdf4 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -513,8 +513,6 @@ class TestCursorPagination: class ExamplePagination(pagination.CursorPagination): page_size = 5 - page_size_query_param = 'page_size' - max_page_size = 20 ordering = 'created' self.pagination = ExamplePagination() @@ -650,24 +648,6 @@ class TestCursorPagination: assert isinstance(self.pagination.to_html(), type('')) - def test_page_size(self): - (previous, current, next, previous_url, next_url) = \ - self.get_pages('/?page_size=10') - - assert previous is None - assert current == [1, 1, 1, 1, 1, 1, 2, 3, 4, 4] - assert next == [4, 4, 5, 6, 7, 7, 7, 7, 7, 7] - assert 'page_size=10' in next_url - - (previous, current, next, previous_url, next_url) = \ - self.get_pages(next_url.replace('page_size=10', 'page_size=4')) - - assert previous == [2, 3, 4, 4] - assert current == [4, 4, 5, 6] - assert next == [7, 7, 7, 7] - assert 'page_size=4' in previous_url - assert 'page_size=4' in next_url - def test_get_displayed_page_numbers(): """ From 2b51d5594b727e7a14b6e1c3c94e325898fb5213 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 11:41:25 +0100 Subject: [PATCH 117/487] Remove whitespace and comment changes --- rest_framework/pagination.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 3536f793..a171c684 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -449,11 +449,7 @@ class CursorPagination(BasePagination): http://cramer.io/2011/03/08/building-cursors-for-the-disqus-api/ """ cursor_query_param = 'cursor' - - # The default page size. - # Defaults to `None`, meaning pagination is disabled. page_size = api_settings.PAGE_SIZE - invalid_cursor_message = _('Invalid cursor') ordering = '-created' template = 'rest_framework/pagination/previous_and_next.html' From 586c3350d45bcf62bc21e8b6a6dc3af79c410434 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 12:10:40 +0100 Subject: [PATCH 118/487] Writable Nested Serializer example in relationships docs. Closes #2924. --- docs/api-guide/relations.md | 53 ++++++++++++++++++++++++++++++++++--- 1 file changed, 50 insertions(+), 3 deletions(-) diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md index 8a810edb..a673c2fc 100644 --- a/docs/api-guide/relations.md +++ b/docs/api-guide/relations.md @@ -256,17 +256,64 @@ For example, the following serializer: Would serialize to a nested representation like this: + >>> album = Album.objects.create(album_name="The Grey Album", artist='Danger Mouse') + >>> Track.objects.create(album=album, order=1, title='Public Service Announcement', duration=245) + + >>> Track.objects.create(album=album, order=2, title='What More Can I Say', duration=264) + + >>> Track.objects.create(album=album, order=3, title='Encore', duration=159) + + >>> serializer = AlbumSerializer(instance=album) + >>> serializer.data { 'album_name': 'The Grey Album', 'artist': 'Danger Mouse', 'tracks': [ - {'order': 1, 'title': 'Public Service Announcement'}, - {'order': 2, 'title': 'What More Can I Say'}, - {'order': 3, 'title': 'Encore'}, + {'order': 1, 'title': 'Public Service Announcement', 'duration': 245}, + {'order': 2, 'title': 'What More Can I Say', 'duration': 264}, + {'order': 3, 'title': 'Encore', 'duration': 159}, ... ], } +# Writable nested serializers + +Be default nested serializers are read-only. If you want to to support write-operations to a nested serializer field you'll need to create either or both of the `create()` and/or `update()` methods, in order to explicitly specify how the child relationships should be saved. + + class TrackSerializer(serializers.ModelSerializer): + class Meta: + model = Track + fields = ('order', 'title') + + class AlbumSerializer(serializers.ModelSerializer): + tracks = TrackSerializer(many=True) + + class Meta: + model = Album + fields = ('album_name', 'artist', 'tracks') + + def create(self, validated_data): + tracks_data = validated_data.pop('tracks') + album = Album.objects.create(**validated_data) + for track_data in tracks_data: + Track.objects.create(album=album, **track_data) + return album + + >>> data = { + 'album_name': 'The Grey Album', + 'artist': 'Danger Mouse', + 'tracks': [ + {'order': 1, 'title': 'Public Service Announcement', 'duration': 245}, + {'order': 2, 'title': 'What More Can I Say', 'duration': 264}, + {'order': 3, 'title': 'Encore', 'duration': 159}, + ], + } + >>> serializer = AlbumSerializer(data=data) + >>> serializer.is_valid() + True + >>> serializer.save() + + # Custom relational fields To implement a custom relational field, you should override `RelatedField`, and implement the `.to_representation(self, value)` method. This method takes the target of the field as the `value` argument, and should return the representation that should be used to serialize the target. The `value` argument will typically be a model instance. From 3c57e08f62ab4491da18c7174638dc2a52577ac0 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 12:22:51 +0100 Subject: [PATCH 119/487] Clarifications to read_only fields. Closes #3064. --- docs/api-guide/fields.md | 2 ++ rest_framework/serializers.py | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 18637f21..c5c65831 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -20,6 +20,8 @@ Each serializer field class constructor takes at least these arguments. Some Fi ### `read_only` +Read-only fields are included in the API output, but should not be included in the input during create or update operations. Any 'read_only' fields that are incorrectly included in the serializer input will be ignored. + Set this to `True` to ensure that the field is used when serializing a representation, but is not used when creating or updating an instance during deserialization. Defaults to `False` diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 1792ae2c..beaae1e1 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -825,6 +825,10 @@ class ModelSerializer(Serializer): def update(self, instance, validated_data): raise_errors_on_nested_writes('update', self, validated_data) + # Simply set each attribute on the instance, and then save it. + # Note that unlike `.create()` we don't need to treat many-to-many + # relationships as being a special case. During updates we already + # have an instance pk for the relationships to be associated with. for attr, value in validated_data.items(): setattr(instance, attr, value) instance.save() From 468361425d38f27580626f0ae9af74d9c4f7bc98 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 12:32:27 +0100 Subject: [PATCH 120/487] page_size should be local, not overwriting class attribute. --- rest_framework/pagination.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index a171c684..a14141d3 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -455,8 +455,8 @@ class CursorPagination(BasePagination): template = 'rest_framework/pagination/previous_and_next.html' def paginate_queryset(self, queryset, request, view=None): - self.page_size = self.get_page_size(request) - if not self.page_size: + page_size = self.get_page_size(request) + if not page_size: return None self.base_url = request.build_absolute_uri() @@ -491,8 +491,8 @@ class CursorPagination(BasePagination): # If we have an offset cursor then offset the entire page by that amount. # We also always fetch an extra item in order to determine if there is a # page following on from this one. - results = list(queryset[offset:offset + self.page_size + 1]) - self.page = list(results[:self.page_size]) + results = list(queryset[offset:offset + page_size + 1]) + self.page = list(results[:page_size]) # Determine the position of the final item following the page. if len(results) > len(self.page): From bca2ea35dff9cd673cee7600c1173adb21798560 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 13:21:08 +0100 Subject: [PATCH 121/487] Ensure that realtionship fields '.choices' returns an empty dict when accessed with a read-only field. Closes #2910. --- rest_framework/relations.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index c5cbfebc..135b9614 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -109,12 +109,18 @@ class RelatedField(Field): @property def choices(self): + queryset = self.get_queryset() + if queryset is None: + # Ensure that field.choices returns something sensible + # even when accessed with a read-only field. + return {} + return OrderedDict([ ( six.text_type(self.to_representation(item)), six.text_type(item) ) - for item in self.get_queryset() + for item in queryset ]) From c14ad7add7de6dcde564a3cf28c68c1399a15659 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 13:31:24 +0100 Subject: [PATCH 122/487] Handle .choices for related fields when queryset argument is actually a mamanger instance. Closes #3145. --- rest_framework/relations.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 135b9614..8bf7d628 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -5,6 +5,7 @@ from django.core.exceptions import ImproperlyConfigured, ObjectDoesNotExist from django.core.urlresolvers import ( NoReverseMatch, Resolver404, get_script_prefix, resolve ) +from django.db.models import Manager from django.db.models.query import QuerySet from django.utils import six from django.utils.encoding import smart_text @@ -87,8 +88,13 @@ class RelatedField(Field): def get_queryset(self): queryset = self.queryset - if isinstance(queryset, QuerySet): + if isinstance(queryset, (QuerySet, Manager)): # Ensure queryset is re-evaluated whenever used. + # Note that actually a `Manager` class may also be used as the + # queryset argument. This occurs on ModelSerializer fields, + # as it allows us to generate a more expressive 'repr' output + # for the field. + # Eg: 'MyRelationship(queryset=ExampleModel.objects.all())' queryset = queryset.all() return queryset From 132eab7bbd1c52a47f90aabf0e44e361a19071c6 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 14:49:44 +0100 Subject: [PATCH 123/487] Raise helpful error when erronously including nested data in multipart post requests with test client. Closes #2919. --- rest_framework/renderers.py | 8 ++++++++ tests/test_testing.py | 10 ++++++++++ 2 files changed, 18 insertions(+) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 6e1370b7..64646d58 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -679,4 +679,12 @@ class MultiPartRenderer(BaseRenderer): BOUNDARY = 'BoUnDaRyStRiNg' if django.VERSION >= (1, 5) else b'BoUnDaRyStRiNg' def render(self, data, accepted_media_type=None, renderer_context=None): + if hasattr(data, 'items'): + for key, value in data.items(): + assert not isinstance(value, dict), ( + "Test data contained a dictionary value for key '%s', " + "but multipart uploads do not support nested data. " + "You may want to consider using format='JSON' in this " + "test case." % key + ) return encode_multipart(self.BOUNDARY, data) diff --git a/tests/test_testing.py b/tests/test_testing.py index 70c83f8d..e0bf759a 100644 --- a/tests/test_testing.py +++ b/tests/test_testing.py @@ -172,6 +172,16 @@ class TestAPITestClient(TestCase): self.assertIsNotNone(response.redirect_chain) self.assertEqual(response.status_code, 200) + def test_invalid_multipart_data(self): + """ + MultiPart encoding cannot support nested data, so raise a helpful + error if the user attempts to do so. + """ + self.assertRaises( + AssertionError, self.client.post, + path='/view/', data={'valid': 123, 'invalid': {'a': 123}} + ) + class TestAPIRequestFactory(TestCase): def test_csrf_exempt_by_default(self): From 8d306823b4a78fda316d54c73ea3429ad81ccf43 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 15:03:33 +0100 Subject: [PATCH 124/487] Update docs on ALLOWED_VERSIONS and DEFAULT_VERSION. Closes #2778. --- docs/api-guide/versioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/versioning.md b/docs/api-guide/versioning.md index ae3ba463..482943b8 100644 --- a/docs/api-guide/versioning.md +++ b/docs/api-guide/versioning.md @@ -71,7 +71,7 @@ You can also set the versioning scheme on an individual view. Typically you won' The following settings keys are also used to control versioning: * `DEFAULT_VERSION`. The value that should be used for `request.version` when no versioning information is present. Defaults to `None`. -* `ALLOWED_VERSIONS`. If set, this value will restrict the set of versions that may be returned by the versioning scheme, and will raise an error if the provided version if not in this set. Defaults to `None`. +* `ALLOWED_VERSIONS`. If set, this value will restrict the set of versions that may be returned by the versioning scheme, and will raise an error if the provided version if not in this set. Note that the value used for the `DEFAULT_VERSION` setting is always considered to be part of the `ALLOWED_VERSIONS` set. Defaults to `None`. * `VERSION_PARAMETER`. The string that should used for any versioning parameters, such as in the media type or URL query parameters. Defaults to `'version'`. You can also set your versioning class plus those three values on a per-view or a per-viewset basis by defining your own versioning scheme and using the `default_version`, `allowed_versions` and `version_param` class variables. For example, if you want to use `URLPathVersioning`: From 6b08e97b6af8114d1ad82fc53a9cdf58168a278e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 14 Jul 2015 15:47:13 +0100 Subject: [PATCH 125/487] Form fields should use textual only value representations. Closes #3139. Closes #2416. Closes #2558. --- rest_framework/renderers.py | 3 +++ rest_framework/utils/serializer_helpers.py | 6 +++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 64646d58..4263adce 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -318,6 +318,9 @@ class HTMLFormRenderer(BaseRenderer): style['template_pack'] = parent_style.get('template_pack', self.template_pack) style['renderer'] = self + # Get a clone of the field with text-only value representation. + field = field.as_form_field() + if style.get('input_type') == 'datetime-local' and isinstance(field.value, six.text_type): field.value = field.value.rstrip('Z') diff --git a/rest_framework/utils/serializer_helpers.py b/rest_framework/utils/serializer_helpers.py index b751a358..9d2f70c8 100644 --- a/rest_framework/utils/serializer_helpers.py +++ b/rest_framework/utils/serializer_helpers.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals import collections -from rest_framework.compat import OrderedDict, unicode_to_repr +from rest_framework.compat import OrderedDict, force_text, unicode_to_repr class ReturnDict(OrderedDict): @@ -54,6 +54,7 @@ class BoundField(object): """ def __init__(self, field, value, errors, prefix=''): self._field = field + self._prefix = prefix self.value = value self.errors = errors self.name = prefix + self.field_name @@ -70,6 +71,9 @@ class BoundField(object): self.__class__.__name__, self.value, self.errors )) + def as_form_field(self): + return BoundField(self._field, force_text(self.value), self.errors, self._prefix) + class NestedBoundField(BoundField): """ From a9f1d99cb5c91aef29d4d9d7a8617b5ba18793cf Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 10:08:22 +0100 Subject: [PATCH 126/487] Fix 'metadata' action on viewsets. Closes #3158. Closes #3157. Closes #3115. --- rest_framework/viewsets.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/rest_framework/viewsets.py b/rest_framework/viewsets.py index 819deb43..05434b72 100644 --- a/rest_framework/viewsets.py +++ b/rest_framework/viewsets.py @@ -83,12 +83,6 @@ class ViewSetMixin(object): if hasattr(self, 'get') and not hasattr(self, 'head'): self.head = self.get - # Explicitly map `options` requests to an (implicit) action named - # 'metadata'. This action doesn't actually exist as a named method, - # because, unlike other methods, we always route to it. - if hasattr(self, 'options'): - self.action_map['options'] = 'metadata' - # And continue as usual return self.dispatch(request, *args, **kwargs) @@ -112,7 +106,14 @@ class ViewSetMixin(object): depending on the request method. """ request = super(ViewSetMixin, self).initialize_request(request, *args, **kwargs) - self.action = self.action_map.get(request.method.lower()) + method = request.method.lower() + if method == 'options': + # This is a special case as we always provide handling for the + # options method in the base `View` class. + # Unlike the other explicitly defined actions, 'metadata' is implict. + self.action = 'metadata' + else: + self.action = self.action_map.get(method) return request From 0ea64f6b33dda111ae7d544ba95bdd1f3211e16a Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 10:19:27 +0100 Subject: [PATCH 127/487] More docs on configuring a custom metadata class. --- docs/api-guide/metadata.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api-guide/metadata.md b/docs/api-guide/metadata.md index 01727440..e12aeb7f 100644 --- a/docs/api-guide/metadata.md +++ b/docs/api-guide/metadata.md @@ -98,6 +98,12 @@ The following class could be used to limit the information that is returned to ` 'description': view.get_view_description() } +Then configure your settings to use this custom class: + + REST_FRAMEWORK = { + 'DEFAULT_METADATA_CLASS': 'myproject.apps.core.MinimalMetadata' + } + [cite]: http://tools.ietf.org/html/rfc7231#section-4.3.7 [no-options]: https://www.mnot.net/blog/2012/10/29/NO_OPTIONS [json-schema]: http://json-schema.org/ From c879aaf39880a87c84ac7fd25e536087bdf35b5a Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 10:26:16 +0100 Subject: [PATCH 128/487] page_size needs to be stored as state on CursorPagination. Refs 3147. --- rest_framework/pagination.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index a14141d3..a171c684 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -455,8 +455,8 @@ class CursorPagination(BasePagination): template = 'rest_framework/pagination/previous_and_next.html' def paginate_queryset(self, queryset, request, view=None): - page_size = self.get_page_size(request) - if not page_size: + self.page_size = self.get_page_size(request) + if not self.page_size: return None self.base_url = request.build_absolute_uri() @@ -491,8 +491,8 @@ class CursorPagination(BasePagination): # If we have an offset cursor then offset the entire page by that amount. # We also always fetch an extra item in order to determine if there is a # page following on from this one. - results = list(queryset[offset:offset + page_size + 1]) - self.page = list(results[:page_size]) + results = list(queryset[offset:offset + self.page_size + 1]) + self.page = list(results[:self.page_size]) # Determine the position of the final item following the page. if len(results) > len(self.page): From 7315ed8b005b9adfbab0ec49677d65b2cb4016cb Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 10:49:00 +0100 Subject: [PATCH 129/487] Resolve browsable API form issues with nested serializers. Closes #3153. --- rest_framework/utils/serializer_helpers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/utils/serializer_helpers.py b/rest_framework/utils/serializer_helpers.py index 9d2f70c8..6172ce81 100644 --- a/rest_framework/utils/serializer_helpers.py +++ b/rest_framework/utils/serializer_helpers.py @@ -72,7 +72,7 @@ class BoundField(object): )) def as_form_field(self): - return BoundField(self._field, force_text(self.value), self.errors, self._prefix) + return self.__class__(self._field, force_text(self.value), self.errors, self._prefix) class NestedBoundField(BoundField): From d231f36588aa69bd217ccf132c45e4199f8503df Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 11:47:40 +0100 Subject: [PATCH 130/487] Support default values being used for empty HTML fields. Closes #3130. --- rest_framework/fields.py | 2 ++ tests/test_fields.py | 47 ++++++++++++++++++++++++++-------------- 2 files changed, 33 insertions(+), 16 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 3ca7d682..eea69344 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -291,6 +291,8 @@ class Field(object): # If the field is blank, and null is a valid value then # determine if we should use null instead. return '' if getattr(self, 'allow_blank', False) else None + elif ret == '' and self.default: + return empty return ret return dictionary.get(self.field_name, empty) diff --git a/tests/test_fields.py b/tests/test_fields.py index 76e6d9d6..cea440c8 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -4,6 +4,7 @@ from decimal import Decimal import django import pytest +from django.http import QueryDict from django.utils import timezone import rest_framework @@ -224,14 +225,6 @@ class TestInvalidErrorKey: assert str(exc_info.value) == expected -class MockHTMLDict(dict): - """ - This class mocks up a dictionary like object, that behaves - as if it was returned for multipart or urlencoded data. - """ - getlist = None - - class TestBooleanHTMLInput: def setup(self): class TestSerializer(serializers.Serializer): @@ -245,7 +238,7 @@ class TestBooleanHTMLInput: """ # This class mocks up a dictionary like object, that behaves # as if it was returned for multipart or urlencoded data. - serializer = self.Serializer(data=MockHTMLDict()) + serializer = self.Serializer(data=QueryDict('')) assert serializer.is_valid() assert serializer.validated_data == {'archived': False} @@ -255,15 +248,39 @@ class TestHTMLInput: class TestSerializer(serializers.Serializer): message = serializers.CharField(default='happy') - serializer = TestSerializer(data=MockHTMLDict()) + serializer = TestSerializer(data=QueryDict('')) assert serializer.is_valid() assert serializer.validated_data == {'message': 'happy'} + def test_empty_html_integerfield(self): + class TestSerializer(serializers.Serializer): + message = serializers.IntegerField(default=123) + + serializer = TestSerializer(data=QueryDict('message=')) + assert serializer.is_valid() + assert serializer.validated_data == {'message': 123} + + def test_empty_html_uuidfield_with_default(self): + class TestSerializer(serializers.Serializer): + message = serializers.UUIDField(default=uuid.uuid4) + + serializer = TestSerializer(data=QueryDict('message=')) + assert serializer.is_valid() + assert list(serializer.validated_data.keys()) == ['message'] + + def test_empty_html_uuidfield_with_optional(self): + class TestSerializer(serializers.Serializer): + message = serializers.UUIDField(required=False) + + serializer = TestSerializer(data=QueryDict('message=')) + assert serializer.is_valid() + assert list(serializer.validated_data.keys()) == [] + def test_empty_html_charfield_allow_null(self): class TestSerializer(serializers.Serializer): message = serializers.CharField(allow_null=True) - serializer = TestSerializer(data=MockHTMLDict({'message': ''})) + serializer = TestSerializer(data=QueryDict('message=')) assert serializer.is_valid() assert serializer.validated_data == {'message': None} @@ -271,7 +288,7 @@ class TestHTMLInput: class TestSerializer(serializers.Serializer): expiry = serializers.DateField(allow_null=True) - serializer = TestSerializer(data=MockHTMLDict({'expiry': ''})) + serializer = TestSerializer(data=QueryDict('expiry=')) assert serializer.is_valid() assert serializer.validated_data == {'expiry': None} @@ -279,7 +296,7 @@ class TestHTMLInput: class TestSerializer(serializers.Serializer): message = serializers.CharField(allow_null=True, allow_blank=True) - serializer = TestSerializer(data=MockHTMLDict({'message': ''})) + serializer = TestSerializer(data=QueryDict('message=')) assert serializer.is_valid() assert serializer.validated_data == {'message': ''} @@ -287,7 +304,7 @@ class TestHTMLInput: class TestSerializer(serializers.Serializer): message = serializers.CharField(required=False) - serializer = TestSerializer(data=MockHTMLDict()) + serializer = TestSerializer(data=QueryDict('')) assert serializer.is_valid() assert serializer.validated_data == {} @@ -1116,8 +1133,6 @@ class TestMultipleChoiceField(FieldValues): ) def test_against_partial_and_full_updates(self): - # serializer = self.Serializer(data=MockHTMLDict()) - from django.http import QueryDict field = serializers.MultipleChoiceField(choices=(('a', 'a'), ('b', 'b'))) field.partial = False assert field.get_value(QueryDict({})) == [] From cde7154c5995aebfb7f528fc87c5bebd6cc873e7 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 11:50:22 +0100 Subject: [PATCH 131/487] Runtests should not suppress stdout. In the context of a web app only serves to hide erronous print statements. --- runtests.py | 4 ++-- tests/test_urlpatterns.py | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/runtests.py b/runtests.py index 7982ee2e..f795829b 100755 --- a/runtests.py +++ b/runtests.py @@ -8,8 +8,8 @@ import sys import pytest PYTEST_ARGS = { - 'default': ['tests', '--tb=short'], - 'fast': ['tests', '--tb=short', '-q'], + 'default': ['tests', '--tb=short', '-s'], + 'fast': ['tests', '--tb=short', '-q', '-s'], } FLAKE8_ARGS = ['rest_framework', 'tests', '--ignore=E501'] diff --git a/tests/test_urlpatterns.py b/tests/test_urlpatterns.py index fee96878..78d37c1a 100644 --- a/tests/test_urlpatterns.py +++ b/tests/test_urlpatterns.py @@ -61,7 +61,6 @@ class FormatSuffixTests(TestCase): assert callback is None continue - print(test_path, callback, callback_args, callback_kwargs) assert callback_args == test_path.args assert callback_kwargs == test_path.kwargs From a8acdbc388aac232209fa63169389a3aaa726305 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 12:04:38 +0100 Subject: [PATCH 132/487] Resolve issue with nested serializers in HTML forms. Closes #3153. --- rest_framework/utils/serializer_helpers.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/rest_framework/utils/serializer_helpers.py b/rest_framework/utils/serializer_helpers.py index 6172ce81..245c5f71 100644 --- a/rest_framework/utils/serializer_helpers.py +++ b/rest_framework/utils/serializer_helpers.py @@ -72,7 +72,8 @@ class BoundField(object): )) def as_form_field(self): - return self.__class__(self._field, force_text(self.value), self.errors, self._prefix) + value = force_text(self.value) + return self.__class__(self._field, value, self.errors, self._prefix) class NestedBoundField(BoundField): @@ -93,6 +94,15 @@ class NestedBoundField(BoundField): return NestedBoundField(field, value, error, prefix=self.name + '.') return BoundField(field, value, error, prefix=self.name + '.') + def as_form_field(self): + values = {} + for key, value in self.value.items(): + if isinstance(value, (list, dict)): + values[key] = value + else: + values[key] = force_text(value) + return self.__class__(self._field, values, self.errors, self._prefix) + class BindingDict(collections.MutableMapping): """ From db40b7eb916bbff2d0a4e4a8b5340a3ef866611f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 12:39:01 +0100 Subject: [PATCH 133/487] Add coverage to runtests. Closes #2936. --- requirements/requirements-testing.txt | 1 + runtests.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements/requirements-testing.txt b/requirements/requirements-testing.txt index a8d5d322..6900028d 100644 --- a/requirements/requirements-testing.txt +++ b/requirements/requirements-testing.txt @@ -1,3 +1,4 @@ # PyTest for running the tests. pytest==2.6.4 pytest-django==2.8.0 +pytest-cov==1.8.1 diff --git a/runtests.py b/runtests.py index f795829b..e99cc65a 100755 --- a/runtests.py +++ b/runtests.py @@ -8,7 +8,7 @@ import sys import pytest PYTEST_ARGS = { - 'default': ['tests', '--tb=short', '-s'], + 'default': ['tests', '--tb=short', '-s', '--cov', 'rest_framework'], 'fast': ['tests', '--tb=short', '-q', '-s'], } From 73c0ebc2d5b1b41f5631dca952f4cc0287d6f1d8 Mon Sep 17 00:00:00 2001 From: Venelin Stoykov Date: Thu, 16 Jul 2015 15:40:41 +0300 Subject: [PATCH 134/487] Test for #3153 --- .../test_browsable_nested_api.py | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 tests/browsable_api/test_browsable_nested_api.py diff --git a/tests/browsable_api/test_browsable_nested_api.py b/tests/browsable_api/test_browsable_nested_api.py new file mode 100644 index 00000000..dbbd11ee --- /dev/null +++ b/tests/browsable_api/test_browsable_nested_api.py @@ -0,0 +1,42 @@ +from __future__ import unicode_literals + +from django.conf.urls import url +from django.test import TestCase +from django.test.utils import override_settings + +from rest_framework import serializers +from rest_framework.generics import ListCreateAPIView +from rest_framework.renderers import BrowsableAPIRenderer + + +class NestedSerializer(serializers.Serializer): + one = serializers.IntegerField(max_value=10) + two = serializers.IntegerField(max_value=10) + + +class TestNestedSerializerSerializer(serializers.Serializer): + nested = NestedSerializer() + + +class NestedSerializersView(ListCreateAPIView): + renderer_classes = (BrowsableAPIRenderer, ) + serializer_class = TestNestedSerializerSerializer + queryset = [{'nested': {'one': 1, 'two': 2}}] + + +urlpatterns = [ + url(r'^api/$', NestedSerializersView.as_view(), name='api'), +] + + +class DropdownWithAuthTests(TestCase): + """Tests correct dropdown behaviour with Auth views enabled.""" + + @override_settings(ROOT_URLCONF='tests.browsable_api.test_browsable_nested_api') + def test_login(self): + response = self.client.get('/api/') + self.assertEqual(200, response.status_code) + content = response.content.decode('utf-8') + self.assertIn('form action="/api/"', content) + self.assertIn('input name="nested.one"', content) + self.assertIn('input name="nested.two"', content) From 264d423493d183ceb4c569985bfacb8a87683192 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 13:51:15 +0100 Subject: [PATCH 135/487] Added allow_empty flag for ListField, ListSerializer, ManyRelation, MultipleChoiceField. --- rest_framework/fields.py | 15 +++++++++++++-- rest_framework/relations.py | 12 +++++++++++- rest_framework/serializers.py | 12 ++++++++++-- tests/test_fields.py | 36 ++++++++++++++++++++++++++++++++++- 4 files changed, 69 insertions(+), 6 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index eea69344..736acf3d 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1141,10 +1141,15 @@ class ChoiceField(Field): class MultipleChoiceField(ChoiceField): default_error_messages = { 'invalid_choice': _('"{input}" is not a valid choice.'), - 'not_a_list': _('Expected a list of items but got type "{input_type}".') + 'not_a_list': _('Expected a list of items but got type "{input_type}".'), + 'empty': _('This selection may not be empty.') } default_empty_html = [] + def __init__(self, *args, **kwargs): + self.allow_empty = kwargs.pop('allow_empty', True) + super(MultipleChoiceField, self).__init__(*args, **kwargs) + def get_value(self, dictionary): # We override the default field access in order to support # lists in HTML forms. @@ -1159,6 +1164,8 @@ class MultipleChoiceField(ChoiceField): def to_internal_value(self, data): if isinstance(data, type('')) or not hasattr(data, '__iter__'): self.fail('not_a_list', input_type=type(data).__name__) + if not self.allow_empty and len(data) == 0: + self.fail('empty') return set([ super(MultipleChoiceField, self).to_internal_value(item) @@ -1263,11 +1270,13 @@ class ListField(Field): child = _UnvalidatedField() initial = [] default_error_messages = { - 'not_a_list': _('Expected a list of items but got type "{input_type}".') + 'not_a_list': _('Expected a list of items but got type "{input_type}".'), + 'empty': _('This list may not be empty.') } def __init__(self, *args, **kwargs): self.child = kwargs.pop('child', copy.deepcopy(self.child)) + self.allow_empty = kwargs.pop('allow_empty', True) assert not inspect.isclass(self.child), '`child` has not been instantiated.' super(ListField, self).__init__(*args, **kwargs) self.child.bind(field_name='', parent=self) @@ -1287,6 +1296,8 @@ class ListField(Field): data = html.parse_html_list(data) if isinstance(data, type('')) or not hasattr(data, '__iter__'): self.fail('not_a_list', input_type=type(data).__name__) + if not self.allow_empty and len(data) == 0: + self.fail('empty') return [self.child.run_validation(item) for item in data] def to_representation(self, data): diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 8bf7d628..97a6417e 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -32,7 +32,7 @@ class PKOnlyObject(object): # rather than the parent serializer. MANY_RELATION_KWARGS = ( 'read_only', 'write_only', 'required', 'default', 'initial', 'source', - 'label', 'help_text', 'style', 'error_messages' + 'label', 'help_text', 'style', 'error_messages', 'allow_empty' ) @@ -366,9 +366,14 @@ class ManyRelatedField(Field): """ initial = [] default_empty_html = [] + default_error_messages = { + 'not_a_list': _('Expected a list of items but got type "{input_type}".'), + 'empty': _('This list may not be empty.') + } def __init__(self, child_relation=None, *args, **kwargs): self.child_relation = child_relation + self.allow_empty = kwargs.pop('allow_empty', True) assert child_relation is not None, '`child_relation` is a required argument.' super(ManyRelatedField, self).__init__(*args, **kwargs) self.child_relation.bind(field_name='', parent=self) @@ -386,6 +391,11 @@ class ManyRelatedField(Field): return dictionary.get(self.field_name, empty) def to_internal_value(self, data): + if isinstance(data, type('')) or not hasattr(data, '__iter__'): + self.fail('not_a_list', input_type=type(data).__name__) + if not self.allow_empty and len(data) == 0: + self.fail('empty') + return [ self.child_relation.to_internal_value(item) for item in data diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index beaae1e1..3c345c00 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -49,7 +49,7 @@ from rest_framework.relations import * # NOQA # isort:skip # rather than the parent serializer. LIST_SERIALIZER_KWARGS = ( 'read_only', 'write_only', 'required', 'default', 'initial', 'source', - 'label', 'help_text', 'style', 'error_messages', + 'label', 'help_text', 'style', 'error_messages', 'allow_empty', 'instance', 'data', 'partial', 'context' ) @@ -493,11 +493,13 @@ class ListSerializer(BaseSerializer): many = True default_error_messages = { - 'not_a_list': _('Expected a list of items but got type "{input_type}".') + 'not_a_list': _('Expected a list of items but got type "{input_type}".'), + 'empty': _('This list may not be empty.') } def __init__(self, *args, **kwargs): self.child = kwargs.pop('child', copy.deepcopy(self.child)) + self.allow_empty = kwargs.pop('allow_empty', True) assert self.child is not None, '`child` is a required argument.' assert not inspect.isclass(self.child), '`child` has not been instantiated.' super(ListSerializer, self).__init__(*args, **kwargs) @@ -553,6 +555,12 @@ class ListSerializer(BaseSerializer): api_settings.NON_FIELD_ERRORS_KEY: [message] }) + if not self.allow_empty and len(data) == 0: + message = self.error_messages['empty'] + raise ValidationError({ + api_settings.NON_FIELD_ERRORS_KEY: [message] + }) + ret = [] errors = [] diff --git a/tests/test_fields.py b/tests/test_fields.py index cea440c8..897003df 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1140,6 +1140,27 @@ class TestMultipleChoiceField(FieldValues): assert field.get_value(QueryDict({})) == rest_framework.fields.empty +class TestEmptyMultipleChoiceField(FieldValues): + """ + Invalid values for `MultipleChoiceField(allow_empty=False)`. + """ + valid_inputs = { + } + invalid_inputs = ( + ([], ['This selection may not be empty.']), + ) + outputs = [ + ] + field = serializers.MultipleChoiceField( + choices=[ + ('consistency', 'Consistency'), + ('availability', 'Availability'), + ('partition', 'Partition tolerance'), + ], + allow_empty=False + ) + + # File serializers... class MockFile: @@ -1233,7 +1254,8 @@ class TestListField(FieldValues): """ valid_inputs = [ ([1, 2, 3], [1, 2, 3]), - (['1', '2', '3'], [1, 2, 3]) + (['1', '2', '3'], [1, 2, 3]), + ([], []) ] invalid_inputs = [ ('not a list', ['Expected a list of items but got type "str".']), @@ -1246,6 +1268,18 @@ class TestListField(FieldValues): field = serializers.ListField(child=serializers.IntegerField()) +class TestEmptyListField(FieldValues): + """ + Values for `ListField` with allow_empty=False flag. + """ + valid_inputs = {} + invalid_inputs = [ + ([], ['This list may not be empty.']) + ] + outputs = {} + field = serializers.ListField(child=serializers.IntegerField(), allow_empty=False) + + class TestUnvalidatedListField(FieldValues): """ Values for `ListField` with no `child` argument. From 806b0b34da649eba6e2aa0a51e95d911a35b9360 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 15:17:18 +0100 Subject: [PATCH 136/487] Include nested objects in metadata for OPTIONS. Closes #3156. Closes #2915. --- rest_framework/metadata.py | 2 ++ runtests.py | 10 +++++++++- tests/test_metadata.py | 25 +++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 1 deletion(-) diff --git a/rest_framework/metadata.py b/rest_framework/metadata.py index 6bc18b3a..5058422f 100644 --- a/rest_framework/metadata.py +++ b/rest_framework/metadata.py @@ -133,6 +133,8 @@ class SimpleMetadata(BaseMetadata): if getattr(field, 'child', None): field_info['child'] = self.get_field_info(field.child) + elif getattr(field, 'fields', None): + field_info['children'] = self.get_serializer_info(field) if not field_info.get('read_only') and hasattr(field, 'choices'): field_info['choices'] = [ diff --git a/runtests.py b/runtests.py index e99cc65a..36a2183b 100755 --- a/runtests.py +++ b/runtests.py @@ -8,7 +8,7 @@ import sys import pytest PYTEST_ARGS = { - 'default': ['tests', '--tb=short', '-s', '--cov', 'rest_framework'], + 'default': ['tests', '--tb=short', '-s'], 'fast': ['tests', '--tb=short', '-q', '-s'], } @@ -87,6 +87,14 @@ if __name__ == "__main__": if len(sys.argv) > 1: pytest_args = sys.argv[1:] first_arg = pytest_args[0] + + try: + pytest_args.remove('--coverage') + except ValueError: + pass + else: + pytest_args = ['--cov', 'rest_framework'] + pytest_args + if first_arg.startswith('-'): # `runtests.py [flags]` pytest_args = ['tests'] + pytest_args diff --git a/tests/test_metadata.py b/tests/test_metadata.py index f7aab897..6819f150 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -59,6 +59,10 @@ class TestMetadata: On generic views OPTIONS should return an 'actions' key with metadata on the fields that may be supplied to PUT and POST requests. """ + class NestedField(serializers.Serializer): + a = serializers.IntegerField() + b = serializers.IntegerField() + class ExampleSerializer(serializers.Serializer): choice_field = serializers.ChoiceField(['red', 'green', 'blue']) integer_field = serializers.IntegerField( @@ -72,6 +76,7 @@ class TestMetadata: child=serializers.IntegerField() ) ) + nested_field = NestedField() class ExampleView(views.APIView): """Example view.""" @@ -140,6 +145,26 @@ class TestMetadata: 'read_only': False } } + }, + 'nested_field': { + 'type': 'nested object', + 'required': True, + 'read_only': False, + 'label': 'Nested field', + 'children': { + 'a': { + 'type': 'integer', + 'required': True, + 'read_only': False, + 'label': 'A' + }, + 'b': { + 'type': 'integer', + 'required': True, + 'read_only': False, + 'label': 'B' + } + } } } } From 4f6eba3ce87d7e0d57b40f1de6f48eecbb4e4e4c Mon Sep 17 00:00:00 2001 From: Leonardo Giordani Date: Thu, 16 Jul 2015 16:25:01 +0200 Subject: [PATCH 137/487] Removed import of unused django.forms.widgets --- docs/tutorial/1-serialization.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md index 09a124d3..8a7a8dc0 100644 --- a/docs/tutorial/1-serialization.md +++ b/docs/tutorial/1-serialization.md @@ -89,7 +89,6 @@ We'll also need to create an initial migration for our snippet model, and sync t The first thing we need to get started on our Web API is to provide a way of serializing and deserializing the snippet instances into representations such as `json`. We can do this by declaring serializers that work very similar to Django's forms. Create a file in the `snippets` directory named `serializers.py` and add the following. - from django.forms import widgets from rest_framework import serializers from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES From e14391e041d405ea869b5f76e603210150a37f3e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 15:46:27 +0100 Subject: [PATCH 138/487] Fix for ModelSerializer ChoiceField with nonstandard args. Closes #3126. --- rest_framework/serializers.py | 13 +++++++++++++ tests/test_model_serializer.py | 14 ++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 3c345c00..4562329e 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -1033,6 +1033,19 @@ class ModelSerializer(Serializer): # Fields with choices get coerced into `ChoiceField` # instead of using their regular typed field. field_class = self.serializer_choice_field + # Some model fields may introduce kwargs that would not be valid + # for the choice field. We need to strip these out. + # Eg. models.DecimalField(max_digits=3, decimal_places=1, choices=DECIMAL_CHOICES) + valid_kwargs = set(( + 'read_only', 'write_only', + 'required', 'default', 'initial', 'source', + 'label', 'help_text', 'style', + 'error_messages', 'validators', 'allow_null', 'allow_blank', + 'choices' + )) + for key in list(field_kwargs.keys()): + if key not in valid_kwargs: + field_kwargs.pop(key) if not issubclass(field_class, ModelField): # `model_field` is only valid for the fallback case of diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index 76c281fc..a6b5d4e1 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -7,6 +7,8 @@ an appropriate set of serializer fields for each case. """ from __future__ import unicode_literals +import decimal + import django import pytest from django.core.exceptions import ImproperlyConfigured @@ -70,6 +72,7 @@ class RegularFieldsModel(models.Model): COLOR_CHOICES = (('red', 'Red'), ('blue', 'Blue'), ('green', 'Green')) +DECIMAL_CHOICES = (('low', decimal.Decimal('0.1')), ('medium', decimal.Decimal('0.5')), ('high', decimal.Decimal('0.9'))) class FieldOptionsModel(models.Model): @@ -82,6 +85,10 @@ class FieldOptionsModel(models.Model): choices_field = models.CharField(max_length=100, choices=COLOR_CHOICES) +class MappingForChoicesWithNonStandardArgs(models.Model): + choices_field_with_nonstandard_args = models.DecimalField(max_digits=3, decimal_places=1, choices=DECIMAL_CHOICES) + + class TestModelSerializer(TestCase): def test_create_method(self): class TestSerializer(serializers.ModelSerializer): @@ -307,6 +314,13 @@ class TestRegularFieldMappings(TestCase): ChildSerializer().fields + def test_choices_with_nonstandard_args(self): + class ExampleSerializer(serializers.ModelSerializer): + class Meta: + model = MappingForChoicesWithNonStandardArgs + + ExampleSerializer() + @pytest.mark.skipif(django.VERSION < (1, 8), reason='DurationField is only available for django1.8+') From c940f15901585b5a56e07a49a279b7ce8d4ad6b2 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 15:50:51 +0100 Subject: [PATCH 139/487] Internal use warning against HTMLFormRenderer. Closes #2773. --- docs/api-guide/renderers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index 70672f0c..c9539a79 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -157,7 +157,7 @@ See also: `TemplateHTMLRenderer` Renders data returned by a serializer into an HTML form. The output of this renderer does not include the enclosing `
    ` tags or an submit actions, as you'll probably need those to include the desired method and URL. Also note that the `HTMLFormRenderer` does not yet support including field error messages. -Note that the template used by the `HTMLFormRenderer` class, and the context submitted to it **may be subject to change**. If you need to use this renderer class it is advised that you either make a local copy of the class and templates, or follow the release note on REST framework upgrades closely. +**Note**: The `HTMLFormRenderer` class is intended for internal use with the browsable API. It should not be considered stable API. The template used by the `HTMLFormRenderer` class, and the context submitted to it **may be subject to change**. If you need to use this renderer class it is advised that you either make a local copy of the class and templates, or follow the release note on REST framework upgrades closely. **.media_type**: `text/html` From 0ccb148183ac56eccbd2ac488402f3f075019bbd Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 15:59:15 +0100 Subject: [PATCH 140/487] Support QueryDict list arguments with ListField. Closes #3155. --- docs/api-guide/renderers.md | 2 +- rest_framework/fields.py | 4 ++++ tests/test_fields.py | 8 ++++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index c9539a79..1d1b4691 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -157,7 +157,7 @@ See also: `TemplateHTMLRenderer` Renders data returned by a serializer into an HTML form. The output of this renderer does not include the enclosing `` tags or an submit actions, as you'll probably need those to include the desired method and URL. Also note that the `HTMLFormRenderer` does not yet support including field error messages. -**Note**: The `HTMLFormRenderer` class is intended for internal use with the browsable API. It should not be considered stable API. The template used by the `HTMLFormRenderer` class, and the context submitted to it **may be subject to change**. If you need to use this renderer class it is advised that you either make a local copy of the class and templates, or follow the release note on REST framework upgrades closely. +**Note**: The `HTMLFormRenderer` class is intended for internal use with the browsable API. It should not be considered a fully documented or stable API. The template used by the `HTMLFormRenderer` class, and the context submitted to it **may be subject to change**. If you need to use this renderer class it is advised that you either make a local copy of the class and templates, or follow the release note on REST framework upgrades closely. **.media_type**: `text/html` diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 736acf3d..10d21c57 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1285,6 +1285,10 @@ class ListField(Field): # We override the default field access in order to support # lists in HTML forms. if html.is_html_input(dictionary): + val = dictionary.getlist(self.field_name, []) + if len(val) > 1: + # Support QueryDict lists in HTML input. + return val return html.parse_html_list(dictionary, prefix=self.field_name) return dictionary.get(self.field_name, empty) diff --git a/tests/test_fields.py b/tests/test_fields.py index 897003df..94eb5df7 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -308,6 +308,14 @@ class TestHTMLInput: assert serializer.is_valid() assert serializer.validated_data == {} + def test_querydict_list_input(self): + class TestSerializer(serializers.Serializer): + scores = serializers.ListField(child=serializers.IntegerField()) + + serializer = TestSerializer(data=QueryDict('scores=1&scores=3')) + assert serializer.is_valid() + assert serializer.validated_data == {'scores': [1, 3]} + class TestCreateOnlyDefault: def setup(self): From 0b6eb4a881341f4164ed21edaba046ad3564cb30 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 16:01:50 +0100 Subject: [PATCH 141/487] Fix for Django 1.7 issue with long default verbose_name arguments on ChoiceField --- tests/test_model_serializer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index a6b5d4e1..24e3e21d 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -86,7 +86,7 @@ class FieldOptionsModel(models.Model): class MappingForChoicesWithNonStandardArgs(models.Model): - choices_field_with_nonstandard_args = models.DecimalField(max_digits=3, decimal_places=1, choices=DECIMAL_CHOICES) + choices_field_with_nonstandard_args = models.DecimalField(max_digits=3, decimal_places=1, choices=DECIMAL_CHOICES, verbose_name='A label') class TestModelSerializer(TestCase): From 7b21336872d82c74041cdb592c5004a172b7d3a7 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 16:18:14 +0100 Subject: [PATCH 142/487] Rename model to play nice with Django 1.7. --- tests/test_model_serializer.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index 24e3e21d..f9ef633c 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -85,7 +85,7 @@ class FieldOptionsModel(models.Model): choices_field = models.CharField(max_length=100, choices=COLOR_CHOICES) -class MappingForChoicesWithNonStandardArgs(models.Model): +class ChoicesModel(models.Model): choices_field_with_nonstandard_args = models.DecimalField(max_digits=3, decimal_places=1, choices=DECIMAL_CHOICES, verbose_name='A label') @@ -317,7 +317,7 @@ class TestRegularFieldMappings(TestCase): def test_choices_with_nonstandard_args(self): class ExampleSerializer(serializers.ModelSerializer): class Meta: - model = MappingForChoicesWithNonStandardArgs + model = ChoicesModel ExampleSerializer() From 788aae2aaf9f0bd8cfdce167b24222c47e72ef99 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 16 Jul 2015 16:46:07 +0100 Subject: [PATCH 143/487] Upgrade guardian support to 1.3. Closes #3163. --- requirements/requirements-optionals.txt | 2 +- rest_framework/filters.py | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/requirements/requirements-optionals.txt b/requirements/requirements-optionals.txt index 411ca0aa..3ada43eb 100644 --- a/requirements/requirements-optionals.txt +++ b/requirements/requirements-optionals.txt @@ -1,4 +1,4 @@ # Optional packages which may be used with REST framework. markdown==2.5.2 -django-guardian==1.2.5 +django-guardian==1.3.0 django-filter==0.10.0 diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 36ce0047..a5e06b57 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -198,4 +198,7 @@ class DjangoObjectPermissionsFilter(BaseFilterBackend): 'model_name': get_model_name(model_cls) } permission = self.perm_format % kwargs - return guardian.shortcuts.get_objects_for_user(user, permission, queryset) + if guardian.VERSION >= (1, 3): + # Maintain behavior compatibility with versions prior to 1.3 + extra = {'accept_global_perms': False} + return guardian.shortcuts.get_objects_for_user(user, permission, queryset, **extra) From 138e9fcc8ff07e7717df0824140ead2b1bddb66e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 17 Jul 2015 12:39:22 +0100 Subject: [PATCH 144/487] Helpful error on erronous 'serializer.save(commit=False)' --- rest_framework/serializers.py | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 4562329e..fa3a5337 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -153,6 +153,16 @@ class BaseSerializer(Field): 'You cannot call `.save()` on a serializer with invalid data.' ) + # Guard against incorrect use of `serializer.save(commit=False)` + assert 'commit' not in kwargs, ( + "'commit' is not a valid keyword argument to the 'save()' method. " + "If you need to access data before committing to the database then " + "inspect 'serializer.validated_data' instead. " + "You can also pass additional keyword arguments to 'save()' if you " + "need to set extra attributes on the saved model instance. " + "For example: 'serializer.save(owner=request.user)'.'" + ) + validated_data = dict( list(self.validated_data.items()) + list(kwargs.items()) @@ -611,6 +621,16 @@ class ListSerializer(BaseSerializer): """ Save and return a list of object instances. """ + # Guard against incorrect use of `serializer.save(commit=False)` + assert 'commit' not in kwargs, ( + "'commit' is not a valid keyword argument to the 'save()' method. " + "If you need to access data before committing to the database then " + "inspect 'serializer.validated_data' instead. " + "You can also pass additional keyword arguments to 'save()' if you " + "need to set extra attributes on the saved model instance. " + "For example: 'serializer.save(owner=request.user)'.'" + ) + validated_data = [ dict(list(attrs.items()) + list(kwargs.items())) for attrs in self.validated_data From a1397ac6997426aec2e4f657e9d39a25998de59d Mon Sep 17 00:00:00 2001 From: Aider Ibragimov Date: Sun, 19 Jul 2015 00:26:03 +0300 Subject: [PATCH 145/487] fix bugs, move version branching to compat, update ModelSerializer mapping --- rest_framework/compat.py | 19 +++++++++++++++++++ rest_framework/fields.py | 16 +++++----------- rest_framework/filters.py | 1 + rest_framework/serializers.py | 1 + 4 files changed, 26 insertions(+), 11 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index d11c6809..07f0741a 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -12,6 +12,7 @@ import django from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.db import connection, transaction +from django.forms import FilePathField as DjangoFilePathField from django.test.client import FakePayload from django.utils import six from django.utils.encoding import force_text @@ -291,3 +292,21 @@ def set_rollback(): else: # transaction not managed pass + + +def get_filepathfield(path, match=None, recursive=False, allow_files=True, + allow_folders=False, required=None): + """Create proper Django FilePathField with allowed kwargs.""" + + if django.VERSION < (1, 5): + # django field doesn't have allow_folders, allow_files kwargs + field = DjangoFilePathField( + path, match=match, recursive=recursive, required=required + ) + else: + field = DjangoFilePathField( + path, match=match, recursive=recursive, allow_files=allow_files, + allow_folders=allow_folders, required=required + ) + + return field diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 350e4957..bf393072 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -26,7 +26,7 @@ from rest_framework import ISO_8601 from rest_framework.compat import ( EmailValidator, MaxLengthValidator, MaxValueValidator, MinLengthValidator, MinValueValidator, OrderedDict, URLValidator, duration_string, - parse_duration, unicode_repr, unicode_to_repr + parse_duration, unicode_repr, unicode_to_repr, get_filepathfield ) from rest_framework.exceptions import ValidationError from rest_framework.settings import api_settings @@ -717,16 +717,10 @@ class FilePathField(CharField): super(FilePathField, self).__init__(**kwargs) # create field and get options to avoid code duplication - if django.VERSION < (1, 5): - # django field doesn't have allow_folders, allow_files kwargs - field = DjangoFilePathField( - path, match=match, recursive=recursive, required=required - ) - else: - field = DjangoFilePathField( - path, match=match, recursive=recursive, allow_files=allow_files, - allow_folders=allow_folders, required=required - ) + field = get_filepathfield( + path, match=match, recursive=recursive, allow_files=allow_files, + allow_folders=allow_folders, required=required + ) self.choices = OrderedDict(field.choices) self.choice_strings_to_values = dict([ diff --git a/rest_framework/filters.py b/rest_framework/filters.py index a5e06b57..6cbaae16 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -191,6 +191,7 @@ class DjangoObjectPermissionsFilter(BaseFilterBackend): perm_format = '%(app_label)s.view_%(model_name)s' def filter_queryset(self, request, queryset, view): + extra = {} user = request.user model_cls = queryset.model kwargs = { diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index fa3a5337..6a6eb4d9 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -773,6 +773,7 @@ class ModelSerializer(Serializer): models.TimeField: TimeField, models.URLField: URLField, models.GenericIPAddressField: IPAddressField, + models.FilePathField: FilePathField, } if ModelDurationField is not None: serializer_field_mapping[ModelDurationField] = DurationField From c4f1c98572e756d378e56e118124901d49b1032c Mon Sep 17 00:00:00 2001 From: Aider Ibragimov Date: Sun, 19 Jul 2015 01:22:57 +0300 Subject: [PATCH 146/487] fix lint issues --- rest_framework/fields.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index bf393072..0ab1939f 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -8,14 +8,11 @@ import inspect import re import uuid -import django from django.conf import settings from django.core.exceptions import ValidationError as DjangoValidationError from django.core.exceptions import ObjectDoesNotExist from django.core.validators import RegexValidator, ip_address_validators -from django.forms import ( - ImageField as DjangoImageField, FilePathField as DjangoFilePathField -) +from django.forms import ImageField as DjangoImageField from django.utils import six, timezone from django.utils.dateparse import parse_date, parse_datetime, parse_time from django.utils.encoding import is_protected_type, smart_text From 205f38863162f1a27a31cdb32ca7e828e363a079 Mon Sep 17 00:00:00 2001 From: Aider Ibragimov Date: Sun, 19 Jul 2015 01:32:51 +0300 Subject: [PATCH 147/487] fix import sort order --- rest_framework/fields.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 0ab1939f..a2a4e3bf 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -23,7 +23,7 @@ from rest_framework import ISO_8601 from rest_framework.compat import ( EmailValidator, MaxLengthValidator, MaxValueValidator, MinLengthValidator, MinValueValidator, OrderedDict, URLValidator, duration_string, - parse_duration, unicode_repr, unicode_to_repr, get_filepathfield + get_filepathfield, parse_duration, unicode_repr, unicode_to_repr ) from rest_framework.exceptions import ValidationError from rest_framework.settings import api_settings From 7f7e6b33ff364abff3917a0b7ffb3f0b6b4a22d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Sun, 19 Jul 2015 21:47:09 -0400 Subject: [PATCH 148/487] Update quickstart.md Closes #3171 --- docs/tutorial/quickstart.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md index 5feacf4c..9b040a39 100644 --- a/docs/tutorial/quickstart.md +++ b/docs/tutorial/quickstart.md @@ -83,8 +83,6 @@ Rather than write multiple views we're grouping together all the common behavior We can easily break these down into individual views if we need to, but using viewsets keeps the view logic nicely organized as well as being very concise. -For trivial cases you can simply set a `model` attribute on the `ViewSet` class and the serializer and queryset will be automatically generated for you. Setting the `queryset` and/or `serializer_class` attributes gives you more explicit control of the API behaviour, and is the recommended style for most applications. - ## URLs Okay, now let's wire up the API URLs. On to `tutorial/urls.py`... From f9c61e8090b37acf79032fc6a84439a35485bdf2 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 22 Jul 2015 12:36:32 +0100 Subject: [PATCH 149/487] Prominent notes on deprecation status of pagination settings. Closes #3173. --- docs/api-guide/settings.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 6fdb77c8..13d23a69 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -119,6 +119,14 @@ Default: `None` #### PAGINATE_BY_PARAM +--- + +**This setting is pending deprecation.** + +See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style). + +--- + The name of a query parameter, which can be used by the client to override the default page size to use for pagination. If set to `None`, clients may not override the default page size. For example, given the following settings: @@ -136,6 +144,14 @@ Default: `None` #### MAX_PAGINATE_BY +--- + +**This setting is pending deprecation.** + +See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style). + +--- + The maximum page size to allow when the page size is specified by the client. If set to `None`, then no maximum limit is applied. For example, given the following settings: From 77e69451c1eba8bc43e021d0666ad986b35e2204 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 22 Jul 2015 13:05:56 +0100 Subject: [PATCH 150/487] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9626ebf..a383660e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ Some tips on good issue reporting: ## Triaging issues -Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to +Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to: * Read through the ticket - does it make sense, is it missing any context that would help explain it better? * Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group? From d9c934debd877b18fa349bf628021784eb71ed40 Mon Sep 17 00:00:00 2001 From: Adrian Mester Date: Thu, 23 Jul 2015 13:10:20 +0300 Subject: [PATCH 151/487] fixed a typo in docs --- docs/api-guide/serializers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index 2f13bd2a..abdb67af 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -565,7 +565,7 @@ Typically we would recommend *not* using inheritance on inner Meta classes, but The ModelSerializer class also exposes an API that you can override in order to alter how serializer fields are automatically determined when instantiating the serializer. -Normally if a `ModelSerializer` does not generate the fields you need by default the you should either add them to the class explicitly, or simply use a regular `Serializer` class instead. However in some cases you may want to create a new base class that defines how the serializer fields are created for any given model. +Normally if a `ModelSerializer` does not generate the fields you need by default then you should either add them to the class explicitly, or simply use a regular `Serializer` class instead. However in some cases you may want to create a new base class that defines how the serializer fields are created for any given model. ### `.serializer_field_mapping` From 22631c73a71e7ca1b5d32c9bf45e4b732e514c7f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 23 Jul 2015 12:41:35 +0100 Subject: [PATCH 152/487] Resolve assertion error with LimitOffsetPagination and erronous parameters. Closes #2920. --- rest_framework/pagination.py | 2 ++ tests/test_pagination.py | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index a171c684..762ce58c 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -419,6 +419,8 @@ class LimitOffsetPagination(BasePagination): _divide_with_ceil(self.count - self.offset, self.limit) + _divide_with_ceil(self.offset, self.limit) ) + if current > final: + current = final def page_number_to_url(page_number): if page_number == 1: diff --git a/tests/test_pagination.py b/tests/test_pagination.py index 03c4fdf4..63fdbeca 100644 --- a/tests/test_pagination.py +++ b/tests/test_pagination.py @@ -435,6 +435,12 @@ class TestLimitOffset: ] } + def test_erronous_offset(self): + request = Request(factory.get('/', {'limit': 5, 'offset': 1000})) + queryset = self.paginate_queryset(request) + self.get_paginated_content(queryset) + self.get_html_context() + def test_invalid_offset(self): """ An invalid offset query param should be treated as 0. From 90fe0fb8811c9f0bd83302f15d93a6f02f0ec664 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 23 Jul 2015 14:31:25 +0100 Subject: [PATCH 153/487] Errors in browsable API on error. Closes #3024. --- rest_framework/exceptions.py | 11 +++++++++-- rest_framework/serializers.py | 2 +- tests/test_generics.py | 20 ++++++++++++++++++++ 3 files changed, 30 insertions(+), 3 deletions(-) diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py index f587d10f..236087bd 100644 --- a/rest_framework/exceptions.py +++ b/rest_framework/exceptions.py @@ -14,6 +14,7 @@ from django.utils.translation import ugettext_lazy as _ from django.utils.translation import ungettext from rest_framework import status +from rest_framework.utils.serializer_helpers import ReturnDict, ReturnList def _force_text_recursive(data): @@ -22,14 +23,20 @@ def _force_text_recursive(data): lazy translation strings into plain text. """ if isinstance(data, list): - return [ + ret = [ _force_text_recursive(item) for item in data ] + if isinstance(data, ReturnList): + return ReturnList(ret, serializer=data.serializer) + return data elif isinstance(data, dict): - return dict([ + ret = dict([ (key, _force_text_recursive(value)) for key, value in data.items() ]) + if isinstance(data, ReturnDict): + return ReturnDict(ret, serializer=data.serializer) + return data return force_text(data) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index fa3a5337..60ee7e5c 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -204,7 +204,7 @@ class BaseSerializer(Field): self._errors = {} if self._errors and raise_exception: - raise ValidationError(self._errors) + raise ValidationError(self.errors) return not bool(self._errors) diff --git a/tests/test_generics.py b/tests/test_generics.py index 0647119b..53035458 100644 --- a/tests/test_generics.py +++ b/tests/test_generics.py @@ -145,6 +145,16 @@ class TestRootView(TestCase): created = self.objects.get(id=4) self.assertEqual(created.text, 'foobar') + def test_post_error_root_view(self): + """ + POST requests to ListCreateAPIView in HTML should include a form error. + """ + data = {'text': 'foobar' * 100} + request = factory.post('/', data, HTTP_ACCEPT='text/html') + response = self.view(request).render() + expected_error = 'Ensure this field has no more than 100 characters.' + self.assertIn(expected_error, response.rendered_content) + EXPECTED_QUERIES_FOR_PUT = 3 if django.VERSION < (1, 6) else 2 @@ -282,6 +292,16 @@ class TestInstanceView(TestCase): self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) self.assertFalse(self.objects.filter(id=999).exists()) + def test_put_error_instance_view(self): + """ + Incorrect PUT requests in HTML should include a form error. + """ + data = {'text': 'foobar' * 100} + request = factory.put('/', data, HTTP_ACCEPT='text/html') + response = self.view(request, pk=1).render() + expected_error = 'Ensure this field has no more than 100 characters.' + self.assertIn(expected_error, response.rendered_content) + class TestFKInstanceView(TestCase): def setUp(self): From 92008d3d16d6ce66c8b1b9f89519e8a375400856 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 23 Jul 2015 14:36:23 +0100 Subject: [PATCH 154/487] None -> '' in the context of form field values --- rest_framework/utils/serializer_helpers.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rest_framework/utils/serializer_helpers.py b/rest_framework/utils/serializer_helpers.py index 245c5f71..229a46d0 100644 --- a/rest_framework/utils/serializer_helpers.py +++ b/rest_framework/utils/serializer_helpers.py @@ -72,7 +72,7 @@ class BoundField(object): )) def as_form_field(self): - value = force_text(self.value) + value = '' if self.value is None else force_text(self.value) return self.__class__(self._field, value, self.errors, self._prefix) @@ -100,7 +100,7 @@ class NestedBoundField(BoundField): if isinstance(value, (list, dict)): values[key] = value else: - values[key] = force_text(value) + values[key] = '' if value is None else force_text(value) return self.__class__(self._field, values, self.errors, self._prefix) From d14bc3c4e190d3bdce4e03b0da18ec08793f7bce Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 23 Jul 2015 14:41:28 +0100 Subject: [PATCH 155/487] Fix test cases for python3 --- tests/test_generics.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_generics.py b/tests/test_generics.py index 53035458..219a83a5 100644 --- a/tests/test_generics.py +++ b/tests/test_generics.py @@ -153,7 +153,7 @@ class TestRootView(TestCase): request = factory.post('/', data, HTTP_ACCEPT='text/html') response = self.view(request).render() expected_error = 'Ensure this field has no more than 100 characters.' - self.assertIn(expected_error, response.rendered_content) + self.assertIn(expected_error, response.rendered_content.decode('utf-8')) EXPECTED_QUERIES_FOR_PUT = 3 if django.VERSION < (1, 6) else 2 @@ -300,7 +300,7 @@ class TestInstanceView(TestCase): request = factory.put('/', data, HTTP_ACCEPT='text/html') response = self.view(request, pk=1).render() expected_error = 'Ensure this field has no more than 100 characters.' - self.assertIn(expected_error, response.rendered_content) + self.assertIn(expected_error, response.rendered_content.decode('utf-8')) class TestFKInstanceView(TestCase): From 4c1597efe09a308fd2cf76aff0f54b83b6b5a037 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 23 Jul 2015 16:16:48 +0100 Subject: [PATCH 156/487] Error modals --- rest_framework/renderers.py | 19 +++++++++++--- .../static/rest_framework/js/default.js | 4 +++ .../templates/rest_framework/admin.html | 25 +++++++++++++++++++ 3 files changed, 45 insertions(+), 3 deletions(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 96e5df18..d45351fd 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -683,15 +683,26 @@ class AdminRenderer(BrowsableAPIRenderer): self.accepted_media_type = accepted_media_type or '' self.renderer_context = renderer_context or {} + response = renderer_context['response'] + request = renderer_context['request'] + view = self.renderer_context['view'] + + if response.status_code == status.HTTP_400_BAD_REQUEST: + # Errors still need to display the list or detail information. + # The only way we can get at that is to simulate a GET request. + self.error_form = self.get_rendered_html_form(data, view, request.method, request) + self.error_title = {'POST': 'Create', 'PUT': 'Edit'}.get(request.method, 'Errors') + + with override_method(view, request, 'GET') as request: + response = view.get(request, *view.args, **view.kwargs) + data = response.data + template = loader.get_template(self.template) context = self.get_context(data, accepted_media_type, renderer_context) context = RequestContext(renderer_context['request'], context) ret = template.render(context) # Creation and deletion should use redirects in the admin style. - response = renderer_context['response'] - request = renderer_context['request'] - if (response.status_code == status.HTTP_201_CREATED) and ('Location' in response): response.status_code = status.HTTP_302_FOUND ret = '' @@ -742,6 +753,8 @@ class AdminRenderer(BrowsableAPIRenderer): context['columns'] = columns context['details'] = details context['results'] = results + context['error_form'] = getattr(self, 'error_form', None) + context['error_title'] = getattr(self, 'error_title', None) return context diff --git a/rest_framework/static/rest_framework/js/default.js b/rest_framework/static/rest_framework/js/default.js index 22e5efde..dc6fd642 100644 --- a/rest_framework/static/rest_framework/js/default.js +++ b/rest_framework/static/rest_framework/js/default.js @@ -59,3 +59,7 @@ if (selectedTab && selectedTab.length > 0) { // If no tab selected, display rightmost tab. $('.form-switcher a:first').tab('show'); } + +$(window).load(function(){ + $('#errorModal').modal('show'); +}); diff --git a/rest_framework/templates/rest_framework/admin.html b/rest_framework/templates/rest_framework/admin.html index 39f2127c..74dc7316 100644 --- a/rest_framework/templates/rest_framework/admin.html +++ b/rest_framework/templates/rest_framework/admin.html @@ -196,6 +196,31 @@
    +{% if error_form %} + + +{% endif %} + {% block script %} From e05021c8c623bb3a4b69691ed3525c687492b2a4 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 23 Jul 2015 17:17:18 +0100 Subject: [PATCH 157/487] Guard against erronous direct .queryset evaluation in CBVs. --- rest_framework/views.py | 12 ++++++++++++ tests/test_generics.py | 16 ++++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/rest_framework/views.py b/rest_framework/views.py index a709c2f6..9c9c8e19 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -7,6 +7,7 @@ import inspect import warnings from django.core.exceptions import PermissionDenied +from django.db import models from django.http import Http404 from django.utils import six from django.utils.encoding import smart_text @@ -118,8 +119,19 @@ class APIView(View): This allows us to discover information about the view when we do URL reverse lookups. Used for breadcrumb generation. """ + if isinstance(getattr(cls, 'queryset', None), models.QuerySet): + def force_evaluation(): + raise AssertionError( + 'Do not evaluate the `.queryset` attribute directly, ' + 'as the result will be cached and reused between requests. ' + 'Use `.all()` or call `.get_queryset()` instead.' + ) + + cls.queryset._fetch_all = force_evaluation + view = super(APIView, cls).as_view(**initkwargs) view.cls = cls + # Note: session based authentication is explicitly CSRF validated, # all other authentication is CSRF exempt. return csrf_exempt(view) diff --git a/tests/test_generics.py b/tests/test_generics.py index 219a83a5..5db0b6f7 100644 --- a/tests/test_generics.py +++ b/tests/test_generics.py @@ -1,12 +1,14 @@ from __future__ import unicode_literals import django +import pytest from django.db import models from django.shortcuts import get_object_or_404 from django.test import TestCase from django.utils import six from rest_framework import generics, renderers, serializers, status +from rest_framework.response import Response from rest_framework.test import APIRequestFactory from tests.models import ( BasicModel, ForeignKeySource, ForeignKeyTarget, RESTFrameworkModel @@ -527,3 +529,17 @@ class TestFilterBackendAppliedToViews(TestCase): response = view(request).render() self.assertContains(response, 'field_b') self.assertNotContains(response, 'field_a') + + +class TestGuardedQueryset(TestCase): + def test_guarded_queryset(self): + class QuerysetAccessError(generics.ListAPIView): + queryset = BasicModel.objects.all() + + def get(self, request): + return Response(list(self.queryset)) + + view = QuerysetAccessError.as_view() + request = factory.get('/') + with pytest.raises(AssertionError): + view(request).render() From c0e3e670ca74e35d4d214419a355c4ac4c96d4ee Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 23 Jul 2015 17:43:49 +0100 Subject: [PATCH 158/487] Fix Django compat for Queryset import --- rest_framework/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/views.py b/rest_framework/views.py index 9c9c8e19..debcb07a 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -119,7 +119,7 @@ class APIView(View): This allows us to discover information about the view when we do URL reverse lookups. Used for breadcrumb generation. """ - if isinstance(getattr(cls, 'queryset', None), models.QuerySet): + if isinstance(getattr(cls, 'queryset', None), models.query.QuerySet): def force_evaluation(): raise AssertionError( 'Do not evaluate the `.queryset` attribute directly, ' From 108dfafa44284bc2ad14558882acb5a62c370da0 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 24 Jul 2015 09:02:16 +0100 Subject: [PATCH 159/487] Fix Django 1.5/1.4 compat issue --- rest_framework/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/views.py b/rest_framework/views.py index debcb07a..8141a655 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -126,8 +126,8 @@ class APIView(View): 'as the result will be cached and reused between requests. ' 'Use `.all()` or call `.get_queryset()` instead.' ) - cls.queryset._fetch_all = force_evaluation + cls.queryset._result_iter = force_evaluation # Django <= 1.5 view = super(APIView, cls).as_view(**initkwargs) view.cls = cls From bdeb28944f3d4d2631871882b48ef08047fc3289 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 24 Jul 2015 09:13:39 +0100 Subject: [PATCH 160/487] Use RuntimeError, not AssertionError when guarding against direct View.queryset evalutation. Refs #3180. --- rest_framework/views.py | 2 +- tests/test_generics.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/rest_framework/views.py b/rest_framework/views.py index 8141a655..ca91d19d 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -121,7 +121,7 @@ class APIView(View): """ if isinstance(getattr(cls, 'queryset', None), models.query.QuerySet): def force_evaluation(): - raise AssertionError( + raise RuntimeError( 'Do not evaluate the `.queryset` attribute directly, ' 'as the result will be cached and reused between requests. ' 'Use `.all()` or call `.get_queryset()` instead.' diff --git a/tests/test_generics.py b/tests/test_generics.py index 5db0b6f7..000adffa 100644 --- a/tests/test_generics.py +++ b/tests/test_generics.py @@ -541,5 +541,5 @@ class TestGuardedQueryset(TestCase): view = QuerysetAccessError.as_view() request = factory.get('/') - with pytest.raises(AssertionError): + with pytest.raises(RuntimeError): view(request).render() From bf25a6ecbcf86212976e2f5c605dc8d710e2f55d Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Wed, 25 Mar 2015 16:51:40 -0700 Subject: [PATCH 161/487] Test case for using `allow_null` with `many=True` and a fix for it --- rest_framework/serializers.py | 2 +- tests/test_serializer_nested.py | 85 +++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+), 1 deletion(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 60ee7e5c..668c5256 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -50,7 +50,7 @@ from rest_framework.relations import * # NOQA # isort:skip LIST_SERIALIZER_KWARGS = ( 'read_only', 'write_only', 'required', 'default', 'initial', 'source', 'label', 'help_text', 'style', 'error_messages', 'allow_empty', - 'instance', 'data', 'partial', 'context' + 'instance', 'data', 'partial', 'context', 'allow_null' ) diff --git a/tests/test_serializer_nested.py b/tests/test_serializer_nested.py index b14a58c9..113f05a0 100644 --- a/tests/test_serializer_nested.py +++ b/tests/test_serializer_nested.py @@ -69,3 +69,88 @@ class TestNotRequiredNestedSerializer: input_data = QueryDict('nested[one]=1') serializer = self.Serializer(data=input_data) assert serializer.is_valid() + + +class TestNestedSerializerWithMany: + def setup(self): + class PaymentInfoSerializer(serializers.Serializer): + url = serializers.URLField() + amount = serializers.DecimalField(max_digits=6, decimal_places=2) + + class NestedSerializer(serializers.Serializer): + foo = serializers.CharField() + + class AcceptRequestSerializer(serializers.Serializer): + ERROR_MESSAGE = '`payment_info` is required under this condition' + + nested = NestedSerializer(many=True) + payment_info = PaymentInfoSerializer(many=True, allow_null=True) + + def validate_payment_info(self, value): + if value is None and not self.context['condition_to_allow_null']: + raise serializers.ValidationError(self.ERROR_MESSAGE) + + return value + + self.Serializer = AcceptRequestSerializer + + def get_serializer(self, data, condition_to_allow_null=True): + return self.Serializer( + data=data, + context={'condition_to_allow_null': condition_to_allow_null}) + + def test_null_allowed_if_allow_null_is_set(self): + input_data = { + 'nested': [{'foo': 'bar'}], + 'payment_info': None + } + expected_data = { + 'nested': [{'foo': 'bar'}], + 'payment_info': None + } + serializer = self.get_serializer(input_data) + + assert serializer.is_valid(), serializer.errors + assert serializer.validated_data == expected_data + + def test_null_is_not_allowed_if_allow_null_is_not_set(self): + input_data = { + 'nested': None, + 'payment_info': None + } + serializer = self.get_serializer(input_data) + + assert not serializer.is_valid() + assert set(serializer.errors) == {'nested'} + assert serializer.errors['nested'][0] == serializer.error_messages['null'] + + def test_run_the_field_validation_even_if_the_field_is_null(self): + input_data = { + 'nested': [{'foo': 'bar'}], + 'payment_info': None, + } + serializer = self.get_serializer(input_data, condition_to_allow_null=False) + + assert not serializer.is_valid() + assert set(serializer.errors) == {'payment_info'} + assert serializer.errors['payment_info'][0] == serializer.ERROR_MESSAGE + + def test_expected_results_if_not_null(self): + input_data = { + 'nested': [{'foo': 'bar'}], + 'payment_info': [ + {'url': 'https://domain.org/api/payment-method/1/', 'amount': '22'}, + {'url': 'https://domain.org/api/payment-method/2/', 'amount': '33'}, + ] + } + expected_data = { + 'nested': [{'foo': 'bar'}], + 'payment_info': [ + {'url': 'https://domain.org/api/payment-method/1/', 'amount': 22}, + {'url': 'https://domain.org/api/payment-method/2/', 'amount': 33}, + ] + } + serializer = self.get_serializer(input_data) + + assert serializer.is_valid() + assert serializer.validated_data == expected_data From 085c3e8a2b5a557d3fd5340eb1c1045d839ebd0c Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Thu, 26 Mar 2015 06:32:41 -0700 Subject: [PATCH 162/487] Fixed python 2.6 compatibility --- tests/test_serializer_nested.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_serializer_nested.py b/tests/test_serializer_nested.py index 113f05a0..3053ca21 100644 --- a/tests/test_serializer_nested.py +++ b/tests/test_serializer_nested.py @@ -121,7 +121,7 @@ class TestNestedSerializerWithMany: serializer = self.get_serializer(input_data) assert not serializer.is_valid() - assert set(serializer.errors) == {'nested'} + assert set(serializer.errors) == set(['nested']) assert serializer.errors['nested'][0] == serializer.error_messages['null'] def test_run_the_field_validation_even_if_the_field_is_null(self): @@ -132,7 +132,7 @@ class TestNestedSerializerWithMany: serializer = self.get_serializer(input_data, condition_to_allow_null=False) assert not serializer.is_valid() - assert set(serializer.errors) == {'payment_info'} + assert set(serializer.errors) == set(['payment_info']) assert serializer.errors['payment_info'][0] == serializer.ERROR_MESSAGE def test_expected_results_if_not_null(self): From bbd44ae94b4b334da2b454488a33ec398b217ff5 Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Sat, 25 Jul 2015 07:52:05 -0700 Subject: [PATCH 163/487] Updated the test cases based on the CR comments --- tests/test_serializer_nested.py | 81 +++++++++++---------------------- 1 file changed, 26 insertions(+), 55 deletions(-) diff --git a/tests/test_serializer_nested.py b/tests/test_serializer_nested.py index 3053ca21..22d4deca 100644 --- a/tests/test_serializer_nested.py +++ b/tests/test_serializer_nested.py @@ -73,84 +73,55 @@ class TestNotRequiredNestedSerializer: class TestNestedSerializerWithMany: def setup(self): - class PaymentInfoSerializer(serializers.Serializer): - url = serializers.URLField() - amount = serializers.DecimalField(max_digits=6, decimal_places=2) - class NestedSerializer(serializers.Serializer): - foo = serializers.CharField() + example = serializers.IntegerField(max_value=10) - class AcceptRequestSerializer(serializers.Serializer): - ERROR_MESSAGE = '`payment_info` is required under this condition' + class TestSerializer(serializers.Serializer): + allow_null = NestedSerializer(many=True, allow_null=True) + not_allow_null = NestedSerializer(many=True) - nested = NestedSerializer(many=True) - payment_info = PaymentInfoSerializer(many=True, allow_null=True) - - def validate_payment_info(self, value): - if value is None and not self.context['condition_to_allow_null']: - raise serializers.ValidationError(self.ERROR_MESSAGE) - - return value - - self.Serializer = AcceptRequestSerializer - - def get_serializer(self, data, condition_to_allow_null=True): - return self.Serializer( - data=data, - context={'condition_to_allow_null': condition_to_allow_null}) + self.Serializer = TestSerializer def test_null_allowed_if_allow_null_is_set(self): input_data = { - 'nested': [{'foo': 'bar'}], - 'payment_info': None + 'allow_null': None, + 'not_allow_null': [{'example': '2'}, {'example': '3'}] } expected_data = { - 'nested': [{'foo': 'bar'}], - 'payment_info': None + 'allow_null': None, + 'not_allow_null': [{'example': 2}, {'example': 3}] } - serializer = self.get_serializer(input_data) + serializer = self.Serializer(data=input_data) assert serializer.is_valid(), serializer.errors assert serializer.validated_data == expected_data def test_null_is_not_allowed_if_allow_null_is_not_set(self): input_data = { - 'nested': None, - 'payment_info': None + 'allow_null': None, + 'not_allow_null': None } - serializer = self.get_serializer(input_data) + serializer = self.Serializer(data=input_data) assert not serializer.is_valid() - assert set(serializer.errors) == set(['nested']) - assert serializer.errors['nested'][0] == serializer.error_messages['null'] + + expected_errors = {'not_allow_null': [serializer.error_messages['null']]} + assert serializer.errors == expected_errors def test_run_the_field_validation_even_if_the_field_is_null(self): - input_data = { - 'nested': [{'foo': 'bar'}], - 'payment_info': None, - } - serializer = self.get_serializer(input_data, condition_to_allow_null=False) + class TestSerializer(self.Serializer): + validation_was_run = False - assert not serializer.is_valid() - assert set(serializer.errors) == set(['payment_info']) - assert serializer.errors['payment_info'][0] == serializer.ERROR_MESSAGE + def validate_allow_null(self, value): + TestSerializer.validation_was_run = True + return value - def test_expected_results_if_not_null(self): input_data = { - 'nested': [{'foo': 'bar'}], - 'payment_info': [ - {'url': 'https://domain.org/api/payment-method/1/', 'amount': '22'}, - {'url': 'https://domain.org/api/payment-method/2/', 'amount': '33'}, - ] + 'allow_null': None, + 'not_allow_null': [{'example': 2}] } - expected_data = { - 'nested': [{'foo': 'bar'}], - 'payment_info': [ - {'url': 'https://domain.org/api/payment-method/1/', 'amount': 22}, - {'url': 'https://domain.org/api/payment-method/2/', 'amount': 33}, - ] - } - serializer = self.get_serializer(input_data) + serializer = TestSerializer(data=input_data) assert serializer.is_valid() - assert serializer.validated_data == expected_data + assert serializer.validated_data == input_data + assert TestSerializer.validation_was_run From f53c6c77418fe913cbb2fe274d0dcde4c2ae164d Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Fri, 13 Mar 2015 08:10:05 -0700 Subject: [PATCH 164/487] Added a test to reproduce the issue --- tests/models.py | 8 +++++++- tests/test_relations_hyperlink.py | 30 ++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/tests/models.py b/tests/models.py index c265182b..8de6e2e0 100644 --- a/tests/models.py +++ b/tests/models.py @@ -15,7 +15,10 @@ class RESTFrameworkModel(models.Model): class BasicModel(RESTFrameworkModel): - text = models.CharField(max_length=100, verbose_name=_("Text comes here"), help_text=_("Text description.")) + text = models.CharField( + max_length=100, + verbose_name=_("Text comes here"), + help_text=_("Text description.")) class BaseFilterableItem(RESTFrameworkModel): @@ -45,6 +48,9 @@ class ManyToManySource(RESTFrameworkModel): class ForeignKeyTarget(RESTFrameworkModel): name = models.CharField(max_length=100) + def get_first_source(self): + return self.sources.first() + class ForeignKeySource(RESTFrameworkModel): name = models.CharField(max_length=100) diff --git a/tests/test_relations_hyperlink.py b/tests/test_relations_hyperlink.py index c0642eda..cadef5ff 100644 --- a/tests/test_relations_hyperlink.py +++ b/tests/test_relations_hyperlink.py @@ -50,6 +50,17 @@ class ForeignKeyTargetSerializer(serializers.HyperlinkedModelSerializer): fields = ('url', 'name', 'sources') +class ForeignKeyTargetCallableSourceSerializer(serializers.HyperlinkedModelSerializer): + class Meta: + model = ForeignKeyTarget + fields = ('url', 'name', 'first_source') + + first_source = serializers.HyperlinkedRelatedField( + read_only=True, + source='get_first_source', + view_name='foreignkeysource-detail') + + class ForeignKeySourceSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = ForeignKeySource @@ -444,3 +455,22 @@ class HyperlinkedNullableOneToOneTests(TestCase): {'url': 'http://testserver/onetoonetarget/2/', 'name': 'target-2', 'nullable_source': None}, ] self.assertEqual(serializer.data, expected) + + +class HyperlinkedRelationCallableSourceTests(TestCase): + urls = 'tests.test_relations_hyperlink' + + def setUp(self): + self.target = ForeignKeyTarget.objects.create(name='target-1') + ForeignKeySource.objects.create(name='source-1', target=self.target) + ForeignKeySource.objects.create(name='source-2', target=self.target) + + def test_relation_field_callable_source(self): + serializer = ForeignKeyTargetCallableSourceSerializer(self.target, context={'request': request}) + expected = { + 'url': 'http://testserver/foreignkeytarget/1/', + 'name': 'target-1', + 'first_source': 'http://testserver/foreignkeysource/1/', + } + with self.assertNumQueries(1): + self.assertEqual(serializer.data, expected) From 46b65d1647d74c9c7495dc2108dd199457740590 Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Sat, 25 Jul 2015 09:42:27 -0700 Subject: [PATCH 165/487] Added another test case for PK relations --- tests/models.py | 5 ++++- tests/test_relations_pk.py | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/tests/models.py b/tests/models.py index 8de6e2e0..4537ae33 100644 --- a/tests/models.py +++ b/tests/models.py @@ -49,7 +49,10 @@ class ForeignKeyTarget(RESTFrameworkModel): name = models.CharField(max_length=100) def get_first_source(self): - return self.sources.first() + try: + return self.sources.all()[0] + except IndexError: + return None class ForeignKeySource(RESTFrameworkModel): diff --git a/tests/test_relations_pk.py b/tests/test_relations_pk.py index 169f7d9c..505d4d95 100644 --- a/tests/test_relations_pk.py +++ b/tests/test_relations_pk.py @@ -30,6 +30,16 @@ class ForeignKeyTargetSerializer(serializers.ModelSerializer): fields = ('id', 'name', 'sources') +class ForeignKeyTargetCallableSourceSerializer(serializers.ModelSerializer): + class Meta: + model = ForeignKeyTarget + fields = ('id', 'name', 'first_source') + + first_source = serializers.PrimaryKeyRelatedField( + read_only=True, + source='get_first_source') + + class ForeignKeySourceSerializer(serializers.ModelSerializer): class Meta: model = ForeignKeySource @@ -450,3 +460,21 @@ class PKNullableOneToOneTests(TestCase): {'id': 2, 'name': 'target-2', 'nullable_source': 1}, ] self.assertEqual(serializer.data, expected) + + +class PKRelationCallableSourceTests(TestCase): + + def setUp(self): + self.target = ForeignKeyTarget.objects.create(name='target-1') + self.first_source = ForeignKeySource.objects.create(id=10, name='source-1', target=self.target) + ForeignKeySource.objects.create(name='source-2', target=self.target) + + def test_relation_field_callable_source(self): + serializer = ForeignKeyTargetCallableSourceSerializer(self.target) + expected = { + 'id': 1, + 'name': 'target-1', + 'first_source': 10, + } + with self.assertNumQueries(1): + self.assertEqual(serializer.data, expected) From 47a22a55cacf17264a54fbce7105ef6f501e0e56 Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Sat, 25 Jul 2015 09:44:00 -0700 Subject: [PATCH 166/487] Added a possible fix --- rest_framework/relations.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 97a6417e..1d20ee82 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -13,7 +13,9 @@ from django.utils.six.moves.urllib import parse as urlparse from django.utils.translation import ugettext_lazy as _ from rest_framework.compat import OrderedDict -from rest_framework.fields import Field, empty, get_attribute +from rest_framework.fields import ( + Field, empty, get_attribute, is_simple_callable +) from rest_framework.reverse import reverse from rest_framework.utils import html @@ -106,7 +108,12 @@ class RelatedField(Field): # Optimized case, return a mock object only containing the pk attribute. try: instance = get_attribute(instance, self.source_attrs[:-1]) - return PKOnlyObject(pk=instance.serializable_value(self.source_attrs[-1])) + + value = instance.serializable_value(self.source_attrs[-1]) + if is_simple_callable(value): + value = value().pk + + return PKOnlyObject(pk=value) except AttributeError: pass From 4f0220b7805a320e33ebee4bea21bfffbc12c2ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Sun, 26 Jul 2015 20:00:34 -0400 Subject: [PATCH 167/487] Add missing link --- docs/topics/third-party-resources.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/topics/third-party-resources.md b/docs/topics/third-party-resources.md index ae2ae3bc..9f0aab38 100644 --- a/docs/topics/third-party-resources.md +++ b/docs/topics/third-party-resources.md @@ -288,6 +288,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque [drf-create-issue]: https://github.com/tomchristie/django-rest-framework/issues/new [authentication]: ../api-guide/authentication.md [permissions]: ../api-guide/permissions.md +[third-party-resources]: ../topics/third-party-resources/#existing-third-party-packages [discussion-group]: https://groups.google.com/forum/#!forum/django-rest-framework [djangorestframework-digestauth]: https://github.com/juanriaza/django-rest-framework-digestauth [django-oauth-toolkit]: https://github.com/evonove/django-oauth-toolkit From 99d9afc9d08f296461983dfa3f3aac82d4080a7e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 27 Jul 2015 09:18:41 +0100 Subject: [PATCH 168/487] Remove out-of-date note on footer block in browsable API template. Closes #3187. --- docs/topics/browsable-api.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/browsable-api.md b/docs/topics/browsable-api.md index bdc5b19c..0e12f925 100644 --- a/docs/topics/browsable-api.md +++ b/docs/topics/browsable-api.md @@ -75,7 +75,6 @@ All of the blocks available in the browsable API base template that can be used * `bootstrap_navbar_variant` - CSS class for the navbar. * `branding` - Branding section of the navbar, see [Bootstrap components][bcomponentsnav]. * `breadcrumbs` - Links showing resource nesting, allowing the user to go back up the resources. It's recommended to preserve these, but they can be overridden using the breadcrumbs block. -* `footer` - Any copyright notices or similar footer materials can go here (by default right-aligned). * `script` - JavaScript files for the page. * `style` - CSS stylesheets for the page. * `title` - Title of the page. From 798cd1a637dbcfb18cb8718e6891060112fd383c Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 27 Jul 2015 10:20:37 +0100 Subject: [PATCH 169/487] Fix for DjangoObjectPermissionsFilter with Guardian < 1.3 --- rest_framework/filters.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index a5e06b57..8c45299e 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -201,4 +201,6 @@ class DjangoObjectPermissionsFilter(BaseFilterBackend): if guardian.VERSION >= (1, 3): # Maintain behavior compatibility with versions prior to 1.3 extra = {'accept_global_perms': False} + else: + extra = {} return guardian.shortcuts.get_objects_for_user(user, permission, queryset, **extra) From f1e2135b04b957fafdeacfc695d7ed61279fdf91 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 27 Jul 2015 13:11:24 +0100 Subject: [PATCH 170/487] Restyle horizontal checkbox. Closes #2783. --- .../rest_framework/css/bootstrap-tweaks.css | 16 +++++++++++++++- .../rest_framework/horizontal/checkbox.html | 17 +++++++++-------- 2 files changed, 24 insertions(+), 9 deletions(-) diff --git a/rest_framework/static/rest_framework/css/bootstrap-tweaks.css b/rest_framework/static/rest_framework/css/bootstrap-tweaks.css index f455c904..f3d20cca 100644 --- a/rest_framework/static/rest_framework/css/bootstrap-tweaks.css +++ b/rest_framework/static/rest_framework/css/bootstrap-tweaks.css @@ -1,6 +1,6 @@ /* -This CSS file contains some tweaks specific to the included Bootstrap theme. +This CSS file contains some tweaks specific to the included Bootstrap theme. It's separate from `style.css` so that it can be easily overridden by replacing a single block in the template. @@ -213,3 +213,17 @@ body a:hover { .request-info { clear:both; } + +.horizontal-checkbox label { + padding-top: 0; +} + +.horizontal-checkbox label { + padding-top: 0 !important; +} + +.horizontal-checkbox input { + float: left; + width: 20px; + margin-top: 3px; +} diff --git a/rest_framework/templates/rest_framework/horizontal/checkbox.html b/rest_framework/templates/rest_framework/horizontal/checkbox.html index 1047de85..d8453958 100644 --- a/rest_framework/templates/rest_framework/horizontal/checkbox.html +++ b/rest_framework/templates/rest_framework/horizontal/checkbox.html @@ -1,11 +1,12 @@ -
    -
    -
    - -
    +
    + {% if field.label %} + + {% endif %} + +
    + {% if field.errors %} {% for error in field.errors %} From 402fb3939627a48f916ba7f90f442cf09d80e3f4 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 27 Jul 2015 13:18:49 +0100 Subject: [PATCH 171/487] HStoreField maps to ListField(CharField(allow_blank=True). Closes #2659. --- rest_framework/serializers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 60ee7e5c..cb0404b6 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -1430,7 +1430,7 @@ if hasattr(models, 'IPAddressField'): if postgres_fields: class CharMappingField(DictField): - child = CharField() + child = CharField(allow_blank=True) ModelSerializer.serializer_field_mapping[postgres_fields.HStoreField] = CharMappingField ModelSerializer.serializer_field_mapping[postgres_fields.ArrayField] = ListField From 75beb6ab2d3e341938226c5d08cede956772ba34 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 27 Jul 2015 13:32:30 +0100 Subject: [PATCH 172/487] Note on ValidationError in perform_create. Closes #2791. --- docs/api-guide/generic-views.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md index d219afa1..7970b275 100644 --- a/docs/api-guide/generic-views.md +++ b/docs/api-guide/generic-views.md @@ -188,6 +188,14 @@ These override points are also particularly useful for adding behavior that occu instance = serializer.save() send_email_confirmation(user=self.request.user, modified=instance) +You can also use these hooks to provide additional validation, by raising a `ValidationError()`. This can be useful if you need some validation logic to apply at the point of database save. For example: + + def perform_create(self, serializer): + queryset = SignupRequest.objects.filter(user=self.request.user) + if queryset.exists(): + raise ValidationError('You have already signed up') + serializer.save(user=self.request.user) + **Note**: These methods replace the old-style version 2.x `pre_save`, `post_save`, `pre_delete` and `post_delete` methods, which are no longer available. **Other methods**: From c5a04a85169524d894df8bcc39fe3e6945868222 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 27 Jul 2015 13:51:03 +0100 Subject: [PATCH 173/487] Add test for nullable ChoiceField and blank HTML input. Closes #2623. --- tests/test_fields.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/tests/test_fields.py b/tests/test_fields.py index 94eb5df7..52ccd636 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1070,6 +1070,22 @@ class TestChoiceField(FieldValues): output = field.run_validation('') assert output == '' + def test_allow_null(self): + """ + If `allow_null=True` then '' on HTML forms is treated as None. + """ + field = serializers.ChoiceField( + allow_null=True, + choices=[ + 1, 2, 3 + ] + ) + field.field_name = 'example' + value = field.get_value(QueryDict('example=')) + assert value is None + output = field.run_validation(None) + assert output is None + class TestChoiceFieldWithType(FieldValues): """ From 0386a016731c6aaa087b75d3c1986db12cc545e6 Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Mon, 27 Jul 2015 07:40:00 -0700 Subject: [PATCH 174/487] Addressed CR comments --- rest_framework/relations.py | 2 ++ tests/models.py | 11 +---------- tests/test_relations_hyperlink.py | 30 ------------------------------ tests/test_relations_pk.py | 28 ---------------------------- 4 files changed, 3 insertions(+), 68 deletions(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 1d20ee82..29585a81 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -109,6 +109,8 @@ class RelatedField(Field): try: instance = get_attribute(instance, self.source_attrs[:-1]) + # Handle edge case where the relationship `source` argument + # points to a `get_relationship()` method on the model value = instance.serializable_value(self.source_attrs[-1]) if is_simple_callable(value): value = value().pk diff --git a/tests/models.py b/tests/models.py index 4537ae33..c265182b 100644 --- a/tests/models.py +++ b/tests/models.py @@ -15,10 +15,7 @@ class RESTFrameworkModel(models.Model): class BasicModel(RESTFrameworkModel): - text = models.CharField( - max_length=100, - verbose_name=_("Text comes here"), - help_text=_("Text description.")) + text = models.CharField(max_length=100, verbose_name=_("Text comes here"), help_text=_("Text description.")) class BaseFilterableItem(RESTFrameworkModel): @@ -48,12 +45,6 @@ class ManyToManySource(RESTFrameworkModel): class ForeignKeyTarget(RESTFrameworkModel): name = models.CharField(max_length=100) - def get_first_source(self): - try: - return self.sources.all()[0] - except IndexError: - return None - class ForeignKeySource(RESTFrameworkModel): name = models.CharField(max_length=100) diff --git a/tests/test_relations_hyperlink.py b/tests/test_relations_hyperlink.py index cadef5ff..c0642eda 100644 --- a/tests/test_relations_hyperlink.py +++ b/tests/test_relations_hyperlink.py @@ -50,17 +50,6 @@ class ForeignKeyTargetSerializer(serializers.HyperlinkedModelSerializer): fields = ('url', 'name', 'sources') -class ForeignKeyTargetCallableSourceSerializer(serializers.HyperlinkedModelSerializer): - class Meta: - model = ForeignKeyTarget - fields = ('url', 'name', 'first_source') - - first_source = serializers.HyperlinkedRelatedField( - read_only=True, - source='get_first_source', - view_name='foreignkeysource-detail') - - class ForeignKeySourceSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = ForeignKeySource @@ -455,22 +444,3 @@ class HyperlinkedNullableOneToOneTests(TestCase): {'url': 'http://testserver/onetoonetarget/2/', 'name': 'target-2', 'nullable_source': None}, ] self.assertEqual(serializer.data, expected) - - -class HyperlinkedRelationCallableSourceTests(TestCase): - urls = 'tests.test_relations_hyperlink' - - def setUp(self): - self.target = ForeignKeyTarget.objects.create(name='target-1') - ForeignKeySource.objects.create(name='source-1', target=self.target) - ForeignKeySource.objects.create(name='source-2', target=self.target) - - def test_relation_field_callable_source(self): - serializer = ForeignKeyTargetCallableSourceSerializer(self.target, context={'request': request}) - expected = { - 'url': 'http://testserver/foreignkeytarget/1/', - 'name': 'target-1', - 'first_source': 'http://testserver/foreignkeysource/1/', - } - with self.assertNumQueries(1): - self.assertEqual(serializer.data, expected) diff --git a/tests/test_relations_pk.py b/tests/test_relations_pk.py index 505d4d95..169f7d9c 100644 --- a/tests/test_relations_pk.py +++ b/tests/test_relations_pk.py @@ -30,16 +30,6 @@ class ForeignKeyTargetSerializer(serializers.ModelSerializer): fields = ('id', 'name', 'sources') -class ForeignKeyTargetCallableSourceSerializer(serializers.ModelSerializer): - class Meta: - model = ForeignKeyTarget - fields = ('id', 'name', 'first_source') - - first_source = serializers.PrimaryKeyRelatedField( - read_only=True, - source='get_first_source') - - class ForeignKeySourceSerializer(serializers.ModelSerializer): class Meta: model = ForeignKeySource @@ -460,21 +450,3 @@ class PKNullableOneToOneTests(TestCase): {'id': 2, 'name': 'target-2', 'nullable_source': 1}, ] self.assertEqual(serializer.data, expected) - - -class PKRelationCallableSourceTests(TestCase): - - def setUp(self): - self.target = ForeignKeyTarget.objects.create(name='target-1') - self.first_source = ForeignKeySource.objects.create(id=10, name='source-1', target=self.target) - ForeignKeySource.objects.create(name='source-2', target=self.target) - - def test_relation_field_callable_source(self): - serializer = ForeignKeyTargetCallableSourceSerializer(self.target) - expected = { - 'id': 1, - 'name': 'target-1', - 'first_source': 10, - } - with self.assertNumQueries(1): - self.assertEqual(serializer.data, expected) From d4353cc1fde13352de4cfcb75d8dfe46fb54f9f2 Mon Sep 17 00:00:00 2001 From: Ion Scerbatiuc Date: Mon, 27 Jul 2015 07:57:05 -0700 Subject: [PATCH 175/487] Moved the code comment inside the if block and removed whitespace --- rest_framework/relations.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 29585a81..e1aa1439 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -108,13 +108,11 @@ class RelatedField(Field): # Optimized case, return a mock object only containing the pk attribute. try: instance = get_attribute(instance, self.source_attrs[:-1]) - - # Handle edge case where the relationship `source` argument - # points to a `get_relationship()` method on the model value = instance.serializable_value(self.source_attrs[-1]) if is_simple_callable(value): + # Handle edge case where the relationship `source` argument + # points to a `get_relationship()` method on the model value = value().pk - return PKOnlyObject(pk=value) except AttributeError: pass From 2109f552443855313edbcf50ac919ef9b7e5f71a Mon Sep 17 00:00:00 2001 From: "clemence.lop" Date: Tue, 28 Jul 2015 15:55:49 +0200 Subject: [PATCH 176/487] Correct API ROOT to enable parametered urls --- rest_framework/routers.py | 1 + 1 file changed, 1 insertion(+) diff --git a/rest_framework/routers.py b/rest_framework/routers.py index 380f3bb4..bba174e6 100644 --- a/rest_framework/routers.py +++ b/rest_framework/routers.py @@ -291,6 +291,7 @@ class DefaultRouter(SimpleRouter): try: ret[key] = reverse( url_name, + kwargs=kwargs, request=request, format=kwargs.get('format', None) ) From d2ae7d4fcd96e26fc102ad581859cc72a9a7551c Mon Sep 17 00:00:00 2001 From: Hachikooking Date: Wed, 29 Jul 2015 14:43:25 +0200 Subject: [PATCH 177/487] Add args to the function call for unnamed parameters --- rest_framework/routers.py | 1 + 1 file changed, 1 insertion(+) diff --git a/rest_framework/routers.py b/rest_framework/routers.py index bba174e6..e72c4987 100644 --- a/rest_framework/routers.py +++ b/rest_framework/routers.py @@ -291,6 +291,7 @@ class DefaultRouter(SimpleRouter): try: ret[key] = reverse( url_name, + args=args, kwargs=kwargs, request=request, format=kwargs.get('format', None) From 0b345516a5987d85cbf682a5599eb638edead92e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Wed, 29 Jul 2015 21:24:55 -0400 Subject: [PATCH 178/487] Turn off autocomplete on search form --- docs_theme/base.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_theme/base.html b/docs_theme/base.html index 4e95f1f9..93b687cf 100644 --- a/docs_theme/base.html +++ b/docs_theme/base.html @@ -69,7 +69,7 @@
    -
    +
    From ea1a8f4ac55340da84484de3c37fc59fb3d4281b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Wed, 29 Jul 2015 21:25:21 -0400 Subject: [PATCH 179/487] Fix weird search behavior. Closes #3197 --- docs_theme/js/theme.js | 56 +++++++++++++++++++++--------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs_theme/js/theme.js b/docs_theme/js/theme.js index 8208f1f4..ddbd9c90 100644 --- a/docs_theme/js/theme.js +++ b/docs_theme/js/theme.js @@ -1,35 +1,35 @@ -function getSearchTerm() -{ - var sPageURL = window.location.search.substring(1); - var sURLVariables = sPageURL.split('&'); - for (var i = 0; i < sURLVariables.length; i++) - { - var sParameterName = sURLVariables[i].split('='); - if (sParameterName[0] == 'q') - { - return sParameterName[1]; - } +var getSearchTerm = function() { + var sPageURL = window.location.search.substring(1); + var sURLVariables = sPageURL.split('&'); + for (var i = 0; i < sURLVariables.length; i++) { + var sParameterName = sURLVariables[i].split('='); + if (sParameterName[0] === 'q') { + return sParameterName[1]; } -} + } +}; + +var initilizeSearch = function() { + require.config({ baseUrl: '/mkdocs/js' }); + require(['search']); +}; $(function() { + var searchTerm = getSearchTerm(), + $searchModal = $('#mkdocs_search_modal'), + $searchQuery = $searchModal.find('#mkdocs-search-query'), + $searchResults = $searchModal.find('#mkdocs-search-results'); - var initialise_search = function(){ - require.config({"baseUrl":"/mkdocs/js"}); - require(["search",]); - } + $('pre code').parent().addClass('prettyprint well'); - var search_term = getSearchTerm(); - if(search_term){ - $('#mkdocs_search_modal').modal(); - } - - $('pre code').parent().addClass('prettyprint well'); - - $(document).on("submit", "#mkdocs_search_modal form", function (e) { - $("#mkdocs-search-results").html("Searching..."); - initialise_search(); - return false; - }); + if (searchTerm) { + $searchQuery.val(searchTerm); + $searchResults.text('Searching...'); + $searchModal.modal(); + } + $searchModal.on('shown', function() { + $searchQuery.focus(); + initilizeSearch(); + }); }); From cb257ec524f82ddc8ca8e6419964737569d4df3c Mon Sep 17 00:00:00 2001 From: Trey Hunner Date: Wed, 29 Jul 2015 20:45:23 -0700 Subject: [PATCH 180/487] Measure code coverage in tox --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index d941b6d7..8348f814 100644 --- a/tox.ini +++ b/tox.ini @@ -9,7 +9,7 @@ envlist = {py27,py32,py33,py34}-django{17,18,master} [testenv] -commands = ./runtests.py --fast {posargs} +commands = ./runtests.py --fast {posargs} --coverage setenv = PYTHONDONTWRITEBYTECODE=1 deps = From 5c1d6a9200091506dbacd8f13881486991e7140e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 14:07:51 +0100 Subject: [PATCH 181/487] Docs for AdminRenderer --- docs/api-guide/renderers.md | 52 +++++++++++++----- docs/img/admin.png | Bin 0 -> 55904 bytes rest_framework/renderers.py | 1 + rest_framework/templatetags/rest_framework.py | 4 +- 4 files changed, 40 insertions(+), 17 deletions(-) create mode 100644 docs/img/admin.png diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index 1d1b4691..61425945 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -153,23 +153,13 @@ You can use `StaticHTMLRenderer` either to return regular HTML pages using REST See also: `TemplateHTMLRenderer` -## HTMLFormRenderer - -Renders data returned by a serializer into an HTML form. The output of this renderer does not include the enclosing `` tags or an submit actions, as you'll probably need those to include the desired method and URL. Also note that the `HTMLFormRenderer` does not yet support including field error messages. - -**Note**: The `HTMLFormRenderer` class is intended for internal use with the browsable API. It should not be considered a fully documented or stable API. The template used by the `HTMLFormRenderer` class, and the context submitted to it **may be subject to change**. If you need to use this renderer class it is advised that you either make a local copy of the class and templates, or follow the release note on REST framework upgrades closely. - -**.media_type**: `text/html` - -**.format**: `'.form'` - -**.charset**: `utf-8` - -**.template**: `'rest_framework/form.html'` - ## BrowsableAPIRenderer -Renders data into HTML for the Browsable API. This renderer will determine which other renderer would have been given highest priority, and use that to display an API style response within the HTML page. +Renders data into HTML for the Browsable API: + +![The BrowsableAPIRenderer](../img/quickstart.png) + +This renderer will determine which other renderer would have been given highest priority, and use that to display an API style response within the HTML page. **.media_type**: `text/html` @@ -187,6 +177,38 @@ By default the response content will be rendered with the highest priority rende def get_default_renderer(self, view): return JSONRenderer() +## AdminRenderer + +Renders data into HTML for an admin-like display: + +![The AdminRender view](../img/admin.png) + +This renderer is suitable for CRUD-style web APIs that should also present a user-friendly interface for managing the data. + +Note that views that have nested or list serializers for their input won't work well with the `AdminRenderer`, as the HTML forms are unable to properly support them. + +**.media_type**: `text/html` + +**.format**: `'.admin'` + +**.charset**: `utf-8` + +**.template**: `'rest_framework/admin.html'` + +## HTMLFormRenderer + +Renders data returned by a serializer into an HTML form. The output of this renderer does not include the enclosing `` tags or an submit actions, as you'll probably need those to include the desired method and URL. Also note that the `HTMLFormRenderer` does not yet support including field error messages. + +**Note**: The `HTMLFormRenderer` class is intended for internal use with the browsable API and admin interface. It should not be considered a fully documented or stable API. The template used by the `HTMLFormRenderer` class, and the context submitted to it **may be subject to change**. If you need to use this renderer class it is advised that you either make a local copy of the class and templates, or follow the release note on REST framework upgrades closely. + +**.media_type**: `text/html` + +**.format**: `'.form'` + +**.charset**: `utf-8` + +**.template**: `'rest_framework/form.html'` + ## MultiPartRenderer This renderer is used for rendering HTML multipart form data. **It is not suitable as a response renderer**, but is instead used for creating test requests, using REST framework's [test client and test request factory][testing]. diff --git a/docs/img/admin.png b/docs/img/admin.png new file mode 100644 index 0000000000000000000000000000000000000000..f12df099dfdaba6ca8214694b6ae9c8f88fd9df4 GIT binary patch literal 55904 zcmeEtWmKHo(k2=#1cJLu@ZiBA5Zr=01b26L2@b(6xVtno?(XjH?%FV%dvDI+u5af5 ztXb2)y7yaEyLLTWs-FFJh^({-B0LT}7#J9$n5d8(7#QRh7#IXHEW~R|kOVUb3=F=) zL{LyxOi++W*4E0<#M}T3Ocb#+-bn#f6}RV9(lr~Jgoykq!X84j9Gq%GK;bJ2EL{)3 zv7^2Xv=SQnM_DENecxg^i(u%*thow?K9b)hq0qDiM^L;Q>8I|Gt4^a0x6eDxqfK^; zsh42R3ZLwMQ~+>!n5dH@9`X6XAYu8jWmS$?e9UCWn9j-#9(c2a2k=pC z%Dm!0r{Jm|*uxRQ(EQ)`+Dyz9!e$7W(yJ3m!hm)2Z!9G3LooId(J}~81Xu76!Cj_O z?$o=`r%d|4Ya~sk06WvikVpgrD})T0WS)Z)C76KpAHGW!;sw*^?vOSo2=%K#>gXvf zH0ui6^Y&cgyC8e=Q!V)-CXGQO&~a%dup-2J6rD&R`omz9=ZP<63hiT+w%s>GlYWza zVoy;Sp&Q!J;fwdGIs^$+ywwf$M9Xx}KB$vPnFvFu_x^MhpE!mbd}3$s#IBy|z1sr5 za1GrvA?^yG2W2)3ssAS0u!bW%5IiG+dB$LIL-!<*-^q`Pj5$@zUOSI64 zBE<~FW}pzMN;Hj0WUc3UXj^eID7bstaZCneqDZ-CVcHRopgxFh`2K3(;>pMS=}Z3D zwjCsP6V-VUbwn2ohS7$iLX4hcSKW0BSzrE99|0BBdEZ`nYsW5pUy^rmD$(+Xp(SG1 zOSB4PTO*9!3ye^wSENA(Oxre^tq6KcFNqYmu^f!|&I?Z-4?LJ6ruT@MdGu#JUP85{ zA5n4QkS@QWro1u6U?}>I%)KG4!PDC?p?qbLp_Rbd)_fF*pptZW<{&Nvi09yLd~Ic+ zKlpK4qv63Eud#eVqW3#o!>ETL@Dun9q2(j?8PSjkwnG3d7@kVtAnJoYlq&!GKDZ12 zc!73VG&BTqes@u*(xAGp0kUukAMkw-GPN_M_qgrR4}u833XXlb!gzR}t;0l%RNMhP zLrDa0?C`Yy)Py4KJ=?)yP0$2M?^nD|QIE)rq#bnH?srDx3=b_!hK88y!z92cds4u! zz(P$xE@UBu{#*R}bb+A)W)Y?X3~O*QzsFa-aRnB93tvb6$KRb}=2vQ0!uB75c$z_$ zg4#l>0!W#Zsv zh|M|7ksN`WBh=w8M&kEKuUmg1PyIOZ5i?kCeZuCx9#l`U#Iac8aKHGpopZ&o5KFNMLgJAFa;Yarl9QHGB$8I5PM-JTf%TV`GsZjaT=u;_tO8t(NlW7cOp`Z&; zlH`(ZlzD6tb%;JBImtQ>O~zc-x)QLd%nBt@uH>)$cAmarL=KF}m#dnf&vnerA22o$ z+}<8Y8i0voppv1D*FLI9Y_8WiKktrI&_NfB(}{DS4pOu%kSr`JbS;KgxGmO_O_R+o zY$zZvJpRsA%vL6?=p-kju$t{D4I145E zRcFaC{aA~ocCO}D<61*eJ6#K^oi$@O<(nYh`)u#b`DpLzz`J*_FT7_tX)%jGDL*T{ zP18+q)T)qTu|Tox{wS(p`y`Vxlg9l+@&$>kgd??y#;ug3TGgNPAFF$JYx2(3zTff+7Wqo?X@8ax+ z=6vNc;1cK(@5XyMaV36cdX;=tccZnteC&6AemTF*+@@eqm2^EMrmen;*n$b_^Cb4% z_8d*Xrbneeya)n$fSexr;KtzAU}|7|`3=`j+VTZl13Zpr)U+y}zE!xKJ*=%D zoAw<<1xD@50>(DRdVf6p$f`)U-akt`dpJY-Nbr&TqhGWH3A>P1q+En}*gU2rr7eft$ zC9=h|=19=b&5rp_>|IVL!$70-zL?<+qvbxfp_O!=?c|Q+ z^4h0`cHkN?^t$f)8j%{YJKQ?Ez@~{RZ-3@{WH$aV#c+_CFFoLTk^n>r4IW zc{*ws>M*5)v{Id%I>N&5x}&;&N3BO45d{&id@CcF1VQCPs!93Ud{$}Y)bC&9-Q%6v zPLGZnQtjlIeNRFz;dX=Ely13OkX_bKy0F+gxw)2M<0a~*wcFK6=sV$~nwU;=X zYL5;nhZgK5RyEItAa%10DeXn6#T0zNk)^{m!!e)R;{DA%7l9M~s=-RLC&QZ73#j4| z>7DMocZAjiVLXy9cRSyEvXgpKGIY|>xZ_;Z9wfI_uTS5#0^TpYPshH%0-kek-EaQ5 zIV1u~k-r%on0+XhdEUO54e#&k zk7n;+ueJ(Zp=vJnu)1zBqBcI5w?DWV3i6E%I+KdYPfUkLh}5>I2KMQDuyTEX3Q?g;23NlKPBTY`ZX|u##)UTbX~3?q zIatBUdwwW6k4EqUAy@pI1V}Kb1~B9U2ptItv2R%$F&I`Rj4;TB_>~m7)zzoSR>90* zYlm$|N0N_6N3%Fxhujdq-CS3+L#IuHXCuAAz>nSbUB{OWU(BE1wYr@-aad@0fPsOh znJB2(t4K+5>RDOP|IoM6HK2F4uzt;L!N9nkIbXk87})s zni)ul{v~2>#zUeaB}*h|WotmhO3z5oM8XSCL`1}Gt8d6DCnWqI_19lKB*ymk)|?Cs zPEJnrPR#UHwnhw$92^`BpP3k#nCM<5=j?uR{bz>1ZNI8=|JBMVYvOER zt|DY&VPI+Z+6ONO2OIalWW@EcS&K zhJP5!``yATUqRG|Cj>?IrSB`P09kONSOs|>ElVsf2`oyo&f9WwFNr;o`}WTN^QSdXH}PM?Bjq?uKqJOs!RRcM8#C_lr~evNI2oH6{6 zHx29i;49gMCuuxPrb1SM^=Lc_1u-!zB55d5!Ed}X2$LixThYBFf-tf2?mEQR_t7}E zX7cLuG0HLY@fT&7z`)`_TokX_GYhCy;`39S=YC-pUw*T!o~VvxH%C-+WN$DiA~0}R z{?~HOn|}=s3gonQ4aejArWFjTz#9zyzXf&RiByn=4t=!*{?hv+%zRi6^S80rM&tsB zL{+3I8b8lBVj8y)0xm8tvpf)B|0Nszmuy$DFYg;!e(%?QdM*C=_g6nYVCei61ivxg zE&rE~z79)}|2Xnmn#zJh9fG_57^D05(Ejb>t1+Jc*Npw}zA?LSl)%Cv_(+|HB$l^w zQlyhQH>h? zy0w9R(tP#Q>WIzs;&i)ZMklRi4UeL{&aUIGQ56O7H)Gx5qX_ZD4l=c}M0TDKE?vu~y|Kb*m}m2CpQs&0Xi6kPll5rGOo=_n zzbD;Uep@}g9~?$EnE}Rf-PTU3^I{@21S2uYc>T?Q{PS9Y|By@QZjbAXs(}3nzFkQ) zuu|URx(GNai3=Z*tW_gQux}D8eGe4^&nw4%U_XnKLaCiIf;7XdL5X?vuUY*Hy)_7S zi@OfgecbxAZ~WoQuBFK=jl$Ajv_U5?994zNi~R1zs>)-YSuehfX-2Rb(7g zS(TZPsK)nlAu(ZRK_-ZkU1dIMg1XT+)zJX`y`8avU5K#!xPq<7jN4`F*I))5tgVs3 zI5)7^h>s()N(MD(XQ_!uf+CrhboaujcKfu|>a@YR=h!Jn%w8LxcS3*El&{;pR;4~e zWba@wLV;N%+W+6v^wsUzNd5r}3ClsUB=pgyn-gP1PJ@-0#dx#>niY5VsUkeF*(dyx zY7f?H#{y}>Q>I~tfiUrb6pV%6N8}q*g&Z3@rUvYU&+sJq!^!bj`1B|t!QHxSrnsik z({)!9;xU(&BjGc%3ha3!)S~dHiQyP}kwCS=Eg9Qz*p66)i~JrDVOXfH0>#;xf~@Mx zujPtq1r~rCVx{zilq4+TyvaL^?7HIhj--V=%R?%e=P4)FDV8PKUmq!8Z}e}JiMH$< z*jYcXJ6RnkU1B5TBT-w`mBCk)BifFq8Q+IB4LMuRhmjdPKkaE9Onl@}j-L0(Jcywp zXP{*5m^l0HQfu<1&5m`L3i|%s9+lJUxO~A4!jNmg)IKC9?K=QLuwGXW`3@e>3zlSZ zcSscTr%-c(G?ii<3|a4dChEpnpX|qRvqsk>gwMZ4_3ia#L=pxs)6ocJaUF^Ov&o$K zd8bQ5god!fW2f!l(D2?R)+naprY#6-3_8C%oEZURC}T4t2(^!of1QvZk<gymym>{6bYRL|ql#t8LSS!#T0RB&nP!5FYB<+L&k z9l!VfOqE z8j=OF7uE-5?1fz=R#c?VSmHnhNoSYfeQn-$1>2;7XenYSz zMTWB=-MT~-sCkNTncQb(*5Y|=aEb>q%_rf!8){pEp7V$n`$`E+PO6)#u4Pz2g-w^=d8xAKp zYFXrGZcduqGS;P40rl7cmphukEBd6{?2DJC#^Y+#jgI>y_c5pa>Q)9X<3^s0jFt$m z3Ta7AO+yj{3XK9IVtaA`YY_^?O53-Co*q5Iw1bV2fSuu1R=+YXIP_xR5Jqz3JIft2 zO1}H108d^;EWX0ALFnXt#Sl&*dwSs) zha~ASc$EBQZZ2jD3OmPxfU0-w#jT_$lc>gVp-(m`$#h^vWrcG z-A9|dJa}i8@;YWs>vQCDrvSZsl7C>|S2JIj^c5e<0od5sSXjp+6I>hjW#XE($)z>z z)qT3=oNJEI5Pt@opVz5{&5kHd*Az4kg;aAxa!Y&ReM~A-i5m4#x?adF=PftMTG{`( zco|C;&6p`PO&*-qBXR(&j>|YF49cC{wVTZ9fH&+%@+dr@5`{&O2*aEj!@lTKd4?=! z5tjK$sZl{MDwb2(ct5eNL=v3QDRRIQZWNIQl+?Q&>oNh1jJ%H+NRD&87xIg4?0a%N z9+*!?pwnD-#pa_xK-}8QM<4CqsxNm}^mJ|WZ){FXDX*aopDK5ExU!db+Nf!$W=4n^ zjjR0VqW=(vEgze;*GV|e@vv54KDQB(D*ERXLH-QEQLgw@7xivSb2ZJ3MSsT-gVtrk zVwfB!w)K7i6*_upT>{5Mz>?NkC+| zWGSYaJ&R|;x1T0U$$e7b+Fbo22Q0Z(rKP4hMiwcwtkHRU54OB=`C<|h!{iD`qElSGi??3Fb!m!E}F3nP>W;K>gF@QwH z4bMN54;etMmu&7fyH9g||2brJmY{73+R?==)8r^Ru3CCb5Zclo5Kv&>6 zg@+6t{75fbD_n%2wV1{-96ZXa-SqV4Jxadj+x!=gh!HTOm4-f>9=;H;L{-eLuFGUv2d5&23GEg_9+Pgs`hI?eXavha6|MW){nPidS!1 zx2>Jq(v@oUsFQYQ9XR6M8O_f3OL!tQ4QEWOVy5L8P|UpUTh`R0JV{&Qq`L@@mm{uU=AVFp$!gJ-)T1W54KVA`f@l*+00o zH8p&8T-eBx^wii%A2BslVZ^_D1%>lu*gB3ob(RD5P?m6sMMHxOVaJomx}lM8$0+%lzCWS^k{_Hsc8QMyU@@PO9md1*sm@Bc`8(N+eEZ7I zJ57NYp?E9;0`c8xu4%+@I$z(g0y0&7Cl)|d?mE+pMi)EF*#g$S5qv$g)Xi{7{v#xN z_CvBN2B{czV#<Di5^r=ZCsh9?E=)tO8LqAjQZeCQm7og zvw{Y6X-mL*Xd~TE)IWvOou+qW5zB#^NT=(e0*BYqT4IWQs$&N7WMugQTP3Lh-$rEl zCP7K)rJ>Dbo}mLICLHs*oGCqK;Vp}jhwT8H1di0kuECiPD2geMzBW21SO~9x^f_E6 zejY&;=oU^Uj)pUkPAO*VSy>w@I<7>o!Y?Q;;=v+hVLr2+FD7(8zVWVC|GZ6hN@*qw zASC<^T4aA8!a5($UcyZ;NYzli!s>KQw1o-(4BJ}vF)!XxQ|)KY`BrcK!|t(|y)9>2 zyOP}~S1Do|84WcrJG*b)>dJz_zVR_J_EmSPyx{(?r|EaREGOH%A-LqQ4r-UA(qg+5 z$HR5kY<|f*mcbHngwr($hD$A9q(~ZUPHK<_?q#Ytji#MyaO9Z{qJ6b|B>90;LugI> zpSE~c7c)6+MZfWFs5M2km{D9XFE*N`n%UH{cWjgubus=aI)xSatq{8L<8a<<46!{@ zM#ee;E@22$WH!Z{TSAfM?c$$;n{M9o@Saj$?sIdXu5eJp{)R%ue{5F1Vmmmlao`l8mJDuF_a3@@-G9-yINc z32qbj1NPVJ)~ZZDhu5L??MiKsaES9BRO3yQ(amPjkelQzXY3@)Vs&Ed}E@b3Y0Ekw~Jjc z#VLj9CF>`%N0jutzRyu!7SG@I)61hVj4ddq0H+F!kIqe#B4`Iz+hGBR9tx&SqX)ft)ax|Ph_ zFv>j=KV-_*GSZ2mF?+N>k=1G;Mr{Rj}OtAov!*iD39WC*xYw1Yb5v@TwMnz@uX=syM}&d;uP;NIxZ>x(J7Hn z`1wkCixYjQnY&jp=aBrj1DK_0_Nk3kYWy#f7<4-NlOvW1ZAM&-o)Aqgb+fdN6HD{4 zZA$APS2dTf@)Bk;?_R8@<*c;*R^09-Hxb$ML}M;6(PWw(!$*7u?`~z1%hPu}i+@?< zwubhKxCRFvHYc<;{o-X{7H4bzT)PbmLR5pSD>G#6|Md-3qLch4HMg*mnZ`^_%XAh{ z+S6rHE$7>helpEc82}im(vSnXX}i@l$wr%e_sp`_bmw233;1*NxnI_s@(z=)bPgsksba&n!V9#F86C&w-*CbPKT|W7HcI#-%qqX2W5?p-|p{Cp34B% zUh`zG9$t=|M8HYHW~Zst`WR;swL~%ohUWFIworq8%hReplJJ8MyG99R3#bl^m(}n) zs(g7xE%p~I9xNzOBK~4Rj5F*H)kSqRpGdxHA)1%1;aoR$(b;d9FW9&o?0KHeZP;^T|s4?g|yMDy-|7(F}P1Ox@^Q zz%0&hU?~TaYC7$Vw(K~-1OW;nG@#{$%jm?n1nWVqjWqulwOPX?^UJSC#5`Bd@#DIx z@4UpwKS?``kwx_;2^I^48=&(K+#&6Ye3#c5z``>{K2dzgh3F~(fGj`N1yqX5!-9J- zMwZXI_;>f3DimP;;XKQs2x#~^=|b*Lmf#-JuRFdzIAVcdB1b$^k(Qf_`mB=tP*Lh# z4!!66*Dsz^q{j55LF`_1>OZz>{JamxT5CYPa1D6yM@*H@)PR~B2* z{VsO-l;eA{iki7I^F#dt+cGTtXNTMTV| z-Oi4&pdz4^CEBQLaCFVD`<(c`u~Bi;SU ztL#o|buQuk@1$#??zHOIdIzT0S`P2_NZrfb71)X;+d zrnr#3z4@Raj18AFI)&B$q#%DKe6a4|z$jeYzbV3h^%4vLI|F%M^jqeww^Zat zvrm!(28PL>)%jOYprXKhufc#=d+=`~tn$j2m%N*J8(mnUzc_Sz#xeA_>J_hHQbo-9 zLvj5J9R9z++0*?^^HyEw6^UvbQNg$Dvp3W$I%D1Z%5TwWdnNgeSfc{pAjA&__jlyP5%xE z@kSk7iKw8wJaYM#taSFUTep&uW1hPP&0a@((O0tg171kP8g3d8;uI-<2wFkc6& z?kK{4`~ZXSd=1PAr7;WS+u>ThV&X;<`1BU1v)ET{K7nlPw@x^}MsQi3aqGX9YsM>j zk8n7{Z!u|82hRjRKP9b}6qoZZQw@)#qtId3Ek7(w?sWNZ;F`$*4&WYBvUB$5u?eQw z%edfAHBW|0)?tRwY%{i!qjGloH&Y+^ z)xSqKH7V?7pA@&hana`-8Fnw}deW=uv?D94obW}Kojbhjq$jI(1Rdcn3su7^D`( z-FEMJIm=0RRJX`4tOCr33K@9ryS1i((!GeLheu_k;w7cfze}dqPc2IILLgr2{%`Os=06YTdE9wK?#HPjw8ZjJUQ3 zhFhmq#jH4nNBav=ATkQlqfNv@j@tDG!k(q!Vmpp5_*<_*`U!bHUTpK(^0_fg)$XU% z=KUxZdG`-oK8)yCSUuq;dRmGrPX>k2w0$M>E1ydX);kweZzt+gM&M=>O4W^MHN?eN zrwF+OF-js9pNHs}QT9UuC(@FkN4NCfhk2SD;nGKomRd+K8J2pTcQ&`~?QeDJYl8Ae zc^B*S7d9P6gd zonr6iQ+Tk3iJA9eEGS0bSP}T%vSZ5TCRT?eg7*2S^f}S<)j6AxzSmcl}C_Nc;?}Vj*5hEi&Hhi0L z@#asQ5!&mP7!>{Tpz5ZKXhD>JR`+jhox8R&zH&nOop^@Di0Fa=!m-i75mz0VNy1ro z`A2KH2p-|*VVGO@`-ZcTXuJ&=5a~b0BKr% zicFo{RxQuk5Q$ugGXsscRY=*8@4aZ&pgcEs-|`VXfvk$`PFr41N`BCMeLKY~Q7Zyn z^psm8S-mdTi)(UrIzbsTKZogZSv-!18HPufbUn%?h9)@bT**218FsYq%HxSKW6Fb_ zqu+rzf!s?^`<}-udJhV;3C12JX7>q~zcfH&ylM^MsW){ZM z2ND}8s+|yj)39#Lk9PG6rB}}+-Bub&e8-Tn&k&6E&xY+y2nE5cQf{RJ$oQ~wQS4xm z3Z8~Wsoz_?YTiN~iOdX`Yz+_@PgEIdNv(WIWv$iOr+aZNw-^DvUIzT?TbOa5bGQ1? z3ie5SDnp$_m48p8v2hcG9VB*6NQeH7VlLS}BLyiiU?k(2<=lpej#RQ4q#P;3ci)ex zxI3cx5?BH+x%Q3tyF0~ine3$n`^{wB!7Lg(!(iMM_lS{zARg<`V*>_DHJ#n%Y+GZ*N0T0^!I=zlH}$;I z;!j@G(zf^R<2?3o?gvP=d7>JG0D8a5rUyfVjb>HAP_WaaQY7gkM(*Q!u+ zlZlQQC0dbhIKw!Z4ws%k=4$s#7s}CnAW76i)UMlFX43mH3?p)?K2c@tg^=LoaG|_t zWD{N3xET|cuVt=&5t>I%nR6g`e$(LUCjX=?ubz;}@TFriGJYqHyM)|}hD+V;tW?d6 zXC3?J^zEv2x%kZT?dsI|1E!*Zm4b~?SIFdPBTd5dYpPNduW6&G<9{8^c&p zf0vQ4{5rq+RaEBM1W#`N3OalBi6>YDv+xP|Cm~LFA5LW?L>JATnUe@RgC)xj*k|+; z%h5(|;$K3Gd`z5s+-bN@HsMS5F0v*vNcEQ8lM{U~|Kxn1*&v=8WqR@sDhm}+>Rbgi zfP;Ik<~Ty7Z&N@lN}rIr_lBv7W3+z<;x(~vLdUviN`!lLhwkIW+dN(;>osN1C{X?Y zdXpn3UcFWUlpyjRus5{h7u+RyODoShY~{JPsIuM&m%CO?;l~|;ILhIUUmKMEffeCgn138{&OY& zSG@w}Q;E8Fco-{6mW}cN-&>a8XO@>n;BLJ~>e{SD`+8$wbfy|EOd2N+LrC}#Y-IuM zNo8Cyi;pv=13kxb^1ms!@@{(ygbr$?`G!lXn??Ss>_9#fA`;D?bcwOj-DbpkpIs$t ztQ)?dX_eVN!2h;X+g$N}N7I&PW5w@>t}~hKYz6C~qK|Ti!1rk^2QR_uVhrmn0p>Ok z66!Y4&zIu&zskG+p`(NS9wGG2zV=$^ioO=QV4Cmkq5sJqz#vLqGkzt=|6dh?LHr-9 z!s6o4<+n(-+4-=Q{y5zo&hS`VS+Tfkn(`mP#-{+1b2(lQi`jf6)aQ7kkb~~_L~rb4yMcSK z!RPcbVx+&PAFCwl$#fkL0 z-oF=X+h+*ES&dw~gHHYAoc#SZzWco4%XUpGrIm;JSfT$RI}1ddolfN(6o4t4IhZFE z%r9rBvGQ2jCsuKy^xOQe-NgvJ^?6OW+(f~w9(+(vjvM4ntt@=38Er#>KiA|jMO^jk zi;T$dY^I6%R&CQd&fJ%qznubuqNwoZ^K>c6f;*{ec@>YAeDyd zaO}-jG4_u5m2J79M`m!lKdbUS#^-$ZpUux(24bDK9lJ`_Y#jN=*qKAuV0sI=rD@I= zf0Y^@psm5O_F*6ci;W!`LoyRX4AwA+6d5|!s)+tsaoTGOC{C=>T1L-~Pn$Pa4xouR z{}=Dj28EHxN$Ivr_Z{@&JovSG0v=OQTf-^%5$*S=`a1sV%d%wux>xD~fwRpEUV}NW zrutfw6tmN_B5M{g*X*vTO#1oFPyd_pR?XY*LB*4sj^ECdkakz(m3pP+^<~@4P-_}21k|kDJ3*DVVZ?I>2Q#u#qr}N0E}#fQ>K2z z9O}e}F9=&jSFjQL*EpSR@sGuufz~Zbxu&KYBI&fFgX_<`HTpeje(gH4cCYX8viT{M z&JON9Lsy)Lt}VQvdQRAOnn}Ac}b=8r*pf5W9rq$ z1!>>?i=R=_t7ce@G4FIUvb?Upan>YB4a=nPx|H=u^7KX1nBus}2Eqlh@zOg#4ylLKGs+o#xdKo6r{$hZQ1 z+Xo1^Nb_H(tMnYms82&QY;+B`T35&zLRjOqKhh2$lA2z}EMpQjGFaKDeNt}hzq)Q1 z#J!)tC0t3e^Rm>3B0R^of4I1qOsKx_bc6(aFd7F1Kr5H8JPPyl56pQOX#o8nHIo)b z%J`mh>xRacZN%-hkH2K%%sIY*h2%DzFO;tUoqhZ*-Hg?gc588dY&}7ZZ_{XgH2Jtd zgA;=nH-b2S<>0_27Mh0LeQZ3f*}AOh<{MSWE`2||lt|{;l&W~W%~#udR8JSUBQ`pC zPbBfUn6|3$-rRlZhSId6Y^mCESvuEGDn7GMnm9a8Tph}7`wX~EnZf65-DU=VUDP?K zYU38*g*U4-q3vqt>mZb8yqeulwBR8KYo?P^W=3tF0`Q0{{T>`Ugr9|))S!7R5trzJnnL4 zwVp-jL+anCC_rhcr<_)$uRc#AMr>XmtYn;&IUY?2;b7_}OMgnEh#M3y9u#lTkSRwG z@DIh@wcXz#*o-_)X`q!7lI#IG%DaBu8)~9rsJS&~@i<*?5>*q^%#QGvsLJXJ-Ie4R z6Re^5+Uevsk~2LSvNZ)b75g1KaC|^eDilM2e%~cHkNNEW4557PY~h<&l0!%_XE=kn z%yXK0{GfaY7P5b#C}?i3BKOn0w>9z9Gn-kAHdrcpc-Pg`bQYTYqky>@+W7wA0<N6CGFnx$1+fk{zl2lb&LPrM=?U4Wkhp3c*;P+>3E@_ zLMH2QQ6ZOW#)4+^=dlWab9?Ov?@X=ofJa=K^2uVuFhQXanw5%OF*mtLG%3ZiJ9yJh zG3$+}=Id!pcevjfY(W*Ol}+vOW3x_<9=HnFj}F*|L6fsNKLObxb{QY>g1k<4Dfjya zjGW4c64aDu$@I|Qy9NBAf1%>}^`SJ2zlJH6mNgn^t`{{IwLFH0lJOoNKYkO+_psh& z*NCDUb$9xD;nY=gDyj_hXZNVWCDSWzOFUU#k^`L&e&UK-cgst`rkY7~qZ(U&z z6+U1cI1m|dGs)|HHkhgMFNjm!0&D_PJ$8m_k|J!JidP$Ox_N#ggS6B6K*}f18z;RJ zlc>6cp{F&RQ)!J&WiHOi=oA<+Yqh!vl#R-(ZGuZw?Ss!xnE=MCmjodni26Py60E*y$SkNBE}DA^L59B z8aUS0VUCpg6)Vnp69bhKya7jJ(F5qMyiKcL+`50b7I=yz73Fl*O$mBAFLKhy0=A7ggbQ^~d^9Pqxs2vKRv2sn3IXvx`F`+ObY1-&4fM!nK7Y-(aQRg9 z(8H(hhdCYPoNW3J(;`R17eTUWa`nO5tX&!LFm@)y9%R-F#v0PM^Uli|(VP})1-B-; za{xJtMHzHj;nP8NNl-vCZpmmOJ6+@Voua(0>zD7gcdH-9);(P6OiXN!{ zh}nLT=0C#a8wuO7Kw#MsVN$15! z8lbef|NcPrFKg~St|^=T&J#W*BupyF+&(UM^h76q1HT)G3Yp{SmV2M z0-jd6OK=r8Z8+)2I4vjpq#pUKrCl)y;rTuG9Un@QE1BzQ3c!kZ*OVM5m zgb&ezja_y_%x3An>pa5wMA7Ikhr-rr`7w;t#F{H-M86M7iznt1BiY!=A1ujLFnBb9 zl>lVXy`*FA11)g6pC@M!8A_K0s`0s3>}QMc%J@ZJAZG?NTWNmcsyM2IBY(X07iaf` zs@v#{-?&&DxV8)ETF^33_`dkOY0ja%-$tirBiv*2^aVglWu;?_#~kIdo%jcbOnc*Vh4JeaX)ma zhwiE|4#1WqkGh$*0KvniqRIy7sBCn)DST1Wb3(e5j~0vFw{UE9WayqBVf z8}@FgQkM6&ym}kJG_uGvakUb(&<5DCuafR;hZ!T}OUJ{5h_Cdiro%C(XT#tmAB|*W z6{yXJM%VV7n;%Ji^V-+G5Kyd*$9wY7N#Jx}eh&u6=Czh*u(a{PlBcf@y_h5wGgpNR zKgM&>r_+fUa*RfT=6*Sh6=8em+(*phxg%F!geonGSGH6;PA{~iw1H`cuOR9J?b<46 zZp+@xFHT*#3AyU^oy&VjF0yzlZfl)vFSmf1KPfpDg3nJuLFV+i=rjLXxk#Z>fir*-T zQF)oUkDlO)I;op?{-ISddf8m$-p1tuHZDE>X)Y^~g~Q|fdpd^a^Q=A8r}yrzN)HGU ztX|Zm06zTdS?Ns&v%VFtJ_f4Aty1j;oLb?n?!!`qD&xKum*b21P{R4km2ox2>>frW zz5=R6q*p%6z`uok`B<28)?&SU=2?)+P4TDVH%L;wN2*p2bfcw8;?9|cmSHo@VXdb_ zo>M9_#bjdP6TnC&@gJr~SoOEw@<^z*Q*tnwy{FdKeo1<{*&;5l>)lItt~!Uh88)v* zb;U`Gkf?9*OTW6l9UPP$dzsxGC(P~*_~x*vhJ1~uXJMNZbI)}Co?em#tWIh{7RIRi z#GG2T{v2sq>H}-EL-ETx8n|zkd(bNELZqc&v}X9AX>RZR>-FCrVK-iCzuLx1LD`^Q zSWp93_((KRUU5bqJ-5`sp4DApi|Jd3WYX`X3zYVuB^9~Z8&*v=TDY_%nzRM&&AWVx zts&0nomTs^T&Y3A+L3rvhwYKlxS2?=i3COr2K6tOkIXx(Q!iX$!CHz%Tcy*FO0)~R z(LkVFu6Ae3GPnPi;c7R9{yn3ZGS|c3KPE5IZlV)TmefoMU2M*))I)#nP}?R(M|vX3 zlK!a-J<(*Xof_j8Qq^HIcQvF9#=q-6A66y<-U)n3WGHPO;f6&76DgNMm)W&7VVp4JzRMXN6;`LuK~R5T5PYv*}5QFcEFUIeDWML?}I(yEsi{km~g7i~VuH|Go~ zH8%p9+I3cxph(XfH_&Bcpw{u`i&plxKhvoM!XET+Z0^1v5?Zv0A4hrL2hIC{7j^yB zi~$tMH>YkhlZ+J=aB`zG)xgF2Ap9*_|iDuB1XJG@a88dwnKxjppfp2HiztV%@#%y(~~xqJXwoopE3 zW=s}GB=BDD)lu`_?$kb_1ikX3uLtI3a@)eQ-DaX}y^bL)EUBCgo0}ZrA?-P{dm2y5v5N zw|oh)>sBLrFoq;%l;Q}Zvhn7wsnmrK!OK{;K3od zTaZA4ySux)OGp9)5AN;`K^k{=cMaCixYN+^I_KVVZgRixe^syQ)q7RDDq+>$d#yc| z%{9lEv(IU4`>rmX3z=#*-~2t!(LZ&3z&JIpk~865R7?CZT3PfCeQG`dvS(`Dmec5T z&rl5>sV80r`i~R4>WlZ(MqFpb`=fB!&Y$4tVB40Q-4>+Z1J%6J2HvHBZwy}N z#(%8zySm%kAK(^J-9Kjyv=?u>9Hg;DJ*OZo?^FDbXYA9brxywjW8whKiwX6#;iK#t9;$xubr*PET9?rTFk8Zx`=g-D`QSW|-t@t5XU^7qWt@l9 zH}F0}!iCVG1%ZTas;v(FNa;{{ipsUE|Xya~MC=xqWzw z6aPWn3VQc4-)+YHWqhNEgTR=b``&tz<%b^Y1N}mL{MB2eC3~+)UwNpHMML+Iry4QPRaC|D zG>~V6nqw#(`UZHDsmF%2Cl?0yg%00(yx(M19X;r$Ab1%%$(5BW=JI!sK*8giD79k^ zZu?*(NJ9L_yG1&VS`Np#3)Ly9FzUxT+$XK^ z%mM(V=x%=-6?y+n#p$ytb*|+wJfY@35*O${jiB@&u2NdzZMME^cZ|&$I!QEuwiumh zjr%ov`6JpLua5xe3-%ZL^~)CpAkLuBLJq$DUFZC^? zwrUSFLSMn@!{+LOcT+(|_u8{pDfI_i`SP}FmcC+SAIF(Y1SL~rbU)Nt`0~%&4zIQA z$pORcP0q3Rvv3{$5z{ck8Fh(XnmIc-RNsT0GVzq zi15Z&Jq!{bid~n>HXEGw)Tn&98&VmKK^eO4JH4np^rM<}?$TEWV=Ch)__aFsDq!_phlyq`rT$kB-LZRT3%>tbEau6aI^l={1aKzXXU?r z#tnG4`;7S6A|mULGKGq(dnq>NzZ}>UBA-bbJ|5rcvPyjZI~Tx01u6Zy&x+*BtE;O< z{=MS{`x6RxWvTVK1(o%gqDc+We)M9QgtW96Omk$1)wqL`6us#pzV(^BNrzw&5tAR- zno>XFUgu4biJEAYNzTp`6^uH`N^ET}E)GtivyxKX%pbqES|DjEGsc$M=X^VR*GEmS z^G#)_aZsrY*9lq)u!3+Cu zk5BgP0as_+Kbym!KeVHm39I)y(m8?GKjmheOz9)X0^O`$WO)wKw^nUHEk0T$#IojaXibh=_<4R)pvyb1YaR{7IY|ewZ@?>;L^+Y zQ)14#25d|4Bgfa5-obyIa<|rAhlshm-_%*po3Lqmcr>6XXWLAFnZ{$*OJg$~+StnV z=s}Z3IX-IOkZRt1a?|D%lPzUZS(g2_X2PZo2EVip-^X~b@Ll0G5dkg+0dWR8b4X&S zSSfFWSgu-WY)lL#CNuS+ZeOs*OLi^17f=h}Ul6k>WYyHL3kqh49l**Pkiv|?a42yn zLkKFJqrFZwd}~$S#!sEq0RV-0c|2%PF%29@FE;xh*(wRr1Sbmxn%X-X@_kP`RGulww8({*l2z73D)RgSuABER}m6Z-0T)3LRRU}1p4>ibZ*|8yC2xJpCm zUjtpV%a{Kd1kYezL3O>akSPB#PoPae*Z3vj1$kw0|Gf(T`X~p4HyZ8={{%<>MV)v2 z65MLc!?yk|xcwyh>_qdoJ3F>8}$x8F_|9UbB;m`kXr415yJts%U-;5RObyTU1l%;Lz&zm>ra z243Oxr^sKDW}FsFx&h>FK>^SI!CnkzRNtrhI%zX7c*;z!;&iVDHnE;Va%~kG&+rTA z?$Ca(UWax0`g1$fANRfqul-`p_^}l4SYSfWM|>NLJ-2~vRsHyJxMTe}HbvBWyU4L) zM26Xe<6vBjjG|3Cg+`R$W_B@qw=J?*!fKq$EvdeJZp`Tucxh==GLWcJ>vtuO8PgNAPL|)DnG8BB9AIg zJznI-Sk0>z4~`6EVd?rpN_D88$}= z^q0tjzoYqDIXvE;OP)9OgNK_&K!+p#J96#}@K)`Mfv*o_lJD>Fn)YdPD3IAT1iI;2 zsQHzSwvy5NU~6{mu5()pmY*yiEU(W-7`1Nc#IxLO!Z+TXH~FXO>}i}EHi^+J6&7ed zo`VP5>#svTf05p$ei|VWjZzDawHx%`!4;8FpL@t&+{l@#f1*7qKtmBqrE_+4`Vicd z@i0uM)j9K*Z~mZYUxenSJMiviTR^uQQ9eYHCa<;5+lAt4Xh0c zN0Y?*WB{w|0`5(?C1DZKKT`{ZY(h`BX50RV=CUaTO|G2j#DbI@gdk^mRN5e}ApQo| z6)Ew`j4@rYZ3;54))`eJQiyS(AI16Z!g4w3GS%MNVKh;wMM-SHSbFN7W)uxsKYJJv3xLx9UF0F}bpPdmlFo4aerUG>Vx zD#3)NBEo;S>sNo@zjBRT00!68w)0uPWspc=PnkaG<`yb;g3}hq`f*=P=5}qJG=lz9vYr~~1 ziAiT-uC}iS)9GhS&{)|t9G5=a$XB`ALet(n?Y)dZOQ8fnn!=q@ti379dOa~!o`cuQ zf@~?;fyU(wE#JM(!?3>9diGwM4Yf5+n8{B|&28fTgRJ+aEdmoBTAqP^FNO2U?{Y#D zP~&;VkD4pTmfI(PiT#YgH{Hzhe)5Fe>=R};RQ zeic0HSXsta=~3ER5j(P}{}T9?Jrb1;okaQd3U~~MFnh2HAm*$8GIsV6ZuDvK{d~VA1TUlN zJB8#;+s%DB&OEuAooCZ0F~`1|_NN_xLY$|E%hqYj{5tz5Kfrm)&rI%he&5>lp`SU! zio@rh*NYGI+HY2-0bl(uEQk5clvs4RhE7ZzCo8VL*OyGne5RUy0GG`w&e}=IqdzT+ zPMc?dkmO@W3p1@bui~QCYWc{f`2E_*sL}-kEc_mU376RN6s`cdwY1Zn!ES(kv@bNa zuE1}}2b67}eo@Y7QML468W`$aF^#WRc!p9r3xM-#3e@e|K?!d>3fHS741&(UA(8A- z=Uh%ov*ULV_(l1`7y6b{W%t?_q$yye?a6lh*~Bt-UEI_0XEMu|L=f!Ci8};k1C?0F ziRM!`VPczFsz_HiE`7}IG+I*1b2H?VGUL5Y#8#9bDv051beoQ;)3PnpN=z$0zXV=-mabydGAY;Jg#E)uK{TaR@v{r zDVJk}9XC5h%azWiO5SP+-bqZ|*yL17ngG7VM`2f(poPme{ZzO*3SKDT=Q=K^bU|Sp z!3<8i#CdznUJz?`p}Ky_QPjVF$FD~;{mdKipwtg{JTV&L~M8fY+vaFrm*fd$q-Yaw)BCV^TH zH_s3?|K1sYN$*%lpms*TD6#GD7EA{$)F2^wLx%kKR`9F77K|zl2AEFT4@(~7P22|q z$bXAmxM85VXq%h)-@RK&6&dhOM?(1gdBEZWfaKh9G-5~W$X%(TFh9vDk)73h=2X>XXkjY ztmiB6BgC5CcDNQ`5Vd-o{X~%RR+;%_MfU$?MeezIhvxxOFRvZAgA{-#604nS%ehBK zz(%XX>2G4T6}ps|lM?BIxqMn@yihyMoDci&WKRYj&j~80J9>k!p1u4+)*)?KxAg7X zw@t(}XSm0PUsHvkE+S>Z0+a5DGo{rd;lh@;VOS~0ptE*+;zO~8R12tM$vi?aWM;qh zi^1w0Gy3&!ct22mC;CXbBjHk1l{>%fnQB(U%d-GV_DIaPm^Lz0kh-L0V7h5}(%V7F ziF&VxgU~So4K&NR31v#Xcz5w(1QGSR4SdG5j}~FiCp7jh$YC7;yiHU`zTHAV>oY6b1aP_JIy8>UO9kbdsd>~uo|R* zVs)+~9S-;R?1Ewy0}a^AG{M8}{_R+h^zIk@<8?g}zYR(1hG}aTLLH@R>86#EjRek z<0Qe@RQ}cf3vT~!7WGpdNmmIn5r546eT8jUgT~qE+p808{T(k4J&Gl<{K9f1Uqt-3 zpt>*DNR=)lr@3F=^?sKO6MlkzmFu{_>sWC75mxZuLAs z#A0eLf{WN#IFg=+TVoP12yuuNO%^C++@7ZK`0YmtHn|0-49uMfwoqphKbx9Q{{*>y&2k#OP8eYd znmba7jc=B>8>wHj2e~I!4w6p7c6^dEf@xmp&Yvuzc>=&#v17P~la}B1Hoh#*?o5en4SGCPu9pzlio93D@jH=O1m#P) z?nJsWZxbyQeKY1~Ki;pNe|$>Y@EAd1NYsy9j_=C%uH>C#)G)a2BRpzeYvUi$FX?p{-u}8w(_lM=O@fVLieRo z1sYn|=VOucmN*!T^!grl5p^)Lld#N(-k_FHHDPNetwzVKhnWeeYRzV~aEM9ot$KXh zkII;V&^aN1;+osWJpWK_t;^XLZ7!zzN5ZKhANxIe@3^bzAJ(qB3W)a_k#!$HjD-7)?*Y&8nzlDH z@%DnIOj)E%T{FrCij{t4Uwp*OTCd zwZg({D^@6|c$~hmd`i&()Pxi1_V&hhEiJvqIyvoexymQD4g)Ou>}qVZG(HHz%pAMy z{1ZfrOe6r#VBq~=U#eQ7@lL(O5)3RIA5_oeuQ+Ne2OTDUEuz0EUrp2Pgm?=9Mbx=W zR2~u=_G5prncA*FO265}-G?4PzYYy9C2p?0IrKhk=WEg}=2Q$UPA>s0A|eKsk;9{1 z*(BgZv(ASGa`S0@=HQ2UoT=+L=}H4jZ%WOP8bl0Kd|@g@)u?KpwVpl<YHkZT3W;C|ApzdPt5kvb<=1)SP9&x1#;ho z=Y9tO3E$PwC*tB!5zc`7y7?Qc7>sv1Lt|;=NwhNGyT5fOQN2nX(*anYJgz>)8S3gP zx0o`I0<2+$BD6~9Cj4J=yi8^=-cM+ScWd?8*tnSUi14!pRQ4+#@~J4cJ!yi@a%kK$ z-)TM`D%r_vdWp#s=xr4Bs%-9b*f40=EYtRq+H{>n+_KtJ2diYEwxJTgRAUguLzkFr_bgW)xz;N!MZCqRv@A0 zSN>k2v-w_8Vh3MokM*Cb^dD2 z7O&j+()BMxu+6u1b&U8bX+~yG^ob3GgmK#gQQeK85;N?_X?s8%{dc2Y4FB; z0NJ+kg+6q@^G60YCfkD{x*yw9X{Jo+_ADRD)aEbNmqY5?x$)%%0cO>4=wKt-V}rAx z-UpGsMl`{sYI|J)%PAnD0RK!vb@qp75q4TB5|zWO_2bl;_k+VGU&qRzL~MHN7urzu zM~BhAUZ0HYgU-JKiMJ@xc{-aYR0@Rdw^^2ePx+zkzPIxfr0w@(+V^o+2S0rIf&SXp z>I01zmo#ZtF0AAc1EGn#!4A>*kb+VB(4P#|oTdJ0R#L3ewGNonJfAyEsP0s$ft#R??=|la%r|tf5u# z^XXU#rn*wSs+%tl*YU{{e3KRO&4RRs={g6URJh9B630E+R(;a09THj3-OY{gsiT#e zB|#r0JJw+e-#KnM7mZF7Oa5z9+&*_}t>lTt&}I8OI`B`-O-?xD{;AQ%?>b^rvdsdt zVzkjNPGDaRqxPnOuQHaJ@eJf!J<9mt@uz!sUp>nV!H`GdwNDCSgjzlU&k#^JU{(>o z?60zZi<}K6rB1e%te*9G%PtB0wB}{YXvNgVMKK>=U>+`{;vRSgn@vKcq zRMgY$)~zbCIh{$Y@1CGBzv_kE4-ITJ6D*&BQ?Ctk5VLegk~{*cx*Gb2Cn)je2_zsbHVP!0WA06(V3 z?OczW-Q zQ;q$Jw%B-RIbOBTem-M#J&T{G`2aMz0!TA}(uBG>Og+_g-W&C;v0 z=|Pw~Qxnz0F~FOFuXqqFq6Q0cGg*Tj&7Y!QRd-4`wuY}%eFS)WL!+~e*GEgH`UQ1O z5s0 zC}IwYalE}R#TITSyJS9k;q7}b7*Th?8=RMv*rUy(h|_AWyEiXp-R~`>5lYdxd;*kP zs-F}(6LiH265`{q(2WGKmSzJC1fiGv_pNwa9#A%Jq1CM3bh4++0 zj114)nRBKc)TV+{1u3I4EY}`9$W-4wjC9HaWD1eMXE8T3{XurT4GLs6bk$EXR`Zt5 zqqb;K=XIE)>)Z;Ul9oK#>XQVIQ?#O(3R1s306Kz{&7Mt&!;9DaY7a*$=$Mt{CKm}4 znt7l6_^IU6^-eul9M|6PPoiyylvpfMT>A<*l~q+P9l|c15FY~{YA&~nyCZRP^OiVp zZtA-CgbOweb_Iq$2T@o|0J$O%{YqU)?Kj4^uQ}XjUv73P-gEf^Mr1_fl1&3yn*sa~VJ?vi^~*ThH0$l2LB%y&-9YZ&iN_lR&J3s~ODXq0YpJC~>OmUt?pBR%v* z&45uSG=c4nY%4{?m=}-$RU35gHRdAHU7y?gZ4N#|EVUbsgUIodnEzxJos{`gO6SX?s&D|vM_Hb%jZ>~6nL(l3UL zH1z53<^w4R(4aq_z*}-G)mB|yji!Z~_+)ll-WukMO3FmK_MXby;u44fsNX**&hrH| zlO!6<=>jlO+7io;tjFp>_feaS1`q2Z%Y%>y9cR*a9Bp`Fo}*4UP;MmkS5Jy_95*~1E-;_J zc?R?Aa_~q0E|b(|I*d!LT>DjIjnu7M3jNu0bPMTcV_w=M3oy@r{q>p%&SYpWQ~gzB zwgEQuF*LS-NB@q?_XSbaU!ar!pR2764PAiuUfIo0;y&M@rAeEKKOTxQ zhUFkaPLrK~u;BIT-HPrBO3c4|@^9z_D4&`C&l5fMSGwPxtSC%JZDEaU>1+{;O@t38-d!2bMC??V66 zVL-L9y*+c4O=i{#Dtm+YN2fvLv-nv->E+8ePZkEx|G*1{9A?#V4u0~K75hJs{2Evd za2sW4E55M9zhh3~0OK%6dJ6lj8~!&0|Mz>3B{t?k^Mv+mEx8N6Z=ab%1Xmqd2!H#$ zPnQpr)U0`PBJB@Dv@@|!@3;F z3@hb3wqKWQb=XtiCiScI3MVHYjX1Bg*bLFpv2bc6)in3p&$83FKecQZ;dr8ZI3Rv6 z^mAHk(f{!Sq0`>S7wX^|u)IBe9@yR6n-9818M!IbjaLP@YtGhv-gW{D zvoc@(JlJ)&88A~#<}SCBUdXxHirLmXPOTf-a}}<&OnLLYQJRr;jYgLWoECa)3EELh z+Ybla;5&JI7v5;2=t%ZEy%yXn9~!H!tzM0}C=VU#W?CI})XhfY&y^{*%mr3(kD1#D zyiT1Ir2-t){k+8-E$%L@pTe-Wb00`X**=zS{U{D+TQgN-h`P?mN zeREiDiam$yXp33%O-eqScul_pW%LUOh2Iy8VM~CQ--Mrcur}DUiS5pWt@pl(mPJ?e2w9)3!d8Q|;Jk`U)d&P-S zzA<7XERGQ>O_@n3QO3koEig1U>*Ot)(xV{o+p*MKqc)Pdo+ZAuyo#L5>3UVTZE~dF zW&M3*;%L0OGDov*txk(Jj%cltzuGmVDox)|B@k^E*UC)IpU!b~OZ`5sUq_eOLSWTB zSRZjZ#MYj(n8nmps^j3qW;n1m0rw5lJg1fnc-GK}8NOT1Jo%0caafCP9p7zHX33Pt zo(>otEu3>SVeDZEhZTd zSs=FLr|cOZhev&Y$kVcJAe8CSkz3uRkkFA<7wGI0-~H8#rnt+0n53zD<86=r0UrUK zxgY_$8#&G1EoOCM)fVrrww&W(^DUJ)JCYper{#x!*_CnX?oAfMdMUGsJY4yVnL>p% zE5>vxJ7P}xaWQI{Ohe3ZmZM8|-x=ah!WambT+hvuWqfZ>H?HUJXEn{4NMbXHB%6;8 zG&1qbBIBw`4sEkb>l5UVA|rG+9l--j6BCDT)vh4*-%$BWeAH}~u!< zp$59q#eP=rsX!3)_3^fV>ahE)hHK;tZ4h*uHZPOb@4^$Wt~a0i`pOEEUtR8^O^5(6 z-m{x3so5>06e8N6h7%U99;FeuOJ3Pj1jg_6WFm&z%^YTAO-pGWs76d_3@vePUusFe z=d`q>7LCilJ1nkKJrJshR!hupI8@Lj@Gs?61g ztYF6s_t>{~FByY0WwGJ8Ids@Xa}5Jq*eA0k6SvN%{{Fe&X|i{ayocgE6Igg8g}ovY?rgaW1JE`#Rp_8H7d&(YpvYh)36#oXHqeirT@(8Z3HR^=A!ir zfyx1f@rAq>yd#508k1^;88-#z6Y!nc$)1v5r$rh7eqCHT#_Oe4xw8+B%EX{Vc^d0g zsFrU$V@B5etHeS*)#*cPce`yX=i0h}wY|?qNqkmc>n4h(R?1W+HSKg-Qm9=Gkw`74 zHKL;>cZxH7JgW%pk1AH&a@!a(jFY`|O57UQW-*JvF{Fz85SnH|s{=elxZ~#m+K?-H zF^b-9l$5Kh;N#~#a?Rhv^{brHrLQrLa-M3Oo~L&W0m`Ke$8Gr@z$7mhOv7CPtQNA*Z$+aI1uTJp)VTJ;QEpiYtQ@;PlJho&Gqi`GJnA(18qF zf~dAJ9{f{{(on{YU=yX@!NKNg0h#&=wHoC^@qvKyzSTnu8>5^h9j&Py&d*TwH|xly zba92HU3W63&y72o5@57eN!4H9y~bgk`v7uh7tp8+V6~)R-*Y#KxiMNdhl-gwqrp^Q z>hkEhsfR(Xic2xF*ge1Ov+aAPpDyM<=|n@Gh}1n|5+`Y=F;!3<82qrump0jaDp^$3@0sMRK>RbndIf( zk|jHPh80JoF+%Lbkyu zvO87j;w^_v?Ni`m{y{Wy5>>HYg)NHl{4zh-X*0@9#y8@4(R z$J*`Bsbrt`S>`FF?!9Kdx@q)6=I(n;8YAP_YWvB%yQ>||H^lOTbRyQc6<5nxGW`yc zp$WTPnS$uMT{1Uc5Z5?RTk$G+nHdLa;9lAw7Q~;FX{6{Lgv9q}?3#-iWEa-*ygOY6 zTDco`N!10qG-Z)ywHe6Z;&02ZU0(!f9+z6{Y8MjOCyD-KFzfr=*W}JHu`hx3wfJ=f z>H?MwJ77{2+{jjx<0QZAOyM7z%TZA^rB7G5(JIYgF@;Aev(Naw{4_pV zC;qz5Sk;GrYu||!Zwk`9vA0o-6?M;n2m*A$Zx%F7V-8@2ig}RKYTYgu5H?(s?$x?;s+|W`=wN6YkZti9QHvH!3ZU*?YC-M=tIn} zvTaslIK)iyBDB_$+jNFxaYlBR9cE`DIJ8E+4}6qHs?TF9C^Mk=3yds|7Km1F4@6Vx=S*;cD1KlAPEz5%mXwIFDtR-!?0b@^7@G z;`-Y1eHI{%QpY)|S2;VI2BZj7bVq@aCWL#^;Ghz9<|Q9ad9V$pt( zb&k4r&65jh_|C-$U#u`mr_X3kwq_KiVCpL#d$~h?PI8{wDR;F^Qge)-Rp~6Pa*~&a zPJ{QxGC_W80ME1Faq7*tdkO}_dNnE>607;?;cHh97Xc2}sF;U~U;Aj$x{-@2E5Sn&wGg97|v>(2rLvFYan|t)WeYN$J^Xb*e zg0VIky?H`KcvaD{CS|pu5tY=$o}L``ygSyY_gARJ-o z2Bq`+#iyozDVk|Kx=p*~yE;wI5D8+nuVdfZ1`yqi*_DqH@J42|VQlLLS~nKyy;Wt` zvc`+uz*;yL<=1Dc4cj7wJ5CX%Fn5i)pBml6@$EE~_r+3vinJqMmO+i5F|?D~f3GBX z_Hk-1ncUS4Cp0ihyD$&AQV~LU&*&J!#3e)*quw`mrtpl#rJ?uBJXEW!UsGifl?Aj5$kj~)wry9$oVVWQ}$x`lH&dW-8?AoEcnjAljUxWMC09KE~EanWIG^ zK~Ip6Q-!c!_KtaRbz~J;55?%(3Hl4K6UnM;A%!&#m#VKvjXtK+CF)o`I?=1X{W+`7 z*@WS!$o-|IT@`YFI=WfLvMUm9N6R>vsFhS}91C>v(8JS??l8gD90MqB2V-tpg&o$dW0&g1u zhkKHk=jjQcSU0EjP{Eg1T%3NLO+IQ&%<5z^JHmL*u;f);^D52@y6}&ls@kyg3=nhu zi10CvoY(1;bNft7shN@PkS@-)t~SfyZiaj9G0a1qA-leno)TP$JEv8%m(LereN5nl z@;nGWqEPNIXiA@_Y5Buw)8sZ6|3SaWQT1U>-3WzEZ*3`^A}F?IczC#GnoHbP{w_OX zR^60z9ixtyvAMS8!A9=dQ7<~INY+L}Xw7`|L_1|siH=E4#(d3 zdC5zbfP&Tgb}sCP5$squ`0Cg8tA5?RNX~Xrhk*mGm-jZJ`O#r&q;jlj+^NX>;gkhOv%41#?R=y$bm@ZWVET*j@v!r_v9Wh1a#TFRA}yus*y86fyQ#Nv!K(iJ?xPvz zvW>ueK6A>y>dUIla?N@VZwGS7^n1(m7R9glse1qhFy|>d**6O)XpOr6*jp{ zc8k|786VYGtRb?INXPr(1awOaLxq-c=V8F18$ur^9nM=o?sXGJNLqMbB(~UyQ}jGw zjpnq0T0@7Mpr&E;2gm5B*N~Xcs=3v@4-)k#qDoK1Mrzx78{r;~F_UeUk zDk|7!J(*#KqFbEpu0))LX(D?IUxlG!!~qkq*F2`P4q2G?)+sQIB}Yzd)va~`Ccs;K zVSm+i z>NXz&E6?O*uY3naT~;Sv9}5!#{Oslw+@d;6m(2%p+vvJ}P&jMeQ)>~*L=$zlX)thC z+FzQluM9LDiZn`CpK(@msvm?qW^>Lx(%O`{>l_KRAqnlVrTfmSezA#ah0NpR$+$XqX0m4xT2&Ee`;d40~^|WdU zRdA4$p-)rQ}i=Wqs4o&kj>?^B(PCeQj%_-_8j$B}wCsLrrk$Zh}%0#L%sD8^tnO2h?7wiJx zJ|AxlA{~(1B<$p^17;4fdJ0NGgJ0(@&lUUrm4$%?QT(6a6G2`R>E@q8|b3B52`j zdRemNvs%MK25)0e3-c08a5BEd)-u`@@32$8U#+#C6N4eV5qgePUqG6Yp5%hI23sGYX5C|;#KS*k$VIQ3r-6E48Y79IH~2raOMxOMeEQL_vgu+QAq_0`8G&Rq$Db za$6^)=B1 zh6&R^xea%im%V=wG!yI4(wiF+;io@~5ut=q`lt7-f6ykE+|W`;EBu7eAH^;rP)>@* zKmp}X`b8F6>VNY5@=q!)9Ua;@#Mjt=w#^^Q1Gx73bXs0$H8pYq`H$B_lip&{$Q@== ziKe8cdKVcz8&jOx*FmR|SLwnP~^5Qp^<{4a*^fP+UDpj!CpSbk@f{WFl=+BoNV?sYl*U19@ z4+MN=pa_t{26_F#F#(yNApXDq;(#{FQ_vMCg4_Pu6b({L2*rL%eEs*v3y@7HXx~RI z*0iVayH|lhUrw2m<`R;nN=&9RQzl}Gqv~OUo~g${l~bM6w|BA$ZsWAaHg3D}cfD6K zf<~e9Dx{T&t25KBYm-QSBb8N&@V)SH_Ha>ME}o%$KHf|h@234jj=`Z}a$aK8%OVgSjA?MpVrXvm=qR(t>Xny=>sf%YGF~{J zqobkoPfF%qiNNu8lX=;t`|~=@ttiBbcH|lk924%fx}Sbz0doJ$yd|tt@clYz24`u$ z%H_O&t7C4y3Azb*U9*zY+)k(d)KXBO{jmIlGoxainT<~USy;=+cuwy*KybK*Ic`1! zeE21B{Gt~*(RPI8Y|1mUz3y;TNv#gVjGSniBsmete1G`GRAkH4-dE4e-bU~WdQ3mM z80IoV5~$Xf`^bF15zZTxsCV6{>wtc^_?`uBxVnyPXE5BfE%A`1!r!?NbNznAdVoeW z$OrcaSIvSEsY&n-j=n4^af-_2=O`-MfvOfVfa~A609J~pLkk7mOctt~L-e+8+H~-p zfI5!>+jrUF_(+fkm*A1SgA!hL#;&M1f3_ZGTXVDgtX4`$>-ZeWz~Bm9oHy}GvZhj+ zr$W^xR(pKm2rrMYA?Qt{&aytS`v*!g(LUoVpVj33Cee_OaCb4RdrI zTi>0W7MQY(mOq7{mJqG=#S9m z)W3s!fx26qQh952T}wS4WyZ-J%&AY*xiIlaF@55|=&iAM*n!=-s&}cxUN0r%1%xzv?Dl1@ z&oyT%_#{@ZAgG^t4ifdf+OmlLCqD#OOY34*Svki(Xk=}8k9o-eRy(X}OkUTCQ<)8k z=KdH+KlOpi{F=$CF8lbh@N=E*tTFOG>lrM})$A}O4 zh8EZFX0)uOEFA3|r7-3)KU~(Hb)Z|`FpQtH^2`9SPR-gDM^$XRE^HtpG?d_8N=a29 ze(q^%Dw0cLG!`jYBj+-8%x!i~+gjQ}`^nJdXcG+f!ozdMwe|D62D7)!l+Z@VrmTw) z@W6e2gSENUl>d3ei=(ICEN#a6{M9(An^uL^?Sb|%Vg7Nr>AXe(OFb}}PAP_NSg@lS zXSzVbnLMF}TdrXWjpy^O7&y*Jhs)UB#z)IeS;*F{2hBzwmRa}-FGBs4poe2foXjju zYuHAWas=eb`xDW7w&sLWX!!NV@z|bnu~0>(F+t^l*HWLm?xL1#zVjgl-u_260voWq zJ8eC$RjKoTb@!D)aWC(hfk1+j;1VFXyE{RGLxQ`zyL*t}?(XjH?(Po3-3A?WC+B~1 zPI9;I)_%KNOU;L=8K(Pb`E|d~tH$rKp9cujl38la*5(sE9Og=QLwMUT#37h7zlv|U zA@=vg+51MfoJGowJ)G*|q<@GVyxZg?25b@Q*oE|$D8nQp^E%I!TwF8wF)}jlUd%u& zn|G$lWwv=jJ0VnacIpMlS=^Q=zuiH)B_A_er$xO?Rkpdvtfi41QLbLoOT&ALYCOqz zr*)kL+W&x|+%EN#aoh{*TM`Ku{NBlqGrKgDHxN)eXJh}tbd!~nP9|pa49%?2$GJ(i zBrKtTmgv`|?9B;MT#mV))JEZOs`L!VBC=WY-#o0>$E<)x6{bu({$Ob{gXnR&x~?e9 zb+*T9N(G#)zepb3DZ77^3+C0lVdqvXGJ=+EKM9Kv5xKSRZJE8v(c7tl-s&Aw6V!aJ zgZZ-94x#46+S-v~QJ4JHnr5aWPlPx%hEp`3tF8MM{Y8L~SH)Vlv!d+2(R;B`acTJ?ovta>aOndGk_Y zqyxR%KSGsV0AE0wi@|Qj#Y~_mFXxfMbKzHagSo^ihUq=**SsY`hXxj6W zu9(Cy?X27hJS^wmLb$5gY3VuW0xKtSJ+`ebU5a=fxVB>Mg5p&j>T1)-H8hx8DU26Y z(^DxZDLJo!efoGL8|ugPURVu~-6)rhSWHgL>ZOLrE4B|5 z5kmkgjwkjv0|!}NO^=YK$S*sa2LVr1l5ZN5`PE|cnau^PH#4UVES8p9L(IqF7vp5r z9@X#1${&p}Jp#nOr#BL!xUj{ptw*_KB*Z<)Q}XH@Kb6G34Wgis%D1HSNQGaef4CS6 zCE8hSByPx-{AY#VdhtCs+5b`jbTVCeAbk5eri$8hmg}3Khy-QK>YDhxIsE@Z>ANhs|%&;7-ItT0kz1_|J zxfZe-aK|wIRTvS%<$}l2a3`ek?XD(gVne0f(oFiXNy@q;pcK|w4l3VT{w`Ew+xa9G zlJ}U6`(zgC3|X!01zHh-uJ{_&4{Qiqh5j?>-C^Sq}uDym$E za624_bZQ^7FK$q6cs*}>sY0 zGVa6sL_VDUNXH|BSdJdQOA>npnuK9_z<8#Z@ZfTNlRljqGc?041?mb=wWwLGBcN!W zk-XJD0$aG zn23q_v$4aANvFPnF>F0q>-%-R{l^s$4g>t@(d)o#y^H^Sf&TIJ|I9yj2;9Eu^n*n|l@#9plexTs z@(x5My_tx@9~~X#mYa;-1?75DfBy~cci>QPSl~1?G~6FxyR=-O-i`h{F7B-VE* zpHWs#!2ZE!{ySH`S1H$R1hB1t%)^8Lh_$-@&o*p@2=(al_hT=obO}wVV?YycMCq+!#r>@|kDUB0ylMA)h z5$6Zsw(97<<%yD-`NzCic%EEBj!R|-{K2k7{Qjs2M6Rck6_fCP&-4nv7uR+4^}^z*ZSJQG@F%W0M*-M*eD z9=1$qW7{jGYWr5vi@~{-AY-5Fg-!2VC7XMiGDS^n_OioSa~K82jb1bnfJ!M_cCGfF z>F=%C;V$*#`2M9?#I=g-&kHcA2+vD5cgr) ze`H5oV2%`9TnrOi95uJU&d=-_;F_&akl3t|tgfP?Mr+|)GLGh>Su#IvQk!26+f{zi zHOT+OSY9eEU^U|IIPh%7@BslRa*cUJ?bSZFXkr z_<{=^%MNEZ%~y^3VXHO031}U1uwvU$x2^jia9cM7ZeRW`<4W>;_yas>f@* zTmc4cu%o=!^U zJ@7D_ZbW9c7bKH);$JqdE^sVAkY}oExR|;3_~XozLRz|5MoZ7$)MCq+^><#|^5QNc z)v`EG=1C5xV>`R`7fpPxl^-u%M8O{M;A%U(CUiR&f0|86si7EB=XFd%Uwi&wtogih zu%)WW%P++{^(4>%%7S2Qp-=?!&)V9Yg@>N>BX2Qu)2P3f_+l4rxB}sR_n!>G3E^H(MAszw~x4(6K9k1}MKqpnNQI1o>r|P!nFE2iI8q`mblHvDmbL6Wr(I@Zf~=s=jXm z=GTTKbc1ov)Z{ODlm*Z?1!CIWTSR-;s>%^J;cYOP@cnX;DD1X@E*nax3h=u0jBTp` zj9JLHSh;1WM_0`KKFs}B>CMJLd!phYDkcy4TEwENA$^$_jo#wU*oP=9=oIFr4N`K4 z$B5v<7j-)+fh8$QjeEv0dl%Pi1=naCs5~r3nrd6adv4s*YVwK>n1?)0YZ|6w^Ch}p zoBZ&&#shjF#%3CeJZ2JG&}G}}>=rAMJp?eKT>x=tA(O-W_4RBDu zyXlmDe-qjMysG(fSZ%rPRZ(vE`Kr2_=0eHp(0BZny}!=glYw)GjeUFCh-+@irZ4S* z6>rUZFIwWsa{OfB3-R`ms9sdF;J_u`cp-OBi=frG>X08C?W1piM1=)LCOAkj2|=o->xupR3CP3rS9((U!!Xcq=tnP*WD#i{}!C zj0YDHH|1dlo%3WOw0+FI+lk{7q-FZGuIRlPdu2#KmU;O-2gN#$k(AhR(voTUe1$PklPvHmFhZm=T$JWA%%h2T@xS3UnhFSRPwQMW(GUU)9fqDQiSBO&+~&|3dXhE}?Xa$)KlVc#ffTbArf9?(6ur;8J{tap)P4 zvjoLjbF4*}fPea{xETmUly}FQ8sz*`(o?ral2vb-5a|!0B@z^^1okBOGhR=rw zG*BZkh3d&U2#ypX&>rnN4GS7~C4}`FA~fm*gm{zo9tf=;e~EmzVZVEDi2UKfA@DGN zA9RKonVn|0Im1cW{d&d(4=}E7w4ut67@cQSZT$X=gkd;drJ?0hUad_|r)Wl&SDO5H zKvCVBGUfa6Hmt;;6nT%F?Qe5^*s5!>9$(StgSXN@VD#5S%Fpo?x~W&nD1R-CEK)Yl z*!5Q%r5HsyKam)(!fJKT%HEr3XP%TMSI$-ga*`J_9s#0{M_1A43umE~wQj67USb+CylGhJjXuvP<>*sucL%B;#6Za2x3<@*J*CaJKK> zJN2fpE(dvx1-^96UWfRt*Bp-zi;qQ zz(C8nq$q`3t0q1V9ujT3BLRtJ;{uc+KUee4y?Y#VFoB_C3KkepC`dz z&P8f5*a?|rB?u7c*RF07f_w0ZZ}_)4@MC)2V%89mdH|>Q;rstdE61HHJSCR_t2#MYxuXd8j{jHkl;KR2v==Q%cJ=`wj zeZJ$XEN4C5-=j+yd}$(3!miXknZjX8Fzy_FVRr40#2MV%Emyl*%LCM6*Oha(rBZmH zf8b&y_H(RO|16VYE}j!|&eE>{qpNHx2uD3ykG`wmyw#0kvG<46;*&b>plI=lSU-Oy zsuMKbI`IR>^HP{+;L-Cr!DoF&F#CRRZ7H zs@l|)mM$KiFY#&L*&%0+K1G*fT91&5(9P4~ zMV#SukQ@AP1EThN_;^nY`&{-|^AWqdyRH?l56^0{%xhJMkzl+s1H?;_Fw-}pXH`_k z)%5uNlzhhDhQBIxn73V_BgX@i1=Y*QsS~EdW)DLP&y_J=?g(Fl5PZLe7M4x(8Md`v zesmUUV?CRrz=Tpnd;fzX?E?9N#L^P1UBzf3LQ_#+QqdEt3|6h}UN;K+mzt-7vDv6M zT?-y4;C%c}$^JMP{se!kZ7@V2OvJ?)n3M1kxqJEx5nGt;<8gUu*}tS*d)G{B!$QHm z0{5xrp{Q5U^^6~WRRK-%i~R5reQ`bgfX!j|%Hc&v&4@RVi|jsM^BF|33Hhr|FrRa zoQMO_-#V@e$Umqu$dZtY@WOv(=-zP*g8}|W8|EOD zgXQpR)jy!nX@RIY9$hoI|8H6dP_&>bh;Aku$!eK0x7 zPxm;aoc%8>|8-PHPav|Z(O-K5w}{X7mm2NwOSA2x7hOVI22ARoZNmOEjDiam{G%%V z`Nq5LBWS?11^lFcOv4p8$OPK@>OI9D>X;1LpIQglqKQAl_*(fuR#aL(Uzk5|?8AZv z{NO`j_owNb_NR3j_FX3UFOB|R@sRgEKUEa}SCIEUy9GZq$uK6wVZx%Rr`Cy?|7{O&OZi|yr6YH=IGWW8s1UHt4ffjJqk;93G;qkN7 z2a*S9@y!S5RiN$pB-L?r=IQA)SAxbU==n5{&8i~y=2M<#s(mr=o4%(gnZEpk0p3u=oV%ThzMJS{-t4VDb~{@vP`Tzy8y)?$-jIYE8BFW7a^eKY_zDM? z2@j@nh>)mmtYx-boDM9dM&i1O8hJhFp^*-U2?$gih(G8Jb$hLnf*{Hn;mknKPj>sj zP<>~%J2oz2@Ldrw)N{$-EsLGcaz`?%dKA0EdR*L}hbEnDfWbm#s*trji36WmZm{=3 zB<%(FfFd}<&uz`I-DFH6_Hy{J*=vvuJaZ?JNEzp! zGeE2VuJT-Ip363jK#~_PPe)P@X39Icudou8_@U~ghFue#zdBsgi&kvim^a!9WcziF ztvo|08G&c6@VT9O}jF$$XF%?xKh#HT}&B|u?$*L?P^4r8c zZC7#c@NNGx{Kd&>zjc}&jE_vm|C@KcC3@AN%tI5MaK6*k} z?tfCgeLhyd6Mwt7pL$7&*y1w!^ zLDz7O2A*J~*UXaxpVITf(723gYYki8lk5^6Jjh6r%NhXKZtSo%s zH6CuVLi92DwQc#>dLpZ#bM}03cnTZGlJpq$?KpMajP2=ITg#hgq6wg0dD(!OldaTR z4J3S88zJ7a1+vnGgTs}1IYSNMzC!W1PjfPl87_6Ip6$W{ti_%7q zZJ{4=P@-ck@;nQ_n?r}5V`9B*r4p-R(tPyPdko5M50bGL(hJv8s_uS;Gy4${{97uY z`XpH2c>h_nTkSESwZ^5a+1IJ?EZ(Tw$yRAcy+x&&)I5@<_-PA`tzpDtZga|Z zl9&evj!7yZrshIz8NUgy^qe-=;+{VHd|v(I0y=F;(cqdiQC2^|7)di*r>x)fz-X|r z=*bJG_176aH&C@+FTUvXu;&+30xSI+08HRXQ6 zhp19A9mY(?E_GgT5FnWr6rwjMLd{m=$_tN&LPfgAI$~8O5fiE^nSplYgF<6Oy ze!#khZX6`CW4w?2fE4v;0tL-XysN3tU)~jv4YU2}hd2I5`B9DGg(Kbs<6Trum-J94 z`#Sfq>Z3TA&2yvg;i3LNt=`gcmW?u>rjE7S$?I%@F#(!rRjCq87m1Sr^J9+4IeGp> zW1K%OyS)WhhrUbuOPW?0Yln8(@OX+IUJ-RD((gXpxwRc>pUQrwQ`maJz@w_Cp45Nt zLw{TW&Vdpv{+wak%Y$0eQpK{GD=rZK=VCQCS!^k1M1*HLLe(|bxHE^xW=BEnmPTce^Q%dS6|h26bIL+x6=2UPas9G@{OO4<$IUTbk!Z zaMqfMtg5ElAC6ez|{k{!#g6n#XcFN zn7*WS&Sj<7^b1c(#EEo5uuT|~afyhLc6%>W0`2TE-Rog0iCr(nL|#5QKk5OiZf9h^ z=5u?H=Q0xp#1(cI+oP&KGJaUS&@0zUdylI#F4OC?+f==HfR2Duks_0H2ZNqIy^ zEM>1}wz6Mv*J%kST!rmVKX%X-<}luZsdG!xo=Z0C{fzoFqK{Vq%gYR-La;<0@$`ZF zHHQ#IBmh-E(V#h_(WW`#L@z549pizT^>(`Mc5&DkHW?A34GU0`j#!&>uo%@tIc84U zd~(w~mf~!+<4w4nO zr*53R;bdZQb8{s1J^C807G9})RM`@$Bd%Zad@(Yw4)ZW#11|T8YpKPg>lt;6!$oAP zhvb{rkbO|`CSzqn9Ofq)LCS-_nZ(!i(m3U0w^L&-5p$+g$)o%f`IchYJZwWH=>0-G z-IqFhMlMlzW#7)Fx$a2PpZjl{y|yz0W$)k;fgl-2cuy;YC|si)hntshwmaMa8GeAE zkB++MiAmq)U-{M4u$kO|cO-sXdVGY}l13`rDI~r1^yF;kU{GPZ&o6KXac0ixUd0-}or`?QY zF1lZYm^;R>!v`+U$u?&0Y6j05MV+)4CKv1+YHAlpG3V9k(?`e!p`|60k(hsM>ip7w znbc#$9ZqsuRKAy>+BXfLUV+Qd)4DZPliR>JIx`Slpa);&D?V2H${egAzYzG=b0AEV zmXiL+fKYyiVF%$WZ$;u?CDKY#qQz_O=@=EyhG|@}=@#=QNAnRd3!FzA8QKDK3gdA3 zI1!BKoS3SS6P$1#{KDix-0#?15YK2j5_6=Ng(@pK3=uE2o*2ht-zhzP^CXxb>F5{| zLEB!*wP`2#jO>B!srB4Ga$(7(&bnB<72P2}rHj~z$wIsxNOTFZ`U6p91qK~^dwSj} z;s+ywsD$h1-|YJ{guj#k?_5l-)4)zlgcUBlWdo@>@`^`4-fF%3(O}|{A>)#$dn;4h z%kN30?JMU&3a`f8fBS>tarbmW(QpTWAXSf?KR(3q(EB2l>@z(S$e+x<>vD%ihJ5vw zgM^}7*G%F8Q_OVRG0iA6q`e8xPSJT?U-X zTRgyofLqG_4;5MTLU<9wRz$~tbVvVDpi_V|6B7%hq`b+^mwJF6yU*ZIqR04+8+vyN zYVmPtaU^)@P=Oxce_x=qDjIW$md^ZkB$UaLH2)+!vEr=4JY-NyYxnfKPb1%?H3`%r1|-IMlyDTx3<#03}pQz5WV`ICqTQC#1Vf^ z)cb_FiCFCUibn*z40D07`sb@tF2ADds9b^L+4=aY1a0HdRmy?*bm0L}-{PZV%Kl z9~EOOx-_l1`ThQUpae>M^H3@3?HVAW|7iGaWBU>K&C>nplj9sQp>P#Fp{vXAbnO)97Q_(122V?OJ2Cm_vgIu@p{6&JcgKEy>_(3)NMMbyXLO*$^bq{Iz{N-{w3E zxxO%-q`E(9Uu&3@VSr+I-Jx6`muK$rgvm3iUd{{%Ua2*l5BT!z8fgi<9mKa42#W<6 zZcOPe&GYZVR5@sy9@It5PgS)`d!*8)V^^&ysepn~>j#MpVM#5ID$UDV>ztSCuJQSu z2kL0Y*IZ=k;|wf4BvG6sO{s7oTpj7)ycyHKt49$;=7<>VJ7C@kS(Ndi^8r&nYdgi; z-r%LY*J8R%vli_utMS5YIS)b8zMS-`K=x1B688mo%_@`F&XvuwBtH3bXh7dy&sEec z++`QP27Q%H4$0p*;r*1|XU6t{1jhFOo+PuOs{jVCh9=>10s){Z5ZJOD1)u$`Q7Ng#nf1dyvjWCk2`+%5a=1Is;3zTIuik zzELwAbCA`kx4vYxng`qH@nv8`U{S*9Lyst{vh^#nOBkII$=_Kn3Vfnd^E>aBJ6egK z_@trt-j_}L^WK8tRR}1LjX_^xnEzCf!6H}JL-c(=M+$9D z7_aU~hA6%$w35w=RWWW`f7q_bL!*L5#1Na>fX_3oF=0qOA6KahbWnBlUZ55;19? z_qSO1$_#RTxMiV!c@15{EyLf|dc6{!Utbn9HH2m!1aH8LtBH-()Zt2(w&xN7eg5$0}z^5Q_>uu)^k*oPx9*-evs z2W6KHQCdSXlsb$U5Q7THqNPuhU8lSw+sm4L1Yj#hqy2*?pFIN*%jD1Ug=BNPKd3%dU_?x=+ZY?S0CUzt4<+L&6fjrDLkp zu5ls!t(5fpRqJH^P&9!i8QbY?`p?C&$(;bLRR` z!bE37gD=gL(62_LP}UGDP%z|^l4FakIaV8->;?Gk@GYqole0_VuXsRt?`OUe5`{^O z3a`q=K}1UwCuhK0e1{!Ru75F{E98dHEoALxj^9-8Kd6y0$mvX*6bzrp1F#SY?%Feo zbxz`LfAV@#Q{hMHb9SxK#=nNEQQ5nrz+i;6)uara4_n3&cnid=pX~x=dd;3aEH=A< zXmx1dx-N22e@_a0Iax*gBCFW;_MFhOoNrqbbpo{@Xwu~MAxxWM=ryYD37$r&xQZkC zkyI~Eb49JX+cK*TX6aZBWc|rE_f%BQ=Aq+)FGn;gs@^;lhjJOuU@xB`zm*{6e8iZ5 z0A70Bl6VUuWlHjkJg#91*qk=*r93p=61BV9SZrtM0uieZ->vtsy*E7~8)znvESQ4j ziq>fzxkYz48F=H;-+-6O+*ZJc5;aeNj4p2~IkZ7_{eHSFkK2Wb<8B+$5RZGa zA9wwkR?|epowGlAz-9jdJ74`ww}!W&h}<{ z{x0)LkWpkygQm({cU0O)vM|yLU|#THI1>Vc=<%m{Fr;? zVzf<(0=n)tFpx$fmS*-0?Ln2eec+n}O3UwIYDuZowvrVU5);oy6o5u~Tx3#)Q^%0K zrgyefpA?4plaQ)SYYNfz4WfDTvGy2aS&fk62CIBa2?gS`?Tim*Q6={MpQzBRbWhpsx{JJQUxd@mDmvCHvs_Biw-|2mBR-x{ZNMIp6K!_=n3|c z0oHjiF*E804U&53iHAk8LlrN~7}ce%Hr~9V@1Mu{kRQAOnfr z#@h7fsMOJRPlSvw3GS@Y(8{$|HDMN#m7S(+-6DEu*DlJ-M}8zcc`+5(_DKhuUlzTy+}~F{=u5~& zGOFL{rBJNDr;tw>U!PUc$Q#?Ry`fIC)(M(1w%)TPk(damN@yo5!s z=4o!o$oO_RLrfRyZz(dDI2&rncW4h95-L6uiFFIF`qgF zbd^(t+2!m_?0A#TW~$~m+e#4Hi=ko2;_eaJdn8s^6|0G(g9nKlEN2Jz=34uI462I? zVU9VlFbXLn!an1e&_9~!LND_NzM<%z)1|wLlXqI`P;Dflkf?{xHc_;$v^sTW; zB3rtsdsP%aGRqL$lV3S5r~(lk7kF!{;q>$afql{Ro*{2?rS;aioW+^ShYuyNkydvt z1yH=&!r2Dns(l>Uf^I#fCvx>rf%b}63lcm9Wt3}G1Y7TPtG7+lT|GOG9T|8~=PnUP zQM&fy4bV`^DMO`Ma{!*L_gfa_Kia51vv+M}5nQbgj-`?6r+TS-xoh&tw>`t{&7_Yw1QmCe3u~s}_*CI%R(!(diT-~I(T#god0>w2m zQ3`3f+?1H~#WaItd9AG~PJ8>i?Z;c&!qRK`#V-rPc}t`Hof*wn=TKG2sWkEI2^ei> z+QJk$(Q3cCks z4vwD`_wsYBYN^->5Y9usgWnNi`YyFxRAh9jBqo8)E9vJ@E7+w1|K1+FF(MFpO*N!SG!^TyKh5#*UhLmSJ;Gu!jbHsDj80}fu^mYFn!OJ^)l}I;Ab^Zjk zCe=eiclVPtfQYrj>WVpKd>?T|Df_zldHH&7Lo}8lMm1i^s1hO=loGiXiwrFVl4P2h zekY-!?b~%NERxu99cpsQHE!$1vJF5Wb$RYKUX~?qt$re1 zU4A2VkAh=0b(|fwHvhg=@u9IJvbQ+kd#pUEz@`3PdwBT#AYQ4#eCR{b`$9&y_iL9P zPb9kOWloMSJ8w(|p66wF26=h;UkFK8X?S76!-o}Ist%VRJqx~&l~10fQ^gfk?_W*0 z-KGf&L^s;XpqGy4N^g@4x-xTwwRAfN4rrAw~Tx@GO)I*o=J4p3<|Irz}mbC6Oi?G?modqAW_cD0b6+ z3WE#^`eQe z{X>n6vaGz5THI&k*Lgwg+Di1o${O~Pg=DK08M#SiOkr?$k!U-LSB&WGyOtuU6kEC} z$${8yicmWu(+NbZ6f-uh_q5b@4`ISk3&LK=;xIBw_DdJN*kSVIW#qA_z{Gyzum&PZ z5*jTVehNPT#l>NjO>b{e_k)0*9rBbQ<_iuMbszWAowM|5nXYh=#Q_5*?&vK#Nm>GN z=JTDt2aq`ypyU7pzx;N*bYmqOn|ECMjrTV!u0Ph-m&nD}W zGcMjY;gXl-`zZND&y@$6(_KkdMSZ;z=nXNjUWB zk07Q+qzefz#(;*~{+xZ~-1X-EF{`lrcx|SFfN**ug4MBnUVj2LSXda!YEoJe-Gfr} zi4_i+9z+TW&LfR!xkOUsRMO@p$$x1B+**PXtU_Lh2`K4v`A}m zQ~p4p(K*oo*UG*sVG=DLHN)ePc|E=WNHhAnn|?uJDy2y0V01r7WbVn1xXQilTBs(LB`_q zLOBnO&|EwG_?X}Ydm$<&@hCKVFT8IlAJ+>;@-%ZYE8UWAtB5~RXE0MQ|JH(TZWa8T9{KO z;vp1o#Z1mU;;}Gxwq+SQpiZ@(948BE6OAd%fuv~L&AFIWestd$S*{VjJX!&k^ED1! z9g|RqDbVN9_cxeIv#x6@&`44%6w4$<<+$-?9h5qw!umdN+z%U5#wqO+cA?z|OzHq@ zTAIW~MM3%fh1z>j5-IZ^uvk-lxl#5uy8Q7NJwA9Q&|1#Y@{G>N!2y9m ztQ6Ja^x|fB-R`X_SvgI%La714WCY9N%VAb4Xkn|V_>1MI>r3K}GOtsww&(>+2eqhs zU9h27-tQ`f)AROs=Y(109ZXntwY(oShll;pMZzSf*|gBku6zOOobx5p!Zun5o|ehc zH`2zIdU9pclhh9x(&~{bC4dSGKGZ>W?5$zHikM+YUV`i-;xVlIpWTJQzrMyJ!%1=zUow#dib!%E8M zBj!K6e#o}A7C0gl@Jwc)!5#-)gh!Aw@wA?l(V>9zAA5!2EsL}oUD8M@)yZMF%B(d{ z{Sf``&aFaC(7XQpxHt8wwe_+IV=b+CZSbXdVplH}MHOSa;JZG$m$41Ep8Gc5Bm$$m zmq)Uy%F?FT+;}BfVDB9~3s=}+S;KD(C%L!SF0(D-rViru*cj1YF*y_j&jd`Exg(F9 zrS7=knXzjKbkKmSW$d)+-fX`>msZSZ?!$POmA!53z*WJcUvKx|SFMDG_;^kTDJYxI zqpmixvhrCg=b6y4*XBM4L@FOv)( z@%O@cA3l0%t%B_rApKh+?-jVfdr*~36yj~~pM|vl2H^D?)DPz?9QogB{qbp$fr`Ba zWchOa-j9`62i+559>M~n+#l#k(K`m3qVf2c@c!+q!yfWoN%LuCZ`!B7hY#wHt?`wQ zJt?o35zlYkAHjgezN#C{{q0{+RyLqvN_o7Rbo*!aUV+V{@>QHR^`p7I`FHAmY=dy7 zKEBEV{sy#+5;S!CaOxYl-|!5A@Nfdb1TTN9UZRSAO!3cVXaWIO zzg^H7|7RgyL8PdG@ch3&kz6S)Pya3Ta>NHF0yM>lN2GbXiSxiIkXwLBX2*7cZ9UHFiHFR{0+;6 ze;5uWQlJ@bA#YXAf_4784BND_uc|64C6?4a_DAqv!GEpuE+iA^P%KQ=43L9rsCktN zWO^9BR~P&P-_Pau3Vh|BtQY;j^sXeiViWS$&wnoN=P=My7imj1f%MO!g0^@9=t*YX z=z#tGvycyJW9e+Z)5L#b*J8vNx=BA`LE$r|@4y;pR1 z;So8CeS7Q4>1%x#;Dal7gkEyI?wS)z#i8EnMc(t~?if@m_U=jUEG}9SK5X>kIq?QmPWtq;vNfLJu=%=t#q!bK z+>Xug?TjjO;Dd_Zh3+%P)_DBd*O&ChQA9ap4ECE#O+lUrqo-lTcxjdA2E&QjHZ5+g z<)uOTwtHwo+CD$r=l(>*auv<-?_`~|V{`961%3Vnf-Vc zbrHQfZw#&+PFcHRq5ep-XS|^6Gim#bfG= zj%`nT?&!p~o{}5fr?lfu_Ack|tK(TIxfdFQhc$xhP8yyQt`te6@P_?tlv(sE| z3{eW}S?f=@T!u|mlmJZa#IPjpPPKKk-(-0|Rh-TQAcp=r2DGfaZ}MEx6Cc#lPlw*- z8^g7oK#f_ybd^f6^buAR9yxeYE{hj)B!(MpO^L?rqTg<>yPL{AXFXrDIL~Djni$aQ zewJT5I7#2x++fwu^RQ~aoPrFR(F{w!(uvV-SSPt=*yZe_{C-{I*m$i;^d-y6&noW< zfG*Zoc0-j&f^d7CGNKe3N?~tC4>gB#6u$K9#QOosab!xtgnya+C`VdeBORQyX)1u0 z4lEx@lHO5gza8OaW}%wz6ms@`0+mbB@VLfXf2p$^5}r55GD_#FBz4@obxm^NUR{lU zaaF3q_pg)xCXg#_5zjCu-+rhopP$I@dAG0iR-KNhA0k=VSbi$?WsF-AQX(w9k=wvd zQV%VrE~PRq4`KQ9VUTXWp!H?H>l%;4vCGP%(JIkX+na^!Ko6U6 z^&`HGf1ZyY_~6ugG*qk0GKI5hcZXNyVyddRQL{nvC;rMS3NiFZtjy5ywW}vgS!(N* z`GY63>ziwbKXOgEjYQ^-|q7TR_*Gy@bcN>$d9@?4oa(NBoqK&-khSm<(PB1y|M`VMcT`ZJ z`5|H5zg|=8y1%_lX1VGvAkI(gDU(a-*JbSW1nJXayvhIIM}pR)w8LDR`g!i89gi@> z-{SM@6Xbjd|D(P%Zjv@E_8|BzMVM4YkGr_aMn>G~^@{sfJ6?m&C=+YrqwQS4d^)8w7TY6MWs93Vc$BI zY4YRugZ+lvO(RQ^++TkfwItQ|Yh=D}9P{r!{@C>_N#el}#Sh?D_mH)cJOgD3^3B<8?0C z-H&oo%W=`A2)6FI_92~JrgKm0ya#l79CFY07@F%=rMWvH*5I`FW?Soe^s?nNg{_AM zthRe;?>wAVb!f25jY>@pVDR>y=9Vz&<4^CT;L@aTYaLdpPnr+r-pmGWt~7~IzbFT=2Mf%*n;2&dtmyX{@$$&s zoYU2hDKr~0IpDTAncNHB-oLrFye;Cf*bfbZTQHl(Q)V@(O16U6l4C8+CTGRXBma!O za78|9KS_&s*5r`aI6ORWIG8d4wEJcpf78)<*$;1O4p96)Q%E#PCwwTkQ?RCSj|l#g zvi$vQEyK>t%}FIO4c_d)5HHnQsV4_y26?m970OMom7N&0@oo@JE{08~Q<6}c7pke9W zHCEA6E#Va9Rl=JslmO_^-{f5<6p(<%8zhYL0QZ}egz{6o+oa2k{O1&S1sm-FABs$4{AYuAV-u>|vg|Fh74A=gc@z-_%-RQDEW$mDD-_O6vyKK>X($e9{ z$?yc`*eDwkW=531e$Y+UVXY=C+)tt$EDYdY$K!Aa%^4R-)eRHFt3G?uL1ppTmq6@f0xAml62HTG+_Dv`zG%^oe%RM7q+anUV;8Z Mg`@<___cig7ZH~p!vFvP literal 0 HcmV?d00001 diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index d45351fd..93fa5564 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -705,6 +705,7 @@ class AdminRenderer(BrowsableAPIRenderer): # Creation and deletion should use redirects in the admin style. if (response.status_code == status.HTTP_201_CREATED) and ('Location' in response): response.status_code = status.HTTP_302_FOUND + response['Location'] = request.build_absolute_uri() ret = '' if response.status_code == status.HTTP_204_NO_CONTENT: diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index b553ea6f..1376f6d4 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -112,8 +112,8 @@ def add_class(value, css_class): def format_value(value): if getattr(value, 'is_hyperlink', False): return mark_safe('%s' % (value, escape(value.name))) - if isinstance(value, (int, float, decimal.Decimal, bool, type(None))): - return mark_safe('%s' % escape(value)) + if value in (True, False, None): + 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]): template = loader.get_template('rest_framework/admin/list_value.html') From a4e0f0305089d581dc77fcc56deed4cf54c48a14 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 14:18:09 +0100 Subject: [PATCH 182/487] Tweak quickstart to show newest users first in list view --- docs/tutorial/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md index 9b040a39..2bb27435 100644 --- a/docs/tutorial/quickstart.md +++ b/docs/tutorial/quickstart.md @@ -68,7 +68,7 @@ Right, we'd better write some views then. Open `tutorial/quickstart/views.py` a """ API endpoint that allows users to be viewed or edited. """ - queryset = User.objects.all() + queryset = User.objects.all().order_by('-date_joined') serializer_class = UserSerializer From 79b825ef320b9abe3b6d582442a2cb555db7e9b4 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 14:38:04 +0100 Subject: [PATCH 183/487] Drop unused import --- rest_framework/templatetags/rest_framework.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index 1376f6d4..dca113bf 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -1,6 +1,5 @@ from __future__ import absolute_import, unicode_literals -import decimal import re from django import template @@ -133,6 +132,8 @@ def format_value(value): return mark_safe('{value}'.format(value=escape(value))) elif '@' in value and not re.search(r'\s', value): return mark_safe('{value}'.format(value=escape(value))) + elif '\n' in value: + return mark_safe('
    %s
    ' % escape(value)) return six.text_type(value) From 5b39d820bea1bea66bec9d1461858c2830125c2f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 15:13:22 +0100 Subject: [PATCH 184/487] Remove 'load url from future' tags in templates. --- rest_framework/templates/rest_framework/admin.html | 1 - rest_framework/templates/rest_framework/base.html | 1 - rest_framework/templates/rest_framework/login_base.html | 1 - 3 files changed, 3 deletions(-) diff --git a/rest_framework/templates/rest_framework/admin.html b/rest_framework/templates/rest_framework/admin.html index 74dc7316..7db06e07 100644 --- a/rest_framework/templates/rest_framework/admin.html +++ b/rest_framework/templates/rest_framework/admin.html @@ -1,4 +1,3 @@ -{% load url from future %} {% load staticfiles %} {% load rest_framework %} diff --git a/rest_framework/templates/rest_framework/base.html b/rest_framework/templates/rest_framework/base.html index 449cd380..abbc7595 100644 --- a/rest_framework/templates/rest_framework/base.html +++ b/rest_framework/templates/rest_framework/base.html @@ -1,4 +1,3 @@ -{% load url from future %} {% load staticfiles %} {% load rest_framework %} diff --git a/rest_framework/templates/rest_framework/login_base.html b/rest_framework/templates/rest_framework/login_base.html index 9ac80308..7f2bfb51 100644 --- a/rest_framework/templates/rest_framework/login_base.html +++ b/rest_framework/templates/rest_framework/login_base.html @@ -1,5 +1,4 @@ {% extends "rest_framework/base.html" %} -{% load url from future %} {% load staticfiles %} {% load rest_framework %} From c203ca4c64eb20f928a42d231d4e46b78b29e890 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 15:26:42 +0100 Subject: [PATCH 185/487] Deprecations --- rest_framework/pagination.py | 11 +++++---- rest_framework/request.py | 46 ----------------------------------- rest_framework/serializers.py | 38 ----------------------------- rest_framework/views.py | 12 ++------- tests/test_renderers.py | 2 +- tests/test_request.py | 28 ++++++++++----------- tests/test_views.py | 8 +++--- 7 files changed, 27 insertions(+), 118 deletions(-) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index 90c6a434..c00e2796 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -195,7 +195,8 @@ class PageNumberPagination(BasePagination): """ Prior to version 3.1, pagination was handled in the view, and the attributes were set there. The attributes should now be set on - the pagination class, but the old style is still pending deprecation. + the pagination class. The old style continues to work but is deprecated + and will be fully removed in version 3.3. """ assert not ( getattr(view, 'pagination_serializer_class', None) or @@ -216,11 +217,11 @@ class PageNumberPagination(BasePagination): if value is not None: setattr(self, attr_name, value) warnings.warn( - "The `%s` settings key is pending deprecation. " + "The `%s` settings key is deprecated. " "Use the `%s` attribute on the pagination class instead." % ( settings_key, attr_name ), - PendingDeprecationWarning, + DeprecationWarning, ) for (view_attr, attr_name) in ( @@ -233,11 +234,11 @@ class PageNumberPagination(BasePagination): if value is not None: setattr(self, attr_name, value) warnings.warn( - "The `%s` view attribute is pending deprecation. " + "The `%s` view attribute is deprecated. " "Use the `%s` attribute on the pagination class instead." % ( view_attr, attr_name ), - PendingDeprecationWarning, + DeprecationWarning, ) def paginate_queryset(self, queryset, request, view=None): diff --git a/rest_framework/request.py b/rest_framework/request.py index 568ba1b5..f38bb8c4 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -204,58 +204,12 @@ class Request(object): """ return self._request.GET - @property - def QUERY_PARAMS(self): - """ - Synonym for `.query_params`, for backwards compatibility. - """ - warnings.warn( - "`request.QUERY_PARAMS` is deprecated. Use `request.query_params` instead.", - DeprecationWarning, - stacklevel=1 - ) - return self._request.GET - @property def data(self): if not _hasattr(self, '_full_data'): self._load_data_and_files() return self._full_data - @property - def DATA(self): - """ - Parses the request body and returns the data. - - Similar to usual behaviour of `request.POST`, except that it handles - arbitrary parsers, and also works on methods other than POST (eg PUT). - """ - warnings.warn( - "`request.DATA` is deprecated. Use `request.data` instead.", - DeprecationWarning, - stacklevel=1 - ) - if not _hasattr(self, '_data'): - self._load_data_and_files() - return self._data - - @property - def FILES(self): - """ - Parses the request body and returns any files uploaded in the request. - - Similar to usual behaviour of `request.FILES`, except that it handles - arbitrary parsers, and also works on methods other than POST (eg PUT). - """ - warnings.warn( - "`request.FILES` is deprecated. Use `request.data` instead.", - DeprecationWarning, - stacklevel=1 - ) - if not _hasattr(self, '_files'): - self._load_data_and_files() - return self._files - @property def user(self): """ diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index cb0404b6..a175ec4a 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -1181,44 +1181,6 @@ class ModelSerializer(Serializer): kwargs['read_only'] = True extra_kwargs[field_name] = kwargs - # These are all pending deprecation. - write_only_fields = getattr(self.Meta, 'write_only_fields', None) - if write_only_fields is not None: - warnings.warn( - "The `Meta.write_only_fields` option is deprecated. " - "Use `Meta.extra_kwargs={: {'write_only': True}}` instead.", - DeprecationWarning, - stacklevel=3 - ) - for field_name in write_only_fields: - kwargs = extra_kwargs.get(field_name, {}) - kwargs['write_only'] = True - extra_kwargs[field_name] = kwargs - - view_name = getattr(self.Meta, 'view_name', None) - if view_name is not None: - warnings.warn( - "The `Meta.view_name` option is deprecated. " - "Use `Meta.extra_kwargs={'url': {'view_name': ...}}` instead.", - DeprecationWarning, - stacklevel=3 - ) - kwargs = extra_kwargs.get(self.url_field_name, {}) - kwargs['view_name'] = view_name - extra_kwargs[self.url_field_name] = kwargs - - lookup_field = getattr(self.Meta, 'lookup_field', None) - if lookup_field is not None: - warnings.warn( - "The `Meta.lookup_field` option is deprecated. " - "Use `Meta.extra_kwargs={'url': {'lookup_field': ...}}` instead.", - DeprecationWarning, - stacklevel=3 - ) - kwargs = extra_kwargs.get(self.url_field_name, {}) - kwargs['lookup_field'] = lookup_field - extra_kwargs[self.url_field_name] = kwargs - return extra_kwargs def get_uniqueness_extra_kwargs(self, field_names, declared_fields, extra_kwargs): diff --git a/rest_framework/views.py b/rest_framework/views.py index ca91d19d..810d7ff4 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -428,16 +428,8 @@ class APIView(View): exception_handler = self.settings.EXCEPTION_HANDLER - if len(inspect.getargspec(exception_handler).args) == 1: - warnings.warn( - 'The `exception_handler(exc)` call signature is deprecated. ' - 'Use `exception_handler(exc, context) instead.', - DeprecationWarning - ) - response = exception_handler(exc) - else: - context = self.get_exception_handler_context() - response = exception_handler(exc, context) + context = self.get_exception_handler_context() + response = exception_handler(exc, context) if response is None: raise diff --git a/tests/test_renderers.py b/tests/test_renderers.py index 113c1b66..03b95243 100644 --- a/tests/test_renderers.py +++ b/tests/test_renderers.py @@ -81,7 +81,7 @@ class MockGETView(APIView): class MockPOSTView(APIView): def post(self, request, **kwargs): - return Response({'foo': request.DATA}) + return Response({'foo': request.data}) class EmptyGETView(APIView): diff --git a/tests/test_request.py b/tests/test_request.py index 7c62c90a..f4b381ae 100644 --- a/tests/test_request.py +++ b/tests/test_request.py @@ -76,37 +76,37 @@ class TestMethodOverloading(TestCase): class TestContentParsing(TestCase): def test_standard_behaviour_determines_no_content_GET(self): """ - Ensure request.DATA returns empty QueryDict for GET request. + Ensure request.data returns empty QueryDict for GET request. """ request = Request(factory.get('/')) - self.assertEqual(request.DATA, {}) + self.assertEqual(request.data, {}) def test_standard_behaviour_determines_no_content_HEAD(self): """ - Ensure request.DATA returns empty QueryDict for HEAD request. + Ensure request.data returns empty QueryDict for HEAD request. """ request = Request(factory.head('/')) - self.assertEqual(request.DATA, {}) + self.assertEqual(request.data, {}) def test_request_DATA_with_form_content(self): """ - Ensure request.DATA returns content for POST request with form content. + Ensure request.data returns content for POST request with form content. """ data = {'qwerty': 'uiop'} request = Request(factory.post('/', data)) request.parsers = (FormParser(), MultiPartParser()) - self.assertEqual(list(request.DATA.items()), list(data.items())) + self.assertEqual(list(request.data.items()), list(data.items())) def test_request_DATA_with_text_content(self): """ - Ensure request.DATA returns content for POST request with + Ensure request.data returns content for POST request with non-form content. """ content = six.b('qwerty') content_type = 'text/plain' request = Request(factory.post('/', content, content_type=content_type)) request.parsers = (PlainTextParser(),) - self.assertEqual(request.DATA, content) + self.assertEqual(request.data, content) def test_request_POST_with_form_content(self): """ @@ -119,27 +119,27 @@ class TestContentParsing(TestCase): def test_standard_behaviour_determines_form_content_PUT(self): """ - Ensure request.DATA returns content for PUT request with form content. + Ensure request.data returns content for PUT request with form content. """ data = {'qwerty': 'uiop'} request = Request(factory.put('/', data)) request.parsers = (FormParser(), MultiPartParser()) - self.assertEqual(list(request.DATA.items()), list(data.items())) + self.assertEqual(list(request.data.items()), list(data.items())) def test_standard_behaviour_determines_non_form_content_PUT(self): """ - Ensure request.DATA returns content for PUT request with + Ensure request.data returns content for PUT request with non-form content. """ content = six.b('qwerty') content_type = 'text/plain' request = Request(factory.put('/', content, content_type=content_type)) request.parsers = (PlainTextParser(), ) - self.assertEqual(request.DATA, content) + self.assertEqual(request.data, content) def test_overloaded_behaviour_allows_content_tunnelling(self): """ - Ensure request.DATA returns content for overloaded POST request. + Ensure request.data returns content for overloaded POST request. """ json_data = {'foobar': 'qwerty'} content = json.dumps(json_data) @@ -150,7 +150,7 @@ class TestContentParsing(TestCase): } request = Request(factory.post('/', form_data)) request.parsers = (JSONParser(), ) - self.assertEqual(request.DATA, json_data) + self.assertEqual(request.data, json_data) def test_form_POST_unicode(self): """ diff --git a/tests/test_views.py b/tests/test_views.py index 65024609..81e71802 100644 --- a/tests/test_views.py +++ b/tests/test_views.py @@ -25,7 +25,7 @@ class BasicView(APIView): return Response({'method': 'GET'}) def post(self, request, *args, **kwargs): - return Response({'method': 'POST', 'data': request.DATA}) + return Response({'method': 'POST', 'data': request.data}) @api_view(['GET', 'POST', 'PUT', 'PATCH']) @@ -33,11 +33,11 @@ def basic_view(request): if request.method == 'GET': return {'method': 'GET'} elif request.method == 'POST': - return {'method': 'POST', 'data': request.DATA} + return {'method': 'POST', 'data': request.data} elif request.method == 'PUT': - return {'method': 'PUT', 'data': request.DATA} + return {'method': 'PUT', 'data': request.data} elif request.method == 'PATCH': - return {'method': 'PATCH', 'data': request.DATA} + return {'method': 'PATCH', 'data': request.data} class ErrorView(APIView): From 4fd971e3e5e4c6e972cb764cecd355638c67a36f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 15:42:11 +0100 Subject: [PATCH 186/487] Update exception handler test in line with deprecations --- tests/test_views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_views.py b/tests/test_views.py index 81e71802..cbe1939e 100644 --- a/tests/test_views.py +++ b/tests/test_views.py @@ -123,7 +123,7 @@ class TestCustomExceptionHandler(TestCase): def setUp(self): self.DEFAULT_HANDLER = api_settings.EXCEPTION_HANDLER - def exception_handler(exc): + def exception_handler(exc, request): return Response('Error!', status=status.HTTP_400_BAD_REQUEST) api_settings.EXCEPTION_HANDLER = exception_handler From c8ad0cce198533bce31afcb919caea659e6ea093 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 15:43:39 +0100 Subject: [PATCH 187/487] Bump minimum Django version to 1.5 --- .travis.yml | 2 -- README.md | 2 +- docs/index.md | 2 +- docs/tutorial/1-serialization.md | 2 +- rest_framework/compat.py | 35 -------------------------------- rest_framework/request.py | 1 - rest_framework/serializers.py | 2 -- rest_framework/test.py | 6 +++--- rest_framework/views.py | 3 --- tox.ini | 1 - 10 files changed, 6 insertions(+), 50 deletions(-) diff --git a/.travis.yml b/.travis.yml index 50dc368e..c653aa83 100644 --- a/.travis.yml +++ b/.travis.yml @@ -23,8 +23,6 @@ env: - TOX_ENV=py32-django15 - TOX_ENV=py27-django15 - TOX_ENV=py26-django15 - - TOX_ENV=py27-django14 - - TOX_ENV=py26-django14 - TOX_ENV=py27-djangomaster - TOX_ENV=py32-djangomaster - TOX_ENV=py33-djangomaster diff --git a/README.md b/README.md index af8ac58e..8ba86680 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ There is a live example API for testing purposes, [available here][sandbox]. # Requirements * Python (2.6.5+, 2.7, 3.2, 3.3, 3.4) -* Django (1.4.11+, 1.5.6+, 1.6.3+, 1.7, 1.8) +* Django (1.5.6+, 1.6.3+, 1.7, 1.8) # Installation diff --git a/docs/index.md b/docs/index.md index 27c50fee..4a8442ce 100644 --- a/docs/index.md +++ b/docs/index.md @@ -53,7 +53,7 @@ Some reasons you might want to use REST framework: REST framework requires the following: * Python (2.6.5+, 2.7, 3.2, 3.3, 3.4) -* Django (1.4.11+, 1.5.6+, 1.6.3+, 1.7+, 1.8) +* Django (1.5.6+, 1.6.3+, 1.7+, 1.8) The following packages are optional: diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md index 8a7a8dc0..c54af0ce 100644 --- a/docs/tutorial/1-serialization.md +++ b/docs/tutorial/1-serialization.md @@ -317,7 +317,7 @@ Quit out of the shell... Validating models... 0 errors found - Django version 1.4.3, using settings 'tutorial.settings' + Django version 1.8.3, using settings 'tutorial.settings' Development server is running at http://127.0.0.1:8000/ Quit the server with CONTROL-C. diff --git a/rest_framework/compat.py b/rest_framework/compat.py index d11c6809..b1153d66 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -203,41 +203,6 @@ if 'patch' not in View.http_method_names: View.http_method_names = View.http_method_names + ['patch'] - -try: - # In 1.5 the test client uses force_bytes - from django.utils.encoding import force_bytes as force_bytes_or_smart_bytes -except ImportError: - # In 1.4 the test client just uses smart_str - from django.utils.encoding import smart_str as force_bytes_or_smart_bytes - - -# RequestFactory only provides `generic` from 1.5 onwards -if django.VERSION >= (1, 5): - from django.test.client import RequestFactory -else: - from django.test.client import RequestFactory as DjangoRequestFactory - - class RequestFactory(DjangoRequestFactory): - def generic(self, method, path, - data='', content_type='application/octet-stream', **extra): - parsed = _urlparse(path) - data = force_bytes_or_smart_bytes(data, settings.DEFAULT_CHARSET) - r = { - 'PATH_INFO': self._get_path(parsed), - 'QUERY_STRING': force_text(parsed[4]), - 'REQUEST_METHOD': six.text_type(method), - } - if data: - r.update({ - 'CONTENT_LENGTH': len(data), - 'CONTENT_TYPE': six.text_type(content_type), - 'wsgi.input': FakePayload(data), - }) - r.update(extra) - return self.request(**r) - - # Markdown is optional try: import markdown diff --git a/rest_framework/request.py b/rest_framework/request.py index 568ba1b5..79f251ea 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -11,7 +11,6 @@ The wrapped request then offers a richer API, in particular : from __future__ import unicode_literals import sys -import warnings from django.conf import settings from django.http import QueryDict diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index cb0404b6..f3873d3b 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -12,8 +12,6 @@ response content is handled by parsers and renderers. """ from __future__ import unicode_literals -import warnings - from django.db import models from django.db.models.fields import Field as DjangoModelField from django.db.models.fields import FieldDoesNotExist diff --git a/rest_framework/test.py b/rest_framework/test.py index 92ac09f5..e0670365 100644 --- a/rest_framework/test.py +++ b/rest_framework/test.py @@ -8,12 +8,12 @@ import django from django.conf import settings from django.test import testcases from django.test.client import Client as DjangoClient +from django.test.client import RequestFactory as DjangoRequestFactory from django.test.client import ClientHandler from django.utils import six +from django.utils.encoding import force_bytes from django.utils.http import urlencode -from rest_framework.compat import RequestFactory as DjangoRequestFactory -from rest_framework.compat import force_bytes_or_smart_bytes from rest_framework.settings import api_settings @@ -47,7 +47,7 @@ class APIRequestFactory(DjangoRequestFactory): if content_type: # Content type specified explicitly, treat data as a raw bytestring - ret = force_bytes_or_smart_bytes(data, settings.DEFAULT_CHARSET) + ret = force_bytes(data, settings.DEFAULT_CHARSET) else: format = format or self.default_format diff --git a/rest_framework/views.py b/rest_framework/views.py index ca91d19d..41577083 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -3,9 +3,6 @@ Provides an APIView class that is the base of all views in REST framework. """ from __future__ import unicode_literals -import inspect -import warnings - from django.core.exceptions import PermissionDenied from django.db import models from django.http import Http404 diff --git a/tox.ini b/tox.ini index d941b6d7..84f40624 100644 --- a/tox.ini +++ b/tox.ini @@ -13,7 +13,6 @@ commands = ./runtests.py --fast {posargs} setenv = PYTHONDONTWRITEBYTECODE=1 deps = - django14: Django==1.4.11 # Should track minimum supported django15: Django==1.5.6 # Should track minimum supported django16: Django==1.6.3 # Should track minimum supported django17: Django==1.7.8 # Should track maximum supported From b969e9a8723a22d368a3f07b0bedec698b310893 Mon Sep 17 00:00:00 2001 From: David Kaplan Date: Thu, 30 Jul 2015 10:47:12 -0400 Subject: [PATCH 188/487] Update permissions.md Add DRY Rest Permissions info to the permissions page --- docs/api-guide/permissions.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md index 31fe4c30..a78334ea 100644 --- a/docs/api-guide/permissions.md +++ b/docs/api-guide/permissions.md @@ -251,6 +251,10 @@ The [Composed Permissions][composed-permissions] package provides a simple way t The [REST Condition][rest-condition] package is another extension for building complex permissions in a simple and convenient way. The extension allows you to combine permissions with logical operators. +## DRY Rest Permissions + +The [DRY Rest Permissions][dry-rest-permissions] package provides the ability to define different permissions for individual default and custom actions. This package is made for apps with permissions that are derived from relationships defined in the app's data model. It also supports permission checks being returned to a client app through the API's serializer. Additionally it supports adding permissions to the default and custom list actions to restrict the data they retrive per user. + [cite]: https://developer.apple.com/library/mac/#documentation/security/Conceptual/AuthenticationAndAuthorizationGuide/Authorization/Authorization.html [authentication]: authentication.md [throttling]: throttling.md @@ -264,3 +268,4 @@ The [REST Condition][rest-condition] package is another extension for building c [drf-any-permissions]: https://github.com/kevin-brown/drf-any-permissions [composed-permissions]: https://github.com/niwibe/djangorestframework-composed-permissions [rest-condition]: https://github.com/caxap/rest_condition +[dry-rest-permissions]: https://github.com/Helioscene/dry-rest-permissions From 8d7627a0799b14738c5a79610f7aac8235386609 Mon Sep 17 00:00:00 2001 From: David Kaplan Date: Thu, 30 Jul 2015 10:51:44 -0400 Subject: [PATCH 189/487] Update third-party-resources.md Add DRY Rest Framework reference onto the third party resources page. --- docs/topics/third-party-resources.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/topics/third-party-resources.md b/docs/topics/third-party-resources.md index 9f0aab38..adf524fd 100644 --- a/docs/topics/third-party-resources.md +++ b/docs/topics/third-party-resources.md @@ -195,6 +195,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque * [drf-any-permissions][drf-any-permissions] - Provides alternative permission handling. * [djangorestframework-composed-permissions][djangorestframework-composed-permissions] - Provides a simple way to define complex permissions. * [rest_condition][rest-condition] - Another extension for building complex permissions in a simple and convenient way. +* [dry-rest-permissions][dry-rest-permissions] - Provides a simple way to define permissions for individual api actions. ### Serializers @@ -341,3 +342,4 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque [cdrf.co]:http://www.cdrf.co [drf-tracking]: https://github.com/aschn/drf-tracking [django-rest-framework-braces]: https://github.com/dealertrack/django-rest-framework-braces +[dry-rest-permissions]: https://github.com/Helioscene/dry-rest-permissions From 1b3b01e042920e13934608d36da93a4d02dd95e9 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 15:59:27 +0100 Subject: [PATCH 190/487] Remove unused imports --- rest_framework/request.py | 1 - rest_framework/serializers.py | 2 -- rest_framework/views.py | 3 --- 3 files changed, 6 deletions(-) diff --git a/rest_framework/request.py b/rest_framework/request.py index f38bb8c4..858ecd59 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -11,7 +11,6 @@ The wrapped request then offers a richer API, in particular : from __future__ import unicode_literals import sys -import warnings from django.conf import settings from django.http import QueryDict diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index a175ec4a..b62901a7 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -12,8 +12,6 @@ response content is handled by parsers and renderers. """ from __future__ import unicode_literals -import warnings - from django.db import models from django.db.models.fields import Field as DjangoModelField from django.db.models.fields import FieldDoesNotExist diff --git a/rest_framework/views.py b/rest_framework/views.py index 810d7ff4..468737ad 100644 --- a/rest_framework/views.py +++ b/rest_framework/views.py @@ -3,9 +3,6 @@ Provides an APIView class that is the base of all views in REST framework. """ from __future__ import unicode_literals -import inspect -import warnings - from django.core.exceptions import PermissionDenied from django.db import models from django.http import Http404 From e68d737825a3abeb7e2c126f5a9cb7257ecc6156 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 30 Jul 2015 17:03:08 +0100 Subject: [PATCH 191/487] Respect blank on many to many, and set allow_empty=False if it is not present. Closes #2804. --- rest_framework/relations.py | 1 + rest_framework/utils/field_mapping.py | 3 +++ tests/test_model_serializer.py | 4 ++-- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/rest_framework/relations.py b/rest_framework/relations.py index c1c27174..79f53ee5 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -64,6 +64,7 @@ class RelatedField(Field): 'when setting read_only=`True`.' ) kwargs.pop('many', None) + kwargs.pop('allow_empty', None) super(RelatedField, self).__init__(**kwargs) def __new__(cls, *args, **kwargs): diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index 38c43315..9494b0af 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -225,6 +225,7 @@ def get_relation_kwargs(field_name, relation_info): # If this field is read-only, then return early. # No further keyword arguments are valid. return kwargs + if model_field.has_default() or model_field.null: kwargs['required'] = False if model_field.null: @@ -234,6 +235,8 @@ def get_relation_kwargs(field_name, relation_info): if getattr(model_field, 'unique', False): validator = UniqueValidator(queryset=model_field.model._default_manager) kwargs['validators'] = kwargs.get('validators', []) + [validator] + if to_many and not model_field.blank: + kwargs['allow_empty'] = False return kwargs diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index f9ef633c..8f3f82b6 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -395,7 +395,7 @@ class TestRelationalFieldMappings(TestCase): id = IntegerField(label='ID', read_only=True) foreign_key = PrimaryKeyRelatedField(queryset=ForeignKeyTargetModel.objects.all()) one_to_one = PrimaryKeyRelatedField(queryset=OneToOneTargetModel.objects.all(), validators=[]) - many_to_many = PrimaryKeyRelatedField(many=True, queryset=ManyToManyTargetModel.objects.all()) + many_to_many = PrimaryKeyRelatedField(allow_empty=False, many=True, queryset=ManyToManyTargetModel.objects.all()) through = PrimaryKeyRelatedField(many=True, read_only=True) """) self.assertEqual(unicode_repr(TestSerializer()), expected) @@ -434,7 +434,7 @@ class TestRelationalFieldMappings(TestCase): url = HyperlinkedIdentityField(view_name='relationalmodel-detail') foreign_key = HyperlinkedRelatedField(queryset=ForeignKeyTargetModel.objects.all(), view_name='foreignkeytargetmodel-detail') one_to_one = HyperlinkedRelatedField(queryset=OneToOneTargetModel.objects.all(), validators=[], view_name='onetoonetargetmodel-detail') - many_to_many = HyperlinkedRelatedField(many=True, queryset=ManyToManyTargetModel.objects.all(), view_name='manytomanytargetmodel-detail') + many_to_many = HyperlinkedRelatedField(allow_empty=False, many=True, queryset=ManyToManyTargetModel.objects.all(), view_name='manytomanytargetmodel-detail') through = HyperlinkedRelatedField(many=True, read_only=True, view_name='throughtargetmodel-detail') """) self.assertEqual(unicode_repr(TestSerializer()), expected) From ed55fbe8626494a12860cf582972800e75c3b500 Mon Sep 17 00:00:00 2001 From: Ian Foote Date: Fri, 31 Jul 2015 12:59:50 +0100 Subject: [PATCH 192/487] Fix custom HyperlinkedRelatedField example Fix `get_object` method signature to match [`HyperlinkedRelatedField.get_object`](https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/relations.py#L227-L236). --- docs/api-guide/relations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md index a673c2fc..47d5ab2e 100644 --- a/docs/api-guide/relations.md +++ b/docs/api-guide/relations.md @@ -498,10 +498,10 @@ For example, if all your object URLs used both a account and a slug in the the U kwargs = {'account': obj.account, 'slug': obj.slug} return reverse(view_name, kwargs=kwargs, request=request, format=format) - def get_object(self, queryset, view_name, view_args, view_kwargs): + def get_object(self, view_name, view_args, view_kwargs): account = view_kwargs['account'] slug = view_kwargs['slug'] - return queryset.get(account=account, slug=slug) + return self.get_queryset().get(account=account, slug=slug) --- From 5b955363765970d7ba7f241fb4599492ad5bfce2 Mon Sep 17 00:00:00 2001 From: Trey Hunner Date: Wed, 29 Jul 2015 20:53:57 -0700 Subject: [PATCH 193/487] Run codecov after success on Travis CI --- .travis.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.travis.yml b/.travis.yml index 50dc368e..7ba76b50 100644 --- a/.travis.yml +++ b/.travis.yml @@ -43,3 +43,7 @@ install: script: - tox -e $TOX_ENV + +after_success: + - pip install codecov + - codecov From 48b21b6063fec77fc938f9ee7eb41f0d147dc1d1 Mon Sep 17 00:00:00 2001 From: Trey Hunner Date: Fri, 31 Jul 2015 18:28:49 -0700 Subject: [PATCH 194/487] Always measure branch coverage --- .coveragerc | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .coveragerc diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 00000000..398ff08a --- /dev/null +++ b/.coveragerc @@ -0,0 +1,2 @@ +[run] +branch = True From 472784b70aeec2e2afce5c39757d6140533ab32e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 3 Aug 2015 09:27:03 +0100 Subject: [PATCH 195/487] Docs for custom hyperlinked fields. --- docs/api-guide/relations.md | 100 ++++++++++++++++++++++++------------ rest_framework/relations.py | 10 ++-- 2 files changed, 74 insertions(+), 36 deletions(-) diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md index 47d5ab2e..bc24667d 100644 --- a/docs/api-guide/relations.md +++ b/docs/api-guide/relations.md @@ -151,6 +151,16 @@ Would serialize to a representation like this: By default this field is read-write, although you can change this behavior using the `read_only` flag. +--- + +**Note**: This field is designed for objects that map to a URL that accepts a single URL keyword argument, as set using the `lookup_field` and `lookup_url_kwarg` arguments. + +This is suitable for URLs that contain a single primary key or slug argument as part of the URL. + +If you require more complex hyperlinked representation you'll need to customize the field, as described in the [custom hyperlinked fields](#custom-hyperlinked-fields) section, below. + +--- + **Arguments**: * `view_name` - The view name that should be used as the target of the relationship. If you're using [the standard router classes][routers] this will be a string with the format `-detail`. **required**. @@ -353,6 +363,63 @@ This custom field would then serialize to the following representation. --- +# Custom hyperlinked fields + +In some cases you may need to customize the behavior of a hyperlinked field, in order to represent URLs that require more than a single lookup field. + +You can achieve this by overriding `HyperlinkedRelatedField`. There are two methods that may be overridden: + +**get_url(self, obj, view_name, request, format)** + +The `get_url` method is used to map the object instance to its URL representation. + +May raise a `NoReverseMatch` if the `view_name` and `lookup_field` +attributes are not configured to correctly match the URL conf. + +**get_object(self, queryset, view_name, view_args, view_kwargs)** + +If you want to support a writable hyperlinked field then you'll also want to override `get_object`, in order to map incoming URLs back to the object they represent. For read-only hyperlinked fields there is no need to override this method. + +The return value of this method should the object that corresponds to the matched URL conf arguments. + +May raise an `ObjectDoesNotExist` exception. + +## Example + +Say we have a URL for a customer object that takes two keyword arguments, like so: + + /api//customers// + +This cannot be represented with the default implementation, which accepts only a single lookup field. + +In this case we'd need to override `HyperlinkedRelatedField` to get the behavior we want: + + from rest_framework import serializers + from rest_framework.reverse import reverse + + class CustomerHyperlink(serializers.HyperlinkedRelatedField): + # We define these as class attributes, so we don't need to pass them as arguments. + view_name = 'customer-detail' + queryset = Customer.objects.all() + + def get_url(self, obj, view_name, request, format): + url_kwargs = { + 'organization_slug': obj.organization.slug, + 'customer_pk': obj.pk } + return reverse(view_name, url_kwargs, request=request, format=format) + + def get_object(self, view_name, view_args, view_kwargs): + lookup_kwargs = { + 'organization__slug': view_kwargs['organization_slug'], + 'pk': view_kwargs['customer_pk'] } + return self.get_queryset().get(**lookup_kwargs) + +Note that if you wanted to use this style together with the generic views then you'd also need to override `.get_object` on the view in order to get the correct lookup behavior. + +Generally we recommend a flat style for API representations where possible, but the nested URL style can also be reasonable when used in moderation. + +--- + # Further notes ## The `queryset` argument @@ -470,39 +537,6 @@ If you explicitly specify a relational field pointing to a ``ManyToManyField`` with a through model, be sure to set ``read_only`` to ``True``. -## Advanced Hyperlinked fields - -If you have very specific requirements for the style of your hyperlinked relationships you can override `HyperlinkedRelatedField`. - -There are two methods you'll need to override. - -#### get_url(self, obj, view_name, request, format) - -This method should return the URL that corresponds to the given object. - -May raise a `NoReverseMatch` if the `view_name` and `lookup_field` -attributes are not configured to correctly match the URL conf. - -#### get_object(self, queryset, view_name, view_args, view_kwargs) - -This method should the object that corresponds to the matched URL conf arguments. - -May raise an `ObjectDoesNotExist` exception. - -### Example - -For example, if all your object URLs used both a account and a slug in the the URL to reference the object, you might create a custom field like this: - - class CustomHyperlinkedField(serializers.HyperlinkedRelatedField): - def get_url(self, obj, view_name, request, format): - kwargs = {'account': obj.account, 'slug': obj.slug} - return reverse(view_name, kwargs=kwargs, request=request, format=format) - - def get_object(self, view_name, view_args, view_kwargs): - account = view_kwargs['account'] - slug = view_kwargs['slug'] - return self.get_queryset().get(account=account, slug=slug) - --- # Third Party Packages diff --git a/rest_framework/relations.py b/rest_framework/relations.py index 79f53ee5..07624854 100644 --- a/rest_framework/relations.py +++ b/rest_framework/relations.py @@ -53,8 +53,10 @@ MANY_RELATION_KWARGS = ( class RelatedField(Field): + queryset = None + def __init__(self, **kwargs): - self.queryset = kwargs.pop('queryset', None) + self.queryset = kwargs.pop('queryset', self.queryset) assert self.queryset is not None or kwargs.get('read_only', None), ( 'Relational field must provide a `queryset` argument, ' 'or set read_only=`True`.' @@ -198,6 +200,7 @@ class PrimaryKeyRelatedField(RelatedField): class HyperlinkedRelatedField(RelatedField): lookup_field = 'pk' + view_name = None default_error_messages = { 'required': _('This field is required.'), @@ -208,8 +211,9 @@ class HyperlinkedRelatedField(RelatedField): } def __init__(self, view_name=None, **kwargs): - assert view_name is not None, 'The `view_name` argument is required.' - self.view_name = view_name + if view_name is not None: + view_name = self.view_name = view_name + assert self.view_name is not None, 'The `view_name` argument is required.' self.lookup_field = kwargs.pop('lookup_field', self.lookup_field) self.lookup_url_kwarg = kwargs.pop('lookup_url_kwarg', self.lookup_field) self.format = kwargs.pop('format', None) From 650866cc43da38d152c0361ddd030923ff4b13d3 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 3 Aug 2015 09:48:03 +0100 Subject: [PATCH 196/487] Blank relational fields map to required=False serializer fields. Closes #3210. --- rest_framework/utils/field_mapping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index 9494b0af..917c8458 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -226,7 +226,7 @@ def get_relation_kwargs(field_name, relation_info): # No further keyword arguments are valid. return kwargs - if model_field.has_default() or model_field.null: + if model_field.has_default() or model_field.blank or model_field.null: kwargs['required'] = False if model_field.null: kwargs['allow_null'] = True From 877e964d7e630c9a7009aec2457419264c6e3b39 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 3 Aug 2015 10:15:28 +0100 Subject: [PATCH 197/487] Don't need to support Django 1.4 with FilePathField. --- rest_framework/compat.py | 18 ------------------ rest_framework/fields.py | 8 +++++--- 2 files changed, 5 insertions(+), 21 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 08df02ec..d1854182 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -257,21 +257,3 @@ def set_rollback(): else: # transaction not managed pass - - -def get_filepathfield(path, match=None, recursive=False, allow_files=True, - allow_folders=False, required=None): - """Create proper Django FilePathField with allowed kwargs.""" - - if django.VERSION < (1, 5): - # django field doesn't have allow_folders, allow_files kwargs - field = DjangoFilePathField( - path, match=match, recursive=recursive, required=required - ) - else: - field = DjangoFilePathField( - path, match=match, recursive=recursive, allow_files=allow_files, - allow_folders=allow_folders, required=required - ) - - return field diff --git a/rest_framework/fields.py b/rest_framework/fields.py index a2a4e3bf..bff73dd2 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -12,6 +12,7 @@ from django.conf import settings from django.core.exceptions import ValidationError as DjangoValidationError from django.core.exceptions import ObjectDoesNotExist from django.core.validators import RegexValidator, ip_address_validators +from django.forms import FilePathField as DjangoFilePathField from django.forms import ImageField as DjangoImageField from django.utils import six, timezone from django.utils.dateparse import parse_date, parse_datetime, parse_time @@ -23,7 +24,7 @@ from rest_framework import ISO_8601 from rest_framework.compat import ( EmailValidator, MaxLengthValidator, MaxValueValidator, MinLengthValidator, MinValueValidator, OrderedDict, URLValidator, duration_string, - get_filepathfield, parse_duration, unicode_repr, unicode_to_repr + parse_duration, unicode_repr, unicode_to_repr ) from rest_framework.exceptions import ValidationError from rest_framework.settings import api_settings @@ -713,8 +714,9 @@ class FilePathField(CharField): allow_folders=False, required=None, **kwargs): super(FilePathField, self).__init__(**kwargs) - # create field and get options to avoid code duplication - field = get_filepathfield( + # Defer to Django's FilePathField implmentation to get the + # valid set of choices. + field = DjangoFilePathField( path, match=match, recursive=recursive, allow_files=allow_files, allow_folders=allow_folders, required=required ) From bf35906dc01f03ead9a5fd96a47c05c4ace95cff Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 3 Aug 2015 10:17:41 +0100 Subject: [PATCH 198/487] FilePathField subclassing from ChoiceField --- rest_framework/fields.py | 53 +++++++++++++--------------------------- 1 file changed, 17 insertions(+), 36 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index bff73dd2..aa264b2a 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -705,42 +705,6 @@ class IPAddressField(CharField): return super(IPAddressField, self).to_internal_value(data) -class FilePathField(CharField): - default_error_messages = { - 'invalid_choice': _('"{input}" is not a valid path choice.') - } - - def __init__(self, path, match=None, recursive=False, allow_files=True, - allow_folders=False, required=None, **kwargs): - super(FilePathField, self).__init__(**kwargs) - - # Defer to Django's FilePathField implmentation to get the - # valid set of choices. - field = DjangoFilePathField( - path, match=match, recursive=recursive, allow_files=allow_files, - allow_folders=allow_folders, required=required - ) - - self.choices = OrderedDict(field.choices) - self.choice_strings_to_values = dict([ - (six.text_type(key), key) for key in self.choices.keys() - ]) - - def to_internal_value(self, data): - if data == '' and self.allow_blank: - return '' - - try: - return self.choice_strings_to_values[six.text_type(data)] - except KeyError: - self.fail('invalid_choice', input=data) - - def to_representation(self, value): - if value in ('', None): - return value - return self.choice_strings_to_values[six.text_type(value)] - - # Number types... class IntegerField(Field): @@ -1215,6 +1179,23 @@ class MultipleChoiceField(ChoiceField): ]) +class FilePathField(ChoiceField): + default_error_messages = { + 'invalid_choice': _('"{input}" is not a valid path choice.') + } + + def __init__(self, path, match=None, recursive=False, allow_files=True, + allow_folders=False, required=None, **kwargs): + # Defer to Django's FilePathField implmentation to get the + # valid set of choices. + field = DjangoFilePathField( + path, match=match, recursive=recursive, allow_files=allow_files, + allow_folders=allow_folders, required=required + ) + kwargs['choices'] = field.choices + super(FilePathField, self).__init__(**kwargs) + + # File types... class FileField(Field): From 4cb14d82406c30e2080b3a5ce1e88f54a5d8a632 Mon Sep 17 00:00:00 2001 From: Trey Hunner Date: Mon, 3 Aug 2015 08:39:24 -0700 Subject: [PATCH 199/487] Don't measure branch coverage --- .coveragerc | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 .coveragerc diff --git a/.coveragerc b/.coveragerc deleted file mode 100644 index 398ff08a..00000000 --- a/.coveragerc +++ /dev/null @@ -1,2 +0,0 @@ -[run] -branch = True From 60c17253ab5618e071bc51b0ce9df8053bda9ae3 Mon Sep 17 00:00:00 2001 From: Cesar Canassa Date: Mon, 3 Aug 2015 17:54:18 +0200 Subject: [PATCH 200/487] Add test to check if a 415 status is returned for unsupported media types --- tests/test_response.py | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/tests/test_response.py b/tests/test_response.py index 1dd5d5ea..b53688e5 100644 --- a/tests/test_response.py +++ b/tests/test_response.py @@ -5,6 +5,7 @@ from django.test import TestCase from django.utils import six from rest_framework import generics, routers, serializers, status, viewsets +from rest_framework.parsers import JSONParser from rest_framework.renderers import ( BaseRenderer, BrowsableAPIRenderer, JSONRenderer ) @@ -79,6 +80,14 @@ class MockViewSettingContentType(APIView): return Response(DUMMYCONTENT, status=DUMMYSTATUS, content_type='setbyview') +class JSONView(APIView): + parser_classes = (JSONParser,) + + def post(self, request, **kwargs): + assert request.data + return Response(DUMMYCONTENT) + + class HTMLView(APIView): renderer_classes = (BrowsableAPIRenderer, ) @@ -114,6 +123,7 @@ urlpatterns = [ url(r'^.*\.(?P.+)$', MockView.as_view(renderer_classes=[RendererA, RendererB, RendererC])), url(r'^$', MockView.as_view(renderer_classes=[RendererA, RendererB, RendererC])), url(r'^html$', HTMLView.as_view()), + url(r'^json$', JSONView.as_view()), url(r'^html1$', HTMLView1.as_view()), url(r'^html_new_model$', HTMLNewModelView.as_view()), url(r'^html_new_model_viewset', include(new_model_viewset_router.urls)), @@ -203,6 +213,25 @@ class RendererIntegrationTests(TestCase): self.assertEqual(resp.status_code, DUMMYSTATUS) +class UnsupportedMediaTypeTests(TestCase): + urls = 'tests.test_response' + + def test_should_allow_posting_json(self): + response = self.client.post('/json', data='{"test": 123}', content_type='application/json') + + self.assertEqual(response.status_code, 200) + + def test_should_not_allow_posting_xml(self): + response = self.client.post('/json', data='123', content_type='application/xml') + + self.assertEqual(response.status_code, 415) + + def test_should_not_allow_posting_a_form(self): + response = self.client.post('/json', data={'test': 123}) + + self.assertEqual(response.status_code, 415) + + class Issue122Tests(TestCase): """ Tests that covers #122. From 34c74b8925ed0e012c524d0e569f7b93d634928a Mon Sep 17 00:00:00 2001 From: Trey Hunner Date: Mon, 3 Aug 2015 08:57:18 -0700 Subject: [PATCH 201/487] Add coverage badge --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index af8ac58e..78e69ee6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # [Django REST framework][docs] [![build-status-image]][travis] +[![coverage-status-image]][codecov] [![pypi-version]][pypi] **Awesome web-browsable Web APIs.** @@ -159,6 +160,8 @@ Send a description of the issue via email to [rest-framework-security@googlegrou [build-status-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.svg?branch=master [travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master +[coverage-status-image]: http://codecov.io/github/tomchristie/django-rest-framework/coverage.svg?branch=master +[codecov]: http://codecov.io/github/tomchristie/django-rest-framework?branch=master [pypi-version]: https://img.shields.io/pypi/v/djangorestframework.svg [pypi]: https://pypi.python.org/pypi/djangorestframework [twitter]: https://twitter.com/_tomchristie From cc5af22dc06128a2f634af1c6340c31f0f4579e6 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 4 Aug 2015 09:45:20 +0100 Subject: [PATCH 202/487] Use 'shilds.io' badge for codecov --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5dd40335..bb1650bd 100644 --- a/README.md +++ b/README.md @@ -161,7 +161,7 @@ Send a description of the issue via email to [rest-framework-security@googlegrou [build-status-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.svg?branch=master [travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master [coverage-status-image]: http://codecov.io/github/tomchristie/django-rest-framework/coverage.svg?branch=master -[codecov]: http://codecov.io/github/tomchristie/django-rest-framework?branch=master +[codecov]: https://img.shields.io/codecov/c/github/tomchristie/django-rest-framework/master.svg [pypi-version]: https://img.shields.io/pypi/v/djangorestframework.svg [pypi]: https://pypi.python.org/pypi/djangorestframework [twitter]: https://twitter.com/_tomchristie From 18c93912180aa93d1120495d4f7e47d7bed025f4 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 4 Aug 2015 09:47:36 +0100 Subject: [PATCH 203/487] Use shields.io image --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bb1650bd..6d7a3a95 100644 --- a/README.md +++ b/README.md @@ -160,8 +160,8 @@ Send a description of the issue via email to [rest-framework-security@googlegrou [build-status-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.svg?branch=master [travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master -[coverage-status-image]: http://codecov.io/github/tomchristie/django-rest-framework/coverage.svg?branch=master -[codecov]: https://img.shields.io/codecov/c/github/tomchristie/django-rest-framework/master.svg +[coverage-status-image]: https://img.shields.io/codecov/c/github/tomchristie/django-rest-framework/master.svg +[codecov]: http://codecov.io/github/tomchristie/django-rest-framework?branch=master [pypi-version]: https://img.shields.io/pypi/v/djangorestframework.svg [pypi]: https://pypi.python.org/pypi/djangorestframework [twitter]: https://twitter.com/_tomchristie From 7b515086003e0f6a61e73467f0f28df4420de2f8 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 5 Aug 2015 13:42:44 +0100 Subject: [PATCH 204/487] Error on double underscore ordering with CursorPagination. Refs #3221. --- rest_framework/pagination.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py index c00e2796..f8850354 100644 --- a/rest_framework/pagination.py +++ b/rest_framework/pagination.py @@ -665,6 +665,11 @@ class CursorPagination(BasePagination): 'Using cursor pagination, but no ordering attribute was declared ' 'on the pagination class.' ) + assert '__' not in ordering, ( + 'Cursor pagination does not support double underscore lookups ' + 'for orderings. Orderings should be an unchanging, unique or ' + 'nearly-unique field on the model, such as "-created" or "pk".' + ) assert isinstance(ordering, (six.string_types, list, tuple)), ( 'Invalid ordering. Expected string or tuple, but got {type}'.format( From 6161ac7d07226da1fed643a6957a834b3dc3b619 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 5 Aug 2015 13:45:56 +0100 Subject: [PATCH 205/487] Fix parse_html_dict signature. Closes #3212. --- rest_framework/utils/html.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/utils/html.py b/rest_framework/utils/html.py index 341f7bcd..c5fc5d8d 100644 --- a/rest_framework/utils/html.py +++ b/rest_framework/utils/html.py @@ -62,7 +62,7 @@ def parse_html_list(dictionary, prefix=''): return [ret[item] for item in sorted(ret.keys())] -def parse_html_dict(dictionary, prefix): +def parse_html_dict(dictionary, prefix=''): """ Used to support dictionary values in HTML forms. From 6942fa5dabe83793b9db19e86821c24438f22885 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 5 Aug 2015 13:59:55 +0100 Subject: [PATCH 206/487] Mask view docstring on 401 and 403 responses. Closes #3216. --- rest_framework/renderers.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index bcc3302c..cb45252f 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -592,7 +592,9 @@ class BrowsableAPIRenderer(BaseRenderer): def get_name(self, view): return view.get_view_name() - def get_description(self, view): + def get_description(self, view, status_code): + if status_code in (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN): + return '' return view.get_view_description(html=True) def get_breadcrumbs(self, request): @@ -631,7 +633,7 @@ class BrowsableAPIRenderer(BaseRenderer): 'view': view, 'request': request, 'response': response, - 'description': self.get_description(view), + 'description': self.get_description(view, response.status_code), 'name': self.get_name(view), 'version': VERSION, 'paginator': paginator, From f7d44dfae0d73a33373f62cf1905c10f89fcfb9e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 5 Aug 2015 17:07:47 +0100 Subject: [PATCH 207/487] Loud errors on request.DATA et al. --- rest_framework/request.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/rest_framework/request.py b/rest_framework/request.py index 858ecd59..ef35972c 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -448,3 +448,24 @@ class Request(object): return getattr(self._request, attr) except AttributeError: six.reraise(info[0], info[1], info[2].tb_next) + + @property + def DATA(self): + raise NotImplementedError( + '`request.DATA` has been deprecated in favor of `request.data` ' + 'since version 3.0, and has been fully removed as of version 3.2.' + ) + + @property + def FILES(self): + raise NotImplementedError( + '`request.FILES` has been deprecated in favor of `request.files` ' + 'since version 3.0, and has been fully removed as of version 3.2.' + ) + + @property + def QUERY_PARAMS(self): + raise NotImplementedError( + '`request.QUERY_PARAMS` has been deprecated in favor of `request.query_params` ' + 'since version 3.0, and has been fully removed as of version 3.2.' + ) From c099d9aac4dce2ba3b2cca440bd7f8a3d368958f Mon Sep 17 00:00:00 2001 From: wwj718 Date: Thu, 6 Aug 2015 11:08:56 +0800 Subject: [PATCH 208/487] import permission_classes many people don't know how to import permission_classes --- docs/api-guide/permissions.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md index a78334ea..73821d55 100644 --- a/docs/api-guide/permissions.md +++ b/docs/api-guide/permissions.md @@ -88,6 +88,8 @@ using the `APIView` class based views. Or, if you're using the `@api_view` decorator with function based views. + from rest_framework.decorators import permission_classes + @api_view('GET') @permission_classes((IsAuthenticated, )) def example_view(request, format=None): From 38a1b3ec6b62ea0e5bfcb0de2043067d8e333c95 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 6 Aug 2015 09:51:00 +0100 Subject: [PATCH 209/487] Rationalize decimal logic. Closes #3222. --- rest_framework/fields.py | 38 ++++++++++++++++++++++++-------------- tests/test_fields.py | 6 ++++-- 2 files changed, 28 insertions(+), 16 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index aa264b2a..37c90295 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -797,6 +797,11 @@ class DecimalField(Field): self.max_value = max_value self.min_value = min_value + if self.max_digits is not None and self.decimal_places is not None: + self.max_whole_digits = self.max_digits - self.decimal_places + else: + self.max_whole_digits = None + super(DecimalField, self).__init__(**kwargs) if self.max_value is not None: @@ -840,24 +845,29 @@ class DecimalField(Field): values or to enhance it in any way you need to. """ sign, digittuple, exponent = value.as_tuple() - decimals = exponent * decimal.Decimal(-1) if exponent < 0 else 0 - # digittuple doesn't include any leading zeros. - digits = len(digittuple) - if decimals > digits: - # We have leading zeros up to or past the decimal point. Count - # everything past the decimal point as a digit. We do not count - # 0 before the decimal point as a digit since that would mean - # we would not allow max_digits = decimal_places. - digits = decimals - whole_digits = digits - decimals + if exponent >= 0: + # 1234500.0 + total_digits = len(digittuple) + exponent + whole_digits = total_digits + decimal_places = 0 + elif len(digittuple) > abs(exponent): + # 123.45 + total_digits = len(digittuple) + whole_digits = total_digits - abs(exponent) + decimal_places = abs(exponent) + else: + # 0.001234 + total_digits = abs(exponent) + whole_digits = 0 + decimal_places = total_digits - if self.max_digits is not None and digits > self.max_digits: + if self.max_digits is not None and total_digits > self.max_digits: self.fail('max_digits', max_digits=self.max_digits) - if self.decimal_places is not None and decimals > self.decimal_places: + if self.decimal_places is not None and decimal_places > self.decimal_places: self.fail('max_decimal_places', max_decimal_places=self.decimal_places) - if self.max_digits is not None and self.decimal_places is not None and whole_digits > (self.max_digits - self.decimal_places): - self.fail('max_whole_digits', max_whole_digits=self.max_digits - self.decimal_places) + if self.max_whole_digits is not None and whole_digits > self.max_whole_digits: + self.fail('max_whole_digits', max_whole_digits=self.max_whole_digits) return value diff --git a/tests/test_fields.py b/tests/test_fields.py index 04278735..6adba66a 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -766,15 +766,17 @@ class TestDecimalField(FieldValues): 0: Decimal('0'), 12.3: Decimal('12.3'), 0.1: Decimal('0.1'), - '2E+2': Decimal('200'), + '2E+1': Decimal('20'), } invalid_inputs = ( ('abc', ["A valid number is required."]), (Decimal('Nan'), ["A valid number is required."]), (Decimal('Inf'), ["A valid number is required."]), ('12.345', ["Ensure that there are no more than 3 digits in total."]), + (200000000000.0, ["Ensure that there are no more than 3 digits in total."]), ('0.01', ["Ensure that there are no more than 1 decimal places."]), - (123, ["Ensure that there are no more than 2 digits before the decimal point."]) + (123, ["Ensure that there are no more than 2 digits before the decimal point."]), + ('2E+2', ["Ensure that there are no more than 2 digits before the decimal point."]) ) outputs = { '1': '1.0', From 9a778793f8dc97e0b76070e1e005514b8717a03d Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 6 Aug 2015 09:56:09 +0100 Subject: [PATCH 210/487] Adding imports to docs --- docs/api-guide/permissions.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md index 73821d55..0f5947d6 100644 --- a/docs/api-guide/permissions.md +++ b/docs/api-guide/permissions.md @@ -74,8 +74,8 @@ You can also set the authentication policy on a per-view, or per-viewset basis, using the `APIView` class based views. from rest_framework.permissions import IsAuthenticated - from rest_framework.response import Response - from rest_framework.views import APIView + from rest_framework.response import Response + from rest_framework.views import APIView class ExampleView(APIView): permission_classes = (IsAuthenticated,) @@ -88,8 +88,10 @@ using the `APIView` class based views. Or, if you're using the `@api_view` decorator with function based views. - from rest_framework.decorators import permission_classes - + from rest_framework.decorators import api_view, permission_classes + from rest_framework.permissions import IsAuthenticated + from rest_framework.response import Response + @api_view('GET') @permission_classes((IsAuthenticated, )) def example_view(request, format=None): From 27ac5a368091823f071eed198f6125eee2de8dfa Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 6 Aug 2015 11:43:03 +0100 Subject: [PATCH 211/487] Support grouped choices --- rest_framework/fields.py | 87 ++++++++++++++----- .../rest_framework/horizontal/select.html | 10 ++- .../horizontal/select_multiple.html | 10 ++- .../rest_framework/inline/select.html | 11 ++- .../inline/select_multiple.html | 12 ++- .../rest_framework/vertical/select.html | 11 ++- .../vertical/select_multiple.html | 10 ++- rest_framework/utils/field_mapping.py | 4 +- tests/test_model_serializer.py | 2 +- 9 files changed, 118 insertions(+), 39 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 9e44a3dc..4aa33452 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -5,7 +5,6 @@ import copy import datetime import decimal import inspect -import itertools import re import uuid @@ -109,32 +108,54 @@ def set_value(dictionary, keys, value): dictionary[keys[-1]] = value -def flatten_choice(choice): +def pairwise_choices(choices): """ - Convert a single choices choice into a flat list of choices. + Convert any single choices into key/value pairs instead. - Returns a list of choices pairs. - - flatten_choice(1) -> [(1, 1)] - flatten_choice((1, '1st')) -> [(1, '1st')] - flatten_choice(('Grp', ((1, '1st'), (2, '2nd')))) -> [(1, '1st'), (2, '2nd')] + pairwise_choices([1]) -> [(1, 1)] + pairwise_choices([(1, '1st')]) -> [(1, '1st')] + pairwise_choices([('Group', ((1, '1st'), 2))]) -> [(1, '1st'), (2, 2)] """ # Allow single, paired or grouped choices style: # choices = [1, 2, 3] # choices = [(1, 'First'), (2, 'Second'), (3, 'Third')] # choices = [('Category', ((1, 'First'), (2, 'Second'))), (3, 'Third')] - if (not isinstance(choice, (list, tuple))): - # single choice - return [(choice, choice)] - else: - key, display_value = choice - if isinstance(display_value, (list, tuple)): - # grouped choices - sub_choices = [flatten_choice(c) for c in display_value] - return list(itertools.chain(*sub_choices)) + ret = [] + for choice in choices: + if (not isinstance(choice, (list, tuple))): + # single choice + item = (choice, choice) + ret.append(item) else: - # paired choice - return [(key, display_value)] + key, value = choice + if isinstance(value, (list, tuple)): + # grouped choices (category, sub choices) + item = (key, pairwise_choices(value)) + ret.append(item) + else: + # paired choice (key, display value) + item = (key, value) + ret.append(item) + return ret + + +def flatten_choices(choices): + """ + Convert a group choices into a flat list of choices. + + flatten_choices([(1, '1st')]) -> [(1, '1st')] + flatten_choices([('Grp', ((1, '1st'), (2, '2nd')))]) -> [(1, '1st'), (2, '2nd')] + """ + ret = [] + for key, value in choices: + if isinstance(value, (list, tuple)): + # grouped choices (category, sub choices) + ret.extend(flatten_choices(value)) + else: + # choice (key, display value) + item = (key, value) + ret.append(item) + return ret class CreateOnlyDefault(object): @@ -1140,8 +1161,8 @@ class ChoiceField(Field): } def __init__(self, choices, **kwargs): - flat_choices = [flatten_choice(c) for c in choices] - self.choices = OrderedDict(list(itertools.chain(*flat_choices))) + self.grouped_choices = pairwise_choices(choices) + self.choices = OrderedDict(flatten_choices(self.grouped_choices)) # Map the string representation of choices to the underlying value. # Allows us to deal with eg. integer choices while supporting either @@ -1168,6 +1189,30 @@ class ChoiceField(Field): return value return self.choice_strings_to_values.get(six.text_type(value), value) + def iter_options(self): + class StartOptionGroup(object): + start_option_group = True + + def __init__(self, label): + self.label = label + + class EndOptionGroup(object): + end_option_group = True + + class Option(object): + def __init__(self, value, display_text): + self.value = value + self.display_text = display_text + + for key, value in self.grouped_choices: + if isinstance(value, (list, tuple)): + yield StartOptionGroup(label=key) + for sub_key, sub_value in value: + yield Option(value=sub_key, display_text=sub_value) + yield EndOptionGroup() + else: + yield Option(value=key, display_text=value) + class MultipleChoiceField(ChoiceField): default_error_messages = { diff --git a/rest_framework/templates/rest_framework/horizontal/select.html b/rest_framework/templates/rest_framework/horizontal/select.html index 8957eef9..4aa3db3d 100644 --- a/rest_framework/templates/rest_framework/horizontal/select.html +++ b/rest_framework/templates/rest_framework/horizontal/select.html @@ -10,8 +10,14 @@ {% if field.allow_null or field.allow_blank %} {% endif %} - {% for key, text in field.choices.items %} - + {% for select in field.iter_options %} + {% if select.start_option_group %} + + {% elif select.end_option_group %} + + {% else %} + + {% endif %} {% endfor %} diff --git a/rest_framework/templates/rest_framework/horizontal/select_multiple.html b/rest_framework/templates/rest_framework/horizontal/select_multiple.html index 407b356f..b1ca2f14 100644 --- a/rest_framework/templates/rest_framework/horizontal/select_multiple.html +++ b/rest_framework/templates/rest_framework/horizontal/select_multiple.html @@ -10,8 +10,14 @@
    diff --git a/rest_framework/templates/rest_framework/inline/select_multiple.html b/rest_framework/templates/rest_framework/inline/select_multiple.html index b9b8bb4e..3bae43eb 100644 --- a/rest_framework/templates/rest_framework/inline/select_multiple.html +++ b/rest_framework/templates/rest_framework/inline/select_multiple.html @@ -9,9 +9,15 @@ {% endif %} diff --git a/rest_framework/templates/rest_framework/vertical/select.html b/rest_framework/templates/rest_framework/vertical/select.html index dc32d39d..ce30022d 100644 --- a/rest_framework/templates/rest_framework/vertical/select.html +++ b/rest_framework/templates/rest_framework/vertical/select.html @@ -9,9 +9,14 @@ {% if field.allow_null or field.allow_blank %} {% endif %} - - {% for key, text in field.choices.items %} - + {% for select in field.iter_options %} + {% if select.start_option_group %} + + {% elif select.end_option_group %} + + {% else %} + + {% endif %} {% endfor %} diff --git a/rest_framework/templates/rest_framework/vertical/select_multiple.html b/rest_framework/templates/rest_framework/vertical/select_multiple.html index 2bb3d5ae..cb65cec5 100644 --- a/rest_framework/templates/rest_framework/vertical/select_multiple.html +++ b/rest_framework/templates/rest_framework/vertical/select_multiple.html @@ -9,8 +9,14 @@ {% endif %} diff --git a/rest_framework/templates/rest_framework/horizontal/select_multiple.html b/rest_framework/templates/rest_framework/horizontal/select_multiple.html index f8763ce7..b00a63fb 100644 --- a/rest_framework/templates/rest_framework/horizontal/select_multiple.html +++ b/rest_framework/templates/rest_framework/horizontal/select_multiple.html @@ -16,7 +16,7 @@ {% elif select.end_option_group %} {% else %} - + {% endif %} {% empty %} diff --git a/rest_framework/templates/rest_framework/inline/select.html b/rest_framework/templates/rest_framework/inline/select.html index d5204bb8..99f10ae7 100644 --- a/rest_framework/templates/rest_framework/inline/select.html +++ b/rest_framework/templates/rest_framework/inline/select.html @@ -15,7 +15,7 @@ {% elif select.end_option_group %} {% else %} - + {% endif %} {% endfor %} diff --git a/rest_framework/templates/rest_framework/inline/select_multiple.html b/rest_framework/templates/rest_framework/inline/select_multiple.html index a2e94d21..1c0e96b3 100644 --- a/rest_framework/templates/rest_framework/inline/select_multiple.html +++ b/rest_framework/templates/rest_framework/inline/select_multiple.html @@ -15,7 +15,7 @@ {% elif select.end_option_group %} {% else %} - + {% endif %} {% empty %} diff --git a/rest_framework/templates/rest_framework/vertical/select.html b/rest_framework/templates/rest_framework/vertical/select.html index ce30022d..973efb67 100644 --- a/rest_framework/templates/rest_framework/vertical/select.html +++ b/rest_framework/templates/rest_framework/vertical/select.html @@ -15,7 +15,7 @@ {% elif select.end_option_group %} {% else %} - + {% endif %} {% endfor %} diff --git a/rest_framework/templates/rest_framework/vertical/select_multiple.html b/rest_framework/templates/rest_framework/vertical/select_multiple.html index b5effe03..dcbee2ed 100644 --- a/rest_framework/templates/rest_framework/vertical/select_multiple.html +++ b/rest_framework/templates/rest_framework/vertical/select_multiple.html @@ -15,7 +15,7 @@ {% elif select.end_option_group %} {% else %} - + {% endif %} {% empty %} From 99beeb80e1819dc16f02079fa70b65f4f2b212be Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 21 Aug 2015 10:53:10 +0100 Subject: [PATCH 263/487] No cutoff for default ChoiceField, only for relationships --- rest_framework/fields.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index a362c9d2..0bf442f5 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1202,7 +1202,7 @@ class ChoiceField(Field): default_error_messages = { 'invalid_choice': _('"{input}" is not a valid choice.') } - html_cutoff = 1000 + html_cutoff = None html_cutoff_text = _('More than {count} items...') def __init__(self, choices, **kwargs): From 314c0095aabc118275ef5b374c9fbfd2123a22e6 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 21 Aug 2015 10:56:22 +0100 Subject: [PATCH 264/487] iter_options function should have no cutoff by deault --- rest_framework/fields.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 0bf442f5..10a31028 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -156,7 +156,7 @@ def flatten_choices_dict(choices): return ret -def iter_options(grouped_choices, cutoff=1000, cutoff_text=None): +def iter_options(grouped_choices, cutoff=None, cutoff_text=None): """ Helper function for options and option groups in templates. """ From c271568bf55f5fb9053a78f20ac2bc84951d709b Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 21 Aug 2015 10:57:46 +0100 Subject: [PATCH 265/487] Remove erronous checkin --- rest_framework/templates/rest_framework/filters/ordering.html | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 rest_framework/templates/rest_framework/filters/ordering.html diff --git a/rest_framework/templates/rest_framework/filters/ordering.html b/rest_framework/templates/rest_framework/filters/ordering.html deleted file mode 100644 index e69de29b..00000000 From 314daaedfac3fb49d0b99648bb92bcd786c7805e Mon Sep 17 00:00:00 2001 From: borzdyko Date: Fri, 21 Aug 2015 18:13:13 +0300 Subject: [PATCH 266/487] Using https://docs.djangoproject.com/en/1.8/ref/models/querysets/#regex for search filter by starting field with '$' --- rest_framework/filters.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index e05d31ae..93126367 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -94,6 +94,8 @@ class SearchFilter(BaseFilterBackend): return "%s__iexact" % field_name[1:] elif field_name.startswith('@'): return "%s__search" % field_name[1:] + if field_name.startswith('$'): + return "%s__iregex" % field_name[1:] else: return "%s__icontains" % field_name From 5db900c625e5202eba52f375e6544fddd763f590 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 21 Aug 2015 16:13:52 +0100 Subject: [PATCH 267/487] First pass at HTML rendering for filters --- rest_framework/filters.py | 52 ++++++++++++++++++- rest_framework/renderers.py | 21 ++++++++ .../static/rest_framework/css/default.css | 8 +++ .../templates/rest_framework/base.html | 12 +++++ .../rest_framework/filters/base.html | 16 ++++++ .../rest_framework/filters/django_filter.html | 4 ++ .../rest_framework/filters/ordering.html | 10 ++++ 7 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 rest_framework/templates/rest_framework/filters/base.html create mode 100644 rest_framework/templates/rest_framework/filters/django_filter.html create mode 100644 rest_framework/templates/rest_framework/filters/ordering.html diff --git a/rest_framework/filters.py b/rest_framework/filters.py index e05d31ae..265dfae1 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -9,6 +9,7 @@ from functools import reduce from django.core.exceptions import ImproperlyConfigured from django.db import models +from django.template import Context, Template, loader from django.utils import six from rest_framework.compat import ( @@ -36,6 +37,7 @@ class DjangoFilterBackend(BaseFilterBackend): A filter backend that uses django-filter. """ default_filter_set = FilterSet + template = 'rest_framework/filters/django_filter.html' def __init__(self): assert django_filters, 'Using DjangoFilterBackend, but django-filter is not installed' @@ -57,11 +59,33 @@ class DjangoFilterBackend(BaseFilterBackend): return filter_class if filter_fields: + from crispy_forms.helper import FormHelper + from crispy_forms.layout import Field, Fieldset, Layout, Submit + class AutoFilterSet(self.default_filter_set): class Meta: model = queryset.model fields = filter_fields + @property + def form(self): + self._form = super(AutoFilterSet, self).form + for field in self._form.fields.values(): + field.help_text = None + layout_components = filter_fields + [ + Submit('', 'Apply', css_class='btn-default'), + ] + + helper = FormHelper() + helper.form_method = 'get' + helper.form_action = '.' + helper.template_pack = 'bootstrap3' + + helper.layout = Layout(*layout_components) + + self._form.helper = helper + return self._form + return AutoFilterSet return None @@ -74,6 +98,15 @@ class DjangoFilterBackend(BaseFilterBackend): return queryset + def to_html(self, request, queryset, view): + cls = self.get_filter_class(view, queryset) + filter_instance = cls(request.query_params, queryset=queryset) + context = Context({ + 'filter': filter_instance + }) + template = loader.get_template(self.template) + return template.render(context) + class SearchFilter(BaseFilterBackend): # The URL query parameter used for the search. @@ -127,6 +160,7 @@ class OrderingFilter(BaseFilterBackend): # The URL query parameter used for the ordering. ordering_param = api_settings.ORDERING_PARAM ordering_fields = None + template = 'rest_framework/filters/ordering.html' def get_ordering(self, request, queryset, view): """ @@ -152,7 +186,7 @@ class OrderingFilter(BaseFilterBackend): return (ordering,) return ordering - def remove_invalid_fields(self, queryset, fields, view): + def get_valid_fields(self, queryset, view): valid_fields = getattr(view, 'ordering_fields', self.ordering_fields) if valid_fields is None: @@ -172,6 +206,10 @@ class OrderingFilter(BaseFilterBackend): valid_fields = [field.name for field in queryset.model._meta.fields] valid_fields += queryset.query.aggregates.keys() + return valid_fields + + def remove_invalid_fields(self, queryset, fields, view): + valid_fields = self.get_valid_fields(queryset, view) return [term for term in fields if term.lstrip('-') in valid_fields] def filter_queryset(self, request, queryset, view): @@ -182,6 +220,18 @@ class OrderingFilter(BaseFilterBackend): return queryset + def get_template_context(self, request, queryset, view): + #default_tuple = self.get_default_ordering() + #default = None if default_tuple is None else default_tuple[0] + { + 'options': self.get_valid_fields(queryset, view), + } + + def to_html(self, request, queryset, view): + template = loader.get_template(self.template) + context = Context(self.get_template_context(request, queryset, view)) + return template.render(context) + class DjangoObjectPermissionsFilter(BaseFilterBackend): """ diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index fb0dfcbd..826a4062 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -374,6 +374,7 @@ class BrowsableAPIRenderer(BaseRenderer): media_type = 'text/html' format = 'api' template = 'rest_framework/api.html' + filter_template = 'rest_framework/filters/base.html' charset = 'utf-8' form_renderer_class = HTMLFormRenderer @@ -600,6 +601,24 @@ class BrowsableAPIRenderer(BaseRenderer): def get_breadcrumbs(self, request): return get_breadcrumbs(request.path, request) + def get_filter_form(self, view, request): + if not hasattr(view, 'get_queryset') or not hasattr(view, 'filter_backends'): + return + + queryset = view.get_queryset() + elements = [] + for backend in view.filter_backends: + if hasattr(backend, 'to_html'): + html = backend().to_html(request, queryset, view) + elements.append(html) + + if not elements: + return + + template = loader.get_template(self.filter_template) + context = Context({'elements': elements}) + return template.render(context) + def get_context(self, data, accepted_media_type, renderer_context): """ Returns the context used to render. @@ -647,6 +666,8 @@ class BrowsableAPIRenderer(BaseRenderer): 'delete_form': self.get_rendered_html_form(data, view, 'DELETE', request), 'options_form': self.get_rendered_html_form(data, view, 'OPTIONS', request), + 'filter_form': self.get_filter_form(view, request), + 'raw_data_put_form': raw_data_put_form, 'raw_data_post_form': raw_data_post_form, 'raw_data_patch_form': raw_data_patch_form, diff --git a/rest_framework/static/rest_framework/css/default.css b/rest_framework/static/rest_framework/css/default.css index f6c67546..f4e645ca 100644 --- a/rest_framework/static/rest_framework/css/default.css +++ b/rest_framework/static/rest_framework/css/default.css @@ -73,3 +73,11 @@ pre { border-bottom: none; padding-bottom: 0px; } + +#filtersModal form input[type=submit] { + width: auto; +} + +#filtersModal .modal-body h2 { + margin-top: 0 +} diff --git a/rest_framework/templates/rest_framework/base.html b/rest_framework/templates/rest_framework/base.html index abbc7595..71075ad8 100644 --- a/rest_framework/templates/rest_framework/base.html +++ b/rest_framework/templates/rest_framework/base.html @@ -109,6 +109,13 @@ {% endif %} + {% if filter_form %} + + {% endif %} +

    {{ name }}

    @@ -242,6 +249,11 @@ {% endblock %} + + {% if filter_form %} + {{ filter_form }} + {% endif %} + {% endblock %} diff --git a/rest_framework/templates/rest_framework/filters/base.html b/rest_framework/templates/rest_framework/filters/base.html new file mode 100644 index 00000000..f830e16b --- /dev/null +++ b/rest_framework/templates/rest_framework/filters/base.html @@ -0,0 +1,16 @@ + diff --git a/rest_framework/templates/rest_framework/filters/django_filter.html b/rest_framework/templates/rest_framework/filters/django_filter.html new file mode 100644 index 00000000..fa9030da --- /dev/null +++ b/rest_framework/templates/rest_framework/filters/django_filter.html @@ -0,0 +1,4 @@ +{% load crispy_forms_tags %} + +

    Field search

    +{% crispy filter.form %} diff --git a/rest_framework/templates/rest_framework/filters/ordering.html b/rest_framework/templates/rest_framework/filters/ordering.html new file mode 100644 index 00000000..4ff22031 --- /dev/null +++ b/rest_framework/templates/rest_framework/filters/ordering.html @@ -0,0 +1,10 @@ +

    Ordering

    +
    + + Most recently created + + + Least recently created + Username ascending + Username descending +
    From 21d0e5183139e421f7f2b9fd96d765e9a1563b65 Mon Sep 17 00:00:00 2001 From: borzdyko Date: Fri, 21 Aug 2015 18:23:39 +0300 Subject: [PATCH 268/487] Test for regex search filter --- tests/test_filters.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/tests/test_filters.py b/tests/test_filters.py index 9db685c2..0610b085 100644 --- a/tests/test_filters.py +++ b/tests/test_filters.py @@ -407,6 +407,23 @@ class SearchFilterTests(TestCase): ] ) + def test_regexp_search(self): + class SearchListView(generics.ListAPIView): + queryset = SearchFilterModel.objects.all() + serializer_class = SearchFilterSerializer + filter_backends = (filters.SearchFilter,) + search_fields = ('$title', '$text') + + view = SearchListView.as_view() + request = factory.get('/', {'search': 'z{2} ^b'}) + response = view(request) + self.assertEqual( + response.data, + [ + {'id': 2, 'title': 'zz', 'text': 'bcd'} + ] + ) + def test_search_with_nonstandard_search_param(self): with override_settings(REST_FRAMEWORK={'SEARCH_PARAM': 'query'}): reload_module(filters) From f0782b9451be3b04dd4239d1199ea6a7278edd21 Mon Sep 17 00:00:00 2001 From: borzdyko Date: Fri, 21 Aug 2015 18:26:23 +0300 Subject: [PATCH 269/487] Doc for regex search filter --- docs/api-guide/filtering.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md index e65c6bf4..6f4648cf 100644 --- a/docs/api-guide/filtering.md +++ b/docs/api-guide/filtering.md @@ -260,6 +260,7 @@ The search behavior may be restricted by prepending various characters to the `s * '^' Starts-with search. * '=' Exact matches. * '@' Full-text search. (Currently only supported Django's MySQL backend.) +* '$' Regex search. For example: From 01fa2647c9d2d5ed1a7cbff513afd9f3b38efd5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Sat, 22 Aug 2015 08:49:05 -0400 Subject: [PATCH 270/487] Bump up maximum supported Django versions --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 489e8a7a..ef505248 100644 --- a/tox.ini +++ b/tox.ini @@ -14,8 +14,8 @@ setenv = deps = django15: Django==1.5.6 # Should track minimum supported django16: Django==1.6.3 # Should track minimum supported - django17: Django==1.7.8 # Should track maximum supported - django18: Django==1.8.2 # Should track maximum supported + django17: Django==1.7.10 # Should track maximum supported + django18: Django==1.8.4 # Should track maximum supported djangomaster: https://github.com/django/django/archive/master.tar.gz -rrequirements/requirements-testing.txt -rrequirements/requirements-optionals.txt From 9ac646385f79d352c4105cb96ebb19a3c84b1d77 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 24 Aug 2015 10:13:16 +0100 Subject: [PATCH 271/487] Resolve empty HTML charfield behavior. Closes #3318. --- rest_framework/fields.py | 6 ++++-- tests/test_fields.py | 18 +++++++++++++++++- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 10a31028..faf41e7a 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -385,8 +385,10 @@ class Field(object): # If the field is blank, and null is a valid value then # determine if we should use null instead. return '' if getattr(self, 'allow_blank', False) else None - elif ret == '' and self.default: - return empty + elif ret == '' and not self.required: + # If the field is blank, and emptyness is valid then + # determine if we should use emptyness instead. + return '' if getattr(self, 'allow_blank', False) else empty return ret return dictionary.get(self.field_name, empty) diff --git a/tests/test_fields.py b/tests/test_fields.py index 58c1c924..8065c826 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -253,7 +253,7 @@ class TestBooleanHTMLInput: class TestHTMLInput: - def test_empty_html_charfield(self): + def test_empty_html_charfield_with_default(self): class TestSerializer(serializers.Serializer): message = serializers.CharField(default='happy') @@ -261,6 +261,22 @@ class TestHTMLInput: assert serializer.is_valid() assert serializer.validated_data == {'message': 'happy'} + def test_empty_html_charfield_without_default(self): + class TestSerializer(serializers.Serializer): + message = serializers.CharField(allow_blank=True) + + serializer = TestSerializer(data=QueryDict('message=')) + assert serializer.is_valid() + assert serializer.validated_data == {'message': ''} + + def test_empty_html_charfield_without_default_not_required(self): + class TestSerializer(serializers.Serializer): + message = serializers.CharField(allow_blank=True, required=False) + + serializer = TestSerializer(data=QueryDict('message=')) + assert serializer.is_valid() + assert serializer.validated_data == {'message': ''} + def test_empty_html_integerfield(self): class TestSerializer(serializers.Serializer): message = serializers.IntegerField(default=123) From 0198bce34f13e3852f082863bd2add7d0285e48b Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 24 Aug 2015 10:59:52 +0100 Subject: [PATCH 272/487] Release 3.2.3 --- docs/topics/release-notes.md | 33 +++++++++++++++++++++++++++++++-- rest_framework/__init__.py | 2 +- 2 files changed, 32 insertions(+), 3 deletions(-) diff --git a/docs/topics/release-notes.md b/docs/topics/release-notes.md index 4fa365d0..68803a5b 100644 --- a/docs/topics/release-notes.md +++ b/docs/topics/release-notes.md @@ -40,6 +40,18 @@ You can determine your currently installed version using `pip freeze`: ## 3.2.x series +### 3.2.3 + +**Date**: [24th August 2015][3.2.3-milestone]. + +* Added `html_cutoff` and `html_cutoff_text` for limiting select dropdowns. ([#3313][gh3313]) +* Added regex style to `SearchFilter`. ([#3316][gh3316]) +* Resolve issues with setting blank HTML fields. ([#3318][gh3318]) ([#3321][gh3321]) +* Correctly display existing 'select multiple' values in browsable API forms. ([#3290][gh3290]) +* Resolve duplicated validation message for `IPAddressField`. ([#3249[gh3249]) ([#3250][gh3250]) +* Fix to ensure admin renderer continues to work when pagination is disabled. ([#3275][gh3275]) +* Resolve error with `LimitOffsetPagination` when count=0, offset=0. ([#3303][gh3303]) + ### 3.2.2 **Date**: [13th August 2015][3.2.2-milestone]. @@ -285,7 +297,8 @@ For older release notes, [please see the version 2.x documentation][old-release- [3.1.3-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.1.3+Release%22 [3.2.0-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.0+Release%22 [3.2.1-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.1+Release%22 -[3.2.2-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.1+Release%22 +[3.2.2-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.2+Release%22 +[3.2.3-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.3+Release%22 [gh2013]: https://github.com/tomchristie/django-rest-framework/issues/2013 @@ -486,4 +499,20 @@ For older release notes, [please see the version 2.x documentation][old-release- [gh2776]: https://github.com/tomchristie/django-rest-framework/issues/2776 [gh3261]: https://github.com/tomchristie/django-rest-framework/issues/3261 [gh3260]: https://github.com/tomchristie/django-rest-framework/issues/3260 -[gh3241]: https://github.com/tomchristie/django-rest-framework/issues/3241 \ No newline at end of file +[gh3241]: https://github.com/tomchristie/django-rest-framework/issues/3241 + + +[gh3249]: https://github.com/tomchristie/django-rest-framework/issues/3249 +[gh3250]: https://github.com/tomchristie/django-rest-framework/issues/3250 +[gh3275]: https://github.com/tomchristie/django-rest-framework/issues/3275 +[gh3288]: https://github.com/tomchristie/django-rest-framework/issues/3288 +[gh3290]: https://github.com/tomchristie/django-rest-framework/issues/3290 +[gh3303]: https://github.com/tomchristie/django-rest-framework/issues/3303 +[gh3313]: https://github.com/tomchristie/django-rest-framework/issues/3313 +[gh3316]: https://github.com/tomchristie/django-rest-framework/issues/3316 +[gh3318]: https://github.com/tomchristie/django-rest-framework/issues/3318 +[gh3321]: https://github.com/tomchristie/django-rest-framework/issues/3321 + + + + diff --git a/rest_framework/__init__.py b/rest_framework/__init__.py index 4cc499af..add4fc8e 100644 --- a/rest_framework/__init__.py +++ b/rest_framework/__init__.py @@ -8,7 +8,7 @@ ______ _____ _____ _____ __ """ __title__ = 'Django REST framework' -__version__ = '3.2.2' +__version__ = '3.2.3' __author__ = 'Tom Christie' __license__ = 'BSD 2-Clause' __copyright__ = 'Copyright 2011-2015 Tom Christie' From 65df9fd5c6820733b7ba0ec78152bfffb01301db Mon Sep 17 00:00:00 2001 From: Rikuoja Date: Mon, 24 Aug 2015 17:02:49 +0300 Subject: [PATCH 273/487] Fix #3323 --- rest_framework/filters.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 93126367..90c19aba 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -102,15 +102,16 @@ class SearchFilter(BaseFilterBackend): def filter_queryset(self, request, queryset, view): search_fields = getattr(view, 'search_fields', None) - orm_lookups = [ - self.construct_search(six.text_type(search_field)) - for search_field in search_fields - ] search_terms = self.get_search_terms(request) if not search_fields or not search_terms: return queryset + orm_lookups = [ + self.construct_search(six.text_type(search_field)) + for search_field in search_fields + ] + base = queryset for search_term in search_terms: queries = [ From 49d799c45428ba88e4487e5cba351f97a5386c99 Mon Sep 17 00:00:00 2001 From: Slava Shklyaev Date: Mon, 24 Aug 2015 21:09:08 +0300 Subject: [PATCH 274/487] Fix typo --- docs/api-guide/pagination.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/pagination.md b/docs/api-guide/pagination.md index 15ebc622..881fbf14 100644 --- a/docs/api-guide/pagination.md +++ b/docs/api-guide/pagination.md @@ -15,7 +15,7 @@ The pagination API can support either: The built-in styles currently all use links included as part of the content of the response. This style is more accessible when using the browsable API. -Pagination is only performed automatically if you're using the generic views or viewsets. If you're using a regular `APIView`, you'll need to call into the pagination API yourself to ensure you return a paginated response. See the source code for the `mixins.ListMixin` and `generics.GenericAPIView` classes for an example. +Pagination is only performed automatically if you're using the generic views or viewsets. If you're using a regular `APIView`, you'll need to call into the pagination API yourself to ensure you return a paginated response. See the source code for the `mixins.ListModelMixin` and `generics.GenericAPIView` classes for an example. ## Setting the pagination style From 086115c7b86bec3b7dcabd01f141cef15adef7f5 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 25 Aug 2015 13:32:35 +0100 Subject: [PATCH 275/487] Clean up after publishing to PyPI --- setup.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/setup.py b/setup.py index 2dfcbc5b..8e9d0a9a 100755 --- a/setup.py +++ b/setup.py @@ -2,6 +2,7 @@ # -*- coding: utf-8 -*- import os import re +import shutil import sys from setuptools import setup @@ -55,6 +56,9 @@ if sys.argv[-1] == 'publish': print("You probably want to also tag the version now:") print(" git tag -a %s -m 'version %s'" % (version, version)) print(" git push --tags") + shutil.rmtree('dist') + shutil.rmtree('build') + shutil.rmtree('djangorestframework.egg-info') sys.exit() From 32946f41600d45e83dbc41212f0c476da069084f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 25 Aug 2015 14:03:30 +0100 Subject: [PATCH 276/487] Tweaks to roadmap --- docs/topics/funding.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/topics/funding.md b/docs/topics/funding.md index 69a352e4..b9cf7c1e 100644 --- a/docs/topics/funding.md +++ b/docs/topics/funding.md @@ -282,20 +282,26 @@ For further enquires please contact tom@tomch ## Roadmap +Although we're incredibly proud of REST framework in its current state we believe there is still huge scope for improvement. What we're aiming for here is a *highly polished, rock solid product*. This needs to backed up with impeccable documentation and a great third party ecosystem. + The roadmap below is a broad indication of just some of the ongoing and future work we believe is important to REST framework. +* Increasing our "bus factor" through documented organizational process & safeguards. +* More time towards testing and hardening releases, with only gradual, well-documented deprecations. +* A formal policy on security backports for non-current releases. +* Continuing triage & community support. +* Improved project documentation, including versioned & internationalized docs. +* Improved third party package visibility. +* Further work on the the admin API, making it suitable as a customizable end-user facing application. * Support for alternative backends such as SQLAlchemy. * HTTP Caching API & support for conditional database lookups. -* Performance improvements. -* Improved project documentation, including versioned & internationalized docs. +* Benchmarking and performance improvements. +* In depth documentation on advanced usage and best practices. +* Documentation & support for integration with realtime systems. * Hypermedia support and client libraries. +* Support for JSON schema as endpoints or `OPTIONS` responses. * API metric tools. * Debug & logging tools. -* In depth documentation on advanced usage and best practices. * Third party GraphQL support. -* Documentation & support for integration with realtime systems. -* Improved third party package visibility. -* Increasing our "bus factor" through documented organizational process & safeguards. -* Continuing triage & community support. By taking out a paid plan you'll be directly contributing towards making these features happen. From eb37f90dcdc384df30d7b23ef6acbf4db2a83758 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 26 Aug 2015 13:09:22 +0100 Subject: [PATCH 277/487] Tweak buisiness case --- docs/topics/funding.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/topics/funding.md b/docs/topics/funding.md index b9cf7c1e..be3070ed 100644 --- a/docs/topics/funding.md +++ b/docs/topics/funding.md @@ -100,15 +100,16 @@ Our successful Kickstarter campaign demonstrates the cost-reward ratio of shared With *typical corporate fundings of just £100-£1000 per organization* we successfully delivered: * The comprehensive 3.0 serializer redesign. -* Pagination API including new offset/limit and cursor pagination implementations, plus on-page controls. -* The versioning API, including URL based and header based versioning schemes. -* Customizable exception handling. -* The metadata APIs for handling `OPTIONS` requests. +* Substantial improvements to the Browsable API. +* The admin interface. +* A new pagination API including new offset/limit and cursor pagination implementations, plus on-page controls. +* A versioning API, including URL based and header based versioning schemes. +* Support for customizable exception handling. +* Support for Django's PostgreSQL HStoreField, ArrayField and JSONField. * Templated HTML form support, including HTML forms with nested list and objects. * Internationalization support for API responses, currently with 27 languages. -* Improvements to the browsable API. -* The admin interface. -* Support for Django's PostgreSQL HStoreField, ArrayField and JSONField. +* The metadata APIs for handling `OPTIONS` requests and schema endpoints. +* Numerous minor improvements and better quality throughout the codebase. * Ongoing triage and community support, closing over 1600 tickets. This incredible level of return on investment is *only possible through collaboratively funded models*, which is why we believe that supporting our paid plans is in everyone's best interest. From f646b469d44940f09fb552f44566d4c32ee9f7a8 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 26 Aug 2015 13:22:18 +0100 Subject: [PATCH 278/487] Copy tweaks --- docs/topics/funding.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/funding.md b/docs/topics/funding.md index be3070ed..acd213e0 100644 --- a/docs/topics/funding.md +++ b/docs/topics/funding.md @@ -102,8 +102,8 @@ With *typical corporate fundings of just £100-£1000 per organization* we succe * The comprehensive 3.0 serializer redesign. * Substantial improvements to the Browsable API. * The admin interface. -* A new pagination API including new offset/limit and cursor pagination implementations, plus on-page controls. -* A versioning API, including URL based and header based versioning schemes. +* A new pagination API including offset/limit and cursor pagination implementations, plus on-page controls. +* A versioning API, including URL-based and header-based versioning schemes. * Support for customizable exception handling. * Support for Django's PostgreSQL HStoreField, ArrayField and JSONField. * Templated HTML form support, including HTML forms with nested list and objects. From aeb57913c9f2a7ad1ffc1db825c3e6f44b4818ee Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Aug 2015 14:25:44 +0100 Subject: [PATCH 279/487] Filter HTML refinments --- rest_framework/compat.py | 8 ++ rest_framework/filters.py | 121 ++++++++++++------ rest_framework/renderers.py | 3 +- .../templates/rest_framework/admin.html | 9 ++ .../rest_framework/filters/django_filter.html | 9 +- .../filters/django_filter_crispyforms.html | 4 + .../rest_framework/filters/ordering.html | 17 ++- .../rest_framework/filters/search.html | 11 ++ 8 files changed, 134 insertions(+), 48 deletions(-) create mode 100644 rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html create mode 100644 rest_framework/templates/rest_framework/filters/search.html diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 2cff6108..e26ec819 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -80,6 +80,14 @@ try: except ImportError: django_filters = None + +# django-crispy-forms is optional +try: + import crispy_forms +except ImportError: + crispy_forms = None + + if django.VERSION >= (1, 6): def clean_manytomany_helptext(text): return text diff --git a/rest_framework/filters.py b/rest_framework/filters.py index bb623870..0af93988 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -7,17 +7,57 @@ from __future__ import unicode_literals import operator from functools import reduce +from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.db import models from django.template import Context, Template, loader from django.utils import six from rest_framework.compat import ( - distinct, django_filters, get_model_name, guardian + crispy_forms, distinct, django_filters, get_model_name, guardian ) from rest_framework.settings import api_settings -FilterSet = django_filters and django_filters.FilterSet or None + +if 'crispy_forms' in settings.INSTALLED_APPS and crispy_forms and django_filters: + # If django-crispy-forms is installed, use it to get a bootstrap3 rendering + # of the DjangoFilterBackend controls when displayed as HTML. + from crispy_forms.helper import FormHelper + from crispy_forms.layout import Field, Fieldset, Layout, Submit + + class FilterSet(django_filters.FilterSet): + def __init__(self, *args, **kwargs): + super(FilterSet, self).__init__(*args, **kwargs) + for field in self.form.fields.values(): + field.help_text = None + + layout_components = list(self.form.fields.keys()) + [ + Submit('', 'Submit', css_class='btn-default'), + ] + + helper = FormHelper() + helper.form_method = 'GET' + helper.template_pack = 'bootstrap3' + helper.layout = Layout(*layout_components) + + self.form.helper = helper + + filter_template = 'rest_framework/filters/django_filter_crispyforms.html' + +elif django_filters: + # If django-crispy-forms is not installed, use the standard + # 'form.as_p' rendering when DjangoFilterBackend is displayed as HTML. + class FilterSet(django_filters.FilterSet): + def __init__(self, *args, **kwargs): + super(FilterSet, self).__init__(*args, **kwargs) + for field in self.form.fields.values(): + field.help_text = None + + filter_template = 'rest_framework/filters/django_filter.html' + +else: + FilterSet = None + filter_template = None class BaseFilterBackend(object): @@ -37,7 +77,7 @@ class DjangoFilterBackend(BaseFilterBackend): A filter backend that uses django-filter. """ default_filter_set = FilterSet - template = 'rest_framework/filters/django_filter.html' + template = filter_template def __init__(self): assert django_filters, 'Using DjangoFilterBackend, but django-filter is not installed' @@ -59,33 +99,11 @@ class DjangoFilterBackend(BaseFilterBackend): return filter_class if filter_fields: - from crispy_forms.helper import FormHelper - from crispy_forms.layout import Field, Fieldset, Layout, Submit - - class AutoFilterSet(self.default_filter_set): + class AutoFilterSet(FilterSet): class Meta: model = queryset.model fields = filter_fields - @property - def form(self): - self._form = super(AutoFilterSet, self).form - for field in self._form.fields.values(): - field.help_text = None - layout_components = filter_fields + [ - Submit('', 'Apply', css_class='btn-default'), - ] - - helper = FormHelper() - helper.form_method = 'get' - helper.form_action = '.' - helper.template_pack = 'bootstrap3' - - helper.layout = Layout(*layout_components) - - self._form.helper = helper - return self._form - return AutoFilterSet return None @@ -111,6 +129,7 @@ class DjangoFilterBackend(BaseFilterBackend): class SearchFilter(BaseFilterBackend): # The URL query parameter used for the search. search_param = api_settings.SEARCH_PARAM + template = 'rest_framework/filters/search.html' def get_search_terms(self, request): """ @@ -134,7 +153,6 @@ class SearchFilter(BaseFilterBackend): def filter_queryset(self, request, queryset, view): search_fields = getattr(view, 'search_fields', None) - search_terms = self.get_search_terms(request) if not search_fields or not search_terms: @@ -158,6 +176,19 @@ class SearchFilter(BaseFilterBackend): # in the resulting queryset. return distinct(queryset, base) + def to_html(self, request, queryset, view): + if not getattr(view, 'search_fields', None): + return '' + + term = self.get_search_terms(request) + term = term[0] if term else '' + context = Context({ + 'param': self.search_param, + 'term': term + }) + template = loader.get_template(self.template) + return template.render(context) + class OrderingFilter(BaseFilterBackend): # The URL query parameter used for the ordering. @@ -200,19 +231,30 @@ class OrderingFilter(BaseFilterBackend): "'serializer_class' or 'ordering_fields' attribute.") raise ImproperlyConfigured(msg % self.__class__.__name__) valid_fields = [ - field.source or field_name + (field.source or field_name, field.label) for field_name, field in serializer_class().fields.items() - if not getattr(field, 'write_only', False) + if not getattr(field, 'write_only', False) and not field.source == '*' ] elif valid_fields == '__all__': # View explicitly allows filtering on any model field - valid_fields = [field.name for field in queryset.model._meta.fields] - valid_fields += queryset.query.aggregates.keys() + valid_fields = [ + (field.name, field.label) + for field in queryset.model._meta.fields + ] + valid_fields += [ + (key, key.title().split('__')) + for key in queryset.query.aggregates.keys() + ] + else: + valid_fields = [ + (item, item) if isinstance(item, six.string_types) else item + for item in valid_fields + ] return valid_fields def remove_invalid_fields(self, queryset, fields, view): - valid_fields = self.get_valid_fields(queryset, view) + valid_fields = [item[0] for item in self.get_valid_fields(queryset, view)] return [term for term in fields if term.lstrip('-') in valid_fields] def filter_queryset(self, request, queryset, view): @@ -224,10 +266,17 @@ class OrderingFilter(BaseFilterBackend): return queryset def get_template_context(self, request, queryset, view): - #default_tuple = self.get_default_ordering() - #default = None if default_tuple is None else default_tuple[0] - { - 'options': self.get_valid_fields(queryset, view), + current = self.get_ordering(request, queryset, view) + current = None if current is None else current[0] + options = [] + for key, label in self.get_valid_fields(queryset, view): + options.append((key, '%s - ascending' % label)) + options.append(('-' + key, '%s - descending' % label)) + return { + 'request': request, + 'current': current, + 'param': self.ordering_param, + 'options': options, } def to_html(self, request, queryset, view): diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index 826a4062..d59c7e20 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -610,7 +610,8 @@ class BrowsableAPIRenderer(BaseRenderer): for backend in view.filter_backends: if hasattr(backend, 'to_html'): html = backend().to_html(request, queryset, view) - elements.append(html) + if html: + elements.append(html) if not elements: return diff --git a/rest_framework/templates/rest_framework/admin.html b/rest_framework/templates/rest_framework/admin.html index 7db06e07..41a942a1 100644 --- a/rest_framework/templates/rest_framework/admin.html +++ b/rest_framework/templates/rest_framework/admin.html @@ -113,6 +113,13 @@ {% endif %} + {% if filter_form %} + + {% endif %} +

    {{ name }}

    @@ -220,6 +227,8 @@
    {% endif %} +{% if filter_form %}{{ filter_form }}{% endif %} + {% block script %} diff --git a/rest_framework/templates/rest_framework/filters/django_filter.html b/rest_framework/templates/rest_framework/filters/django_filter.html index fa9030da..c3f91458 100644 --- a/rest_framework/templates/rest_framework/filters/django_filter.html +++ b/rest_framework/templates/rest_framework/filters/django_filter.html @@ -1,4 +1,5 @@ -{% load crispy_forms_tags %} - -

    Field search

    -{% crispy filter.form %} +

    Field filters

    +
    + {{ filter.form.as_p }} + + diff --git a/rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html b/rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html new file mode 100644 index 00000000..5240a430 --- /dev/null +++ b/rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html @@ -0,0 +1,4 @@ +{% load crispy_forms_tags %} + +

    Field filters

    +{% crispy filter.form %} diff --git a/rest_framework/templates/rest_framework/filters/ordering.html b/rest_framework/templates/rest_framework/filters/ordering.html index 4ff22031..d978c634 100644 --- a/rest_framework/templates/rest_framework/filters/ordering.html +++ b/rest_framework/templates/rest_framework/filters/ordering.html @@ -1,10 +1,13 @@ +{% load rest_framework %}

    Ordering

    - - Most recently created - - - Least recently created - Username ascending - Username descending + {% for key, label in options %} + {% if key == current %} + + {{ label }} + + {% else %} + {{ label }} + {% endif %} + {% endfor %}
    diff --git a/rest_framework/templates/rest_framework/filters/search.html b/rest_framework/templates/rest_framework/filters/search.html new file mode 100644 index 00000000..7c4ce491 --- /dev/null +++ b/rest_framework/templates/rest_framework/filters/search.html @@ -0,0 +1,11 @@ +

    Search

    +
    +
    +
    + + + + +
    +
    + From 9bcb1477e246b411f7957bfb7d9361a6c01be785 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Aug 2015 14:28:28 +0100 Subject: [PATCH 280/487] Minor tweaks --- rest_framework/filters.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 0af93988..c231f574 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -10,7 +10,7 @@ from functools import reduce from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.db import models -from django.template import Context, Template, loader +from django.template import Context, loader from django.utils import six from rest_framework.compat import ( @@ -18,12 +18,11 @@ from rest_framework.compat import ( ) from rest_framework.settings import api_settings - if 'crispy_forms' in settings.INSTALLED_APPS and crispy_forms and django_filters: # If django-crispy-forms is installed, use it to get a bootstrap3 rendering # of the DjangoFilterBackend controls when displayed as HTML. from crispy_forms.helper import FormHelper - from crispy_forms.layout import Field, Fieldset, Layout, Submit + from crispy_forms.layout import Layout, Submit class FilterSet(django_filters.FilterSet): def __init__(self, *args, **kwargs): @@ -238,7 +237,7 @@ class OrderingFilter(BaseFilterBackend): elif valid_fields == '__all__': # View explicitly allows filtering on any model field valid_fields = [ - (field.name, field.label) + (field.name, getattr(field, 'label', field.name.title())) for field in queryset.model._meta.fields ] valid_fields += [ From 0b77e733a8ba0b4c88e3a144361946d5323f1f58 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Aug 2015 14:35:39 +0100 Subject: [PATCH 281/487] Don't display filter control on detail views --- rest_framework/renderers.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index d59c7e20..efd534df 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -601,10 +601,20 @@ class BrowsableAPIRenderer(BaseRenderer): def get_breadcrumbs(self, request): return get_breadcrumbs(request.path, request) - def get_filter_form(self, view, request): + def get_filter_form(self, data, view, request): if not hasattr(view, 'get_queryset') or not hasattr(view, 'filter_backends'): return + # Infer if this is a list view or not. + paginator = getattr(view, 'paginator', None) + if (paginator is not None and data is not None): + try: + paginator.get_results(data) + except (TypeError, KeyError): + return + elif not isinstance(data, list): + return + queryset = view.get_queryset() elements = [] for backend in view.filter_backends: @@ -667,7 +677,7 @@ class BrowsableAPIRenderer(BaseRenderer): 'delete_form': self.get_rendered_html_form(data, view, 'DELETE', request), 'options_form': self.get_rendered_html_form(data, view, 'OPTIONS', request), - 'filter_form': self.get_filter_form(view, request), + 'filter_form': self.get_filter_form(data, view, request), 'raw_data_put_form': raw_data_put_form, 'raw_data_post_form': raw_data_post_form, From 9aca6442a777dbae4bd42565f99363ada537a3e8 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Aug 2015 15:31:21 +0100 Subject: [PATCH 282/487] Add to the roadmap --- docs/topics/funding.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/topics/funding.md b/docs/topics/funding.md index acd213e0..3fae1da1 100644 --- a/docs/topics/funding.md +++ b/docs/topics/funding.md @@ -293,8 +293,10 @@ The roadmap below is a broad indication of just some of the ongoing and future w * Continuing triage & community support. * Improved project documentation, including versioned & internationalized docs. * Improved third party package visibility. -* Further work on the the admin API, making it suitable as a customizable end-user facing application. +* Refining the admin interface, ensuring it has a fully customizable API and making it suitable as end-user facing application. +* Cleaning up internal complexities including the `BrowsableAPIRenderer` and `Request` object. * Support for alternative backends such as SQLAlchemy. +* Support for non-database backed services. * HTTP Caching API & support for conditional database lookups. * Benchmarking and performance improvements. * In depth documentation on advanced usage and best practices. From 48540f180a34345a6278e527cd4e494826f1b8f2 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Aug 2015 17:11:53 +0100 Subject: [PATCH 283/487] unittest compat fallback --- rest_framework/compat.py | 8 ++++++++ tests/test_atomic_requests.py | 10 +++++----- tests/test_filters.py | 3 +-- tests/test_permissions.py | 3 +-- 4 files changed, 15 insertions(+), 9 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 2cff6108..164cf200 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -67,6 +67,14 @@ except ImportError: from django.utils.datastructures import SortedDict as OrderedDict +# unittest.SkipUnless only available in Python 2.7. +try: + import unittest + unittest.skipUnless +except (ImportError, AttributeError): + from django.test.utils import unittest + + # contrib.postgres only supported from 1.8 onwards. try: from django.contrib.postgres import fields as postgres_fields diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index d0d088f5..8f683066 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -5,9 +5,9 @@ from django.db import connection, connections, transaction from django.http import Http404 from django.test import TestCase, TransactionTestCase from django.utils.decorators import method_decorator -from django.utils.unittest import skipUnless from rest_framework import status +from rest_framework.compat import unittest from rest_framework.exceptions import APIException from rest_framework.response import Response from rest_framework.test import APIRequestFactory @@ -35,7 +35,7 @@ class APIExceptionView(APIView): raise APIException -@skipUnless(connection.features.uses_savepoints, +@unittest.skipUnless(connection.features.uses_savepoints, "'atomic' requires transactions and savepoints.") class DBTransactionTests(TestCase): def setUp(self): @@ -55,7 +55,7 @@ class DBTransactionTests(TestCase): assert BasicModel.objects.count() == 1 -@skipUnless(connection.features.uses_savepoints, +@unittest.skipUnless(connection.features.uses_savepoints, "'atomic' requires transactions and savepoints.") class DBTransactionErrorTests(TestCase): def setUp(self): @@ -83,7 +83,7 @@ class DBTransactionErrorTests(TestCase): assert BasicModel.objects.count() == 1 -@skipUnless(connection.features.uses_savepoints, +@unittest.skipUnless(connection.features.uses_savepoints, "'atomic' requires transactions and savepoints.") class DBTransactionAPIExceptionTests(TestCase): def setUp(self): @@ -113,7 +113,7 @@ class DBTransactionAPIExceptionTests(TestCase): assert BasicModel.objects.count() == 0 -@skipUnless(connection.features.uses_savepoints, +@unittest.skipUnless(connection.features.uses_savepoints, "'atomic' requires transactions and savepoints.") class NonAtomicDBTransactionAPIExceptionTests(TransactionTestCase): @property diff --git a/tests/test_filters.py b/tests/test_filters.py index 0610b085..bce6e08f 100644 --- a/tests/test_filters.py +++ b/tests/test_filters.py @@ -8,12 +8,11 @@ from django.core.urlresolvers import reverse from django.db import models from django.test import TestCase from django.test.utils import override_settings -from django.utils import unittest from django.utils.dateparse import parse_date from django.utils.six.moves import reload_module from rest_framework import filters, generics, serializers, status -from rest_framework.compat import django_filters +from rest_framework.compat import django_filters, unittest from rest_framework.test import APIRequestFactory from .models import BaseFilterableItem, BasicModel, FilterableItem diff --git a/tests/test_permissions.py b/tests/test_permissions.py index 39802000..ffc262a4 100644 --- a/tests/test_permissions.py +++ b/tests/test_permissions.py @@ -6,13 +6,12 @@ from django.contrib.auth.models import Group, Permission, User from django.core.urlresolvers import ResolverMatch from django.db import models from django.test import TestCase -from django.utils import unittest from rest_framework import ( HTTP_HEADER_ENCODING, authentication, generics, permissions, serializers, status ) -from rest_framework.compat import get_model_name, guardian +from rest_framework.compat import get_model_name, guardian, unittest from rest_framework.filters import DjangoObjectPermissionsFilter from rest_framework.routers import DefaultRouter from rest_framework.test import APIRequestFactory From f691006f2c79b408b819c716fba0a1bc4ed71fc1 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Aug 2015 17:16:19 +0100 Subject: [PATCH 284/487] Resolve generic fields import --- tests/test_relations_generic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_relations_generic.py b/tests/test_relations_generic.py index 96285736..340d4d1d 100644 --- a/tests/test_relations_generic.py +++ b/tests/test_relations_generic.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.contrib.contenttypes.generic import ( +from django.contrib.contenttypes.fields import ( GenericForeignKey, GenericRelation ) from django.contrib.contenttypes.models import ContentType From 4f2769746773f0a796206f4fcf01f180bdaff640 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 27 Aug 2015 17:28:12 +0100 Subject: [PATCH 285/487] Fix get_model import --- rest_framework/compat.py | 8 ++++++++ rest_framework/utils/model_meta.py | 4 ++-- tests/test_utils.py | 4 ++-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 164cf200..607778a9 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -82,6 +82,14 @@ except ImportError: postgres_fields = None +# Apps only exists from 1.7 onwards. +try: + from django.apps import apps + get_model = apps.get_model +except ImportError: + from django.db.models import get_model + + # django-filter is optional try: import django_filters diff --git a/rest_framework/utils/model_meta.py b/rest_framework/utils/model_meta.py index 3bcd9049..97186476 100644 --- a/rest_framework/utils/model_meta.py +++ b/rest_framework/utils/model_meta.py @@ -12,7 +12,7 @@ from django.core.exceptions import ImproperlyConfigured from django.db import models from django.utils import six -from rest_framework.compat import OrderedDict +from rest_framework.compat import OrderedDict, get_model FieldInfo = namedtuple('FieldResult', [ 'pk', # Model field instance @@ -45,7 +45,7 @@ def _resolve_model(obj): """ if isinstance(obj, six.string_types) and len(obj.split('.')) == 2: app_name, model_name = obj.split('.') - resolved_model = models.get_model(app_name, model_name) + resolved_model = get_model(app_name, model_name) if resolved_model is None: msg = "Django did not return a model for {0}.{1}" raise ImproperlyConfigured(msg.format(app_name, model_name)) diff --git a/tests/test_utils.py b/tests/test_utils.py index 062f78e1..4c9fd03c 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -150,12 +150,12 @@ class ResolveModelWithPatchedDjangoTests(TestCase): def setUp(self): """Monkeypatch get_model.""" - self.get_model = rest_framework.utils.model_meta.models.get_model + self.get_model = rest_framework.utils.model_meta.get_model def get_model(app_label, model_name): return None - rest_framework.utils.model_meta.models.get_model = get_model + rest_framework.utils.model_meta.get_model = get_model def tearDown(self): """Revert monkeypatching.""" From 654e0e45279b5023cea7574bda1ebd63dae96347 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Thu, 27 Aug 2015 13:09:08 -0400 Subject: [PATCH 286/487] Update ModelSerializer fields behavior --- rest_framework/serializers.py | 21 +++++++++++++++++++-- tests/test_model_serializer.py | 15 +++++++++++++++ 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index c7d4405c..acaf3bef 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -12,6 +12,8 @@ response content is handled by parsers and renderers. """ from __future__ import unicode_literals +import warnings + from django.db import models from django.db.models.fields import Field as DjangoModelField from django.db.models.fields import FieldDoesNotExist @@ -51,6 +53,8 @@ LIST_SERIALIZER_KWARGS = ( 'instance', 'data', 'partial', 'context', 'allow_null' ) +ALL_FIELDS = '__all__' + # BaseSerializer # -------------- @@ -943,13 +947,13 @@ class ModelSerializer(Serializer): fields = getattr(self.Meta, 'fields', None) exclude = getattr(self.Meta, 'exclude', None) - if fields and not isinstance(fields, (list, tuple)): + if fields and fields != ALL_FIELDS and not isinstance(fields, (list, tuple)): raise TypeError( 'The `fields` option must be a list or tuple. Got %s.' % type(fields).__name__ ) - if exclude and not isinstance(exclude, (list, tuple)): + if exclude and exclude != ALL_FIELDS and not isinstance(exclude, (list, tuple)): raise TypeError( 'The `exclude` option must be a list or tuple. Got %s.' % type(exclude).__name__ @@ -962,6 +966,19 @@ class ModelSerializer(Serializer): ) ) + if fields is None and exclude is None: + warnings.warn( + "Creating a ModelSerializer without either the 'fields' attribute " + "or the 'exclude' attribute will be prohibited. " + "The {serializer_class} serializer needs updating.".format( + serializer_class=self.__class__.__name__ + ), + PendingDeprecationWarning + ) + + if fields == ALL_FIELDS: + fields = None + if fields is not None: # Ensure that all declared fields have also been included in the # `Meta.fields` option. diff --git a/tests/test_model_serializer.py b/tests/test_model_serializer.py index 777b956c..89557fa1 100644 --- a/tests/test_model_serializer.py +++ b/tests/test_model_serializer.py @@ -321,6 +321,21 @@ class TestRegularFieldMappings(TestCase): ExampleSerializer() + def test_fields_and_exclude_behavior(self): + class ImplicitFieldsSerializer(serializers.ModelSerializer): + class Meta: + model = RegularFieldsModel + + class ExplicitFieldsSerializer(serializers.ModelSerializer): + class Meta: + model = RegularFieldsModel + fields = '__all__' + + implicit = ImplicitFieldsSerializer() + explicit = ExplicitFieldsSerializer() + + assert implicit.data == explicit.data + @pytest.mark.skipif(django.VERSION < (1, 8), reason='DurationField is only available for django1.8+') From e70da5ac6b563cf82e8bc86f4a2f7103efc297c8 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 10:03:08 +0100 Subject: [PATCH 287/487] Compat for GenericForeignKey, GenericRelation --- rest_framework/compat.py | 10 ++++++++++ tests/test_relations_generic.py | 4 +--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 607778a9..fa42f95e 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -90,6 +90,16 @@ except ImportError: from django.db.models import get_model +# Import path changes from 1.7 onwards. +try: + from django.contrib.contenttypes.fields import ( + GenericForeignKey, GenericRelation + ) +except ImportError: + from django.contrib.contenttypes.generic import ( + GenericForeignKey, GenericRelation + ) + # django-filter is optional try: import django_filters diff --git a/tests/test_relations_generic.py b/tests/test_relations_generic.py index 340d4d1d..5cb2dfc0 100644 --- a/tests/test_relations_generic.py +++ b/tests/test_relations_generic.py @@ -1,14 +1,12 @@ from __future__ import unicode_literals -from django.contrib.contenttypes.fields import ( - GenericForeignKey, GenericRelation -) from django.contrib.contenttypes.models import ContentType from django.db import models from django.test import TestCase from django.utils.encoding import python_2_unicode_compatible from rest_framework import serializers +from rest_framework.compat import GenericForeignKey, GenericRelation @python_2_unicode_compatible From 25c4c7f9fd3a5d789ec772f341fb5e036fe073dd Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 10:03:16 +0100 Subject: [PATCH 288/487] Pep8 fix --- tests/test_atomic_requests.py | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index 8f683066..a97efb69 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -35,8 +35,10 @@ class APIExceptionView(APIView): raise APIException -@unittest.skipUnless(connection.features.uses_savepoints, - "'atomic' requires transactions and savepoints.") +@unittest.skipUnless( + connection.features.uses_savepoints, + "'atomic' requires transactions and savepoints." +) class DBTransactionTests(TestCase): def setUp(self): self.view = BasicView.as_view() @@ -55,8 +57,10 @@ class DBTransactionTests(TestCase): assert BasicModel.objects.count() == 1 -@unittest.skipUnless(connection.features.uses_savepoints, - "'atomic' requires transactions and savepoints.") +@unittest.skipUnless( + connection.features.uses_savepoints, + "'atomic' requires transactions and savepoints." +) class DBTransactionErrorTests(TestCase): def setUp(self): self.view = ErrorView.as_view() @@ -83,8 +87,10 @@ class DBTransactionErrorTests(TestCase): assert BasicModel.objects.count() == 1 -@unittest.skipUnless(connection.features.uses_savepoints, - "'atomic' requires transactions and savepoints.") +@unittest.skipUnless( + connection.features.uses_savepoints, + "'atomic' requires transactions and savepoints." +) class DBTransactionAPIExceptionTests(TestCase): def setUp(self): self.view = APIExceptionView.as_view() @@ -113,8 +119,10 @@ class DBTransactionAPIExceptionTests(TestCase): assert BasicModel.objects.count() == 0 -@unittest.skipUnless(connection.features.uses_savepoints, - "'atomic' requires transactions and savepoints.") +@unittest.skipUnless( + connection.features.uses_savepoints, + "'atomic' requires transactions and savepoints." +) class NonAtomicDBTransactionAPIExceptionTests(TransactionTestCase): @property def urls(self): From 24a2c3f5c3349ec941790240c1f372a6de723e1b Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 10:19:18 +0100 Subject: [PATCH 289/487] Resolve unittest compat --- rest_framework/compat.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index fa42f95e..a512af77 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -72,7 +72,7 @@ try: import unittest unittest.skipUnless except (ImportError, AttributeError): - from django.test.utils import unittest + from django.utils import unittest # contrib.postgres only supported from 1.8 onwards. From a5ddd90df03fe04793e605d26d01f86391fa4771 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 10:27:49 +0100 Subject: [PATCH 290/487] Log in and log out require escape and mark_safe --- rest_framework/templatetags/rest_framework.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py index 0069d9a5..08acecef 100644 --- a/rest_framework/templatetags/rest_framework.py +++ b/rest_framework/templatetags/rest_framework.py @@ -41,8 +41,9 @@ def optional_login(request): except NoReverseMatch: return '' - snippet = "
  • Log in
    • ".format(href=login_url, next=escape(request.path)) - return snippet + snippet = "
  • Log in
    • " + snippet = snippet.format(href=login_url, next=escape(request.path)) + return mark_safe(snippet) @register.simple_tag @@ -64,8 +65,8 @@ def optional_logout(request, user):
  • Log out
    • """ - - return snippet.format(user=user, href=logout_url, next=escape(request.path)) + snippet = snippet.format(user=escape(user), href=logout_url, next=escape(request.path)) + return mark_safe(snippet) @register.simple_tag From 6fa534f21475f4c9527b1181f8a427978ce1c085 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 10:44:49 +0100 Subject: [PATCH 291/487] Fix urlpatterns in test --- tests/test_atomic_requests.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index a97efb69..f24c7e68 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -135,9 +135,8 @@ class NonAtomicDBTransactionAPIExceptionTests(TransactionTestCase): BasicModel.objects.all() raise Http404 - return patterns( - '', - url(r'^$', NonAtomicAPIExceptionView.as_view()) + return ( + url(r'^$', NonAtomicAPIExceptionView.as_view()), ) def setUp(self): From 7560e8381f90c646bdfeaf1ee491482f39766f53 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 10:53:44 +0100 Subject: [PATCH 292/487] Drop unused patterns --- tests/test_atomic_requests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_atomic_requests.py b/tests/test_atomic_requests.py index f24c7e68..2d973cb8 100644 --- a/tests/test_atomic_requests.py +++ b/tests/test_atomic_requests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.conf.urls import patterns, url +from django.conf.urls import url from django.db import connection, connections, transaction from django.http import Http404 from django.test import TestCase, TransactionTestCase From b51c1ff0b0535a135ba018064c99a5995a9d8893 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 11:55:23 +0100 Subject: [PATCH 293/487] Django 1.9's test case HttpResponse.json() is not cachable. --- rest_framework/response.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/response.py b/rest_framework/response.py index 3f038e3b..0e97668e 100644 --- a/rest_framework/response.py +++ b/rest_framework/response.py @@ -98,7 +98,7 @@ class Response(SimpleTemplateResponse): state = super(Response, self).__getstate__() for key in ( 'accepted_renderer', 'renderer_context', 'resolver_match', - 'client', 'request', 'wsgi_request' + 'client', 'request', 'json', 'wsgi_request' ): if key in state: del state[key] From 8db6367188d27a41a42bf36eef12774e7cc59354 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 12:08:32 +0100 Subject: [PATCH 294/487] Deal with 1.9's differing null behavior on reverse relationships and m2m --- rest_framework/utils/field_mapping.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index f2598974..7805a285 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -233,9 +233,11 @@ def get_relation_kwargs(field_name, relation_info): # No further keyword arguments are valid. return kwargs - if model_field.has_default() or model_field.blank or model_field.null: + null = model_field.null and not to_many + + if model_field.has_default() or model_field.blank or null: kwargs['required'] = False - if model_field.null: + if null: kwargs['allow_null'] = True if model_field.validators: kwargs['validators'] = model_field.validators From f3ef13ab59c1ae9504e830ea3f45210fab5e973d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Fri, 28 Aug 2015 08:05:20 -0400 Subject: [PATCH 295/487] Update to match docs on ModelForm fields --- docs/api-guide/serializers.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index abdb67af..5138c6ce 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -453,14 +453,31 @@ To do so, open the Django shell, using `python manage.py shell`, then import the ## Specifying which fields to include -If you only want a subset of the default fields to be used in a model serializer, you can do so using `fields` or `exclude` options, just as you would with a `ModelForm`. +It is strongly recommended that you explicitly set all fields that should be edited in the serializer using the `fields` attribute. Failure to do so can easily lead to security problems when a serializer unexpectedly allows a user to set certain fields, especially when new fields are added to a model. + +The alternative approach would be to include all fields automatically, or blacklist only some. This fundamental approach is known to be much less secure and has led to serious exploits on major websites (e.g. [GitHub][github-vuln-blog]). + +There are, however, two shortcuts available for cases where you can guarantee these security concerns do not apply to you: + +1. Set the `fields` attribute to the special value `'__all__'` to indicate that all fields in the model should be used. For example: class AccountSerializer(serializers.ModelSerializer): class Meta: model = Account - fields = ('id', 'account_name', 'users', 'created') + fields = '__all__' + +2. Set the exclude attribute of the ModelForm’s inner Meta class to a list of fields to be excluded from the form. + +For example: + + class AccountSerializer(serializers.ModelSerializer): + class Meta: + model = Account + exclude = 'users' + +In the example above, if the `Account` model had 3 fields `account_name`, `users`, and `created`, this will result in the fields `account_name` and `created` to be serialized. The names in the `fields` option will normally map to model fields on the model class. @@ -1035,6 +1052,7 @@ The [django-rest-framework-gis][django-rest-framework-gis] package provides a `G The [django-rest-framework-hstore][django-rest-framework-hstore] package provides an `HStoreSerializer` to support [django-hstore][django-hstore] `DictionaryField` model field and its `schema-mode` feature. [cite]: https://groups.google.com/d/topic/django-users/sVFaOfQi4wY/discussion +[github-vuln-blog]: https://github.com/blog/1068-public-key-security-vulnerability-and-mitigation [relations]: relations.md [model-managers]: https://docs.djangoproject.com/en/dev/topics/db/managers/ [encapsulation-blogpost]: http://www.dabapps.com/blog/django-models-and-encapsulation/ From 1fe8e9a0bf37e045457aa91a19748ea1a6479a1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Fri, 28 Aug 2015 08:11:07 -0400 Subject: [PATCH 296/487] Add note on deprecation path --- docs/api-guide/serializers.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index 5138c6ce..ed1ada92 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -483,6 +483,12 @@ The names in the `fields` option will normally map to model fields on the model Alternatively names in the `fields` options can map to properties or methods which take no arguments that exist on the model class. +--- + +**Note**: Before version 3.3, the `'__all__'` shortcut did not exist, but omitting the fields attribute had the same effect. Omitting both fields and exclude is now deprecated, but will continue to work as before until version 3.5 + +--- + ## Specifying nested serialization The default `ModelSerializer` uses primary keys for relationships, but you can also easily generate nested representations using the `depth` option: From 78632849cf7d6599883674bbb6baec87dab4fefd Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 13:29:57 +0100 Subject: [PATCH 297/487] Comment against model_field.null 1.98 behavior --- rest_framework/utils/field_mapping.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index 7805a285..62e4dbc1 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -233,6 +233,9 @@ def get_relation_kwargs(field_name, relation_info): # No further keyword arguments are valid. return kwargs + # Currently required for 1.9 master behavior, + # may be able to remove this with 1.9 alpha. + # See https://code.djangoproject.com/ticket/25320 null = model_field.null and not to_many if model_field.has_default() or model_field.blank or null: From 3a0d54c7fbf4b8eb2b3e77ac6e013b4a8ff94e09 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 13:52:18 +0100 Subject: [PATCH 298/487] Fix testing example. Closes #3346 --- docs/api-guide/testing.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api-guide/testing.md b/docs/api-guide/testing.md index dd3295c4..69da7d10 100644 --- a/docs/api-guide/testing.md +++ b/docs/api-guide/testing.md @@ -200,6 +200,7 @@ You can use any of REST framework's test case classes as you would for the regul from django.core.urlresolvers import reverse from rest_framework import status from rest_framework.test import APITestCase + from myproject.apps.core.models import Account class AccountTests(APITestCase): def test_create_account(self): @@ -210,7 +211,8 @@ You can use any of REST framework's test case classes as you would for the regul data = {'name': 'DabApps'} response = self.client.post(url, data, format='json') self.assertEqual(response.status_code, status.HTTP_201_CREATED) - self.assertEqual(response.data, data) + self.assertEqual(Account.objects.count(), 1) + self.assertEqual(Account.objects.get().name, 'DabApps') --- From 9dd1b2516be3b1993219ad93e5802f5b8d25e324 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Padilla?= Date: Fri, 28 Aug 2015 09:51:11 -0400 Subject: [PATCH 299/487] Update ModelSerializer fields docs --- docs/api-guide/serializers.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index ed1ada92..cefcfa09 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -432,6 +432,7 @@ Declaring a `ModelSerializer` looks like this: class AccountSerializer(serializers.ModelSerializer): class Meta: model = Account + fields = ('id', 'account_name', 'users', 'created') By default, all the model fields on the class will be mapped to a corresponding serializer fields. @@ -453,13 +454,16 @@ To do so, open the Django shell, using `python manage.py shell`, then import the ## Specifying which fields to include -It is strongly recommended that you explicitly set all fields that should be edited in the serializer using the `fields` attribute. Failure to do so can easily lead to security problems when a serializer unexpectedly allows a user to set certain fields, especially when new fields are added to a model. +If you only want a subset of the default fields to be used in a model serializer, you can do so using `fields` or `exclude` options, just as you would with a `ModelForm`. It is strongly recommended that you explicitly set all fields that should be serialized using the `fields` attribute. This will make it less likely to result in unintentionally exposing data when your models change. -The alternative approach would be to include all fields automatically, or blacklist only some. This fundamental approach is known to be much less secure and has led to serious exploits on major websites (e.g. [GitHub][github-vuln-blog]). +For example: -There are, however, two shortcuts available for cases where you can guarantee these security concerns do not apply to you: + class AccountSerializer(serializers.ModelSerializer): + class Meta: + model = Account + fields = ('id', 'account_name', 'users', 'created') -1. Set the `fields` attribute to the special value `'__all__'` to indicate that all fields in the model should be used. +You can also set the `fields` attribute to the special value `'__all__'` to indicate that all fields in the model should be used. For example: @@ -468,27 +472,21 @@ For example: model = Account fields = '__all__' -2. Set the exclude attribute of the ModelForm’s inner Meta class to a list of fields to be excluded from the form. +You can set the `exclude` attribute of the to a list of fields to be excluded from the serializer. For example: class AccountSerializer(serializers.ModelSerializer): class Meta: model = Account - exclude = 'users' + exclude = ('users',) In the example above, if the `Account` model had 3 fields `account_name`, `users`, and `created`, this will result in the fields `account_name` and `created` to be serialized. -The names in the `fields` option will normally map to model fields on the model class. +The names in the `fields` and `exclude` attributes will normally map to model fields on the model class. Alternatively names in the `fields` options can map to properties or methods which take no arguments that exist on the model class. ---- - -**Note**: Before version 3.3, the `'__all__'` shortcut did not exist, but omitting the fields attribute had the same effect. Omitting both fields and exclude is now deprecated, but will continue to work as before until version 3.5 - ---- - ## Specifying nested serialization The default `ModelSerializer` uses primary keys for relationships, but you can also easily generate nested representations using the `depth` option: @@ -1058,7 +1056,6 @@ The [django-rest-framework-gis][django-rest-framework-gis] package provides a `G The [django-rest-framework-hstore][django-rest-framework-hstore] package provides an `HStoreSerializer` to support [django-hstore][django-hstore] `DictionaryField` model field and its `schema-mode` feature. [cite]: https://groups.google.com/d/topic/django-users/sVFaOfQi4wY/discussion -[github-vuln-blog]: https://github.com/blog/1068-public-key-security-vulnerability-and-mitigation [relations]: relations.md [model-managers]: https://docs.djangoproject.com/en/dev/topics/db/managers/ [encapsulation-blogpost]: http://www.dabapps.com/blog/django-models-and-encapsulation/ From f34777a2e9241e4995bd558eede616f872e65b57 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 28 Aug 2015 14:55:22 +0100 Subject: [PATCH 300/487] Translations for HTML filters --- rest_framework/filters.py | 3 ++- rest_framework/templates/rest_framework/admin.html | 2 +- rest_framework/templates/rest_framework/base.html | 3 ++- .../templates/rest_framework/filters/django_filter.html | 5 +++-- .../rest_framework/filters/django_filter_crispyforms.html | 3 ++- .../templates/rest_framework/filters/ordering.html | 3 ++- rest_framework/templates/rest_framework/filters/search.html | 3 ++- 7 files changed, 14 insertions(+), 8 deletions(-) diff --git a/rest_framework/filters.py b/rest_framework/filters.py index c231f574..f3b282a2 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -12,6 +12,7 @@ from django.core.exceptions import ImproperlyConfigured from django.db import models from django.template import Context, loader from django.utils import six +from django.utils.translation import ugettext_lazy as _ from rest_framework.compat import ( crispy_forms, distinct, django_filters, get_model_name, guardian @@ -31,7 +32,7 @@ if 'crispy_forms' in settings.INSTALLED_APPS and crispy_forms and django_filters field.help_text = None layout_components = list(self.form.fields.keys()) + [ - Submit('', 'Submit', css_class='btn-default'), + Submit('', _('Submit'), css_class='btn-default'), ] helper = FormHelper() diff --git a/rest_framework/templates/rest_framework/admin.html b/rest_framework/templates/rest_framework/admin.html index 41a942a1..f670cfe2 100644 --- a/rest_framework/templates/rest_framework/admin.html +++ b/rest_framework/templates/rest_framework/admin.html @@ -116,7 +116,7 @@ {% if filter_form %} {% endif %} diff --git a/rest_framework/templates/rest_framework/base.html b/rest_framework/templates/rest_framework/base.html index 71075ad8..fbf1e982 100644 --- a/rest_framework/templates/rest_framework/base.html +++ b/rest_framework/templates/rest_framework/base.html @@ -1,5 +1,6 @@ {% load staticfiles %} {% load rest_framework %} +{% load i18n %} @@ -112,7 +113,7 @@ {% if filter_form %} {% endif %} diff --git a/rest_framework/templates/rest_framework/filters/django_filter.html b/rest_framework/templates/rest_framework/filters/django_filter.html index c3f91458..b116e353 100644 --- a/rest_framework/templates/rest_framework/filters/django_filter.html +++ b/rest_framework/templates/rest_framework/filters/django_filter.html @@ -1,5 +1,6 @@ -

    Field filters

    +{% load i18n %} +

    {% trans "Field filters" %}

    {{ filter.form.as_p }} - + diff --git a/rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html b/rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html index 5240a430..171767c0 100644 --- a/rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html +++ b/rest_framework/templates/rest_framework/filters/django_filter_crispyforms.html @@ -1,4 +1,5 @@ {% load crispy_forms_tags %} +{% load i18n %} -

    Field filters

    +

    {% trans "Field filters" %}

    {% crispy filter.form %} diff --git a/rest_framework/templates/rest_framework/filters/ordering.html b/rest_framework/templates/rest_framework/filters/ordering.html index d978c634..b71b2a5b 100644 --- a/rest_framework/templates/rest_framework/filters/ordering.html +++ b/rest_framework/templates/rest_framework/filters/ordering.html @@ -1,5 +1,6 @@ {% load rest_framework %} -

    Ordering

    +{% load i18n %} +

    {% trans "Ordering" %}

    {% for key, label in options %} {% if key == current %} diff --git a/rest_framework/templates/rest_framework/filters/search.html b/rest_framework/templates/rest_framework/filters/search.html index 7c4ce491..edb28d45 100644 --- a/rest_framework/templates/rest_framework/filters/search.html +++ b/rest_framework/templates/rest_framework/filters/search.html @@ -1,4 +1,5 @@ -

    Search

    +{% load i18n %} +

    {% trans "Search" %}

    From 6926c716993e8d0b4ecdff1006dd23519dda4089 Mon Sep 17 00:00:00 2001 From: Miroslav Shubernetskiy Date: Mon, 31 Aug 2015 21:23:11 -0400 Subject: [PATCH 301/487] added django-url-filter to 3rd party libraries --- docs/api-guide/filtering.md | 5 +++++ docs/topics/third-party-resources.md | 2 ++ 2 files changed, 7 insertions(+) diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md index 6f4648cf..72a8d1c5 100644 --- a/docs/api-guide/filtering.md +++ b/docs/api-guide/filtering.md @@ -403,6 +403,10 @@ The [django-rest-framework-filters package][django-rest-framework-filters] works The [djangorestframework-word-filter][django-rest-framework-word-search-filter] developed as alternative to `filters.SearchFilter` which will search full word in text, or exact match. +## Django URL Filter + +[django-url-filter][django-url-filter] provides a safe way to filter data via human-friendly URLs. It works very similar to DRF serializers and fields in a sense that they can be nested except they are called filtersets and filters. That provides easy way to filter related data. Also this library is generic-purpose so it can be used to filter other sources of data and not only Django `QuerySet`s. + [cite]: https://docs.djangoproject.com/en/dev/topics/db/queries/#retrieving-specific-objects-with-filters [django-filter]: https://github.com/alex/django-filter [django-filter-docs]: https://django-filter.readthedocs.org/en/latest/index.html @@ -413,3 +417,4 @@ The [djangorestframework-word-filter][django-rest-framework-word-search-filter] [search-django-admin]: https://docs.djangoproject.com/en/dev/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields [django-rest-framework-filters]: https://github.com/philipn/django-rest-framework-filters [django-rest-framework-word-search-filter]: https://github.com/trollknurr/django-rest-framework-word-search-filter +[django-url-filter]: https://github.com/miki725/django-url-filter diff --git a/docs/topics/third-party-resources.md b/docs/topics/third-party-resources.md index adf524fd..9c302f77 100644 --- a/docs/topics/third-party-resources.md +++ b/docs/topics/third-party-resources.md @@ -233,6 +233,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque ### Filtering * [djangorestframework-chain][djangorestframework-chain] - Allows arbitrary chaining of both relations and lookup filters. +* [django-url-filter][django-url-filter] - Allows a safe way to filter data via human-friendly URLs. It is a generic library which is not tied to DRF but it provides easy integration with DRF. ### Misc @@ -343,3 +344,4 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque [drf-tracking]: https://github.com/aschn/drf-tracking [django-rest-framework-braces]: https://github.com/dealertrack/django-rest-framework-braces [dry-rest-permissions]: https://github.com/Helioscene/dry-rest-permissions +[django-url-filter]: https://github.com/miki725/django-url-filter From 7c12a988fac0451d79e49cbd9aaeb4ac8764a9f6 Mon Sep 17 00:00:00 2001 From: Britt Dawn Date: Wed, 2 Sep 2015 09:25:00 -0700 Subject: [PATCH 302/487] Replacing self.tag with self.tag_name in Generic Relationships documentation. --- docs/api-guide/relations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md index 979c3326..fd53acbc 100644 --- a/docs/api-guide/relations.md +++ b/docs/api-guide/relations.md @@ -501,7 +501,7 @@ For example, given the following model for a tag, which has a generic relationsh tagged_object = GenericForeignKey('content_type', 'object_id') def __unicode__(self): - return self.tag + return self.tag_name And the following two models, which may be have associated tags: From b9782b6850a032d20c321b960f4e829ed873d418 Mon Sep 17 00:00:00 2001 From: raphaelmerx Date: Wed, 2 Sep 2015 16:47:50 -0700 Subject: [PATCH 303/487] DurationField accepts integers --- rest_framework/fields.py | 2 +- tests/test_fields.py | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index faf41e7a..159784ea 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -1189,7 +1189,7 @@ class DurationField(Field): def to_internal_value(self, value): if isinstance(value, datetime.timedelta): return value - parsed = parse_duration(value) + parsed = parse_duration(six.text_type(value)) if parsed is not None: return parsed self.fail('invalid', format='[DD] [HH:[MM:]]ss[.uuuuuu]') diff --git a/tests/test_fields.py b/tests/test_fields.py index 8065c826..c1d3e3a4 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -1069,6 +1069,7 @@ class TestDurationField(FieldValues): '3 08:32:01.000123': datetime.timedelta(days=3, hours=8, minutes=32, seconds=1, microseconds=123), '08:01': datetime.timedelta(minutes=8, seconds=1), datetime.timedelta(days=3, hours=8, minutes=32, seconds=1, microseconds=123): datetime.timedelta(days=3, hours=8, minutes=32, seconds=1, microseconds=123), + 3600: datetime.timedelta(hours=1), } invalid_inputs = { 'abc': ['Duration has wrong format. Use one of these formats instead: [DD] [HH:[MM:]]ss[.uuuuuu].'], From 1c049edd8cc7da265deee47eb6ef004fcb297d21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubom=C3=ADr=20Sedl=C3=A1=C5=99?= Date: Thu, 3 Sep 2015 09:43:27 +0200 Subject: [PATCH 304/487] Improve documentation of default argument for fields The documentation now not only mentions that callables are acceptable arguments, it also tells the reader what the callable should look like. --- docs/api-guide/fields.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 2b9a6bba..f681d945 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -51,7 +51,7 @@ Defaults to `False` If set, this gives the default value that will be used for the field if no input value is supplied. If not set the default behavior is to not populate the attribute at all. -May be set to a function or other callable, in which case the value will be evaluated each time it is used. +May be set to a function or other callable, in which case the value will be evaluated each time it is used. When called, it will receive no arguments. If the callable has a `set_context` method, that will be called each time before getting the value with the field instance as only argument. Note that setting a `default` value implies that the field is not required. Including both the `default` and `required` keyword arguments is invalid and will raise an error. From a57ad0767421a86bd35bf5a72c337d6857ad5f42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubom=C3=ADr=20Sedl=C3=A1=C5=99?= Date: Thu, 3 Sep 2015 10:35:28 +0200 Subject: [PATCH 305/487] Add link to validators The `set_context` method there is the same as for the default field. --- docs/api-guide/fields.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index f681d945..2fbb84c0 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -51,7 +51,7 @@ Defaults to `False` If set, this gives the default value that will be used for the field if no input value is supplied. If not set the default behavior is to not populate the attribute at all. -May be set to a function or other callable, in which case the value will be evaluated each time it is used. When called, it will receive no arguments. If the callable has a `set_context` method, that will be called each time before getting the value with the field instance as only argument. +May be set to a function or other callable, in which case the value will be evaluated each time it is used. When called, it will receive no arguments. If the callable has a `set_context` method, that will be called each time before getting the value with the field instance as only argument. This works the same way as for [validators](validators.md#using-set_context). Note that setting a `default` value implies that the field is not required. Including both the `default` and `required` keyword arguments is invalid and will raise an error. From afd2a8f8f0186cfeb781c33922b27372f97f074b Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 3 Sep 2015 10:12:52 +0100 Subject: [PATCH 306/487] Adjust ModelField.null mappings now that Django-25320 is resolved --- rest_framework/utils/field_mapping.py | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/rest_framework/utils/field_mapping.py b/rest_framework/utils/field_mapping.py index 62e4dbc1..f2598974 100644 --- a/rest_framework/utils/field_mapping.py +++ b/rest_framework/utils/field_mapping.py @@ -233,14 +233,9 @@ def get_relation_kwargs(field_name, relation_info): # No further keyword arguments are valid. return kwargs - # Currently required for 1.9 master behavior, - # may be able to remove this with 1.9 alpha. - # See https://code.djangoproject.com/ticket/25320 - null = model_field.null and not to_many - - if model_field.has_default() or model_field.blank or null: + if model_field.has_default() or model_field.blank or model_field.null: kwargs['required'] = False - if null: + if model_field.null: kwargs['allow_null'] = True if model_field.validators: kwargs['validators'] = model_field.validators From f9d1a34fdd4d8065acb2e9ab9ed4a7b0338b66bd Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 3 Sep 2015 11:23:58 +0100 Subject: [PATCH 307/487] Fix nested HTML dictionaries. Closes #3314. --- rest_framework/utils/html.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rest_framework/utils/html.py b/rest_framework/utils/html.py index c5fc5d8d..3b871027 100644 --- a/rest_framework/utils/html.py +++ b/rest_framework/utils/html.py @@ -78,7 +78,7 @@ def parse_html_dict(dictionary, prefix=''): } } """ - ret = {} + ret = MultiValueDict() regex = re.compile(r'^%s\.(.+)$' % re.escape(prefix)) for field, value in dictionary.items(): match = regex.match(field) From 7905e9f9f42727b8b8b4466cb0ad806b264de9bd Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 3 Sep 2015 11:57:11 +0100 Subject: [PATCH 308/487] Docs tweak --- docs/api-guide/filtering.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md index 72a8d1c5..c740dfe7 100644 --- a/docs/api-guide/filtering.md +++ b/docs/api-guide/filtering.md @@ -331,8 +331,6 @@ The `ordering` attribute may be either a string or a list/tuple of strings. The `DjangoObjectPermissionsFilter` is intended to be used together with the [`django-guardian`][guardian] package, with custom `'view'` permissions added. The filter will ensure that querysets only returns objects for which the user has the appropriate view permission. -This filter class must be used with views that provide either a `queryset` or a `model` attribute. - If you're using `DjangoObjectPermissionsFilter`, you'll probably also want to add an appropriate object permissions class, to ensure that users can only operate on instances if they have the appropriate object permissions. The easiest way to do this is to subclass `DjangoObjectPermissions` and add `'view'` permissions to the `perms_map` attribute. A complete example using both `DjangoObjectPermissionsFilter` and `DjangoObjectPermissions` might look something like this. From 39ec564ae92805ce630c6855ce95f3d586c7203f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 3 Sep 2015 14:22:13 +0100 Subject: [PATCH 309/487] Do not access settings on compat import --- rest_framework/compat.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/rest_framework/compat.py b/rest_framework/compat.py index 2cff6108..460795f6 100644 --- a/rest_framework/compat.py +++ b/rest_framework/compat.py @@ -94,12 +94,11 @@ else: # Django-guardian is optional. Import only if guardian is in INSTALLED_APPS # Fixes (#1712). We keep the try/except for the test suite. guardian = None -if 'guardian' in settings.INSTALLED_APPS: - try: - import guardian - import guardian.shortcuts # Fixes #1624 - except ImportError: - pass +try: + import guardian + import guardian.shortcuts # Fixes #1624 +except ImportError: + pass def get_model_name(model_cls): From 10da18b20b7feaa7a615d6cddbdabda7968ff98c Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 3 Sep 2015 16:24:13 +0100 Subject: [PATCH 310/487] Access settings lazily, not at module import --- rest_framework/fields.py | 114 ++++++++++++++++++++-------------- rest_framework/serializers.py | 5 +- rest_framework/settings.py | 12 +++- 3 files changed, 82 insertions(+), 49 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 159784ea..8b42690d 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -9,6 +9,7 @@ import re import uuid from django.conf import settings +from django.core.exceptions import ImproperlyConfigured from django.core.exceptions import ValidationError as DjangoValidationError from django.core.exceptions import ObjectDoesNotExist from django.core.validators import RegexValidator, ip_address_validators @@ -882,12 +883,11 @@ class DecimalField(Field): } MAX_STRING_LENGTH = 1000 # Guard against malicious string inputs. - coerce_to_string = api_settings.COERCE_DECIMAL_TO_STRING - def __init__(self, max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None, **kwargs): self.max_digits = max_digits self.decimal_places = decimal_places - self.coerce_to_string = coerce_to_string if (coerce_to_string is not None) else self.coerce_to_string + if coerce_to_string is not None: + self.coerce_to_string = coerce_to_string self.max_value = max_value self.min_value = min_value @@ -967,12 +967,14 @@ class DecimalField(Field): return value def to_representation(self, value): + coerce_to_string = getattr(self, 'coerce_to_string', api_settings.COERCE_DECIMAL_TO_STRING) + if not isinstance(value, decimal.Decimal): value = decimal.Decimal(six.text_type(value).strip()) quantized = self.quantize(value) - if not self.coerce_to_string: + if not coerce_to_string: return quantized return '{0:f}'.format(quantized) @@ -994,15 +996,15 @@ class DateTimeField(Field): 'invalid': _('Datetime has wrong format. Use one of these formats instead: {format}.'), 'date': _('Expected a datetime but got a date.'), } - format = api_settings.DATETIME_FORMAT - input_formats = api_settings.DATETIME_INPUT_FORMATS - default_timezone = timezone.get_default_timezone() if settings.USE_TZ else None datetime_parser = datetime.datetime.strptime def __init__(self, format=empty, input_formats=None, default_timezone=None, *args, **kwargs): - self.format = format if format is not empty else self.format - self.input_formats = input_formats if input_formats is not None else self.input_formats - self.default_timezone = default_timezone if default_timezone is not None else self.default_timezone + 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(DateTimeField, self).__init__(*args, **kwargs) def enforce_timezone(self, value): @@ -1010,21 +1012,31 @@ class DateTimeField(Field): When `self.default_timezone` is `None`, always return naive datetimes. When `self.default_timezone` is not `None`, always return aware datetimes. """ - if (self.default_timezone is not None) and not timezone.is_aware(value): - return timezone.make_aware(value, self.default_timezone) - elif (self.default_timezone is None) and timezone.is_aware(value): + field_timezone = getattr(self, 'timezone', self.default_timezone()) + + if (field_timezone is not None) and not timezone.is_aware(value): + return timezone.make_aware(value, field_timezone) + elif (field_timezone is None) and timezone.is_aware(value): return timezone.make_naive(value, timezone.UTC()) return value + def default_timezone(self): + try: + return timezone.get_default_timezone() if settings.USE_TZ else None + except ImproperlyConfigured: + return None + def to_internal_value(self, value): + input_formats = getattr(self, 'input_formats', api_settings.DATETIME_INPUT_FORMATS) + if isinstance(value, datetime.date) and not isinstance(value, datetime.datetime): self.fail('date') if isinstance(value, datetime.datetime): return self.enforce_timezone(value) - for format in self.input_formats: - if format.lower() == ISO_8601: + for input_format in input_formats: + if input_format.lower() == ISO_8601: try: parsed = parse_datetime(value) except (ValueError, TypeError): @@ -1034,25 +1046,27 @@ class DateTimeField(Field): return self.enforce_timezone(parsed) else: try: - parsed = self.datetime_parser(value, format) + parsed = self.datetime_parser(value, input_format) except (ValueError, TypeError): pass else: return self.enforce_timezone(parsed) - humanized_format = humanize_datetime.datetime_formats(self.input_formats) + humanized_format = humanize_datetime.datetime_formats(input_formats) self.fail('invalid', format=humanized_format) def to_representation(self, value): - if self.format is None: + output_format = getattr(self, 'format', api_settings.DATETIME_FORMAT) + + if output_format is None: return value - if self.format.lower() == ISO_8601: + if output_format.lower() == ISO_8601: value = value.isoformat() if value.endswith('+00:00'): value = value[:-6] + 'Z' return value - return value.strftime(self.format) + return value.strftime(output_format) class DateField(Field): @@ -1060,24 +1074,26 @@ class DateField(Field): 'invalid': _('Date has wrong format. Use one of these formats instead: {format}.'), 'datetime': _('Expected a date but got a datetime.'), } - format = api_settings.DATE_FORMAT - input_formats = api_settings.DATE_INPUT_FORMATS datetime_parser = datetime.datetime.strptime def __init__(self, format=empty, input_formats=None, *args, **kwargs): - self.format = format if format is not empty else self.format - self.input_formats = input_formats if input_formats is not None else self.input_formats + if format is not empty: + self.format = format + if input_formats is not None: + self.input_formats = input_formats super(DateField, self).__init__(*args, **kwargs) def to_internal_value(self, value): + input_formats = getattr(self, 'input_formats', api_settings.DATE_INPUT_FORMATS) + if isinstance(value, datetime.datetime): self.fail('datetime') if isinstance(value, datetime.date): return value - for format in self.input_formats: - if format.lower() == ISO_8601: + for input_format in input_formats: + if input_format.lower() == ISO_8601: try: parsed = parse_date(value) except (ValueError, TypeError): @@ -1087,20 +1103,22 @@ class DateField(Field): return parsed else: try: - parsed = self.datetime_parser(value, format) + parsed = self.datetime_parser(value, input_format) except (ValueError, TypeError): pass else: return parsed.date() - humanized_format = humanize_datetime.date_formats(self.input_formats) + humanized_format = humanize_datetime.date_formats(input_formats) self.fail('invalid', format=humanized_format) def to_representation(self, value): + output_format = getattr(self, 'format', api_settings.DATE_FORMAT) + if not value: return None - if self.format is None: + if output_format is None: return value # Applying a `DateField` to a datetime value is almost always @@ -1112,33 +1130,35 @@ class DateField(Field): 'read-only field and deal with timezone issues explicitly.' ) - if self.format.lower() == ISO_8601: + if output_format.lower() == ISO_8601: if (isinstance(value, str)): value = datetime.datetime.strptime(value, '%Y-%m-%d').date() return value.isoformat() - return value.strftime(self.format) + return value.strftime(output_format) class TimeField(Field): default_error_messages = { 'invalid': _('Time has wrong format. Use one of these formats instead: {format}.'), } - format = api_settings.TIME_FORMAT - input_formats = api_settings.TIME_INPUT_FORMATS datetime_parser = datetime.datetime.strptime def __init__(self, format=empty, input_formats=None, *args, **kwargs): - self.format = format if format is not empty else self.format - self.input_formats = input_formats if input_formats is not None else self.input_formats + if format is not empty: + self.format = format + if input_formats is not None: + self.input_formats = input_formats super(TimeField, self).__init__(*args, **kwargs) def to_internal_value(self, value): + input_formats = getattr(self, 'input_formats', api_settings.TIME_INPUT_FORMATS) + if isinstance(value, datetime.time): return value - for format in self.input_formats: - if format.lower() == ISO_8601: + for input_format in input_formats: + if input_format.lower() == ISO_8601: try: parsed = parse_time(value) except (ValueError, TypeError): @@ -1148,17 +1168,19 @@ class TimeField(Field): return parsed else: try: - parsed = self.datetime_parser(value, format) + parsed = self.datetime_parser(value, input_format) except (ValueError, TypeError): pass else: return parsed.time() - humanized_format = humanize_datetime.time_formats(self.input_formats) + humanized_format = humanize_datetime.time_formats(input_formats) self.fail('invalid', format=humanized_format) def to_representation(self, value): - if self.format is None: + output_format = getattr(self, 'format', api_settings.TIME_FORMAT) + + if output_format is None: return value # Applying a `TimeField` to a datetime value is almost always @@ -1170,9 +1192,9 @@ class TimeField(Field): 'read-only field and deal with timezone issues explicitly.' ) - if self.format.lower() == ISO_8601: + if output_format.lower() == ISO_8601: return value.isoformat() - return value.strftime(self.format) + return value.strftime(output_format) class DurationField(Field): @@ -1316,12 +1338,12 @@ class FileField(Field): 'empty': _('The submitted file is empty.'), 'max_length': _('Ensure this filename has at most {max_length} characters (it has {length}).'), } - use_url = api_settings.UPLOADED_FILES_USE_URL def __init__(self, *args, **kwargs): self.max_length = kwargs.pop('max_length', None) self.allow_empty_file = kwargs.pop('allow_empty_file', False) - self.use_url = kwargs.pop('use_url', self.use_url) + if 'use_url' in kwargs: + self.use_url = kwargs.pop('use_url') super(FileField, self).__init__(*args, **kwargs) def to_internal_value(self, data): @@ -1342,10 +1364,12 @@ class FileField(Field): return data def to_representation(self, value): + use_url = getattr(self, 'use_url', api_settings.UPLOADED_FILES_USE_URL) + if not value: return None - if self.use_url: + if use_url: if not getattr(value, 'url', None): # If the file has not been saved it may not have a URL. return None diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index c7d4405c..8ba1f3c4 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -786,7 +786,7 @@ class ModelSerializer(Serializer): # you'll also need to ensure you update the `create` method on any generic # views, to correctly handle the 'Location' response header for # "HTTP 201 Created" responses. - url_field_name = api_settings.URL_FIELD_NAME + url_field_name = None # Default `create` and `update` behavior... def create(self, validated_data): @@ -869,6 +869,9 @@ class ModelSerializer(Serializer): Return the dict of field names -> field instances that should be used for `self.fields` when instantiating the serializer. """ + if self.url_field_name is None: + self.url_field_name = api_settings.URL_FIELD_NAME + assert hasattr(self, 'Meta'), ( 'Class {serializer_class} missing "Meta" attribute'.format( serializer_class=self.__class__.__name__ diff --git a/rest_framework/settings.py b/rest_framework/settings.py index e20e5128..bc386871 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -26,7 +26,6 @@ from django.utils import six from rest_framework import ISO_8601 from rest_framework.compat import importlib -USER_SETTINGS = getattr(settings, 'REST_FRAMEWORK', None) DEFAULTS = { # Base API policies @@ -188,10 +187,17 @@ class APISettings(object): and return the class, rather than the string literal. """ def __init__(self, user_settings=None, defaults=None, import_strings=None): - self.user_settings = user_settings or {} + if user_settings: + self._user_settings = user_settings self.defaults = defaults or DEFAULTS self.import_strings = import_strings or IMPORT_STRINGS + @property + def user_settings(self): + if not hasattr(self, '_user_settings'): + self._user_settings = getattr(settings, 'REST_FRAMEWORK', {}) + return self._user_settings + def __getattr__(self, attr): if attr not in self.defaults.keys(): raise AttributeError("Invalid API setting: '%s'" % attr) @@ -212,7 +218,7 @@ class APISettings(object): return val -api_settings = APISettings(USER_SETTINGS, DEFAULTS, IMPORT_STRINGS) +api_settings = APISettings(None, DEFAULTS, IMPORT_STRINGS) def reload_api_settings(*args, **kwargs): From dcdd765647b28135dc764f038e9380cf1ccc0ecc Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Thu, 3 Sep 2015 17:27:33 +0200 Subject: [PATCH 311/487] Avoid passing allow_empty to the ListSerializer children. --- rest_framework/serializers.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index c7d4405c..77120a10 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -113,8 +113,12 @@ class BaseSerializer(Field): kwargs['child'] = cls() return CustomListSerializer(*args, **kwargs) """ + allow_empty = kwargs.pop('allow_empty', True) child_serializer = cls(*args, **kwargs) - list_kwargs = {'child': child_serializer} + list_kwargs = { + 'child': child_serializer, + 'allow_empty': allow_empty, + } list_kwargs.update(dict([ (key, value) for key, value in kwargs.items() if key in LIST_SERIALIZER_KWARGS From 8b7ebb9d2ca6dd3dba4e021ae750166dd7fe5ecd Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 3 Sep 2015 16:29:13 +0100 Subject: [PATCH 312/487] Fixed import sorting --- rest_framework/fields.py | 3 +-- rest_framework/settings.py | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 8b42690d..e780c511 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -9,9 +9,8 @@ import re import uuid from django.conf import settings -from django.core.exceptions import ImproperlyConfigured from django.core.exceptions import ValidationError as DjangoValidationError -from django.core.exceptions import ObjectDoesNotExist +from django.core.exceptions import ImproperlyConfigured, ObjectDoesNotExist from django.core.validators import RegexValidator, ip_address_validators from django.forms import FilePathField as DjangoFilePathField from django.forms import ImageField as DjangoImageField diff --git a/rest_framework/settings.py b/rest_framework/settings.py index bc386871..c09472e9 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -26,7 +26,6 @@ from django.utils import six from rest_framework import ISO_8601 from rest_framework.compat import importlib - DEFAULTS = { # Base API policies 'DEFAULT_RENDERER_CLASSES': ( From f9e53091c1defb0971f941a529b5c813060952b7 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 3 Sep 2015 16:40:12 +0100 Subject: [PATCH 313/487] Drop handling of ImproperlyConfigured --- rest_framework/fields.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index e780c511..065051b5 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -10,7 +10,7 @@ import uuid from django.conf import settings from django.core.exceptions import ValidationError as DjangoValidationError -from django.core.exceptions import ImproperlyConfigured, ObjectDoesNotExist +from django.core.exceptions import ObjectDoesNotExist from django.core.validators import RegexValidator, ip_address_validators from django.forms import FilePathField as DjangoFilePathField from django.forms import ImageField as DjangoImageField @@ -1020,10 +1020,7 @@ class DateTimeField(Field): return value def default_timezone(self): - try: - return timezone.get_default_timezone() if settings.USE_TZ else None - except ImproperlyConfigured: - return None + return timezone.get_default_timezone() if settings.USE_TZ else None def to_internal_value(self, value): input_formats = getattr(self, 'input_formats', api_settings.DATETIME_INPUT_FORMATS) From bb95de13bf512066bcfdba31c1d58b5a9fcad3f8 Mon Sep 17 00:00:00 2001 From: potpath Date: Fri, 4 Sep 2015 16:07:20 +0700 Subject: [PATCH 314/487] Update 6-viewsets-and-routers.md --- docs/tutorial/6-viewsets-and-routers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/6-viewsets-and-routers.md b/docs/tutorial/6-viewsets-and-routers.md index 63dff73f..f1dbe944 100644 --- a/docs/tutorial/6-viewsets-and-routers.md +++ b/docs/tutorial/6-viewsets-and-routers.md @@ -45,7 +45,7 @@ Next we're going to replace the `SnippetList`, `SnippetDetail` and `SnippetHighl return Response(snippet.highlighted) def perform_create(self, serializer): - serializer.save(owner=self.request.user) + serializer.save(owner=self.request.user) This time we've used the `ModelViewSet` class in order to get the complete set of default read and write operations. From 4404d40f6068c5e403ddb7a8716e6b53cc3c6ba9 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Sun, 6 Sep 2015 23:02:44 +0200 Subject: [PATCH 315/487] Only pass allow_empty to the `ListSerializer` if it was in the arguments. Helps with backward compatibility. --- rest_framework/serializers.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index 77120a10..037939e3 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -113,12 +113,13 @@ class BaseSerializer(Field): kwargs['child'] = cls() return CustomListSerializer(*args, **kwargs) """ - allow_empty = kwargs.pop('allow_empty', True) + allow_empty = kwargs.pop('allow_empty', None) child_serializer = cls(*args, **kwargs) list_kwargs = { 'child': child_serializer, - 'allow_empty': allow_empty, } + if allow_empty is not None: + list_kwargs['allow_empty'] = allow_empty list_kwargs.update(dict([ (key, value) for key, value in kwargs.items() if key in LIST_SERIALIZER_KWARGS From b57e9cf405475e31c3b7d6d6aa4365885a482e7f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 7 Sep 2015 10:22:44 +0100 Subject: [PATCH 316/487] Test protected branches --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 784b54c0..b183e14d 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,6 @@ If you believe you’ve found something in Django REST framework which has secur Send a description of the issue via email to [rest-framework-security@googlegroups.com][security-mail]. The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure. - [build-status-image]: https://secure.travis-ci.org/tomchristie/django-rest-framework.svg?branch=master [travis]: http://travis-ci.org/tomchristie/django-rest-framework?branch=master [coverage-status-image]: https://img.shields.io/codecov/c/github/tomchristie/django-rest-framework/master.svg From aa4818268641d572cc914cbc495f680275643d8e Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Mon, 7 Sep 2015 23:11:01 +0200 Subject: [PATCH 317/487] Add test coverage on allow_empty for nested serializers. --- tests/test_serializer_nested.py | 50 ++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 4 deletions(-) diff --git a/tests/test_serializer_nested.py b/tests/test_serializer_nested.py index 22d4deca..aeb092ee 100644 --- a/tests/test_serializer_nested.py +++ b/tests/test_serializer_nested.py @@ -79,17 +79,23 @@ class TestNestedSerializerWithMany: class TestSerializer(serializers.Serializer): allow_null = NestedSerializer(many=True, allow_null=True) not_allow_null = NestedSerializer(many=True) + allow_empty = NestedSerializer(many=True, allow_empty=True) + not_allow_empty = NestedSerializer(many=True, allow_empty=False) self.Serializer = TestSerializer def test_null_allowed_if_allow_null_is_set(self): input_data = { 'allow_null': None, - 'not_allow_null': [{'example': '2'}, {'example': '3'}] + 'not_allow_null': [{'example': '2'}, {'example': '3'}], + 'allow_empty': [{'example': '2'}], + 'not_allow_empty': [{'example': '2'}], } expected_data = { 'allow_null': None, - 'not_allow_null': [{'example': 2}, {'example': 3}] + 'not_allow_null': [{'example': 2}, {'example': 3}], + 'allow_empty': [{'example': 2}], + 'not_allow_empty': [{'example': 2}], } serializer = self.Serializer(data=input_data) @@ -99,7 +105,9 @@ class TestNestedSerializerWithMany: def test_null_is_not_allowed_if_allow_null_is_not_set(self): input_data = { 'allow_null': None, - 'not_allow_null': None + 'not_allow_null': None, + 'allow_empty': [{'example': '2'}], + 'not_allow_empty': [{'example': '2'}], } serializer = self.Serializer(data=input_data) @@ -118,10 +126,44 @@ class TestNestedSerializerWithMany: input_data = { 'allow_null': None, - 'not_allow_null': [{'example': 2}] + 'not_allow_null': [{'example': 2}], + 'allow_empty': [{'example': 2}], + 'not_allow_empty': [{'example': 2}], } serializer = TestSerializer(data=input_data) assert serializer.is_valid() assert serializer.validated_data == input_data assert TestSerializer.validation_was_run + + def test_empty_allowed_if_allow_empty_is_set(self): + input_data = { + 'allow_null': [{'example': '2'}], + 'not_allow_null': [{'example': '2'}], + 'allow_empty': [], + 'not_allow_empty': [{'example': '2'}], + } + expected_data = { + 'allow_null': [{'example': 2}], + 'not_allow_null': [{'example': 2}], + 'allow_empty': [], + 'not_allow_empty': [{'example': 2}], + } + serializer = self.Serializer(data=input_data) + + assert serializer.is_valid(), serializer.errors + assert serializer.validated_data == expected_data + + def test_empty_not_allowed_if_allow_empty_is_set_to_false(self): + input_data = { + 'allow_null': [{'example': '2'}], + 'not_allow_null': [{'example': '2'}], + 'allow_empty': [], + 'not_allow_empty': [], + } + serializer = self.Serializer(data=input_data) + + assert not serializer.is_valid() + + expected_errors = {'not_allow_empty': {'non_field_errors': [serializers.ListSerializer.default_error_messages['empty']]}} + assert serializer.errors == expected_errors From 671de792e203a9f0165a6f943c69427c55ef37fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rub=C3=A9n=20D=C3=ADaz?= Date: Thu, 10 Sep 2015 10:19:40 +0300 Subject: [PATCH 318/487] Fixed typo in ScopedRateThrottle example views --- docs/api-guide/throttling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md index 3f668867..57bce54e 100644 --- a/docs/api-guide/throttling.md +++ b/docs/api-guide/throttling.md @@ -148,7 +148,7 @@ For example, given the following views... throttle_scope = 'contacts' ... - class ContactDetailView(ApiView): + class ContactDetailView(APIView): throttle_scope = 'contacts' ... From 4704da9a1acf3cbf1b1b1396821fa6ee61e0ffce Mon Sep 17 00:00:00 2001 From: Nic Young Date: Thu, 10 Sep 2015 17:17:33 -0700 Subject: [PATCH 319/487] Add note about field level validation, fixes #3306 The documentation added warns the user that field level validation will be skipped if the field is declared on the model with the parameter `required=False`. --- docs/api-guide/serializers.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index abdb67af..1ac84590 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -189,6 +189,12 @@ Your `validate_` methods should return the validated value or raise raise serializers.ValidationError("Blog post is not about Django") return value +--- + +**Note:** If your `` is declared on your serializer with the parameter `required=False` then this validation step will not take place if the field is not included. + +--- + #### Object-level validation To do any other validation that requires access to multiple fields, add a method called `.validate()` to your `Serializer` subclass. This method takes a single argument, which is a dictionary of field values. It should raise a `ValidationError` if necessary, or just return the validated values. For example: From ab296ced4ea66b1655313ece62551e6cdf1ecb19 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 11 Sep 2015 13:06:09 +0100 Subject: [PATCH 320/487] Add link to django REST marshmallow --- docs/api-guide/serializers.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index abdb67af..e8c94797 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -1022,6 +1022,10 @@ A new interface for controlling this behavior is currently planned for REST fram The following third party packages are also available. +## Django REST marshmallow + +The [django-rest-marshmallow][django-rest-marshmallow] package provides an alternative implementation for serializers, using the python [marshmallow][marshmallow] library. It exposes the same API as the REST framework serializers, and can be used as a drop-in replacement in some use-cases. + ## MongoengineModelSerializer The [django-rest-framework-mongoengine][mongoengine] package provides a `MongoEngineModelSerializer` serializer class that supports using MongoDB as the storage layer for Django REST framework. @@ -1038,6 +1042,8 @@ The [django-rest-framework-hstore][django-rest-framework-hstore] package provide [relations]: relations.md [model-managers]: https://docs.djangoproject.com/en/dev/topics/db/managers/ [encapsulation-blogpost]: http://www.dabapps.com/blog/django-models-and-encapsulation/ +[django-rest-marshmallow]: http://tomchristie.github.io/django-rest-marshmallow/ +[marshmallow]: https://marshmallow.readthedocs.org/en/latest/ [mongoengine]: https://github.com/umutbozkurt/django-rest-framework-mongoengine [django-rest-framework-gis]: https://github.com/djangonauts/django-rest-framework-gis [django-rest-framework-hstore]: https://github.com/djangonauts/django-rest-framework-hstore From 1a8f9d0a0f7edb7a138bd37e31772ff56dbceb2c Mon Sep 17 00:00:00 2001 From: qqbuby Date: Sat, 12 Sep 2015 01:36:40 +0800 Subject: [PATCH 321/487] fix issue #3395 to correct the output text at line 184in docs/tutorial/1-serialization.md --- docs/tutorial/1-serialization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md index c54af0ce..e26db8be 100644 --- a/docs/tutorial/1-serialization.md +++ b/docs/tutorial/1-serialization.md @@ -181,7 +181,7 @@ We can also serialize querysets instead of model instances. To do so we simply serializer = SnippetSerializer(Snippet.objects.all(), many=True) serializer.data - # [{'pk': 1, 'title': u'', 'code': u'foo = "bar"\n', 'linenos': False, 'language': u'python', 'style': u'friendly'}, {'pk': 2, 'title': u'', 'code': u'print "hello, world"\n', 'linenos': False, 'language': u'python', 'style': u'friendly'}] + #[OrderedDict([('pk', 1), ('title', u''), ('code', u'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('pk', 2), ('title', u''), ('code', u'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('pk', 3), ('title', u''), ('code', u'print "hello, world"'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])] ## Using ModelSerializers From 284f9faa07941a2c804909187211cc782e7c96c9 Mon Sep 17 00:00:00 2001 From: Steven Loria Date: Fri, 11 Sep 2015 23:01:18 -0400 Subject: [PATCH 322/487] Correctly handle [] and {} as invalid inputs to BooleanField --- rest_framework/fields.py | 11 +++++++---- tests/test_fields.py | 12 ++++++++++++ 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/rest_framework/fields.py b/rest_framework/fields.py index 159784ea..7c48c621 100644 --- a/rest_framework/fields.py +++ b/rest_framework/fields.py @@ -608,10 +608,13 @@ class BooleanField(Field): super(BooleanField, self).__init__(**kwargs) def to_internal_value(self, data): - if data in self.TRUE_VALUES: - return True - elif data in self.FALSE_VALUES: - return False + try: + if data in self.TRUE_VALUES: + return True + elif data in self.FALSE_VALUES: + return False + except TypeError: # Input is an unhashable type + pass self.fail('invalid', input=data) def to_representation(self, value): diff --git a/tests/test_fields.py b/tests/test_fields.py index c1d3e3a4..6048f49d 100644 --- a/tests/test_fields.py +++ b/tests/test_fields.py @@ -466,6 +466,18 @@ class TestBooleanField(FieldValues): } field = serializers.BooleanField() + def test_disallow_unhashable_collection_types(self): + inputs = ( + [], + {}, + ) + field = serializers.BooleanField() + for input_value in inputs: + with pytest.raises(serializers.ValidationError) as exc_info: + field.run_validation(input_value) + expected = ['"{0}" is not a valid boolean.'.format(input_value)] + assert exc_info.value.detail == expected + class TestNullBooleanField(FieldValues): """ From 5c076e10bbd3defbda05403a678f7397ac5e6f26 Mon Sep 17 00:00:00 2001 From: Nic Young Date: Sat, 12 Sep 2015 23:04:18 -0700 Subject: [PATCH 323/487] Add link to serpy serialization, fixes #3391 --- docs/api-guide/serializers.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index 70739689..ca540a13 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -1032,6 +1032,9 @@ The following third party packages are also available. The [django-rest-marshmallow][django-rest-marshmallow] package provides an alternative implementation for serializers, using the python [marshmallow][marshmallow] library. It exposes the same API as the REST framework serializers, and can be used as a drop-in replacement in some use-cases. +## Serpy +The [serpy][serpy] package is an alternative implementation for serializers that is built for speed. [Serpy][serpy] serializes complex datatypes to simple native types. The native types can be easily converted to JSON or any other format needed. + ## MongoengineModelSerializer The [django-rest-framework-mongoengine][mongoengine] package provides a `MongoEngineModelSerializer` serializer class that supports using MongoDB as the storage layer for Django REST framework. @@ -1050,6 +1053,7 @@ The [django-rest-framework-hstore][django-rest-framework-hstore] package provide [encapsulation-blogpost]: http://www.dabapps.com/blog/django-models-and-encapsulation/ [django-rest-marshmallow]: http://tomchristie.github.io/django-rest-marshmallow/ [marshmallow]: https://marshmallow.readthedocs.org/en/latest/ +[serpy]: https://github.com/clarkduvall/serpy [mongoengine]: https://github.com/umutbozkurt/django-rest-framework-mongoengine [django-rest-framework-gis]: https://github.com/djangonauts/django-rest-framework-gis [django-rest-framework-hstore]: https://github.com/djangonauts/django-rest-framework-hstore From 1aa16caffe6a6e7eba409cc1a4be2f9a05777cd6 Mon Sep 17 00:00:00 2001 From: qqbuby Date: Sun, 13 Sep 2015 20:24:22 +0800 Subject: [PATCH 324/487] append a space after the comment mark to remain consistent with the other parts of the tutorial --- docs/tutorial/1-serialization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md index e26db8be..890f8d56 100644 --- a/docs/tutorial/1-serialization.md +++ b/docs/tutorial/1-serialization.md @@ -181,7 +181,7 @@ We can also serialize querysets instead of model instances. To do so we simply serializer = SnippetSerializer(Snippet.objects.all(), many=True) serializer.data - #[OrderedDict([('pk', 1), ('title', u''), ('code', u'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('pk', 2), ('title', u''), ('code', u'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('pk', 3), ('title', u''), ('code', u'print "hello, world"'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])] + # [OrderedDict([('pk', 1), ('title', u''), ('code', u'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('pk', 2), ('title', u''), ('code', u'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('pk', 3), ('title', u''), ('code', u'print "hello, world"'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])] ## Using ModelSerializers From 6baca948309da5cc67f25cdfda8eb7198700541f Mon Sep 17 00:00:00 2001 From: James McMahon Date: Mon, 14 Sep 2015 19:34:07 +0100 Subject: [PATCH 325/487] added knox package reference to 3rd party auth apps --- docs/api-guide/authentication.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index 2ccf7d72..7fda98e6 100644 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -360,6 +360,10 @@ HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a [Django-rest-auth][django-rest-auth] library provides a set of REST API endpoints for registration, authentication (including social media authentication), password reset, retrieve and update user details, etc. By having these API endpoints, your client apps such as AngularJS, iOS, Android, and others can communicate to your Django backend site independently via REST APIs for user management. +## django-rest-knox + +[Django-rest-knox][django-rest-knox] library provides models and views to handle token based authentication in a more secure and extensible way than the built-in TokenAuthentication scheme - with Single Page Applications and Mobile clients in mind. It provides per-client tokens, and views to generate them when provided some other authentication (usually basic authentication), to delete the token (providing a server enforced logout) and to delete all tokens (logs out all clients that a user is logged into). + [cite]: http://jacobian.org/writing/rest-worst-practices/ [http401]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 [http403]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 @@ -400,3 +404,4 @@ HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a [mac]: http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05 [djoser]: https://github.com/sunscrapers/djoser [django-rest-auth]: https://github.com/Tivix/django-rest-auth +[django-rest-knox]: https://github.com/James1345/django-rest-knox From 4e7d0493db7ca415980752f37e5ccc837503be8d Mon Sep 17 00:00:00 2001 From: Nic Young Date: Mon, 14 Sep 2015 21:05:28 -0700 Subject: [PATCH 326/487] Update transifex-client requirement to latest release version --- requirements/requirements-packaging.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements-packaging.txt b/requirements/requirements-packaging.txt index 1efb2f83..7510dbd7 100644 --- a/requirements/requirements-packaging.txt +++ b/requirements/requirements-packaging.txt @@ -5,4 +5,4 @@ wheel==0.24.0 twine==1.4.0 # Transifex client for managing translation resources. -transifex-client==0.10 +transifex-client==0.11b3 From 566812ac0b577f79801ec67f86f064cf39ebee01 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 17 Sep 2015 15:17:29 +0100 Subject: [PATCH 327/487] Remove method and content overriding --- rest_framework/renderers.py | 38 +++---- rest_framework/request.py | 98 +------------------ rest_framework/settings.py | 3 - .../static/rest_framework/js/ajax-form.js | 97 ++++++++++++++++++ .../static/rest_framework/js/csrf.js | 47 +++++++++ .../rest_framework/js/jquery-1.11.3.min.js | 5 + .../templates/rest_framework/base.html | 29 +++--- .../rest_framework/raw_data_form.html | 1 - tests/test_request.py | 73 -------------- tests/test_views.py | 30 ------ 10 files changed, 180 insertions(+), 241 deletions(-) create mode 100644 rest_framework/static/rest_framework/js/ajax-form.js create mode 100644 rest_framework/static/rest_framework/js/csrf.js create mode 100644 rest_framework/static/rest_framework/js/jquery-1.11.3.min.js diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py index fb0dfcbd..a450be84 100644 --- a/rest_framework/renderers.py +++ b/rest_framework/renderers.py @@ -420,9 +420,6 @@ class BrowsableAPIRenderer(BaseRenderer): if method not in view.allowed_methods: return # Not a valid method - if not api_settings.FORM_METHOD_OVERRIDE: - return # Cannot use form overloading - try: view.check_permissions(request) if obj is not None: @@ -530,13 +527,6 @@ class BrowsableAPIRenderer(BaseRenderer): instance = None with override_method(view, request, method) as request: - # If we're not using content overloading there's no point in - # supplying a generic form, as the view won't treat the form's - # value as the content of the request. - if not (api_settings.FORM_CONTENT_OVERRIDE and - api_settings.FORM_CONTENTTYPE_OVERRIDE): - return None - # Check permissions if not self.show_form_for_method(view, method, request, instance): return @@ -564,28 +554,22 @@ class BrowsableAPIRenderer(BaseRenderer): # Generate a generic form that includes a content type field, # and a content field. - content_type_field = api_settings.FORM_CONTENTTYPE_OVERRIDE - content_field = api_settings.FORM_CONTENT_OVERRIDE - media_types = [parser.media_type for parser in view.parser_classes] choices = [(media_type, media_type) for media_type in media_types] initial = media_types[0] - # NB. http://jacobian.org/writing/dynamic-form-generation/ class GenericContentForm(forms.Form): - def __init__(self): - super(GenericContentForm, self).__init__() - - self.fields[content_type_field] = forms.ChoiceField( - label='Media type', - choices=choices, - initial=initial - ) - self.fields[content_field] = forms.CharField( - label='Content', - widget=forms.Textarea, - initial=content - ) + _content_type = forms.ChoiceField( + label='Media type', + choices=choices, + initial=initial, + widget=forms.Select(attrs={'data-override': 'content-type'}) + ) + _content = forms.CharField( + label='Content', + widget=forms.Textarea(attrs={'data-override': 'content'}), + initial=content + ) return GenericContentForm() diff --git a/rest_framework/request.py b/rest_framework/request.py index 7b583485..98a70eb3 100644 --- a/rest_framework/request.py +++ b/rest_framework/request.py @@ -129,11 +129,6 @@ class Request(object): - authentication_classes(list/tuple). The authentications used to try authenticating the request's user. """ - - _METHOD_PARAM = api_settings.FORM_METHOD_OVERRIDE - _CONTENT_PARAM = api_settings.FORM_CONTENT_OVERRIDE - _CONTENTTYPE_PARAM = api_settings.FORM_CONTENTTYPE_OVERRIDE - def __init__(self, request, parsers=None, authenticators=None, negotiator=None, parser_context=None): self._request = request @@ -162,30 +157,10 @@ class Request(object): def _default_negotiator(self): return api_settings.DEFAULT_CONTENT_NEGOTIATION_CLASS() - @property - def method(self): - """ - Returns the HTTP method. - - This allows the `method` to be overridden by using a hidden `form` - field on a form POST request. - """ - if not _hasattr(self, '_method'): - self._load_method_and_content_type() - return self._method - @property def content_type(self): - """ - Returns the content type header. - - This should be used instead of `request.META.get('HTTP_CONTENT_TYPE')`, - as it allows the content type to be overridden by using a hidden form - field on a form POST request. - """ - if not _hasattr(self, '_content_type'): - self._load_method_and_content_type() - return self._content_type + meta = self._request.META + return meta.get('CONTENT_TYPE', meta.get('HTTP_CONTENT_TYPE', '')) @property def stream(self): @@ -265,9 +240,6 @@ class Request(object): """ Parses the request content into `self.data`. """ - if not _hasattr(self, '_content_type'): - self._load_method_and_content_type() - if not _hasattr(self, '_data'): self._data, self._files = self._parse() if self._files: @@ -276,32 +248,14 @@ class Request(object): else: self._full_data = self._data - def _load_method_and_content_type(self): - """ - Sets the method and content_type, and then check if they've - been overridden. - """ - self._content_type = self.META.get('HTTP_CONTENT_TYPE', - self.META.get('CONTENT_TYPE', '')) - - self._perform_form_overloading() - - if not _hasattr(self, '_method'): - self._method = self._request.method - - # Allow X-HTTP-METHOD-OVERRIDE header - if 'HTTP_X_HTTP_METHOD_OVERRIDE' in self.META: - self._method = self.META['HTTP_X_HTTP_METHOD_OVERRIDE'].upper() - def _load_stream(self): """ Return the content body of the request, as a stream. """ + meta = self._request.META try: content_length = int( - self.META.get( - 'CONTENT_LENGTH', self.META.get('HTTP_CONTENT_LENGTH') - ) + meta.get('CONTENT_LENGTH', meta.get('HTTP_CONTENT_LENGTH', 0)) ) except (ValueError, TypeError): content_length = 0 @@ -313,50 +267,6 @@ class Request(object): else: self._stream = six.BytesIO(self.raw_post_data) - def _perform_form_overloading(self): - """ - If this is a form POST request, then we need to check if the method and - content/content_type have been overridden by setting them in hidden - form fields or not. - """ - - USE_FORM_OVERLOADING = ( - self._METHOD_PARAM or - (self._CONTENT_PARAM and self._CONTENTTYPE_PARAM) - ) - - # We only need to use form overloading on form POST requests. - if ( - self._request.method != 'POST' or - not USE_FORM_OVERLOADING or - not is_form_media_type(self._content_type) - ): - return - - # At this point we're committed to parsing the request as form data. - self._data = self._request.POST - self._files = self._request.FILES - self._full_data = self._data.copy() - self._full_data.update(self._files) - - # Method overloading - change the method and remove the param from the content. - if ( - self._METHOD_PARAM and - self._METHOD_PARAM in self._data - ): - self._method = self._data[self._METHOD_PARAM].upper() - - # Content overloading - modify the content type, and force re-parse. - if ( - self._CONTENT_PARAM and - self._CONTENTTYPE_PARAM and - self._CONTENT_PARAM in self._data and - self._CONTENTTYPE_PARAM in self._data - ): - self._content_type = self._data[self._CONTENTTYPE_PARAM] - self._stream = six.BytesIO(self._data[self._CONTENT_PARAM].encode(self.parser_context['encoding'])) - self._data, self._files, self._full_data = (Empty, Empty, Empty) - def _parse(self): """ Parse the request content, returning a two-tuple of (data, files) diff --git a/rest_framework/settings.py b/rest_framework/settings.py index e20e5128..ec58d3ab 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -94,9 +94,6 @@ DEFAULTS = { 'TEST_REQUEST_DEFAULT_FORMAT': 'multipart', # Browser enhancements - 'FORM_METHOD_OVERRIDE': '_method', - 'FORM_CONTENT_OVERRIDE': '_content', - 'FORM_CONTENTTYPE_OVERRIDE': '_content_type', 'URL_ACCEPT_OVERRIDE': 'accept', 'URL_FORMAT_OVERRIDE': 'format', diff --git a/rest_framework/static/rest_framework/js/ajax-form.js b/rest_framework/static/rest_framework/js/ajax-form.js new file mode 100644 index 00000000..db07fd8f --- /dev/null +++ b/rest_framework/static/rest_framework/js/ajax-form.js @@ -0,0 +1,97 @@ +function replaceDocument(docString) { + var doc = document.open("text/html"); + doc.write(docString); + doc.close(); +} + + +function doAjaxSubmit(e) { + var form = $(this); + var btn = $(this.clk); + var method = btn.data('method') || form.data('method') || form.attr('method') || 'GET'; + method = method.toUpperCase() + if (method === 'GET') { + // GET requests can always use standard form submits. + return; + } + + var contentType = + form.find('input[data-override="content-type"]').val() || + form.find('select[data-override="content-type"] option:selected').text(); + if (method === 'POST' && !contentType) { + // POST requests can use standard form submits, unless we have + // overridden the content type. + return; + } + + // At this point we need to make an AJAX form submission. + e.preventDefault(); + + var url = form.attr('action'); + var data; + if (contentType) { + data = form.find('[data-override="content"]').val() || '' + } else { + contentType = form.attr('enctype') || form.attr('encoding') + if (contentType === 'multipart/form-data') { + if (!window.FormData) { + alert('Your browser does not support AJAX multipart form submissions'); + return; + } + // Use the FormData API and allow the content type to be set automatically, + // so it includes the boundary string. + // See https://developer.mozilla.org/en-US/docs/Web/API/FormData/Using_FormData_Objects + contentType = false; + data = new FormData(form[0]); + } else { + contentType = 'application/x-www-form-urlencoded; charset=UTF-8' + data = form.serialize(); + } + } + + var ret = $.ajax({ + url: url, + method: method, + data: data, + contentType: contentType, + processData: false, + headers: {'Accept': 'text/html; q=1.0, */*'}, + }); + ret.always(function(data, textStatus, jqXHR) { + if (textStatus != 'success') { + jqXHR = data; + } + var responseContentType = jqXHR.getResponseHeader("content-type") || ""; + if (responseContentType.toLowerCase().indexOf('text/html') === 0) { + replaceDocument(jqXHR.responseText); + try { + // Modify the location and scroll to top, as if after page load. + history.replaceState({}, '', url); + scroll(0,0); + } catch(err) { + // History API not supported, so redirect. + window.location = url; + } + } else { + // Not HTML content. We can't open this directly, so redirect. + window.location = url; + } + }); + return ret; +} + + +function captureSubmittingElement(e) { + var target = e.target; + var form = this; + form.clk = target; +} + + +$.fn.ajaxForm = function() { + var options = {} + return this + .unbind('submit.form-plugin click.form-plugin') + .bind('submit.form-plugin', options, doAjaxSubmit) + .bind('click.form-plugin', options, captureSubmittingElement); +}; diff --git a/rest_framework/static/rest_framework/js/csrf.js b/rest_framework/static/rest_framework/js/csrf.js new file mode 100644 index 00000000..4e8da0de --- /dev/null +++ b/rest_framework/static/rest_framework/js/csrf.js @@ -0,0 +1,47 @@ +function getCookie(name) { + var cookieValue = null; + if (document.cookie && document.cookie != '') { + var cookies = document.cookie.split(';'); + for (var i = 0; i < cookies.length; i++) { + var cookie = jQuery.trim(cookies[i]); + // Does this cookie string begin with the name we want? + if (cookie.substring(0, name.length + 1) == (name + '=')) { + cookieValue = decodeURIComponent(cookie.substring(name.length + 1)); + break; + } + } + } + return cookieValue; +} + +function csrfSafeMethod(method) { + // these HTTP methods do not require CSRF protection + return (/^(GET|HEAD|OPTIONS|TRACE)$/.test(method)); +} + +function sameOrigin(url) { + // test that a given url is a same-origin URL + // url could be relative or scheme relative or absolute + var host = document.location.host; // host + port + var protocol = document.location.protocol; + var sr_origin = '//' + host; + var origin = protocol + sr_origin; + // Allow absolute or scheme relative URLs to same origin + return (url == origin || url.slice(0, origin.length + 1) == origin + '/') || + (url == sr_origin || url.slice(0, sr_origin.length + 1) == sr_origin + '/') || + // or any other URL that isn't scheme relative or absolute i.e relative. + !(/^(\/\/|http:|https:).*/.test(url)); +} + +var csrftoken = getCookie('csrftoken'); + +$.ajaxSetup({ + beforeSend: function(xhr, settings) { + if (!csrfSafeMethod(settings.type) && sameOrigin(settings.url)) { + // Send the token to same-origin, relative URLs only. + // Send the token only if the method warrants CSRF protection + // Using the CSRFToken value acquired earlier + xhr.setRequestHeader("X-CSRFToken", csrftoken); + } + } +}); diff --git a/rest_framework/static/rest_framework/js/jquery-1.11.3.min.js b/rest_framework/static/rest_framework/js/jquery-1.11.3.min.js new file mode 100644 index 00000000..0f60b7bd --- /dev/null +++ b/rest_framework/static/rest_framework/js/jquery-1.11.3.min.js @@ -0,0 +1,5 @@ +/*! jQuery v1.11.3 | (c) 2005, 2015 jQuery Foundation, Inc. | jquery.org/license */ +!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.3",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)+1>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b="length"in a&&a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ha(),z=ha(),A=ha(),B=function(a,b){return a===b&&(l=!0),0},C=1<<31,D={}.hasOwnProperty,E=[],F=E.pop,G=E.push,H=E.push,I=E.slice,J=function(a,b){for(var c=0,d=a.length;d>c;c++)if(a[c]===b)return c;return-1},K="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",L="[\\x20\\t\\r\\n\\f]",M="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",N=M.replace("w","w#"),O="\\["+L+"*("+M+")(?:"+L+"*([*^$|!~]?=)"+L+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+N+"))|)"+L+"*\\]",P=":("+M+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+O+")*)|.*)\\)|)",Q=new RegExp(L+"+","g"),R=new RegExp("^"+L+"+|((?:^|[^\\\\])(?:\\\\.)*)"+L+"+$","g"),S=new RegExp("^"+L+"*,"+L+"*"),T=new RegExp("^"+L+"*([>+~]|"+L+")"+L+"*"),U=new RegExp("="+L+"*([^\\]'\"]*?)"+L+"*\\]","g"),V=new RegExp(P),W=new RegExp("^"+N+"$"),X={ID:new RegExp("^#("+M+")"),CLASS:new RegExp("^\\.("+M+")"),TAG:new RegExp("^("+M.replace("w","w*")+")"),ATTR:new RegExp("^"+O),PSEUDO:new RegExp("^"+P),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+L+"*(even|odd|(([+-]|)(\\d*)n|)"+L+"*(?:([+-]|)"+L+"*(\\d+)|))"+L+"*\\)|)","i"),bool:new RegExp("^(?:"+K+")$","i"),needsContext:new RegExp("^"+L+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+L+"*((?:-\\d)?\\d*)"+L+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,aa=/[+~]/,ba=/'|\\/g,ca=new RegExp("\\\\([\\da-f]{1,6}"+L+"?|("+L+")|.)","ig"),da=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},ea=function(){m()};try{H.apply(E=I.call(v.childNodes),v.childNodes),E[v.childNodes.length].nodeType}catch(fa){H={apply:E.length?function(a,b){G.apply(a,I.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function ga(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],k=b.nodeType,"string"!=typeof a||!a||1!==k&&9!==k&&11!==k)return d;if(!e&&p){if(11!==k&&(f=_.exec(a)))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return H.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName)return H.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=1!==k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(ba,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+ra(o[l]);w=aa.test(a)&&pa(b.parentNode)||b,x=o.join(",")}if(x)try{return H.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function ha(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ia(a){return a[u]=!0,a}function ja(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ka(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function la(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||C)-(~a.sourceIndex||C);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function na(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function oa(a){return ia(function(b){return b=+b,ia(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function pa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=ga.support={},f=ga.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=ga.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=g.documentElement,e=g.defaultView,e&&e!==e.top&&(e.addEventListener?e.addEventListener("unload",ea,!1):e.attachEvent&&e.attachEvent("onunload",ea)),p=!f(g),c.attributes=ja(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ja(function(a){return a.appendChild(g.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(g.getElementsByClassName),c.getById=ja(function(a){return o.appendChild(a).id=u,!g.getElementsByName||!g.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(ca,da);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(ca,da);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(g.querySelectorAll))&&(ja(function(a){o.appendChild(a).innerHTML="",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+L+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+L+"*(?:value|"+K+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ja(function(a){var b=g.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+L+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ja(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",P)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===g||a.ownerDocument===v&&t(v,a)?-1:b===g||b.ownerDocument===v&&t(v,b)?1:k?J(k,a)-J(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,h=[a],i=[b];if(!e||!f)return a===g?-1:b===g?1:e?-1:f?1:k?J(k,a)-J(k,b):0;if(e===f)return la(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?la(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},g):n},ga.matches=function(a,b){return ga(a,null,null,b)},ga.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return ga(b,n,null,[a]).length>0},ga.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},ga.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&D.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},ga.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},ga.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=ga.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=ga.selectors={cacheLength:50,createPseudo:ia,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(ca,da),a[3]=(a[3]||a[4]||a[5]||"").replace(ca,da),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||ga.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&ga.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(ca,da).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+L+")"+a+"("+L+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=ga.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(Q," ")+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||ga.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ia(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=J(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ia(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?ia(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ia(function(a){return function(b){return ga(a,b).length>0}}),contains:ia(function(a){return a=a.replace(ca,da),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ia(function(a){return W.test(a||"")||ga.error("unsupported lang: "+a),a=a.replace(ca,da).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:oa(function(){return[0]}),last:oa(function(a,b){return[b-1]}),eq:oa(function(a,b,c){return[0>c?c+b:c]}),even:oa(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:oa(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:oa(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:oa(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function sa(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function ta(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function ua(a,b,c){for(var d=0,e=b.length;e>d;d++)ga(a,b[d],c);return c}function va(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function wa(a,b,c,d,e,f){return d&&!d[u]&&(d=wa(d)),e&&!e[u]&&(e=wa(e,f)),ia(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||ua(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:va(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=va(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?J(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=va(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):H.apply(g,r)})}function xa(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=sa(function(a){return a===b},h,!0),l=sa(function(a){return J(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];f>i;i++)if(c=d.relative[a[i].type])m=[sa(ta(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return wa(i>1&&ta(m),i>1&&ra(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&xa(a.slice(i,e)),f>e&&xa(a=a.slice(e)),f>e&&ra(a))}m.push(c)}return ta(m)}function ya(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=F.call(i));s=va(s)}H.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&ga.uniqueSort(i)}return k&&(w=v,j=t),r};return c?ia(f):f}return h=ga.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=xa(b[c]),f[u]?d.push(f):e.push(f);f=A(a,ya(e,d)),f.selector=a}return f},i=ga.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(ca,da),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(ca,da),aa.test(j[0].type)&&pa(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&ra(j),!a)return H.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,aa.test(a)&&pa(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ja(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ja(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||ka("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ja(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ka("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ja(function(a){return null==a.getAttribute("disabled")})||ka(K,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),ga}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1; + +return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h;if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML="
    {{ column|capfirst }}
    {{ column|capfirst }}
    - {% if key in linked %}{% endif %} {{ value|format_value }} - {% if key in linked %}{% endif %} +
    a",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function aa(){return!0}function ba(){return!1}function ca(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),ha=/^\s+/,ia=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,ja=/<([\w:]+)/,ka=/\s*$/g,ra={option:[1,""],legend:[1,"
    ","
    "],area:[1,"",""],param:[1,"",""],thead:[1,"","
    "],tr:[2,"","
    "],col:[2,"","
    "],td:[3,"","
    "],_default:k.htmlSerialize?[0,"",""]:[1,"X
    ","
    "]},sa=da(y),ta=sa.appendChild(y.createElement("div"));ra.optgroup=ra.option,ra.tbody=ra.tfoot=ra.colgroup=ra.caption=ra.thead,ra.th=ra.td;function ua(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ua(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function va(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wa(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xa(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function ya(a){var b=pa.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function za(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Aa(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Ba(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xa(b).text=a.text,ya(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!ga.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(ta.innerHTML=a.outerHTML,ta.removeChild(f=ta.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ua(f),h=ua(a),g=0;null!=(e=h[g]);++g)d[g]&&Ba(e,d[g]);if(b)if(c)for(h=h||ua(a),d=d||ua(f),g=0;null!=(e=h[g]);g++)Aa(e,d[g]);else Aa(a,f);return d=ua(f,"script"),d.length>0&&za(d,!i&&ua(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=da(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(la.test(f)){h=h||o.appendChild(b.createElement("div")),i=(ja.exec(f)||["",""])[1].toLowerCase(),l=ra[i]||ra._default,h.innerHTML=l[1]+f.replace(ia,"<$1>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&ha.test(f)&&p.push(b.createTextNode(ha.exec(f)[0])),!k.tbody){f="table"!==i||ka.test(f)?""!==l[1]||ka.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ua(p,"input"),va),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ua(o.appendChild(f),"script"),g&&za(h),c)){e=0;while(f=h[e++])oa.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wa(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wa(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ua(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&za(ua(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ua(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fa,""):void 0;if(!("string"!=typeof a||ma.test(a)||!k.htmlSerialize&&ga.test(a)||!k.leadingWhitespace&&ha.test(a)||ra[(ja.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ia,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ua(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ua(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&na.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ua(i,"script"),xa),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ua(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,ya),j=0;f>j;j++)d=g[j],oa.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qa,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Ca,Da={};function Ea(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fa(a){var b=y,c=Da[a];return c||(c=Ea(a,b),"none"!==c&&c||(Ca=(Ca||m("