mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-23 01:57:00 +03:00
Merge branch 'master' into resources-routers
This commit is contained in:
commit
b4945f476c
|
@ -119,6 +119,8 @@ To use the `TokenAuthentication` scheme, include `rest_framework.authtoken` in y
|
||||||
...
|
...
|
||||||
'rest_framework.authtoken'
|
'rest_framework.authtoken'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
Make sure to run `manage.py syncdb` after changing your settings.
|
||||||
|
|
||||||
You'll also need to create tokens for your users.
|
You'll also need to create tokens for your users.
|
||||||
|
|
||||||
|
@ -140,6 +142,10 @@ Unauthenticated responses that are denied permission will result in an `HTTP 401
|
||||||
|
|
||||||
WWW-Authenticate: Token
|
WWW-Authenticate: Token
|
||||||
|
|
||||||
|
The `curl` command line tool may be useful for testing token authenticated APIs. For example:
|
||||||
|
|
||||||
|
curl -X GET http://127.0.0.1:8000/api/example/ -H 'Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b'
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Note:** If you use `TokenAuthentication` in production you must ensure that your API is only available over `https` only.
|
**Note:** If you use `TokenAuthentication` in production you must ensure that your API is only available over `https` only.
|
||||||
|
@ -294,7 +300,7 @@ The only thing needed to make the `OAuth2Authentication` class work is to insert
|
||||||
|
|
||||||
The command line to test the authentication looks like:
|
The command line to test the authentication looks like:
|
||||||
|
|
||||||
curl -H "Authorization: Bearer <your-access-token>" http://localhost:8000/api/?client_id=YOUR_CLIENT_ID\&client_secret=YOUR_CLIENT_SECRET
|
curl -H "Authorization: Bearer <your-access-token>" http://localhost:8000/api/
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -197,12 +197,16 @@ If you want to override this behavior, you'll need to declare the `DateTimeField
|
||||||
class Meta:
|
class Meta:
|
||||||
model = Comment
|
model = Comment
|
||||||
|
|
||||||
|
Note that by default, datetime representations are deteremined by the renderer in use, although this can be explicitly overridden as detailed below.
|
||||||
|
|
||||||
|
In the case of JSON this means the default datetime representation uses the [ECMA 262 date time string specification][ecma262]. This is a subset of ISO 8601 which uses millisecond precision, and includes the 'Z' suffix for the UTC timezone, for example: `2013-01-29T12:34:56.123Z`.
|
||||||
|
|
||||||
**Signature:** `DateTimeField(format=None, input_formats=None)`
|
**Signature:** `DateTimeField(format=None, input_formats=None)`
|
||||||
|
|
||||||
* `format` - A string representing the output format. If not specified, the `DATETIME_FORMAT` setting will be used, which defaults to `'iso-8601'`.
|
* `format` - A string representing the output format. If not specified, this defaults to `None`, which indicates that python `datetime` objects should be returned by `to_native`. In this case the datetime encoding will be determined by the renderer.
|
||||||
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATETIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
|
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATETIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
|
||||||
|
|
||||||
DateTime format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style datetimes should be used. (eg `'2013-01-29T12:34:56.000000'`)
|
DateTime format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style datetimes should be used. (eg `'2013-01-29T12:34:56.000000Z'`)
|
||||||
|
|
||||||
## DateField
|
## DateField
|
||||||
|
|
||||||
|
@ -212,7 +216,7 @@ Corresponds to `django.db.models.fields.DateField`
|
||||||
|
|
||||||
**Signature:** `DateField(format=None, input_formats=None)`
|
**Signature:** `DateField(format=None, input_formats=None)`
|
||||||
|
|
||||||
* `format` - A string representing the output format. If not specified, the `DATE_FORMAT` setting will be used, which defaults to `'iso-8601'`.
|
* `format` - A string representing the output format. If not specified, this defaults to `None`, which indicates that python `date` objects should be returned by `to_native`. In this case the date encoding will be determined by the renderer.
|
||||||
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATE_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
|
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATE_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
|
||||||
|
|
||||||
Date format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style dates should be used. (eg `'2013-01-29'`)
|
Date format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style dates should be used. (eg `'2013-01-29'`)
|
||||||
|
@ -227,7 +231,7 @@ Corresponds to `django.db.models.fields.TimeField`
|
||||||
|
|
||||||
**Signature:** `TimeField(format=None, input_formats=None)`
|
**Signature:** `TimeField(format=None, input_formats=None)`
|
||||||
|
|
||||||
* `format` - A string representing the output format. If not specified, the `TIME_FORMAT` setting will be used, which defaults to `'iso-8601'`.
|
* `format` - A string representing the output format. If not specified, this defaults to `None`, which indicates that python `time` objects should be returned by `to_native`. In this case the time encoding will be determined by the renderer.
|
||||||
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `TIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
|
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `TIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
|
||||||
|
|
||||||
Time format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style times should be used. (eg `'12:34:56.000000'`)
|
Time format strings may either be [python strftime formats][strftime] which explicitly specifiy the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style times should be used. (eg `'12:34:56.000000'`)
|
||||||
|
@ -273,7 +277,51 @@ Django's regular [FILE_UPLOAD_HANDLERS] are used for handling uploaded files.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
# Custom fields
|
||||||
|
|
||||||
|
If you want to create a custom field, you'll probably want to override either one or both of the `.to_native()` and `.from_native()` methods. These two methods are used to convert between the intial datatype, and a primative, serializable datatype. Primative datatypes may be any of a number, string, date/time/datetime or None. They may also be any list or dictionary like object that only contains other primative objects.
|
||||||
|
|
||||||
|
The `.to_native()` method is called to convert the initial datatype into a primative, serializable datatype. The `from_native()` method is called to restore a primative datatype into it's initial representation.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
Let's look at an example of serializing a class that represents an RGB color value:
|
||||||
|
|
||||||
|
class Color(object):
|
||||||
|
"""
|
||||||
|
A color represented in the RGB colorspace.
|
||||||
|
"""
|
||||||
|
def __init__(self, red, green, blue):
|
||||||
|
assert(red >= 0 and green >= 0 and blue >= 0)
|
||||||
|
assert(red < 256 and green < 256 and blue < 256)
|
||||||
|
self.red, self.green, self.blue = red, green, blue
|
||||||
|
|
||||||
|
class ColourField(serializers.WritableField):
|
||||||
|
"""
|
||||||
|
Color objects are serialized into "rgb(#, #, #)" notation.
|
||||||
|
"""
|
||||||
|
def to_native(self, obj):
|
||||||
|
return "rgb(%d, %d, %d)" % (obj.red, obj.green, obj.blue)
|
||||||
|
|
||||||
|
def from_native(self, data):
|
||||||
|
data = data.strip('rgb(').rstrip(')')
|
||||||
|
red, green, blue = [int(col) for col in data.split(',')]
|
||||||
|
return Color(red, green, blue)
|
||||||
|
|
||||||
|
|
||||||
|
By default field values are treated as mapping to an attribute on the object. If you need to customize how the field value is accessed and set you need to override `.field_to_native()` and/or `.field_from_native()`.
|
||||||
|
|
||||||
|
As an example, let's create a field that can be used represent the class name of the object being serialized:
|
||||||
|
|
||||||
|
class ClassNameField(serializers.Field):
|
||||||
|
def field_to_native(self, obj, field_name):
|
||||||
|
"""
|
||||||
|
Serialize the object's class name.
|
||||||
|
"""
|
||||||
|
return obj.__class__
|
||||||
|
|
||||||
[cite]: https://docs.djangoproject.com/en/dev/ref/forms/api/#django.forms.Form.cleaned_data
|
[cite]: https://docs.djangoproject.com/en/dev/ref/forms/api/#django.forms.Form.cleaned_data
|
||||||
[FILE_UPLOAD_HANDLERS]: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-FILE_UPLOAD_HANDLERS
|
[FILE_UPLOAD_HANDLERS]: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-FILE_UPLOAD_HANDLERS
|
||||||
|
[ecma262]: http://ecma-international.org/ecma-262/5.1/#sec-15.9.1.15
|
||||||
[strftime]: http://docs.python.org/2/library/datetime.html#strftime-and-strptime-behavior
|
[strftime]: http://docs.python.org/2/library/datetime.html#strftime-and-strptime-behavior
|
||||||
[iso8601]: http://www.w3.org/TR/NOTE-datetime
|
[iso8601]: http://www.w3.org/TR/NOTE-datetime
|
||||||
|
|
|
@ -37,9 +37,6 @@ Declaring a serializer looks very similar to declaring a form:
|
||||||
"""
|
"""
|
||||||
Given a dictionary of deserialized field values, either update
|
Given a dictionary of deserialized field values, either update
|
||||||
an existing model instance, or create a new model instance.
|
an existing model instance, or create a new model instance.
|
||||||
|
|
||||||
Note that if we don't define this method, then deserializing
|
|
||||||
data will simply return a dictionary of items.
|
|
||||||
"""
|
"""
|
||||||
if instance is not None:
|
if instance is not None:
|
||||||
instance.title = attrs.get('title', instance.title)
|
instance.title = attrs.get('title', instance.title)
|
||||||
|
@ -48,7 +45,9 @@ Declaring a serializer looks very similar to declaring a form:
|
||||||
return instance
|
return instance
|
||||||
return Comment(**attrs)
|
return Comment(**attrs)
|
||||||
|
|
||||||
The first part of serializer class defines the fields that get serialized/deserialized. The `restore_object` method defines how fully fledged instances get created when deserializing data. The `restore_object` method is optional, and is only required if we want our serializer to support deserialization.
|
The first part of serializer class defines the fields that get serialized/deserialized. The `restore_object` method defines how fully fledged instances get created when deserializing data.
|
||||||
|
|
||||||
|
The `restore_object` method is optional, and is only required if we want our serializer to support deserialization into fully fledged object instances. If we don't define this method, then deserializing data will simply return a dictionary of items.
|
||||||
|
|
||||||
## Serializing objects
|
## Serializing objects
|
||||||
|
|
||||||
|
@ -88,23 +87,21 @@ By default, serializers must be passed values for all required fields or they wi
|
||||||
|
|
||||||
serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True) # Update `instance` with partial data
|
serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True) # Update `instance` with partial data
|
||||||
|
|
||||||
## Serializing querysets
|
|
||||||
|
|
||||||
To serialize a queryset instead of an object instance, you should pass the `many=True` flag when instantiating the serializer.
|
|
||||||
|
|
||||||
queryset = Comment.objects.all()
|
|
||||||
serializer = CommentSerializer(queryset, many=True)
|
|
||||||
serializer.data
|
|
||||||
# [{'email': u'leila@example.com', 'content': u'foo bar', 'created': datetime.datetime(2012, 8, 22, 16, 20, 9, 822774)}, {'email': u'jamie@example.com', 'content': u'baz', 'created': datetime.datetime(2013, 1, 12, 16, 12, 45, 104445)}]
|
|
||||||
|
|
||||||
## Validation
|
## Validation
|
||||||
|
|
||||||
When deserializing data, you always need to call `is_valid()` before attempting to access the deserialized object. If any validation errors occur, the `.errors` property will contain a dictionary representing the resulting error messages.
|
When deserializing data, you always need to call `is_valid()` before attempting to access the deserialized object. If any validation errors occur, the `.errors` property will contain a dictionary representing the resulting error messages. For example:
|
||||||
|
|
||||||
|
serializer = CommentSerializer(data={'email': 'foobar', 'content': 'baz'})
|
||||||
|
serializer.is_valid()
|
||||||
|
# False
|
||||||
|
serializer.errors
|
||||||
|
# {'email': [u'Enter a valid e-mail address.'], 'created': [u'This field is required.']}
|
||||||
|
|
||||||
Each key in the dictionary will be the field name, and the values will be lists of strings of any error messages corresponding to that field. The `non_field_errors` key may also be present, and will list any general validation errors.
|
Each key in the dictionary will be the field name, and the values will be lists of strings of any error messages corresponding to that field. The `non_field_errors` key may also be present, and will list any general validation errors.
|
||||||
|
|
||||||
When deserializing a list of items, errors will be returned as a list of dictionaries representing each of the deserialized items.
|
When deserializing a list of items, errors will be returned as a list of dictionaries representing each of the deserialized items.
|
||||||
|
|
||||||
### Field-level validation
|
#### Field-level validation
|
||||||
|
|
||||||
You can specify custom field-level validation by adding `.validate_<fieldname>` methods to your `Serializer` subclass. These are analagous to `.clean_<fieldname>` methods on Django forms, but accept slightly different arguments.
|
You can specify custom field-level validation by adding `.validate_<fieldname>` methods to your `Serializer` subclass. These are analagous to `.clean_<fieldname>` methods on Django forms, but accept slightly different arguments.
|
||||||
|
|
||||||
|
@ -127,7 +124,7 @@ Your `validate_<fieldname>` methods should either just return the `attrs` dictio
|
||||||
raise serializers.ValidationError("Blog post is not about Django")
|
raise serializers.ValidationError("Blog post is not about Django")
|
||||||
return attrs
|
return attrs
|
||||||
|
|
||||||
### Object-level validation
|
#### 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 the `attrs` dictionary. It should raise a `ValidationError` if necessary, or just return `attrs`. For example:
|
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 the `attrs` dictionary. It should raise a `ValidationError` if necessary, or just return `attrs`. For example:
|
||||||
|
|
||||||
|
@ -148,26 +145,44 @@ To do any other validation that requires access to multiple fields, add a method
|
||||||
|
|
||||||
## Saving object state
|
## Saving object state
|
||||||
|
|
||||||
Serializers also include a `.save()` method that you can override if you want to provide a method of persisting the state of a deserialized object. The default behavior of the method is to simply call `.save()` on the deserialized object instance.
|
To save the deserialized objects created by a serializer, call the `.save()` method:
|
||||||
|
|
||||||
|
if serializer.is_valid():
|
||||||
|
serializer.save()
|
||||||
|
|
||||||
|
The default behavior of the method is to simply call `.save()` on the deserialized object instance. You can override the default save behaviour by overriding the `.save_object(obj)` method on the serializer class.
|
||||||
|
|
||||||
The generic views provided by REST framework call the `.save()` method when updating or creating entities.
|
The generic views provided by REST framework call the `.save()` method when updating or creating entities.
|
||||||
|
|
||||||
## Dealing with nested objects
|
## Dealing with nested objects
|
||||||
|
|
||||||
The previous example is fine for dealing with objects that only have simple datatypes, but sometimes we also need to be able to represent more complex objects,
|
The previous examples are fine for dealing with objects that only have simple datatypes, but sometimes we also need to be able to represent more complex objects, where some of the attributes of an object might not be simple datatypes such as strings, dates or integers.
|
||||||
where some of the attributes of an object might not be simple datatypes such as strings, dates or integers.
|
|
||||||
|
|
||||||
The `Serializer` class is itself a type of `Field`, and can be used to represent relationships where one object type is nested inside another.
|
The `Serializer` class is itself a type of `Field`, and can be used to represent relationships where one object type is nested inside another.
|
||||||
|
|
||||||
class UserSerializer(serializers.Serializer):
|
class UserSerializer(serializers.Serializer):
|
||||||
email = serializers.Field()
|
email = serializers.EmailField()
|
||||||
username = serializers.Field()
|
username = serializers.CharField(max_length=100)
|
||||||
|
|
||||||
class CommentSerializer(serializers.Serializer):
|
class CommentSerializer(serializers.Serializer):
|
||||||
user = UserSerializer()
|
user = UserSerializer()
|
||||||
title = serializers.Field()
|
content = serializers.CharField(max_length=200)
|
||||||
content = serializers.Field()
|
created = serializers.DateTimeField()
|
||||||
created = serializers.Field()
|
|
||||||
|
If a nested representation may optionally accept the `None` value you should pass the `required=False` flag to the nested serializer.
|
||||||
|
|
||||||
|
class CommentSerializer(serializers.Serializer):
|
||||||
|
user = UserSerializer(required=False) # May be an anonymous user.
|
||||||
|
content = serializers.CharField(max_length=200)
|
||||||
|
created = serializers.DateTimeField()
|
||||||
|
|
||||||
|
Similarly if a nested representation should be a list of items, you should the `many=True` flag to the nested serialized.
|
||||||
|
|
||||||
|
class CommentSerializer(serializers.Serializer):
|
||||||
|
user = UserSerializer(required=False)
|
||||||
|
edits = EditItemSerializer(many=True) # A nested list of 'edit' items.
|
||||||
|
content = serializers.CharField(max_length=200)
|
||||||
|
created = serializers.DateTimeField()
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -175,6 +190,96 @@ The `Serializer` class is itself a type of `Field`, and can be used to represent
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Dealing with multiple objects
|
||||||
|
|
||||||
|
The `Serializer` class can also handle serializing or deserializing lists of objects.
|
||||||
|
|
||||||
|
#### Serializing multiple objects
|
||||||
|
|
||||||
|
To serialize a queryset or list of objects instead of a single object instance, you should pass the `many=True` flag when instantiating the serializer. You can then pass a queryset or list of objects to be serialized.
|
||||||
|
|
||||||
|
queryset = Book.objects.all()
|
||||||
|
serializer = BookSerializer(queryset, many=True)
|
||||||
|
serializer.data
|
||||||
|
# [
|
||||||
|
# {'id': 0, 'title': 'The electric kool-aid acid test', 'author': 'Tom Wolfe'},
|
||||||
|
# {'id': 1, 'title': 'If this is a man', 'author': 'Primo Levi'},
|
||||||
|
# {'id': 2, 'title': 'The wind-up bird chronicle', 'author': 'Haruki Murakami'}
|
||||||
|
# ]
|
||||||
|
|
||||||
|
#### Deserializing multiple objects for creation
|
||||||
|
|
||||||
|
To deserialize a list of object data, and create multiple object instances in a single pass, you should also set the `many=True` flag, and pass a list of data to be deserialized.
|
||||||
|
|
||||||
|
This allows you to write views that create multiple items when a `POST` request is made.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
data = [
|
||||||
|
{'title': 'The bell jar', 'author': 'Sylvia Plath'},
|
||||||
|
{'title': 'For whom the bell tolls', 'author': 'Ernest Hemingway'}
|
||||||
|
]
|
||||||
|
serializer = BookSerializer(data=data, many=True)
|
||||||
|
serializer.is_valid()
|
||||||
|
# True
|
||||||
|
serializer.save() # `.save()` will be called on each deserialized instance
|
||||||
|
|
||||||
|
#### Deserializing multiple objects for update
|
||||||
|
|
||||||
|
You can also deserialize a list of objects as part of a bulk update of multiple existing items.
|
||||||
|
In this case you need to supply both an existing list or queryset of items, as well as a list of data to update those items with.
|
||||||
|
|
||||||
|
This allows you to write views that update or create multiple items when a `PUT` request is made.
|
||||||
|
|
||||||
|
# Capitalizing the titles of the books
|
||||||
|
queryset = Book.objects.all()
|
||||||
|
data = [
|
||||||
|
{'id': 3, 'title': 'The Bell Jar', 'author': 'Sylvia Plath'},
|
||||||
|
{'id': 4, 'title': 'For Whom the Bell Tolls', 'author': 'Ernest Hemingway'}
|
||||||
|
]
|
||||||
|
serializer = BookSerializer(queryset, data=data, many=True)
|
||||||
|
serializer.is_valid()
|
||||||
|
# True
|
||||||
|
serialize.save() # `.save()` will be called on each updated or newly created instance.
|
||||||
|
|
||||||
|
By default bulk updates will be limited to updating instances that already exist in the provided queryset.
|
||||||
|
|
||||||
|
When performing a bulk update you may want to allow new items to be created, and missing items to be deleted. To do so, pass `allow_add_remove=True` to the serializer.
|
||||||
|
|
||||||
|
serializer = BookSerializer(queryset, data=data, many=True, allow_add_remove=True)
|
||||||
|
serializer.is_valid()
|
||||||
|
# True
|
||||||
|
serializer.save() # `.save()` will be called on updated or newly created instances.
|
||||||
|
# `.delete()` will be called on any other items in the `queryset`.
|
||||||
|
|
||||||
|
Passing `allow_add_remove=True` ensures that any update operations will completely overwrite the existing queryset, rather than simply updating existing objects.
|
||||||
|
|
||||||
|
#### How identity is determined when performing bulk updates
|
||||||
|
|
||||||
|
Performing a bulk update is slightly more complicated than performing a bulk creation, because the serializer needs a way to determine how the items in the incoming data should be matched against the existing object instances.
|
||||||
|
|
||||||
|
By default the serializer class will use the `id` key on the incoming data to determine the canonical identity of an object. If you need to change this behavior you should override the `get_identity` method on the `Serializer` class. For example:
|
||||||
|
|
||||||
|
class AccountSerializer(serializers.Serializer):
|
||||||
|
slug = serializers.CharField(max_length=100)
|
||||||
|
created = serializers.DateTimeField()
|
||||||
|
... # Various other fields
|
||||||
|
|
||||||
|
def get_identity(self, data):
|
||||||
|
"""
|
||||||
|
This hook is required for bulk update.
|
||||||
|
We need to override the default, to use the slug as the identity.
|
||||||
|
|
||||||
|
Note that the data has not yet been validated at this point,
|
||||||
|
so we need to deal gracefully with incorrect datatypes.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return data.get('slug', None)
|
||||||
|
except AttributeError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
To map the incoming data items to their corresponding object instances, the `.get_identity()` method will be called both against the incoming data, and against the serialized representation of the existing objects.
|
||||||
|
|
||||||
## Including extra context
|
## Including extra context
|
||||||
|
|
||||||
There are some cases where you need to provide extra context to the serializer in addition to the object being serialized. One common case is if you're using a serializer that includes hyperlinked relations, which requires the serializer to have access to the current request so that it can properly generate fully qualified URLs.
|
There are some cases where you need to provide extra context to the serializer in addition to the object being serialized. One common case is if you're using a serializer that includes hyperlinked relations, which requires the serializer to have access to the current request so that it can properly generate fully qualified URLs.
|
||||||
|
@ -187,47 +292,6 @@ You can provide arbitrary additional context by passing a `context` argument whe
|
||||||
|
|
||||||
The context dictionary can be used within any serializer field logic, such as a custom `.to_native()` method, by accessing the `self.context` attribute.
|
The context dictionary can be used within any serializer field logic, such as a custom `.to_native()` method, by accessing the `self.context` attribute.
|
||||||
|
|
||||||
## Creating custom fields
|
|
||||||
|
|
||||||
If you want to create a custom field, you'll probably want to override either one or both of the `.to_native()` and `.from_native()` methods. These two methods are used to convert between the intial datatype, and a primative, serializable datatype. Primative datatypes may be any of a number, string, date/time/datetime or None. They may also be any list or dictionary like object that only contains other primative objects.
|
|
||||||
|
|
||||||
The `.to_native()` method is called to convert the initial datatype into a primative, serializable datatype. The `from_native()` method is called to restore a primative datatype into it's initial representation.
|
|
||||||
|
|
||||||
Let's look at an example of serializing a class that represents an RGB color value:
|
|
||||||
|
|
||||||
class Color(object):
|
|
||||||
"""
|
|
||||||
A color represented in the RGB colorspace.
|
|
||||||
"""
|
|
||||||
def __init__(self, red, green, blue):
|
|
||||||
assert(red >= 0 and green >= 0 and blue >= 0)
|
|
||||||
assert(red < 256 and green < 256 and blue < 256)
|
|
||||||
self.red, self.green, self.blue = red, green, blue
|
|
||||||
|
|
||||||
class ColourField(serializers.WritableField):
|
|
||||||
"""
|
|
||||||
Color objects are serialized into "rgb(#, #, #)" notation.
|
|
||||||
"""
|
|
||||||
def to_native(self, obj):
|
|
||||||
return "rgb(%d, %d, %d)" % (obj.red, obj.green, obj.blue)
|
|
||||||
|
|
||||||
def from_native(self, data):
|
|
||||||
data = data.strip('rgb(').rstrip(')')
|
|
||||||
red, green, blue = [int(col) for col in data.split(',')]
|
|
||||||
return Color(red, green, blue)
|
|
||||||
|
|
||||||
|
|
||||||
By default field values are treated as mapping to an attribute on the object. If you need to customize how the field value is accessed and set you need to override `.field_to_native()` and/or `.field_from_native()`.
|
|
||||||
|
|
||||||
As an example, let's create a field that can be used represent the class name of the object being serialized:
|
|
||||||
|
|
||||||
class ClassNameField(serializers.Field):
|
|
||||||
def field_to_native(self, obj, field_name):
|
|
||||||
"""
|
|
||||||
Serialize the object's class name.
|
|
||||||
"""
|
|
||||||
return obj.__class__
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# ModelSerializers
|
# ModelSerializers
|
||||||
|
|
|
@ -192,44 +192,56 @@ Default: `'format'`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Date/Time formatting
|
## Date and time formatting
|
||||||
|
|
||||||
*The following settings are used to control how date and time representations may be parsed and rendered.*
|
*The following settings are used to control how date and time representations may be parsed and rendered.*
|
||||||
|
|
||||||
#### DATETIME_FORMAT
|
#### DATETIME_FORMAT
|
||||||
|
|
||||||
A format string that should be used by default for rendering the output of `DateTimeField` serializer fields.
|
A format string that should be used by default for rendering the output of `DateTimeField` serializer fields. If `None`, then `DateTimeField` serializer fields will return python `datetime` objects, and the datetime encoding will be determined by the renderer.
|
||||||
|
|
||||||
Default: `'iso-8601'`
|
May be any of `None`, `'iso-8601'` or a python [strftime format][strftime] string.
|
||||||
|
|
||||||
|
Default: `None'`
|
||||||
|
|
||||||
#### DATETIME_INPUT_FORMATS
|
#### DATETIME_INPUT_FORMATS
|
||||||
|
|
||||||
A list of format strings that should be used by default for parsing inputs to `DateTimeField` serializer fields.
|
A list of format strings that should be used by default for parsing inputs to `DateTimeField` serializer fields.
|
||||||
|
|
||||||
|
May be a list including the string `'iso-8601'` or python [strftime format][strftime] strings.
|
||||||
|
|
||||||
Default: `['iso-8601']`
|
Default: `['iso-8601']`
|
||||||
|
|
||||||
#### DATE_FORMAT
|
#### DATE_FORMAT
|
||||||
|
|
||||||
A format string that should be used by default for rendering the output of `DateField` serializer fields.
|
A format string that should be used by default for rendering the output of `DateField` serializer fields. If `None`, then `DateField` serializer fields will return python `date` objects, and the date encoding will be determined by the renderer.
|
||||||
|
|
||||||
Default: `'iso-8601'`
|
May be any of `None`, `'iso-8601'` or a python [strftime format][strftime] string.
|
||||||
|
|
||||||
|
Default: `None`
|
||||||
|
|
||||||
#### DATE_INPUT_FORMATS
|
#### DATE_INPUT_FORMATS
|
||||||
|
|
||||||
A list of format strings that should be used by default for parsing inputs to `DateField` serializer fields.
|
A list of format strings that should be used by default for parsing inputs to `DateField` serializer fields.
|
||||||
|
|
||||||
|
May be a list including the string `'iso-8601'` or python [strftime format][strftime] strings.
|
||||||
|
|
||||||
Default: `['iso-8601']`
|
Default: `['iso-8601']`
|
||||||
|
|
||||||
#### TIME_FORMAT
|
#### TIME_FORMAT
|
||||||
|
|
||||||
A format string that should be used by default for rendering the output of `TimeField` serializer fields.
|
A format string that should be used by default for rendering the output of `TimeField` serializer fields. If `None`, then `TimeField` serializer fields will return python `time` objects, and the time encoding will be determined by the renderer.
|
||||||
|
|
||||||
Default: `'iso-8601'`
|
May be any of `None`, `'iso-8601'` or a python [strftime format][strftime] string.
|
||||||
|
|
||||||
|
Default: `None`
|
||||||
|
|
||||||
#### TIME_INPUT_FORMATS
|
#### TIME_INPUT_FORMATS
|
||||||
|
|
||||||
A list of format strings that should be used by default for parsing inputs to `TimeField` serializer fields.
|
A list of format strings that should be used by default for parsing inputs to `TimeField` serializer fields.
|
||||||
|
|
||||||
|
May be a list including the string `'iso-8601'` or python [strftime format][strftime] strings.
|
||||||
|
|
||||||
Default: `['iso-8601']`
|
Default: `['iso-8601']`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -243,3 +255,4 @@ The name of a parameter in the URL conf that may be used to provide a format suf
|
||||||
Default: `'format'`
|
Default: `'format'`
|
||||||
|
|
||||||
[cite]: http://www.python.org/dev/peps/pep-0020/
|
[cite]: http://www.python.org/dev/peps/pep-0020/
|
||||||
|
[strftime]: http://docs.python.org/2/library/time.html#time.strftime
|
|
@ -277,3 +277,14 @@ footer a {
|
||||||
footer a:hover {
|
footer a:hover {
|
||||||
color: gray;
|
color: gray;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.btn-inverse {
|
||||||
|
background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#606060), to(#404040)) !important;
|
||||||
|
background-image: -webkit-linear-gradient(top, #606060, #404040) !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.modal-open .modal,.btn:focus{outline:none;}
|
||||||
|
|
||||||
|
@media (max-width: 650px) {
|
||||||
|
.repo-link.btn-inverse {display: none;}
|
||||||
|
}
|
||||||
|
|
|
@ -9,9 +9,9 @@
|
||||||
|
|
||||||
# Django REST framework
|
# Django REST framework
|
||||||
|
|
||||||
**Web APIs for Django, made easy.**
|
**Awesome web-browseable Web APIs.**
|
||||||
|
|
||||||
Django REST framework is a flexible, powerful library that makes it incredibly easy to build Web APIs. It is designed as a modular and easy to customize architecture, based on Django's class based views.
|
Django REST framework is a flexible, powerful Web API toolkit. It is designed as a modular and easy to customize architecture, based on Django's class based views.
|
||||||
|
|
||||||
APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box.
|
APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box.
|
||||||
|
|
||||||
|
|
|
@ -41,6 +41,9 @@
|
||||||
<div class="navbar-inner">
|
<div class="navbar-inner">
|
||||||
<div class="container-fluid">
|
<div class="container-fluid">
|
||||||
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
|
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
|
||||||
|
<a class="repo-link btn btn-inverse btn-small {{ next_url_disabled }}" href="{{ next_url }}">Next <i class="icon-arrow-right icon-white"></i></a>
|
||||||
|
<a class="repo-link btn btn-inverse btn-small {{ prev_url_disabled }}" href="{{ prev_url }}"><i class="icon-arrow-left icon-white"></i> Previous</a>
|
||||||
|
<a class="repo-link btn btn-inverse btn-small" href="#searchModal" data-toggle="modal"><i class="icon-search icon-white"></i> Search</a>
|
||||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
||||||
<span class="icon-bar"></span>
|
<span class="icon-bar"></span>
|
||||||
<span class="icon-bar"></span>
|
<span class="icon-bar"></span>
|
||||||
|
@ -118,6 +121,34 @@
|
||||||
|
|
||||||
<div class="body-content">
|
<div class="body-content">
|
||||||
<div class="container-fluid">
|
<div class="container-fluid">
|
||||||
|
|
||||||
|
<!-- Search Modal -->
|
||||||
|
<div id="searchModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-header">
|
||||||
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
||||||
|
<h3 id="myModalLabel">Documentation search</h3>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<!-- Custom google search -->
|
||||||
|
<script>
|
||||||
|
(function() {
|
||||||
|
var cx = '015016005043623903336:rxraeohqk6w';
|
||||||
|
var gcse = document.createElement('script');
|
||||||
|
gcse.type = 'text/javascript';
|
||||||
|
gcse.async = true;
|
||||||
|
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
|
||||||
|
'//www.google.com/cse/cse.js?cx=' + cx;
|
||||||
|
var s = document.getElementsByTagName('script')[0];
|
||||||
|
s.parentNode.insertBefore(gcse, s);
|
||||||
|
})();
|
||||||
|
</script>
|
||||||
|
<gcse:search></gcse:search>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
<button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
<div class="row-fluid">
|
<div class="row-fluid">
|
||||||
|
|
||||||
<div class="span3">
|
<div class="span3">
|
||||||
|
|
|
@ -4,12 +4,138 @@
|
||||||
>
|
>
|
||||||
> — [Tim Berners-Lee][cite]
|
> — [Tim Berners-Lee][cite]
|
||||||
|
|
||||||
## Running the tests
|
There are many ways you can contribute to Django REST framework. We'd like it to be a community-led project, so please get involved and help shape the future of the project.
|
||||||
|
|
||||||
## Building the docs
|
# Community
|
||||||
|
|
||||||
## Managing compatibility issues
|
If you use and enjoy REST framework please consider [staring the project on GitHub][github], and [upvoting it on Django packages][django-packages]. Doing so helps potential new users see that the project is well used, and help us continue to attract new users.
|
||||||
|
|
||||||
**Describe compat module**
|
You might also consider writing a blog post on your experience with using REST framework, writing a tutorial about using the project with a particular javascript framework, or simply sharing the love on Twitter.
|
||||||
|
|
||||||
[cite]: http://www.w3.org/People/Berners-Lee/FAQ.html
|
Other really great ways you can help move the community forward include helping answer questions on the [discussion group][google-group], or setting up an [email alert on StackOverflow][so-filter] so that you get notified of any new questions with the `django-rest-framework` tag.
|
||||||
|
|
||||||
|
When answering questions make sure to help future contributors find their way around by hyperlinking wherever possible to related threads and tickets, and include backlinks from those items if relevant.
|
||||||
|
|
||||||
|
# Issues
|
||||||
|
|
||||||
|
It's really helpful if you make sure you address issues to the correct channel. Usage questions should be directed to the [discussion group][google-group]. Feature requests, bug reports and other issues should be raised on the GitHub [issue tracker][issues].
|
||||||
|
|
||||||
|
Some tips on good issue reporting:
|
||||||
|
|
||||||
|
* When decribing issues try to phrase your ticket in terms of the *behavior* you think needs changing rather than the *code* you think need changing.
|
||||||
|
* Search the issue list first for related items, and make sure you're running the latest version of REST framework before reporting an issue.
|
||||||
|
* If reporting a bug, then try to include a pull request with a failing test case. This'll help us quickly identify if there is a valid issue, and make sure that it gets fixed more quickly if there is one.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* TODO: Triage
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
* git clone & PYTHONPATH
|
||||||
|
* Pep8
|
||||||
|
* Recommend editor that runs pep8
|
||||||
|
|
||||||
|
### Pull requests
|
||||||
|
|
||||||
|
* Make pull requests early
|
||||||
|
* Describe branching
|
||||||
|
|
||||||
|
### Managing compatibility issues
|
||||||
|
|
||||||
|
* Describe compat module
|
||||||
|
|
||||||
|
# Testing
|
||||||
|
|
||||||
|
* Running the tests
|
||||||
|
* tox
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
|
||||||
|
The documentation for REST framework is built from the [Markdown][markdown] source files in [the docs directory][docs].
|
||||||
|
|
||||||
|
There are many great markdown editors that make working with the documentation really easy. The [Mou editor for Mac][mou] is one such editor that comes highly recommended.
|
||||||
|
|
||||||
|
## Building the documentation
|
||||||
|
|
||||||
|
To build the documentation, simply run the `mkdocs.py` script.
|
||||||
|
|
||||||
|
./mkdocs.py
|
||||||
|
|
||||||
|
This will build the html output into the `html` directory.
|
||||||
|
|
||||||
|
You can build the documentation and open a preview in a browser window by using the `-p` flag.
|
||||||
|
|
||||||
|
./mkdocs.py -p
|
||||||
|
|
||||||
|
## Language style
|
||||||
|
|
||||||
|
Documentation should be in American English. The tone of the documentation is very important - try to stick to a simple, plain, objective and well-balanced style where possible.
|
||||||
|
|
||||||
|
Some other tips:
|
||||||
|
|
||||||
|
* Keep paragraphs reasonably short.
|
||||||
|
* Use double spacing after the end of sentences.
|
||||||
|
* Don't use the abbreviations such as 'e.g..' but instead use long form, such as 'For example'.
|
||||||
|
|
||||||
|
## Markdown style
|
||||||
|
|
||||||
|
There are a couple of conventions you should follow when working on the documentation.
|
||||||
|
|
||||||
|
##### 1. Headers
|
||||||
|
|
||||||
|
Headers should use the hash style. For example:
|
||||||
|
|
||||||
|
### Some important topic
|
||||||
|
|
||||||
|
The underline style should not be used. **Don't do this:**
|
||||||
|
|
||||||
|
Some important topic
|
||||||
|
====================
|
||||||
|
|
||||||
|
##### 2. Links
|
||||||
|
|
||||||
|
Links should always use the reference style, with the referenced hyperlinks kept at the end of the document.
|
||||||
|
|
||||||
|
Here is a link to [some other thing][other-thing].
|
||||||
|
|
||||||
|
More text...
|
||||||
|
|
||||||
|
[other-thing]: http://example.com/other/thing
|
||||||
|
|
||||||
|
This style helps keep the documentation source consistent and readable.
|
||||||
|
|
||||||
|
If you are hyperlinking to another REST framework document, you should use a relative link, and link to the `.md` suffix. For example:
|
||||||
|
|
||||||
|
[authentication]: ../api-guide/authentication.md
|
||||||
|
|
||||||
|
Linking in this style means you'll be able to click the hyperlink in your markdown editor to open the referenced document. When the documentation is built, these links will be converted into regular links to HTML pages.
|
||||||
|
|
||||||
|
##### 3. Notes
|
||||||
|
|
||||||
|
If you want to draw attention to a note or warning, use a pair of enclosing lines, like so:
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Note:** Make sure you do this thing.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Third party packages
|
||||||
|
|
||||||
|
* Django reusable app
|
||||||
|
|
||||||
|
# Core committers
|
||||||
|
|
||||||
|
* Still use pull reqs
|
||||||
|
* Credits
|
||||||
|
|
||||||
|
[cite]: http://www.w3.org/People/Berners-Lee/FAQ.html
|
||||||
|
[github]: https://github.com/tomchristie/django-rest-framework
|
||||||
|
[django-packages]: https://www.djangopackages.com/grids/g/api/
|
||||||
|
[google-group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
|
||||||
|
[so-filter]: http://stackexchange.com/filters/66475/rest-framework
|
||||||
|
[issues]: https://github.com/tomchristie/django-rest-framework/issues?state=open
|
||||||
|
[markdown]: http://daringfireball.net/projects/markdown/basics
|
||||||
|
[docs]: https://github.com/tomchristie/django-rest-framework/tree/master/docs
|
||||||
|
[mou]: http://mouapp.com/
|
||||||
|
|
|
@ -112,6 +112,7 @@ The following people have helped make REST framework great.
|
||||||
* Bouke Haarsma - [bouke]
|
* Bouke Haarsma - [bouke]
|
||||||
* Pierre Dulac - [dulaccc]
|
* Pierre Dulac - [dulaccc]
|
||||||
* Dave Kuhn - [kuhnza]
|
* Dave Kuhn - [kuhnza]
|
||||||
|
* Sitong Peng - [stoneg]
|
||||||
|
|
||||||
Many thanks to everyone who's contributed to the project.
|
Many thanks to everyone who's contributed to the project.
|
||||||
|
|
||||||
|
@ -258,3 +259,4 @@ You can also contact [@_tomchristie][twitter] directly on twitter.
|
||||||
[bouke]: https://github.com/bouke
|
[bouke]: https://github.com/bouke
|
||||||
[dulaccc]: https://github.com/dulaccc
|
[dulaccc]: https://github.com/dulaccc
|
||||||
[kuhnza]: https://github.com/kuhnza
|
[kuhnza]: https://github.com/kuhnza
|
||||||
|
[stoneg]: https://github.com/stoneg
|
||||||
|
|
|
@ -42,6 +42,17 @@ You can determine your currently installed version using `pip freeze`:
|
||||||
|
|
||||||
### Master
|
### Master
|
||||||
|
|
||||||
|
* OAuth2 authentication no longer requires unneccessary URL parameters in addition to the token.
|
||||||
|
* URL hyperlinking in browseable API now handles more cases correctly.
|
||||||
|
* Bugfix: Fix regression with DjangoFilterBackend not worthing correctly with single object views.
|
||||||
|
|
||||||
|
### 2.2.5
|
||||||
|
|
||||||
|
**Date**: 26th March 2013
|
||||||
|
|
||||||
|
* Serializer support for bulk create and bulk update operations.
|
||||||
|
* Regression fix: Date and time fields return date/time objects by default. Fixes regressions caused by 2.2.2. See [#743][743] for more details.
|
||||||
|
* Bugfix: Fix 500 error is OAuth not attempted with OAuthAuthentication class installed.
|
||||||
* `Serializer.save()` now supports arbitrary keyword args which are passed through to the object `.save()` method. Mixins use `force_insert` and `force_update` where appropriate, resulting in one less database query.
|
* `Serializer.save()` now supports arbitrary keyword args which are passed through to the object `.save()` method. Mixins use `force_insert` and `force_update` where appropriate, resulting in one less database query.
|
||||||
|
|
||||||
### 2.2.4
|
### 2.2.4
|
||||||
|
@ -434,6 +445,7 @@ This change will not affect user code, so long as it's following the recommended
|
||||||
[django-deprecation-policy]: https://docs.djangoproject.com/en/dev/internals/release-process/#internal-release-deprecation-policy
|
[django-deprecation-policy]: https://docs.djangoproject.com/en/dev/internals/release-process/#internal-release-deprecation-policy
|
||||||
[defusedxml-announce]: http://blog.python.org/2013/02/announcing-defusedxml-fixes-for-xml.html
|
[defusedxml-announce]: http://blog.python.org/2013/02/announcing-defusedxml-fixes-for-xml.html
|
||||||
[2.2-announcement]: 2.2-announcement.md
|
[2.2-announcement]: 2.2-announcement.md
|
||||||
|
[743]: https://github.com/tomchristie/django-rest-framework/pull/743
|
||||||
[staticfiles14]: https://docs.djangoproject.com/en/1.4/howto/static-files/#with-a-template-tag
|
[staticfiles14]: https://docs.djangoproject.com/en/1.4/howto/static-files/#with-a-template-tag
|
||||||
[staticfiles13]: https://docs.djangoproject.com/en/1.3/howto/static-files/#with-a-template-tag
|
[staticfiles13]: https://docs.djangoproject.com/en/1.3/howto/static-files/#with-a-template-tag
|
||||||
[2.1.0-notes]: https://groups.google.com/d/topic/django-rest-framework/Vv2M0CMY9bg/discussion
|
[2.1.0-notes]: https://groups.google.com/d/topic/django-rest-framework/Vv2M0CMY9bg/discussion
|
||||||
|
|
|
@ -179,7 +179,7 @@ Now, if you open a browser again, you find that the 'DELETE' and 'PUT' actions o
|
||||||
|
|
||||||
## Authenticating with the API
|
## Authenticating with the API
|
||||||
|
|
||||||
Because we now have a set of permissions on the API, we need to authenticate our requests to it if we want to edit any snippets. We havn't set up any [authentication classes][authentication], so the defaults are currently applied, which are `SessionAuthentication` and `BasicAuthentication`.
|
Because we now have a set of permissions on the API, we need to authenticate our requests to it if we want to edit any snippets. We haven't set up any [authentication classes][authentication], so the defaults are currently applied, which are `SessionAuthentication` and `BasicAuthentication`.
|
||||||
|
|
||||||
When we interact with the API through the web browser, we can login, and the browser session will then provide the required authentication for the requests.
|
When we interact with the API through the web browser, we can login, and the browser session will then provide the required authentication for the requests.
|
||||||
|
|
||||||
|
|
75
mkdocs.py
75
mkdocs.py
|
@ -37,6 +37,60 @@ page = open(os.path.join(docs_dir, 'template.html'), 'r').read()
|
||||||
# shutil.rmtree(target)
|
# shutil.rmtree(target)
|
||||||
# shutil.copytree(source, target)
|
# shutil.copytree(source, target)
|
||||||
|
|
||||||
|
|
||||||
|
# Hacky, but what the hell, it'll do the job
|
||||||
|
path_list = [
|
||||||
|
'index.md',
|
||||||
|
'tutorial/quickstart.md',
|
||||||
|
'tutorial/1-serialization.md',
|
||||||
|
'tutorial/2-requests-and-responses.md',
|
||||||
|
'tutorial/3-class-based-views.md',
|
||||||
|
'tutorial/4-authentication-and-permissions.md',
|
||||||
|
'tutorial/5-relationships-and-hyperlinked-apis.md',
|
||||||
|
'api-guide/requests.md',
|
||||||
|
'api-guide/responses.md',
|
||||||
|
'api-guide/views.md',
|
||||||
|
'api-guide/generic-views.md',
|
||||||
|
'api-guide/parsers.md',
|
||||||
|
'api-guide/renderers.md',
|
||||||
|
'api-guide/serializers.md',
|
||||||
|
'api-guide/fields.md',
|
||||||
|
'api-guide/relations.md',
|
||||||
|
'api-guide/authentication.md',
|
||||||
|
'api-guide/permissions.md',
|
||||||
|
'api-guide/throttling.md',
|
||||||
|
'api-guide/filtering.md',
|
||||||
|
'api-guide/pagination.md',
|
||||||
|
'api-guide/content-negotiation.md',
|
||||||
|
'api-guide/format-suffixes.md',
|
||||||
|
'api-guide/reverse.md',
|
||||||
|
'api-guide/exceptions.md',
|
||||||
|
'api-guide/status-codes.md',
|
||||||
|
'api-guide/settings.md',
|
||||||
|
'topics/ajax-csrf-cors.md',
|
||||||
|
'topics/browser-enhancements.md',
|
||||||
|
'topics/browsable-api.md',
|
||||||
|
'topics/rest-hypermedia-hateoas.md',
|
||||||
|
'topics/contributing.md',
|
||||||
|
'topics/rest-framework-2-announcement.md',
|
||||||
|
'topics/2.2-announcement.md',
|
||||||
|
'topics/release-notes.md',
|
||||||
|
'topics/credits.md',
|
||||||
|
]
|
||||||
|
|
||||||
|
prev_url_map = {}
|
||||||
|
next_url_map = {}
|
||||||
|
for idx in range(len(path_list)):
|
||||||
|
path = path_list[idx]
|
||||||
|
rel = '../' * path.count('/')
|
||||||
|
|
||||||
|
if idx > 0:
|
||||||
|
prev_url_map[path] = rel + path_list[idx - 1][:-3] + suffix
|
||||||
|
|
||||||
|
if idx < len(path_list) - 1:
|
||||||
|
next_url_map[path] = rel + path_list[idx + 1][:-3] + suffix
|
||||||
|
|
||||||
|
|
||||||
for (dirpath, dirnames, filenames) in os.walk(docs_dir):
|
for (dirpath, dirnames, filenames) in os.walk(docs_dir):
|
||||||
relative_dir = dirpath.replace(docs_dir, '').lstrip(os.path.sep)
|
relative_dir = dirpath.replace(docs_dir, '').lstrip(os.path.sep)
|
||||||
build_dir = os.path.join(html_dir, relative_dir)
|
build_dir = os.path.join(html_dir, relative_dir)
|
||||||
|
@ -46,6 +100,7 @@ for (dirpath, dirnames, filenames) in os.walk(docs_dir):
|
||||||
|
|
||||||
for filename in filenames:
|
for filename in filenames:
|
||||||
path = os.path.join(dirpath, filename)
|
path = os.path.join(dirpath, filename)
|
||||||
|
relative_path = os.path.join(relative_dir, filename)
|
||||||
|
|
||||||
if not filename.endswith('.md'):
|
if not filename.endswith('.md'):
|
||||||
if relative_dir:
|
if relative_dir:
|
||||||
|
@ -78,16 +133,34 @@ for (dirpath, dirnames, filenames) in os.walk(docs_dir):
|
||||||
toc += template + '\n'
|
toc += template + '\n'
|
||||||
|
|
||||||
if filename == 'index.md':
|
if filename == 'index.md':
|
||||||
main_title = 'Django REST framework - APIs made easy'
|
main_title = 'Django REST framework - Web Browseable APIs'
|
||||||
else:
|
else:
|
||||||
main_title = 'Django REST framework - ' + main_title
|
main_title = 'Django REST framework - ' + main_title
|
||||||
|
|
||||||
|
prev_url = prev_url_map.get(relative_path)
|
||||||
|
next_url = next_url_map.get(relative_path)
|
||||||
|
|
||||||
content = markdown.markdown(text, ['headerid'])
|
content = markdown.markdown(text, ['headerid'])
|
||||||
|
|
||||||
output = page.replace('{{ content }}', content).replace('{{ toc }}', toc).replace('{{ base_url }}', base_url).replace('{{ suffix }}', suffix).replace('{{ index }}', index)
|
output = page.replace('{{ content }}', content).replace('{{ toc }}', toc).replace('{{ base_url }}', base_url).replace('{{ suffix }}', suffix).replace('{{ index }}', index)
|
||||||
output = output.replace('{{ title }}', main_title)
|
output = output.replace('{{ title }}', main_title)
|
||||||
output = output.replace('{{ description }}', description)
|
output = output.replace('{{ description }}', description)
|
||||||
output = output.replace('{{ page_id }}', filename[:-3])
|
output = output.replace('{{ page_id }}', filename[:-3])
|
||||||
|
|
||||||
|
if prev_url:
|
||||||
|
output = output.replace('{{ prev_url }}', prev_url)
|
||||||
|
output = output.replace('{{ prev_url_disabled }}', '')
|
||||||
|
else:
|
||||||
|
output = output.replace('{{ prev_url }}', '#')
|
||||||
|
output = output.replace('{{ prev_url_disabled }}', 'disabled')
|
||||||
|
|
||||||
|
if next_url:
|
||||||
|
output = output.replace('{{ next_url }}', next_url)
|
||||||
|
output = output.replace('{{ next_url_disabled }}', '')
|
||||||
|
else:
|
||||||
|
output = output.replace('{{ next_url }}', '#')
|
||||||
|
output = output.replace('{{ next_url_disabled }}', 'disabled')
|
||||||
|
|
||||||
output = re.sub(r'a href="([^"]*)\.md"', r'a href="\1%s"' % suffix, output)
|
output = re.sub(r'a href="([^"]*)\.md"', r'a href="\1%s"' % suffix, output)
|
||||||
output = re.sub(r'<pre><code>:::bash', r'<pre class="prettyprint lang-bsh">', output)
|
output = re.sub(r'<pre><code>:::bash', r'<pre class="prettyprint lang-bsh">', output)
|
||||||
output = re.sub(r'<pre>', r'<pre class="prettyprint lang-py">', output)
|
output = re.sub(r'<pre>', r'<pre class="prettyprint lang-py">', output)
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
__version__ = '2.2.4'
|
__version__ = '2.2.5'
|
||||||
|
|
||||||
VERSION = __version__ # synonym
|
VERSION = __version__ # synonym
|
||||||
|
|
||||||
|
|
|
@ -2,14 +2,16 @@
|
||||||
Provides a set of pluggable authentication policies.
|
Provides a set of pluggable authentication policies.
|
||||||
"""
|
"""
|
||||||
from __future__ import unicode_literals
|
from __future__ import unicode_literals
|
||||||
|
import base64
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
from django.contrib.auth import authenticate
|
from django.contrib.auth import authenticate
|
||||||
from django.core.exceptions import ImproperlyConfigured
|
from django.core.exceptions import ImproperlyConfigured
|
||||||
from rest_framework import exceptions, HTTP_HEADER_ENCODING
|
from rest_framework import exceptions, HTTP_HEADER_ENCODING
|
||||||
from rest_framework.compat import CsrfViewMiddleware
|
from rest_framework.compat import CsrfViewMiddleware
|
||||||
from rest_framework.compat import oauth, oauth_provider, oauth_provider_store
|
from rest_framework.compat import oauth, oauth_provider, oauth_provider_store
|
||||||
from rest_framework.compat import oauth2_provider, oauth2_provider_forms, oauth2_provider_backends
|
from rest_framework.compat import oauth2_provider, oauth2_provider_forms
|
||||||
from rest_framework.authtoken.models import Token
|
from rest_framework.authtoken.models import Token
|
||||||
import base64
|
|
||||||
|
|
||||||
|
|
||||||
def get_authorization_header(request):
|
def get_authorization_header(request):
|
||||||
|
@ -204,6 +206,9 @@ class OAuthAuthentication(BaseAuthentication):
|
||||||
except oauth.Error as err:
|
except oauth.Error as err:
|
||||||
raise exceptions.AuthenticationFailed(err.message)
|
raise exceptions.AuthenticationFailed(err.message)
|
||||||
|
|
||||||
|
if not oauth_request:
|
||||||
|
return None
|
||||||
|
|
||||||
oauth_params = oauth_provider.consts.OAUTH_PARAMETERS_NAMES
|
oauth_params = oauth_provider.consts.OAUTH_PARAMETERS_NAMES
|
||||||
|
|
||||||
found = any(param for param in oauth_params if param in oauth_request)
|
found = any(param for param in oauth_params if param in oauth_request)
|
||||||
|
@ -312,21 +317,15 @@ class OAuth2Authentication(BaseAuthentication):
|
||||||
Authenticate the request, given the access token.
|
Authenticate the request, given the access token.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# Authenticate the client
|
try:
|
||||||
oauth2_client_form = oauth2_provider_forms.ClientAuthForm(request.REQUEST)
|
token = oauth2_provider.models.AccessToken.objects.select_related('user')
|
||||||
if not oauth2_client_form.is_valid():
|
# TODO: Change to timezone aware datetime when oauth2_provider add
|
||||||
raise exceptions.AuthenticationFailed('Client could not be validated')
|
# support to it.
|
||||||
client = oauth2_client_form.cleaned_data.get('client')
|
token = token.get(token=access_token, expires__gt=datetime.now())
|
||||||
|
except oauth2_provider.models.AccessToken.DoesNotExist:
|
||||||
# Retrieve the `OAuth2AccessToken` instance from the access_token
|
|
||||||
auth_backend = oauth2_provider_backends.AccessTokenBackend()
|
|
||||||
token = auth_backend.authenticate(access_token, client)
|
|
||||||
if token is None:
|
|
||||||
raise exceptions.AuthenticationFailed('Invalid token')
|
raise exceptions.AuthenticationFailed('Invalid token')
|
||||||
|
|
||||||
user = token.user
|
if not token.user.is_active:
|
||||||
|
|
||||||
if not user.is_active:
|
|
||||||
msg = 'User inactive or deleted: %s' % user.username
|
msg = 'User inactive or deleted: %s' % user.username
|
||||||
raise exceptions.AuthenticationFailed(msg)
|
raise exceptions.AuthenticationFailed(msg)
|
||||||
|
|
||||||
|
|
|
@ -395,6 +395,37 @@ except ImportError:
|
||||||
kw = dict((k, int(v)) for k, v in kw.iteritems() if v is not None)
|
kw = dict((k, int(v)) for k, v in kw.iteritems() if v is not None)
|
||||||
return datetime.datetime(**kw)
|
return datetime.datetime(**kw)
|
||||||
|
|
||||||
|
|
||||||
|
# smart_urlquote is new on Django 1.4
|
||||||
|
try:
|
||||||
|
from django.utils.html import smart_urlquote
|
||||||
|
except ImportError:
|
||||||
|
try:
|
||||||
|
from urllib.parse import quote, urlsplit, urlunsplit
|
||||||
|
except ImportError: # Python 2
|
||||||
|
from urllib import quote
|
||||||
|
from urlparse import urlsplit, urlunsplit
|
||||||
|
|
||||||
|
def smart_urlquote(url):
|
||||||
|
"Quotes a URL if it isn't already quoted."
|
||||||
|
# Handle IDN before quoting.
|
||||||
|
scheme, netloc, path, query, fragment = urlsplit(url)
|
||||||
|
try:
|
||||||
|
netloc = netloc.encode('idna').decode('ascii') # IDN -> ACE
|
||||||
|
except UnicodeError: # invalid domain part
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
url = urlunsplit((scheme, netloc, path, query, fragment))
|
||||||
|
|
||||||
|
# An URL is considered unquoted if it contains no % characters or
|
||||||
|
# contains a % not followed by two hexadecimal digits. See #9655.
|
||||||
|
if '%' not in url or unquoted_percents_re.search(url):
|
||||||
|
# See http://bugs.python.org/issue2637
|
||||||
|
url = quote(force_bytes(url), safe=b'!*\'();:@&=+$,/?#[]~')
|
||||||
|
|
||||||
|
return force_text(url)
|
||||||
|
|
||||||
|
|
||||||
# Markdown is optional
|
# Markdown is optional
|
||||||
try:
|
try:
|
||||||
import markdown
|
import markdown
|
||||||
|
@ -445,14 +476,12 @@ except ImportError:
|
||||||
# OAuth 2 support is optional
|
# OAuth 2 support is optional
|
||||||
try:
|
try:
|
||||||
import provider.oauth2 as oauth2_provider
|
import provider.oauth2 as oauth2_provider
|
||||||
from provider.oauth2 import backends as oauth2_provider_backends
|
|
||||||
from provider.oauth2 import models as oauth2_provider_models
|
from provider.oauth2 import models as oauth2_provider_models
|
||||||
from provider.oauth2 import forms as oauth2_provider_forms
|
from provider.oauth2 import forms as oauth2_provider_forms
|
||||||
from provider import scope as oauth2_provider_scope
|
from provider import scope as oauth2_provider_scope
|
||||||
from provider import constants as oauth2_constants
|
from provider import constants as oauth2_constants
|
||||||
except ImportError:
|
except ImportError:
|
||||||
oauth2_provider = None
|
oauth2_provider = None
|
||||||
oauth2_provider_backends = None
|
|
||||||
oauth2_provider_models = None
|
oauth2_provider_models = None
|
||||||
oauth2_provider_forms = None
|
oauth2_provider_forms = None
|
||||||
oauth2_provider_scope = None
|
oauth2_provider_scope = None
|
||||||
|
|
|
@ -494,7 +494,7 @@ class DateField(WritableField):
|
||||||
}
|
}
|
||||||
empty = None
|
empty = None
|
||||||
input_formats = api_settings.DATE_INPUT_FORMATS
|
input_formats = api_settings.DATE_INPUT_FORMATS
|
||||||
format = api_settings.DATE_FORMAT
|
format = None
|
||||||
|
|
||||||
def __init__(self, input_formats=None, format=None, *args, **kwargs):
|
def __init__(self, input_formats=None, format=None, *args, **kwargs):
|
||||||
self.input_formats = input_formats if input_formats is not None else self.input_formats
|
self.input_formats = input_formats if input_formats is not None else self.input_formats
|
||||||
|
@ -536,8 +536,8 @@ class DateField(WritableField):
|
||||||
raise ValidationError(msg)
|
raise ValidationError(msg)
|
||||||
|
|
||||||
def to_native(self, value):
|
def to_native(self, value):
|
||||||
if value is None:
|
if value is None or self.format is None:
|
||||||
return None
|
return value
|
||||||
|
|
||||||
if isinstance(value, datetime.datetime):
|
if isinstance(value, datetime.datetime):
|
||||||
value = value.date()
|
value = value.date()
|
||||||
|
@ -557,7 +557,7 @@ class DateTimeField(WritableField):
|
||||||
}
|
}
|
||||||
empty = None
|
empty = None
|
||||||
input_formats = api_settings.DATETIME_INPUT_FORMATS
|
input_formats = api_settings.DATETIME_INPUT_FORMATS
|
||||||
format = api_settings.DATETIME_FORMAT
|
format = None
|
||||||
|
|
||||||
def __init__(self, input_formats=None, format=None, *args, **kwargs):
|
def __init__(self, input_formats=None, format=None, *args, **kwargs):
|
||||||
self.input_formats = input_formats if input_formats is not None else self.input_formats
|
self.input_formats = input_formats if input_formats is not None else self.input_formats
|
||||||
|
@ -605,11 +605,14 @@ class DateTimeField(WritableField):
|
||||||
raise ValidationError(msg)
|
raise ValidationError(msg)
|
||||||
|
|
||||||
def to_native(self, value):
|
def to_native(self, value):
|
||||||
if value is None:
|
if value is None or self.format is None:
|
||||||
return None
|
return value
|
||||||
|
|
||||||
if self.format.lower() == ISO_8601:
|
if self.format.lower() == ISO_8601:
|
||||||
return value.isoformat()
|
ret = value.isoformat()
|
||||||
|
if ret.endswith('+00:00'):
|
||||||
|
ret = ret[:-6] + 'Z'
|
||||||
|
return ret
|
||||||
return value.strftime(self.format)
|
return value.strftime(self.format)
|
||||||
|
|
||||||
|
|
||||||
|
@ -623,7 +626,7 @@ class TimeField(WritableField):
|
||||||
}
|
}
|
||||||
empty = None
|
empty = None
|
||||||
input_formats = api_settings.TIME_INPUT_FORMATS
|
input_formats = api_settings.TIME_INPUT_FORMATS
|
||||||
format = api_settings.TIME_FORMAT
|
format = None
|
||||||
|
|
||||||
def __init__(self, input_formats=None, format=None, *args, **kwargs):
|
def __init__(self, input_formats=None, format=None, *args, **kwargs):
|
||||||
self.input_formats = input_formats if input_formats is not None else self.input_formats
|
self.input_formats = input_formats if input_formats is not None else self.input_formats
|
||||||
|
@ -658,8 +661,8 @@ class TimeField(WritableField):
|
||||||
raise ValidationError(msg)
|
raise ValidationError(msg)
|
||||||
|
|
||||||
def to_native(self, value):
|
def to_native(self, value):
|
||||||
if value is None:
|
if value is None or self.format is None:
|
||||||
return None
|
return value
|
||||||
|
|
||||||
if isinstance(value, datetime.datetime):
|
if isinstance(value, datetime.datetime):
|
||||||
value = value.time()
|
value = value.time()
|
||||||
|
|
|
@ -55,6 +55,6 @@ class DjangoFilterBackend(BaseFilterBackend):
|
||||||
filter_class = self.get_filter_class(view)
|
filter_class = self.get_filter_class(view)
|
||||||
|
|
||||||
if filter_class:
|
if filter_class:
|
||||||
return filter_class(request.QUERY_PARAMS, queryset=queryset)
|
return filter_class(request.QUERY_PARAMS, queryset=queryset).qs
|
||||||
|
|
||||||
return queryset
|
return queryset
|
||||||
|
|
|
@ -20,6 +20,25 @@ from rest_framework.relations import *
|
||||||
from rest_framework.fields import *
|
from rest_framework.fields import *
|
||||||
|
|
||||||
|
|
||||||
|
class NestedValidationError(ValidationError):
|
||||||
|
"""
|
||||||
|
The default ValidationError behavior is to stringify each item in the list
|
||||||
|
if the messages are a list of error messages.
|
||||||
|
|
||||||
|
In the case of nested serializers, where the parent has many children,
|
||||||
|
then the child's `serializer.errors` will be a list of dicts. In the case
|
||||||
|
of a single child, the `serializer.errors` will be a dict.
|
||||||
|
|
||||||
|
We need to override the default behavior to get properly nested error dicts.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, message):
|
||||||
|
if isinstance(message, dict):
|
||||||
|
self.messages = [message]
|
||||||
|
else:
|
||||||
|
self.messages = message
|
||||||
|
|
||||||
|
|
||||||
class DictWithMetadata(dict):
|
class DictWithMetadata(dict):
|
||||||
"""
|
"""
|
||||||
A dict-like object, that can have additional properties attached.
|
A dict-like object, that can have additional properties attached.
|
||||||
|
@ -98,7 +117,7 @@ class SerializerOptions(object):
|
||||||
self.exclude = getattr(meta, 'exclude', ())
|
self.exclude = getattr(meta, 'exclude', ())
|
||||||
|
|
||||||
|
|
||||||
class BaseSerializer(Field):
|
class BaseSerializer(WritableField):
|
||||||
"""
|
"""
|
||||||
This is the Serializer implementation.
|
This is the Serializer implementation.
|
||||||
We need to implement it as `BaseSerializer` due to metaclass magicks.
|
We need to implement it as `BaseSerializer` due to metaclass magicks.
|
||||||
|
@ -110,13 +129,15 @@ class BaseSerializer(Field):
|
||||||
_dict_class = SortedDictWithMetadata
|
_dict_class = SortedDictWithMetadata
|
||||||
|
|
||||||
def __init__(self, instance=None, data=None, files=None,
|
def __init__(self, instance=None, data=None, files=None,
|
||||||
context=None, partial=False, many=None, source=None):
|
context=None, partial=False, many=None,
|
||||||
super(BaseSerializer, self).__init__(source=source)
|
allow_add_remove=False, **kwargs):
|
||||||
|
super(BaseSerializer, self).__init__(**kwargs)
|
||||||
self.opts = self._options_class(self.Meta)
|
self.opts = self._options_class(self.Meta)
|
||||||
self.parent = None
|
self.parent = None
|
||||||
self.root = None
|
self.root = None
|
||||||
self.partial = partial
|
self.partial = partial
|
||||||
self.many = many
|
self.many = many
|
||||||
|
self.allow_add_remove = allow_add_remove
|
||||||
|
|
||||||
self.context = context or {}
|
self.context = context or {}
|
||||||
|
|
||||||
|
@ -128,6 +149,13 @@ class BaseSerializer(Field):
|
||||||
self._data = None
|
self._data = None
|
||||||
self._files = None
|
self._files = None
|
||||||
self._errors = None
|
self._errors = None
|
||||||
|
self._deleted = None
|
||||||
|
|
||||||
|
if many and instance is not None and not hasattr(instance, '__iter__'):
|
||||||
|
raise ValueError('instance should be a queryset or other iterable with many=True')
|
||||||
|
|
||||||
|
if allow_add_remove and not many:
|
||||||
|
raise ValueError('allow_add_remove should only be used for bulk updates, but you have not set many=True')
|
||||||
|
|
||||||
#####
|
#####
|
||||||
# Methods to determine which fields to use when (de)serializing objects.
|
# Methods to determine which fields to use when (de)serializing objects.
|
||||||
|
@ -296,40 +324,91 @@ class BaseSerializer(Field):
|
||||||
|
|
||||||
def field_to_native(self, obj, field_name):
|
def field_to_native(self, obj, field_name):
|
||||||
"""
|
"""
|
||||||
Override default so that we can apply ModelSerializer as a nested
|
Override default so that the serializer can be used as a nested field
|
||||||
field to relationships.
|
across relationships.
|
||||||
"""
|
"""
|
||||||
if self.source == '*':
|
if self.source == '*':
|
||||||
return self.to_native(obj)
|
return self.to_native(obj)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
if self.source:
|
source = self.source or field_name
|
||||||
for component in self.source.split('.'):
|
value = obj
|
||||||
obj = getattr(obj, component)
|
|
||||||
if is_simple_callable(obj):
|
for component in source.split('.'):
|
||||||
obj = obj()
|
value = get_component(value, component)
|
||||||
else:
|
if value is None:
|
||||||
obj = getattr(obj, field_name)
|
break
|
||||||
if is_simple_callable(obj):
|
|
||||||
obj = obj()
|
|
||||||
except ObjectDoesNotExist:
|
except ObjectDoesNotExist:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
# If the object has an "all" method, assume it's a relationship
|
if is_simple_callable(getattr(value, 'all', None)):
|
||||||
if is_simple_callable(getattr(obj, 'all', None)):
|
return [self.to_native(item) for item in value.all()]
|
||||||
return [self.to_native(item) for item in obj.all()]
|
|
||||||
|
|
||||||
if obj is None:
|
if value is None:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
if self.many is not None:
|
if self.many is not None:
|
||||||
many = self.many
|
many = self.many
|
||||||
else:
|
else:
|
||||||
many = hasattr(obj, '__iter__') and not isinstance(obj, (Page, dict, six.text_type))
|
many = hasattr(value, '__iter__') and not isinstance(value, (Page, dict, six.text_type))
|
||||||
|
|
||||||
if many:
|
if many:
|
||||||
return [self.to_native(item) for item in obj]
|
return [self.to_native(item) for item in value]
|
||||||
return self.to_native(obj)
|
return self.to_native(value)
|
||||||
|
|
||||||
|
def field_from_native(self, data, files, field_name, into):
|
||||||
|
"""
|
||||||
|
Override default so that the serializer can be used as a writable
|
||||||
|
nested field across relationships.
|
||||||
|
"""
|
||||||
|
if self.read_only:
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
value = data[field_name]
|
||||||
|
except KeyError:
|
||||||
|
if self.default is not None and not self.partial:
|
||||||
|
# Note: partial updates shouldn't set defaults
|
||||||
|
value = copy.deepcopy(self.default)
|
||||||
|
else:
|
||||||
|
if self.required:
|
||||||
|
raise ValidationError(self.error_messages['required'])
|
||||||
|
return
|
||||||
|
|
||||||
|
# Set the serializer object if it exists
|
||||||
|
obj = getattr(self.parent.object, field_name) if self.parent.object else None
|
||||||
|
|
||||||
|
if value in (None, ''):
|
||||||
|
into[(self.source or field_name)] = None
|
||||||
|
else:
|
||||||
|
kwargs = {
|
||||||
|
'instance': obj,
|
||||||
|
'data': value,
|
||||||
|
'context': self.context,
|
||||||
|
'partial': self.partial,
|
||||||
|
'many': self.many
|
||||||
|
}
|
||||||
|
serializer = self.__class__(**kwargs)
|
||||||
|
|
||||||
|
if serializer.is_valid():
|
||||||
|
into[self.source or field_name] = serializer.object
|
||||||
|
else:
|
||||||
|
# Propagate errors up to our parent
|
||||||
|
raise NestedValidationError(serializer.errors)
|
||||||
|
|
||||||
|
def get_identity(self, data):
|
||||||
|
"""
|
||||||
|
This hook is required for bulk update.
|
||||||
|
It is used to determine the canonical identity of a given object.
|
||||||
|
|
||||||
|
Note that the data has not been validated at this point, so we need
|
||||||
|
to make sure that we catch any cases of incorrect datatypes being
|
||||||
|
passed to this method.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return data.get('id', None)
|
||||||
|
except AttributeError:
|
||||||
|
return None
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def errors(self):
|
def errors(self):
|
||||||
|
@ -352,10 +431,37 @@ class BaseSerializer(Field):
|
||||||
if many:
|
if many:
|
||||||
ret = []
|
ret = []
|
||||||
errors = []
|
errors = []
|
||||||
for item in data:
|
update = self.object is not None
|
||||||
ret.append(self.from_native(item, None))
|
|
||||||
errors.append(self._errors)
|
if update:
|
||||||
self._errors = any(errors) and errors or []
|
# If this is a bulk update we need to map all the objects
|
||||||
|
# to a canonical identity so we can determine which
|
||||||
|
# individual object is being updated for each item in the
|
||||||
|
# incoming data
|
||||||
|
objects = self.object
|
||||||
|
identities = [self.get_identity(self.to_native(obj)) for obj in objects]
|
||||||
|
identity_to_objects = dict(zip(identities, objects))
|
||||||
|
|
||||||
|
if hasattr(data, '__iter__') and not isinstance(data, (dict, six.text_type)):
|
||||||
|
for item in data:
|
||||||
|
if update:
|
||||||
|
# Determine which object we're updating
|
||||||
|
identity = self.get_identity(item)
|
||||||
|
self.object = identity_to_objects.pop(identity, None)
|
||||||
|
if self.object is None and not self.allow_add_remove:
|
||||||
|
ret.append(None)
|
||||||
|
errors.append({'non_field_errors': ['Cannot create a new item, only existing items may be updated.']})
|
||||||
|
continue
|
||||||
|
|
||||||
|
ret.append(self.from_native(item, None))
|
||||||
|
errors.append(self._errors)
|
||||||
|
|
||||||
|
if update:
|
||||||
|
self._deleted = identity_to_objects.values()
|
||||||
|
|
||||||
|
self._errors = any(errors) and errors or []
|
||||||
|
else:
|
||||||
|
self._errors = {'non_field_errors': ['Expected a list of items.']}
|
||||||
else:
|
else:
|
||||||
ret = self.from_native(data, files)
|
ret = self.from_native(data, files)
|
||||||
|
|
||||||
|
@ -394,6 +500,9 @@ class BaseSerializer(Field):
|
||||||
def save_object(self, obj, **kwargs):
|
def save_object(self, obj, **kwargs):
|
||||||
obj.save(**kwargs)
|
obj.save(**kwargs)
|
||||||
|
|
||||||
|
def delete_object(self, obj):
|
||||||
|
obj.delete()
|
||||||
|
|
||||||
def save(self, **kwargs):
|
def save(self, **kwargs):
|
||||||
"""
|
"""
|
||||||
Save the deserialized object and return it.
|
Save the deserialized object and return it.
|
||||||
|
@ -402,6 +511,10 @@ class BaseSerializer(Field):
|
||||||
[self.save_object(item, **kwargs) for item in self.object]
|
[self.save_object(item, **kwargs) for item in self.object]
|
||||||
else:
|
else:
|
||||||
self.save_object(self.object, **kwargs)
|
self.save_object(self.object, **kwargs)
|
||||||
|
|
||||||
|
if self.allow_add_remove and self._deleted:
|
||||||
|
[self.delete_object(item) for item in self._deleted]
|
||||||
|
|
||||||
return self.object
|
return self.object
|
||||||
|
|
||||||
|
|
||||||
|
@ -584,33 +697,43 @@ class ModelSerializer(Serializer):
|
||||||
"""
|
"""
|
||||||
Restore the model instance.
|
Restore the model instance.
|
||||||
"""
|
"""
|
||||||
self.m2m_data = {}
|
m2m_data = {}
|
||||||
self.related_data = {}
|
related_data = {}
|
||||||
|
meta = self.opts.model._meta
|
||||||
|
|
||||||
# Reverse fk relations
|
# Reverse fk or one-to-one relations
|
||||||
for (obj, model) in self.opts.model._meta.get_all_related_objects_with_model():
|
for (obj, model) in meta.get_all_related_objects_with_model():
|
||||||
field_name = obj.field.related_query_name()
|
field_name = obj.field.related_query_name()
|
||||||
if field_name in attrs:
|
if field_name in attrs:
|
||||||
self.related_data[field_name] = attrs.pop(field_name)
|
related_data[field_name] = attrs.pop(field_name)
|
||||||
|
|
||||||
# Reverse m2m relations
|
# Reverse m2m relations
|
||||||
for (obj, model) in self.opts.model._meta.get_all_related_m2m_objects_with_model():
|
for (obj, model) in meta.get_all_related_m2m_objects_with_model():
|
||||||
field_name = obj.field.related_query_name()
|
field_name = obj.field.related_query_name()
|
||||||
if field_name in attrs:
|
if field_name in attrs:
|
||||||
self.m2m_data[field_name] = attrs.pop(field_name)
|
m2m_data[field_name] = attrs.pop(field_name)
|
||||||
|
|
||||||
# Forward m2m relations
|
# Forward m2m relations
|
||||||
for field in self.opts.model._meta.many_to_many:
|
for field in meta.many_to_many:
|
||||||
if field.name in attrs:
|
if field.name in attrs:
|
||||||
self.m2m_data[field.name] = attrs.pop(field.name)
|
m2m_data[field.name] = attrs.pop(field.name)
|
||||||
|
|
||||||
|
# Update an existing instance...
|
||||||
if instance is not None:
|
if instance is not None:
|
||||||
for key, val in attrs.items():
|
for key, val in attrs.items():
|
||||||
setattr(instance, key, val)
|
setattr(instance, key, val)
|
||||||
|
|
||||||
|
# ...or create a new instance
|
||||||
else:
|
else:
|
||||||
instance = self.opts.model(**attrs)
|
instance = self.opts.model(**attrs)
|
||||||
|
|
||||||
|
# Any relations that cannot be set until we've
|
||||||
|
# saved the model get hidden away on these
|
||||||
|
# private attributes, so we can deal with them
|
||||||
|
# at the point of save.
|
||||||
|
instance._related_data = related_data
|
||||||
|
instance._m2m_data = m2m_data
|
||||||
|
|
||||||
return instance
|
return instance
|
||||||
|
|
||||||
def from_native(self, data, files):
|
def from_native(self, data, files):
|
||||||
|
@ -627,15 +750,15 @@ class ModelSerializer(Serializer):
|
||||||
"""
|
"""
|
||||||
obj.save(**kwargs)
|
obj.save(**kwargs)
|
||||||
|
|
||||||
if getattr(self, 'm2m_data', None):
|
if getattr(obj, '_m2m_data', None):
|
||||||
for accessor_name, object_list in self.m2m_data.items():
|
for accessor_name, object_list in obj._m2m_data.items():
|
||||||
setattr(self.object, accessor_name, object_list)
|
setattr(obj, accessor_name, object_list)
|
||||||
self.m2m_data = {}
|
del(obj._m2m_data)
|
||||||
|
|
||||||
if getattr(self, 'related_data', None):
|
if getattr(obj, '_related_data', None):
|
||||||
for accessor_name, object_list in self.related_data.items():
|
for accessor_name, related in obj._related_data.items():
|
||||||
setattr(self.object, accessor_name, object_list)
|
setattr(obj, accessor_name, related)
|
||||||
self.related_data = {}
|
del(obj._related_data)
|
||||||
|
|
||||||
|
|
||||||
class HyperlinkedModelSerializerOptions(ModelSerializerOptions):
|
class HyperlinkedModelSerializerOptions(ModelSerializerOptions):
|
||||||
|
@ -690,3 +813,13 @@ class HyperlinkedModelSerializer(ModelSerializer):
|
||||||
'many': to_many
|
'many': to_many
|
||||||
}
|
}
|
||||||
return HyperlinkedRelatedField(**kwargs)
|
return HyperlinkedRelatedField(**kwargs)
|
||||||
|
|
||||||
|
def get_identity(self, data):
|
||||||
|
"""
|
||||||
|
This hook is required for bulk update.
|
||||||
|
We need to override the default, to use the url as the identity.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return data.get('url', None)
|
||||||
|
except AttributeError:
|
||||||
|
return None
|
||||||
|
|
|
@ -4,11 +4,8 @@ from django.core.urlresolvers import reverse, NoReverseMatch
|
||||||
from django.http import QueryDict
|
from django.http import QueryDict
|
||||||
from django.utils.html import escape
|
from django.utils.html import escape
|
||||||
from django.utils.safestring import SafeData, mark_safe
|
from django.utils.safestring import SafeData, mark_safe
|
||||||
from rest_framework.compat import urlparse
|
from rest_framework.compat import urlparse, force_text, six, smart_urlquote
|
||||||
from rest_framework.compat import force_text
|
import re, string
|
||||||
from rest_framework.compat import six
|
|
||||||
import re
|
|
||||||
import string
|
|
||||||
|
|
||||||
register = template.Library()
|
register = template.Library()
|
||||||
|
|
||||||
|
@ -112,22 +109,6 @@ def replace_query_param(url, key, val):
|
||||||
class_re = re.compile(r'(?<=class=["\'])(.*)(?=["\'])')
|
class_re = re.compile(r'(?<=class=["\'])(.*)(?=["\'])')
|
||||||
|
|
||||||
|
|
||||||
# Bunch of stuff cloned from urlize
|
|
||||||
LEADING_PUNCTUATION = ['(', '<', '<', '"', "'"]
|
|
||||||
TRAILING_PUNCTUATION = ['.', ',', ')', '>', '\n', '>', '"', "'"]
|
|
||||||
DOTS = ['·', '*', '\xe2\x80\xa2', '•', '•', '•']
|
|
||||||
unencoded_ampersands_re = re.compile(r'&(?!(\w+|#\d+);)')
|
|
||||||
word_split_re = re.compile(r'(\s+)')
|
|
||||||
punctuation_re = re.compile('^(?P<lead>(?:%s)*)(?P<middle>.*?)(?P<trail>(?:%s)*)$' % \
|
|
||||||
('|'.join([re.escape(x) for x in LEADING_PUNCTUATION]),
|
|
||||||
'|'.join([re.escape(x) for x in TRAILING_PUNCTUATION])))
|
|
||||||
simple_email_re = re.compile(r'^\S+@[a-zA-Z0-9._-]+\.[a-zA-Z0-9._-]+$')
|
|
||||||
link_target_attribute_re = re.compile(r'(<a [^>]*?)target=[^\s>]+')
|
|
||||||
html_gunk_re = re.compile(r'(?:<br clear="all">|<i><\/i>|<b><\/b>|<em><\/em>|<strong><\/strong>|<\/?smallcaps>|<\/?uppercase>)', re.IGNORECASE)
|
|
||||||
hard_coded_bullets_re = re.compile(r'((?:<p>(?:%s).*?[a-zA-Z].*?</p>\s*)+)' % '|'.join([re.escape(x) for x in DOTS]), re.DOTALL)
|
|
||||||
trailing_empty_content_re = re.compile(r'(?:<p>(?: |\s|<br \/>)*?</p>\s*)+\Z')
|
|
||||||
|
|
||||||
|
|
||||||
# And the template tags themselves...
|
# And the template tags themselves...
|
||||||
|
|
||||||
@register.simple_tag
|
@register.simple_tag
|
||||||
|
@ -195,15 +176,25 @@ def add_class(value, css_class):
|
||||||
return value
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
# Bunch of stuff cloned from urlize
|
||||||
|
TRAILING_PUNCTUATION = ['.', ',', ':', ';', '.)', '"', "'"]
|
||||||
|
WRAPPING_PUNCTUATION = [('(', ')'), ('<', '>'), ('[', ']'), ('<', '>'),
|
||||||
|
('"', '"'), ("'", "'")]
|
||||||
|
word_split_re = re.compile(r'(\s+)')
|
||||||
|
simple_url_re = re.compile(r'^https?://\w', re.IGNORECASE)
|
||||||
|
simple_url_2_re = re.compile(r'^www\.|^(?!http)\w[^@]+\.(com|edu|gov|int|mil|net|org)$', re.IGNORECASE)
|
||||||
|
simple_email_re = re.compile(r'^\S+@\S+\.\S+$')
|
||||||
|
|
||||||
|
|
||||||
@register.filter
|
@register.filter
|
||||||
def urlize_quoted_links(text, trim_url_limit=None, nofollow=True, autoescape=True):
|
def urlize_quoted_links(text, trim_url_limit=None, nofollow=True, autoescape=True):
|
||||||
"""
|
"""
|
||||||
Converts any URLs in text into clickable links.
|
Converts any URLs in text into clickable links.
|
||||||
|
|
||||||
Works on http://, https://, www. links and links ending in .org, .net or
|
Works on http://, https://, www. links, and also on links ending in one of
|
||||||
.com. Links can have trailing punctuation (periods, commas, close-parens)
|
the original seven gTLDs (.com, .edu, .gov, .int, .mil, .net, and .org).
|
||||||
and leading punctuation (opening parens) and it'll still do the right
|
Links can have trailing punctuation (periods, commas, close-parens) and
|
||||||
thing.
|
leading punctuation (opening parens) and it'll still do the right thing.
|
||||||
|
|
||||||
If trim_url_limit is not None, the URLs in link text longer than this limit
|
If trim_url_limit is not None, the URLs in link text longer than this limit
|
||||||
will truncated to trim_url_limit-3 characters and appended with an elipsis.
|
will truncated to trim_url_limit-3 characters and appended with an elipsis.
|
||||||
|
@ -216,24 +207,41 @@ def urlize_quoted_links(text, trim_url_limit=None, nofollow=True, autoescape=Tru
|
||||||
trim_url = lambda x, limit=trim_url_limit: limit is not None and (len(x) > limit and ('%s...' % x[:max(0, limit - 3)])) or x
|
trim_url = lambda x, limit=trim_url_limit: limit is not None and (len(x) > limit and ('%s...' % x[:max(0, limit - 3)])) or x
|
||||||
safe_input = isinstance(text, SafeData)
|
safe_input = isinstance(text, SafeData)
|
||||||
words = word_split_re.split(force_text(text))
|
words = word_split_re.split(force_text(text))
|
||||||
nofollow_attr = nofollow and ' rel="nofollow"' or ''
|
|
||||||
for i, word in enumerate(words):
|
for i, word in enumerate(words):
|
||||||
match = None
|
match = None
|
||||||
if '.' in word or '@' in word or ':' in word:
|
if '.' in word or '@' in word or ':' in word:
|
||||||
match = punctuation_re.match(word)
|
# Deal with punctuation.
|
||||||
if match:
|
lead, middle, trail = '', word, ''
|
||||||
lead, middle, trail = match.groups()
|
for punctuation in TRAILING_PUNCTUATION:
|
||||||
|
if middle.endswith(punctuation):
|
||||||
|
middle = middle[:-len(punctuation)]
|
||||||
|
trail = punctuation + trail
|
||||||
|
for opening, closing in WRAPPING_PUNCTUATION:
|
||||||
|
if middle.startswith(opening):
|
||||||
|
middle = middle[len(opening):]
|
||||||
|
lead = lead + opening
|
||||||
|
# Keep parentheses at the end only if they're balanced.
|
||||||
|
if (middle.endswith(closing)
|
||||||
|
and middle.count(closing) == middle.count(opening) + 1):
|
||||||
|
middle = middle[:-len(closing)]
|
||||||
|
trail = closing + trail
|
||||||
|
|
||||||
# Make URL we want to point to.
|
# Make URL we want to point to.
|
||||||
url = None
|
url = None
|
||||||
if middle.startswith('http://') or middle.startswith('https://'):
|
nofollow_attr = ' rel="nofollow"' if nofollow else ''
|
||||||
url = middle
|
if simple_url_re.match(middle):
|
||||||
elif middle.startswith('www.') or ('@' not in middle and \
|
url = smart_urlquote(middle)
|
||||||
middle and middle[0] in string.ascii_letters + string.digits and \
|
elif simple_url_2_re.match(middle):
|
||||||
(middle.endswith('.org') or middle.endswith('.net') or middle.endswith('.com'))):
|
url = smart_urlquote('http://%s' % middle)
|
||||||
url = 'http://%s' % middle
|
elif not ':' in middle and simple_email_re.match(middle):
|
||||||
elif '@' in middle and not ':' in middle and simple_email_re.match(middle):
|
local, domain = middle.rsplit('@', 1)
|
||||||
url = 'mailto:%s' % middle
|
try:
|
||||||
|
domain = domain.encode('idna').decode('ascii')
|
||||||
|
except UnicodeError:
|
||||||
|
continue
|
||||||
|
url = 'mailto:%s@%s' % (local, domain)
|
||||||
nofollow_attr = ''
|
nofollow_attr = ''
|
||||||
|
|
||||||
# Make link.
|
# Make link.
|
||||||
if url:
|
if url:
|
||||||
trimmed = trim_url(middle)
|
trimmed = trim_url(middle)
|
||||||
|
@ -251,4 +259,4 @@ def urlize_quoted_links(text, trim_url_limit=None, nofollow=True, autoescape=Tru
|
||||||
words[i] = mark_safe(word)
|
words[i] = mark_safe(word)
|
||||||
elif autoescape:
|
elif autoescape:
|
||||||
words[i] = escape(word)
|
words[i] = escape(word)
|
||||||
return mark_safe(''.join(words))
|
return ''.join(words)
|
||||||
|
|
|
@ -466,17 +466,13 @@ class OAuth2Tests(TestCase):
|
||||||
def _create_authorization_header(self, token=None):
|
def _create_authorization_header(self, token=None):
|
||||||
return "Bearer {0}".format(token or self.access_token.token)
|
return "Bearer {0}".format(token or self.access_token.token)
|
||||||
|
|
||||||
def _client_credentials_params(self):
|
|
||||||
return {'client_id': self.CLIENT_ID, 'client_secret': self.CLIENT_SECRET}
|
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
def test_get_form_with_wrong_authorization_header_token_type_failing(self):
|
def test_get_form_with_wrong_authorization_header_token_type_failing(self):
|
||||||
"""Ensure that a wrong token type lead to the correct HTTP error status code"""
|
"""Ensure that a wrong token type lead to the correct HTTP error status code"""
|
||||||
auth = "Wrong token-type-obsviously"
|
auth = "Wrong token-type-obsviously"
|
||||||
response = self.csrf_client.get('/oauth2-test/', {}, HTTP_AUTHORIZATION=auth)
|
response = self.csrf_client.get('/oauth2-test/', {}, HTTP_AUTHORIZATION=auth)
|
||||||
self.assertEqual(response.status_code, 401)
|
self.assertEqual(response.status_code, 401)
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.get('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.get('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 401)
|
self.assertEqual(response.status_code, 401)
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
|
@ -485,8 +481,7 @@ class OAuth2Tests(TestCase):
|
||||||
auth = "Bearer wrong token format"
|
auth = "Bearer wrong token format"
|
||||||
response = self.csrf_client.get('/oauth2-test/', {}, HTTP_AUTHORIZATION=auth)
|
response = self.csrf_client.get('/oauth2-test/', {}, HTTP_AUTHORIZATION=auth)
|
||||||
self.assertEqual(response.status_code, 401)
|
self.assertEqual(response.status_code, 401)
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.get('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.get('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 401)
|
self.assertEqual(response.status_code, 401)
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
|
@ -495,33 +490,21 @@ class OAuth2Tests(TestCase):
|
||||||
auth = "Bearer wrong-token"
|
auth = "Bearer wrong-token"
|
||||||
response = self.csrf_client.get('/oauth2-test/', {}, HTTP_AUTHORIZATION=auth)
|
response = self.csrf_client.get('/oauth2-test/', {}, HTTP_AUTHORIZATION=auth)
|
||||||
self.assertEqual(response.status_code, 401)
|
self.assertEqual(response.status_code, 401)
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.get('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.get('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 401)
|
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
|
||||||
def test_get_form_with_wrong_client_data_failing_auth(self):
|
|
||||||
"""Ensure GETing form over OAuth with incorrect client credentials fails"""
|
|
||||||
auth = self._create_authorization_header()
|
|
||||||
params = self._client_credentials_params()
|
|
||||||
params['client_id'] += 'a'
|
|
||||||
response = self.csrf_client.get('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 401)
|
self.assertEqual(response.status_code, 401)
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
def test_get_form_passing_auth(self):
|
def test_get_form_passing_auth(self):
|
||||||
"""Ensure GETing form over OAuth with correct client credentials succeed"""
|
"""Ensure GETing form over OAuth with correct client credentials succeed"""
|
||||||
auth = self._create_authorization_header()
|
auth = self._create_authorization_header()
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.get('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.get('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 200)
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
def test_post_form_passing_auth(self):
|
def test_post_form_passing_auth(self):
|
||||||
"""Ensure POSTing form over OAuth with correct credentials passes and does not require CSRF"""
|
"""Ensure POSTing form over OAuth with correct credentials passes and does not require CSRF"""
|
||||||
auth = self._create_authorization_header()
|
auth = self._create_authorization_header()
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.post('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.post('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 200)
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
|
@ -529,16 +512,14 @@ class OAuth2Tests(TestCase):
|
||||||
"""Ensure POSTing when there is no OAuth access token in db fails"""
|
"""Ensure POSTing when there is no OAuth access token in db fails"""
|
||||||
self.access_token.delete()
|
self.access_token.delete()
|
||||||
auth = self._create_authorization_header()
|
auth = self._create_authorization_header()
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.post('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.post('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertIn(response.status_code, (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN))
|
self.assertIn(response.status_code, (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN))
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
def test_post_form_with_refresh_token_failing_auth(self):
|
def test_post_form_with_refresh_token_failing_auth(self):
|
||||||
"""Ensure POSTing with refresh token instead of access token fails"""
|
"""Ensure POSTing with refresh token instead of access token fails"""
|
||||||
auth = self._create_authorization_header(token=self.refresh_token.token)
|
auth = self._create_authorization_header(token=self.refresh_token.token)
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.post('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.post('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertIn(response.status_code, (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN))
|
self.assertIn(response.status_code, (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN))
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
|
@ -547,8 +528,7 @@ class OAuth2Tests(TestCase):
|
||||||
self.access_token.expires = datetime.datetime.now() - datetime.timedelta(seconds=10) # 10 seconds late
|
self.access_token.expires = datetime.datetime.now() - datetime.timedelta(seconds=10) # 10 seconds late
|
||||||
self.access_token.save()
|
self.access_token.save()
|
||||||
auth = self._create_authorization_header()
|
auth = self._create_authorization_header()
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.post('/oauth2-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.post('/oauth2-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertIn(response.status_code, (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN))
|
self.assertIn(response.status_code, (status.HTTP_401_UNAUTHORIZED, status.HTTP_403_FORBIDDEN))
|
||||||
self.assertIn('Invalid token', response.content)
|
self.assertIn('Invalid token', response.content)
|
||||||
|
|
||||||
|
@ -559,10 +539,9 @@ class OAuth2Tests(TestCase):
|
||||||
read_only_access_token.scope = oauth2_provider_scope.SCOPE_NAME_DICT['read']
|
read_only_access_token.scope = oauth2_provider_scope.SCOPE_NAME_DICT['read']
|
||||||
read_only_access_token.save()
|
read_only_access_token.save()
|
||||||
auth = self._create_authorization_header(token=read_only_access_token.token)
|
auth = self._create_authorization_header(token=read_only_access_token.token)
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.get('/oauth2-with-scope-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.get('/oauth2-with-scope-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 200)
|
self.assertEqual(response.status_code, 200)
|
||||||
response = self.csrf_client.post('/oauth2-with-scope-test/', params, HTTP_AUTHORIZATION=auth)
|
response = self.csrf_client.post('/oauth2-with-scope-test/', HTTP_AUTHORIZATION=auth)
|
||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
@unittest.skipUnless(oauth2_provider, 'django-oauth2-provider not installed')
|
||||||
|
@ -572,6 +551,5 @@ class OAuth2Tests(TestCase):
|
||||||
read_write_access_token.scope = oauth2_provider_scope.SCOPE_NAME_DICT['write']
|
read_write_access_token.scope = oauth2_provider_scope.SCOPE_NAME_DICT['write']
|
||||||
read_write_access_token.save()
|
read_write_access_token.save()
|
||||||
auth = self._create_authorization_header(token=read_write_access_token.token)
|
auth = self._create_authorization_header(token=read_write_access_token.token)
|
||||||
params = self._client_credentials_params()
|
response = self.csrf_client.post('/oauth2-with-scope-test/', HTTP_AUTHORIZATION=auth)
|
||||||
response = self.csrf_client.post('/oauth2-with-scope-test/', params, HTTP_AUTHORIZATION=auth)
|
|
||||||
self.assertEqual(response.status_code, 200)
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
|
@ -153,12 +153,22 @@ class DateFieldTest(TestCase):
|
||||||
|
|
||||||
def test_to_native(self):
|
def test_to_native(self):
|
||||||
"""
|
"""
|
||||||
Make sure to_native() returns isoformat as default.
|
Make sure to_native() returns datetime as default.
|
||||||
"""
|
"""
|
||||||
f = serializers.DateField()
|
f = serializers.DateField()
|
||||||
|
|
||||||
result_1 = f.to_native(datetime.date(1984, 7, 31))
|
result_1 = f.to_native(datetime.date(1984, 7, 31))
|
||||||
|
|
||||||
|
self.assertEqual(datetime.date(1984, 7, 31), result_1)
|
||||||
|
|
||||||
|
def test_to_native_iso(self):
|
||||||
|
"""
|
||||||
|
Make sure to_native() with 'iso-8601' returns iso formated date.
|
||||||
|
"""
|
||||||
|
f = serializers.DateField(format='iso-8601')
|
||||||
|
|
||||||
|
result_1 = f.to_native(datetime.date(1984, 7, 31))
|
||||||
|
|
||||||
self.assertEqual('1984-07-31', result_1)
|
self.assertEqual('1984-07-31', result_1)
|
||||||
|
|
||||||
def test_to_native_custom_format(self):
|
def test_to_native_custom_format(self):
|
||||||
|
@ -289,6 +299,22 @@ class DateTimeFieldTest(TestCase):
|
||||||
result_3 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59))
|
result_3 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59))
|
||||||
result_4 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59, 200))
|
result_4 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59, 200))
|
||||||
|
|
||||||
|
self.assertEqual(datetime.datetime(1984, 7, 31), result_1)
|
||||||
|
self.assertEqual(datetime.datetime(1984, 7, 31, 4, 31), result_2)
|
||||||
|
self.assertEqual(datetime.datetime(1984, 7, 31, 4, 31, 59), result_3)
|
||||||
|
self.assertEqual(datetime.datetime(1984, 7, 31, 4, 31, 59, 200), result_4)
|
||||||
|
|
||||||
|
def test_to_native_iso(self):
|
||||||
|
"""
|
||||||
|
Make sure to_native() with format=iso-8601 returns iso formatted datetime.
|
||||||
|
"""
|
||||||
|
f = serializers.DateTimeField(format='iso-8601')
|
||||||
|
|
||||||
|
result_1 = f.to_native(datetime.datetime(1984, 7, 31))
|
||||||
|
result_2 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31))
|
||||||
|
result_3 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59))
|
||||||
|
result_4 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59, 200))
|
||||||
|
|
||||||
self.assertEqual('1984-07-31T00:00:00', result_1)
|
self.assertEqual('1984-07-31T00:00:00', result_1)
|
||||||
self.assertEqual('1984-07-31T04:31:00', result_2)
|
self.assertEqual('1984-07-31T04:31:00', result_2)
|
||||||
self.assertEqual('1984-07-31T04:31:59', result_3)
|
self.assertEqual('1984-07-31T04:31:59', result_3)
|
||||||
|
@ -419,13 +445,26 @@ class TimeFieldTest(TestCase):
|
||||||
|
|
||||||
def test_to_native(self):
|
def test_to_native(self):
|
||||||
"""
|
"""
|
||||||
Make sure to_native() returns isoformat as default.
|
Make sure to_native() returns time object as default.
|
||||||
"""
|
"""
|
||||||
f = serializers.TimeField()
|
f = serializers.TimeField()
|
||||||
result_1 = f.to_native(datetime.time(4, 31))
|
result_1 = f.to_native(datetime.time(4, 31))
|
||||||
result_2 = f.to_native(datetime.time(4, 31, 59))
|
result_2 = f.to_native(datetime.time(4, 31, 59))
|
||||||
result_3 = f.to_native(datetime.time(4, 31, 59, 200))
|
result_3 = f.to_native(datetime.time(4, 31, 59, 200))
|
||||||
|
|
||||||
|
self.assertEqual(datetime.time(4, 31), result_1)
|
||||||
|
self.assertEqual(datetime.time(4, 31, 59), result_2)
|
||||||
|
self.assertEqual(datetime.time(4, 31, 59, 200), result_3)
|
||||||
|
|
||||||
|
def test_to_native_iso(self):
|
||||||
|
"""
|
||||||
|
Make sure to_native() with format='iso-8601' returns iso formatted time.
|
||||||
|
"""
|
||||||
|
f = serializers.TimeField(format='iso-8601')
|
||||||
|
result_1 = f.to_native(datetime.time(4, 31))
|
||||||
|
result_2 = f.to_native(datetime.time(4, 31, 59))
|
||||||
|
result_3 = f.to_native(datetime.time(4, 31, 59, 200))
|
||||||
|
|
||||||
self.assertEqual('04:31:00', result_1)
|
self.assertEqual('04:31:00', result_1)
|
||||||
self.assertEqual('04:31:59', result_2)
|
self.assertEqual('04:31:59', result_2)
|
||||||
self.assertEqual('04:31:59.000200', result_3)
|
self.assertEqual('04:31:59.000200', result_3)
|
||||||
|
|
|
@ -1,11 +1,12 @@
|
||||||
from __future__ import unicode_literals
|
from __future__ import unicode_literals
|
||||||
import datetime
|
import datetime
|
||||||
from decimal import Decimal
|
from decimal import Decimal
|
||||||
|
from django.core.urlresolvers import reverse
|
||||||
from django.test import TestCase
|
from django.test import TestCase
|
||||||
from django.test.client import RequestFactory
|
from django.test.client import RequestFactory
|
||||||
from django.utils import unittest
|
from django.utils import unittest
|
||||||
from rest_framework import generics, status, filters
|
from rest_framework import generics, status, filters
|
||||||
from rest_framework.compat import django_filters
|
from rest_framework.compat import django_filters, patterns, url
|
||||||
from rest_framework.tests.models import FilterableItem, BasicModel
|
from rest_framework.tests.models import FilterableItem, BasicModel
|
||||||
|
|
||||||
factory = RequestFactory()
|
factory = RequestFactory()
|
||||||
|
@ -46,12 +47,21 @@ if django_filters:
|
||||||
filter_class = MisconfiguredFilter
|
filter_class = MisconfiguredFilter
|
||||||
filter_backend = filters.DjangoFilterBackend
|
filter_backend = filters.DjangoFilterBackend
|
||||||
|
|
||||||
|
class FilterClassDetailView(generics.RetrieveAPIView):
|
||||||
|
model = FilterableItem
|
||||||
|
filter_class = SeveralFieldsFilter
|
||||||
|
filter_backend = filters.DjangoFilterBackend
|
||||||
|
|
||||||
class IntegrationTestFiltering(TestCase):
|
urlpatterns = patterns('',
|
||||||
"""
|
url(r'^(?P<pk>\d+)/$', FilterClassDetailView.as_view(), name='detail-view'),
|
||||||
Integration tests for filtered list views.
|
url(r'^$', FilterClassRootView.as_view(), name='root-view'),
|
||||||
"""
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class CommonFilteringTestCase(TestCase):
|
||||||
|
def _serialize_object(self, obj):
|
||||||
|
return {'id': obj.id, 'text': obj.text, 'decimal': obj.decimal, 'date': obj.date}
|
||||||
|
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
"""
|
"""
|
||||||
Create 10 FilterableItem instances.
|
Create 10 FilterableItem instances.
|
||||||
|
@ -65,10 +75,16 @@ class IntegrationTestFiltering(TestCase):
|
||||||
|
|
||||||
self.objects = FilterableItem.objects
|
self.objects = FilterableItem.objects
|
||||||
self.data = [
|
self.data = [
|
||||||
{'id': obj.id, 'text': obj.text, 'decimal': obj.decimal, 'date': obj.date.isoformat()}
|
self._serialize_object(obj)
|
||||||
for obj in self.objects.all()
|
for obj in self.objects.all()
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
class IntegrationTestFiltering(CommonFilteringTestCase):
|
||||||
|
"""
|
||||||
|
Integration tests for filtered list views.
|
||||||
|
"""
|
||||||
|
|
||||||
@unittest.skipUnless(django_filters, 'django-filters not installed')
|
@unittest.skipUnless(django_filters, 'django-filters not installed')
|
||||||
def test_get_filtered_fields_root_view(self):
|
def test_get_filtered_fields_root_view(self):
|
||||||
"""
|
"""
|
||||||
|
@ -95,7 +111,7 @@ class IntegrationTestFiltering(TestCase):
|
||||||
request = factory.get('/?date=%s' % search_date) # search_date str: '2012-09-22'
|
request = factory.get('/?date=%s' % search_date) # search_date str: '2012-09-22'
|
||||||
response = view(request).render()
|
response = view(request).render()
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
expected_data = [f for f in self.data if datetime.datetime.strptime(f['date'], '%Y-%m-%d').date() == search_date]
|
expected_data = [f for f in self.data if f['date'] == search_date]
|
||||||
self.assertEqual(response.data, expected_data)
|
self.assertEqual(response.data, expected_data)
|
||||||
|
|
||||||
@unittest.skipUnless(django_filters, 'django-filters not installed')
|
@unittest.skipUnless(django_filters, 'django-filters not installed')
|
||||||
|
@ -125,7 +141,7 @@ class IntegrationTestFiltering(TestCase):
|
||||||
request = factory.get('/?date=%s' % search_date) # search_date str: '2012-10-02'
|
request = factory.get('/?date=%s' % search_date) # search_date str: '2012-10-02'
|
||||||
response = view(request).render()
|
response = view(request).render()
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
expected_data = [f for f in self.data if datetime.datetime.strptime(f['date'], '%Y-%m-%d').date() > search_date]
|
expected_data = [f for f in self.data if f['date'] > search_date]
|
||||||
self.assertEqual(response.data, expected_data)
|
self.assertEqual(response.data, expected_data)
|
||||||
|
|
||||||
# Tests that the text filter set with 'icontains' in the filter class works.
|
# Tests that the text filter set with 'icontains' in the filter class works.
|
||||||
|
@ -142,8 +158,7 @@ class IntegrationTestFiltering(TestCase):
|
||||||
request = factory.get('/?decimal=%s&date=%s' % (search_decimal, search_date))
|
request = factory.get('/?decimal=%s&date=%s' % (search_decimal, search_date))
|
||||||
response = view(request).render()
|
response = view(request).render()
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
expected_data = [f for f in self.data if
|
expected_data = [f for f in self.data if f['date'] > search_date and
|
||||||
datetime.datetime.strptime(f['date'], '%Y-%m-%d').date() > search_date and
|
|
||||||
f['decimal'] < search_decimal]
|
f['decimal'] < search_decimal]
|
||||||
self.assertEqual(response.data, expected_data)
|
self.assertEqual(response.data, expected_data)
|
||||||
|
|
||||||
|
@ -168,3 +183,50 @@ class IntegrationTestFiltering(TestCase):
|
||||||
request = factory.get('/?integer=%s' % search_integer)
|
request = factory.get('/?integer=%s' % search_integer)
|
||||||
response = view(request).render()
|
response = view(request).render()
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
|
|
||||||
|
|
||||||
|
class IntegrationTestDetailFiltering(CommonFilteringTestCase):
|
||||||
|
"""
|
||||||
|
Integration tests for filtered detail views.
|
||||||
|
"""
|
||||||
|
urls = 'rest_framework.tests.filterset'
|
||||||
|
|
||||||
|
def _get_url(self, item):
|
||||||
|
return reverse('detail-view', kwargs=dict(pk=item.pk))
|
||||||
|
|
||||||
|
@unittest.skipUnless(django_filters, 'django-filters not installed')
|
||||||
|
def test_get_filtered_detail_view(self):
|
||||||
|
"""
|
||||||
|
GET requests to filtered RetrieveAPIView that have a filter_class set
|
||||||
|
should return filtered results.
|
||||||
|
"""
|
||||||
|
item = self.objects.all()[0]
|
||||||
|
data = self._serialize_object(item)
|
||||||
|
|
||||||
|
# Basic test with no filter.
|
||||||
|
response = self.client.get(self._get_url(item))
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
|
self.assertEqual(response.data, data)
|
||||||
|
|
||||||
|
# Tests that the decimal filter set that should fail.
|
||||||
|
search_decimal = Decimal('4.25')
|
||||||
|
high_item = self.objects.filter(decimal__gt=search_decimal)[0]
|
||||||
|
response = self.client.get('{url}?decimal={param}'.format(url=self._get_url(high_item), param=search_decimal))
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
|
||||||
|
|
||||||
|
# Tests that the decimal filter set that should succeed.
|
||||||
|
search_decimal = Decimal('4.25')
|
||||||
|
low_item = self.objects.filter(decimal__lt=search_decimal)[0]
|
||||||
|
low_item_data = self._serialize_object(low_item)
|
||||||
|
response = self.client.get('{url}?decimal={param}'.format(url=self._get_url(low_item), param=search_decimal))
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
|
self.assertEqual(response.data, low_item_data)
|
||||||
|
|
||||||
|
# Tests that multiple filters works.
|
||||||
|
search_decimal = Decimal('5.25')
|
||||||
|
search_date = datetime.date(2012, 10, 2)
|
||||||
|
valid_item = self.objects.filter(decimal__lt=search_decimal, date__gt=search_date)[0]
|
||||||
|
valid_item_data = self._serialize_object(valid_item)
|
||||||
|
response = self.client.get('{url}?decimal={decimal}&date={date}'.format(url=self._get_url(valid_item), decimal=search_decimal, date=search_date))
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
|
self.assertEqual(response.data, valid_item_data)
|
||||||
|
|
|
@ -102,7 +102,7 @@ class IntegrationTestPaginationAndFiltering(TestCase):
|
||||||
|
|
||||||
self.objects = FilterableItem.objects
|
self.objects = FilterableItem.objects
|
||||||
self.data = [
|
self.data = [
|
||||||
{'id': obj.id, 'text': obj.text, 'decimal': obj.decimal, 'date': obj.date.isoformat()}
|
{'id': obj.id, 'text': obj.text, 'decimal': obj.decimal, 'date': obj.date}
|
||||||
for obj in self.objects.all()
|
for obj in self.objects.all()
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -129,16 +129,6 @@ class IntegrationTestPaginationAndFiltering(TestCase):
|
||||||
view = FilterFieldsRootView.as_view()
|
view = FilterFieldsRootView.as_view()
|
||||||
|
|
||||||
EXPECTED_NUM_QUERIES = 2
|
EXPECTED_NUM_QUERIES = 2
|
||||||
if django.VERSION < (1, 4):
|
|
||||||
# On Django 1.3 we need to use django-filter 0.5.4
|
|
||||||
#
|
|
||||||
# The filter objects there don't expose a `.count()` method,
|
|
||||||
# which means we only make a single query *but* it's a single
|
|
||||||
# query across *all* of the queryset, instead of a COUNT and then
|
|
||||||
# a SELECT with a LIMIT.
|
|
||||||
#
|
|
||||||
# Although this is fewer queries, it's actually a regression.
|
|
||||||
EXPECTED_NUM_QUERIES = 1
|
|
||||||
|
|
||||||
request = factory.get('/?decimal=15.20')
|
request = factory.get('/?decimal=15.20')
|
||||||
with self.assertNumQueries(EXPECTED_NUM_QUERIES):
|
with self.assertNumQueries(EXPECTED_NUM_QUERIES):
|
||||||
|
|
|
@ -112,7 +112,7 @@ class BasicTests(TestCase):
|
||||||
self.expected = {
|
self.expected = {
|
||||||
'email': 'tom@example.com',
|
'email': 'tom@example.com',
|
||||||
'content': 'Happy new year!',
|
'content': 'Happy new year!',
|
||||||
'created': '2012-01-01T00:00:00',
|
'created': datetime.datetime(2012, 1, 1),
|
||||||
'sub_comment': 'And Merry Christmas!'
|
'sub_comment': 'And Merry Christmas!'
|
||||||
}
|
}
|
||||||
self.person_data = {'name': 'dwight', 'age': 35}
|
self.person_data = {'name': 'dwight', 'age': 35}
|
||||||
|
@ -261,34 +261,6 @@ class ValidationTests(TestCase):
|
||||||
self.assertEqual(serializer.is_valid(), True)
|
self.assertEqual(serializer.is_valid(), True)
|
||||||
self.assertEqual(serializer.errors, {})
|
self.assertEqual(serializer.errors, {})
|
||||||
|
|
||||||
def test_bad_type_data_is_false(self):
|
|
||||||
"""
|
|
||||||
Data of the wrong type is not valid.
|
|
||||||
"""
|
|
||||||
data = ['i am', 'a', 'list']
|
|
||||||
serializer = CommentSerializer(self.comment, data=data, many=True)
|
|
||||||
self.assertEqual(serializer.is_valid(), False)
|
|
||||||
self.assertTrue(isinstance(serializer.errors, list))
|
|
||||||
|
|
||||||
self.assertEqual(
|
|
||||||
serializer.errors,
|
|
||||||
[
|
|
||||||
{'non_field_errors': ['Invalid data']},
|
|
||||||
{'non_field_errors': ['Invalid data']},
|
|
||||||
{'non_field_errors': ['Invalid data']}
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
data = 'and i am a string'
|
|
||||||
serializer = CommentSerializer(self.comment, data=data)
|
|
||||||
self.assertEqual(serializer.is_valid(), False)
|
|
||||||
self.assertEqual(serializer.errors, {'non_field_errors': ['Invalid data']})
|
|
||||||
|
|
||||||
data = 42
|
|
||||||
serializer = CommentSerializer(self.comment, data=data)
|
|
||||||
self.assertEqual(serializer.is_valid(), False)
|
|
||||||
self.assertEqual(serializer.errors, {'non_field_errors': ['Invalid data']})
|
|
||||||
|
|
||||||
def test_cross_field_validation(self):
|
def test_cross_field_validation(self):
|
||||||
|
|
||||||
class CommentSerializerWithCrossFieldValidator(CommentSerializer):
|
class CommentSerializerWithCrossFieldValidator(CommentSerializer):
|
||||||
|
|
278
rest_framework/tests/serializer_bulk_update.py
Normal file
278
rest_framework/tests/serializer_bulk_update.py
Normal file
|
@ -0,0 +1,278 @@
|
||||||
|
"""
|
||||||
|
Tests to cover bulk create and update using serializers.
|
||||||
|
"""
|
||||||
|
from __future__ import unicode_literals
|
||||||
|
from django.test import TestCase
|
||||||
|
from rest_framework import serializers
|
||||||
|
|
||||||
|
|
||||||
|
class BulkCreateSerializerTests(TestCase):
|
||||||
|
"""
|
||||||
|
Creating multiple instances using serializers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
class BookSerializer(serializers.Serializer):
|
||||||
|
id = serializers.IntegerField()
|
||||||
|
title = serializers.CharField(max_length=100)
|
||||||
|
author = serializers.CharField(max_length=100)
|
||||||
|
|
||||||
|
self.BookSerializer = BookSerializer
|
||||||
|
|
||||||
|
def test_bulk_create_success(self):
|
||||||
|
"""
|
||||||
|
Correct bulk update serialization should return the input data.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}, {
|
||||||
|
'id': 1,
|
||||||
|
'title': 'If this is a man',
|
||||||
|
'author': 'Primo Levi'
|
||||||
|
}, {
|
||||||
|
'id': 2,
|
||||||
|
'title': 'The wind-up bird chronicle',
|
||||||
|
'author': 'Haruki Murakami'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
serializer = self.BookSerializer(data=data, many=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), True)
|
||||||
|
self.assertEqual(serializer.object, data)
|
||||||
|
|
||||||
|
def test_bulk_create_errors(self):
|
||||||
|
"""
|
||||||
|
Correct bulk update serialization should return the input data.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}, {
|
||||||
|
'id': 1,
|
||||||
|
'title': 'If this is a man',
|
||||||
|
'author': 'Primo Levi'
|
||||||
|
}, {
|
||||||
|
'id': 'foo',
|
||||||
|
'title': 'The wind-up bird chronicle',
|
||||||
|
'author': 'Haruki Murakami'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
expected_errors = [
|
||||||
|
{},
|
||||||
|
{},
|
||||||
|
{'id': ['Enter a whole number.']}
|
||||||
|
]
|
||||||
|
|
||||||
|
serializer = self.BookSerializer(data=data, many=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
||||||
|
|
||||||
|
def test_invalid_list_datatype(self):
|
||||||
|
"""
|
||||||
|
Data containing list of incorrect data type should return errors.
|
||||||
|
"""
|
||||||
|
data = ['foo', 'bar', 'baz']
|
||||||
|
serializer = self.BookSerializer(data=data, many=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
|
||||||
|
expected_errors = [
|
||||||
|
{'non_field_errors': ['Invalid data']},
|
||||||
|
{'non_field_errors': ['Invalid data']},
|
||||||
|
{'non_field_errors': ['Invalid data']}
|
||||||
|
]
|
||||||
|
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
||||||
|
|
||||||
|
def test_invalid_single_datatype(self):
|
||||||
|
"""
|
||||||
|
Data containing a single incorrect data type should return errors.
|
||||||
|
"""
|
||||||
|
data = 123
|
||||||
|
serializer = self.BookSerializer(data=data, many=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
|
||||||
|
expected_errors = {'non_field_errors': ['Expected a list of items.']}
|
||||||
|
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
||||||
|
|
||||||
|
def test_invalid_single_object(self):
|
||||||
|
"""
|
||||||
|
Data containing only a single object, instead of a list of objects
|
||||||
|
should return errors.
|
||||||
|
"""
|
||||||
|
data = {
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}
|
||||||
|
serializer = self.BookSerializer(data=data, many=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
|
||||||
|
expected_errors = {'non_field_errors': ['Expected a list of items.']}
|
||||||
|
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
||||||
|
|
||||||
|
|
||||||
|
class BulkUpdateSerializerTests(TestCase):
|
||||||
|
"""
|
||||||
|
Updating multiple instances using serializers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
class Book(object):
|
||||||
|
"""
|
||||||
|
A data type that can be persisted to a mock storage backend
|
||||||
|
with `.save()` and `.delete()`.
|
||||||
|
"""
|
||||||
|
object_map = {}
|
||||||
|
|
||||||
|
def __init__(self, id, title, author):
|
||||||
|
self.id = id
|
||||||
|
self.title = title
|
||||||
|
self.author = author
|
||||||
|
|
||||||
|
def save(self):
|
||||||
|
Book.object_map[self.id] = self
|
||||||
|
|
||||||
|
def delete(self):
|
||||||
|
del Book.object_map[self.id]
|
||||||
|
|
||||||
|
class BookSerializer(serializers.Serializer):
|
||||||
|
id = serializers.IntegerField()
|
||||||
|
title = serializers.CharField(max_length=100)
|
||||||
|
author = serializers.CharField(max_length=100)
|
||||||
|
|
||||||
|
def restore_object(self, attrs, instance=None):
|
||||||
|
if instance:
|
||||||
|
instance.id = attrs['id']
|
||||||
|
instance.title = attrs['title']
|
||||||
|
instance.author = attrs['author']
|
||||||
|
return instance
|
||||||
|
return Book(**attrs)
|
||||||
|
|
||||||
|
self.Book = Book
|
||||||
|
self.BookSerializer = BookSerializer
|
||||||
|
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}, {
|
||||||
|
'id': 1,
|
||||||
|
'title': 'If this is a man',
|
||||||
|
'author': 'Primo Levi'
|
||||||
|
}, {
|
||||||
|
'id': 2,
|
||||||
|
'title': 'The wind-up bird chronicle',
|
||||||
|
'author': 'Haruki Murakami'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
for item in data:
|
||||||
|
book = Book(item['id'], item['title'], item['author'])
|
||||||
|
book.save()
|
||||||
|
|
||||||
|
def books(self):
|
||||||
|
"""
|
||||||
|
Return all the objects in the mock storage backend.
|
||||||
|
"""
|
||||||
|
return self.Book.object_map.values()
|
||||||
|
|
||||||
|
def test_bulk_update_success(self):
|
||||||
|
"""
|
||||||
|
Correct bulk update serialization should return the input data.
|
||||||
|
"""
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}, {
|
||||||
|
'id': 2,
|
||||||
|
'title': 'Kafka on the shore',
|
||||||
|
'author': 'Haruki Murakami'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
serializer = self.BookSerializer(self.books(), data=data, many=True, allow_add_remove=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), True)
|
||||||
|
self.assertEqual(serializer.data, data)
|
||||||
|
serializer.save()
|
||||||
|
new_data = self.BookSerializer(self.books(), many=True).data
|
||||||
|
|
||||||
|
self.assertEqual(data, new_data)
|
||||||
|
|
||||||
|
def test_bulk_update_and_create(self):
|
||||||
|
"""
|
||||||
|
Bulk update serialization may also include created items.
|
||||||
|
"""
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}, {
|
||||||
|
'id': 3,
|
||||||
|
'title': 'Kafka on the shore',
|
||||||
|
'author': 'Haruki Murakami'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
serializer = self.BookSerializer(self.books(), data=data, many=True, allow_add_remove=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), True)
|
||||||
|
self.assertEqual(serializer.data, data)
|
||||||
|
serializer.save()
|
||||||
|
new_data = self.BookSerializer(self.books(), many=True).data
|
||||||
|
self.assertEqual(data, new_data)
|
||||||
|
|
||||||
|
def test_bulk_update_invalid_create(self):
|
||||||
|
"""
|
||||||
|
Bulk update serialization without allow_add_remove may not create items.
|
||||||
|
"""
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}, {
|
||||||
|
'id': 3,
|
||||||
|
'title': 'Kafka on the shore',
|
||||||
|
'author': 'Haruki Murakami'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
expected_errors = [
|
||||||
|
{},
|
||||||
|
{'non_field_errors': ['Cannot create a new item, only existing items may be updated.']}
|
||||||
|
]
|
||||||
|
serializer = self.BookSerializer(self.books(), data=data, many=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
||||||
|
|
||||||
|
def test_bulk_update_error(self):
|
||||||
|
"""
|
||||||
|
Incorrect bulk update serialization should return error data.
|
||||||
|
"""
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'id': 0,
|
||||||
|
'title': 'The electric kool-aid acid test',
|
||||||
|
'author': 'Tom Wolfe'
|
||||||
|
}, {
|
||||||
|
'id': 'foo',
|
||||||
|
'title': 'Kafka on the shore',
|
||||||
|
'author': 'Haruki Murakami'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
expected_errors = [
|
||||||
|
{},
|
||||||
|
{'id': ['Enter a whole number.']}
|
||||||
|
]
|
||||||
|
serializer = self.BookSerializer(self.books(), data=data, many=True, allow_add_remove=True)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
246
rest_framework/tests/serializer_nested.py
Normal file
246
rest_framework/tests/serializer_nested.py
Normal file
|
@ -0,0 +1,246 @@
|
||||||
|
"""
|
||||||
|
Tests to cover nested serializers.
|
||||||
|
|
||||||
|
Doesn't cover model serializers.
|
||||||
|
"""
|
||||||
|
from __future__ import unicode_literals
|
||||||
|
from django.test import TestCase
|
||||||
|
from rest_framework import serializers
|
||||||
|
|
||||||
|
|
||||||
|
class WritableNestedSerializerBasicTests(TestCase):
|
||||||
|
"""
|
||||||
|
Tests for deserializing nested entities.
|
||||||
|
Basic tests that use serializers that simply restore to dicts.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
class TrackSerializer(serializers.Serializer):
|
||||||
|
order = serializers.IntegerField()
|
||||||
|
title = serializers.CharField(max_length=100)
|
||||||
|
duration = serializers.IntegerField()
|
||||||
|
|
||||||
|
class AlbumSerializer(serializers.Serializer):
|
||||||
|
album_name = serializers.CharField(max_length=100)
|
||||||
|
artist = serializers.CharField(max_length=100)
|
||||||
|
tracks = TrackSerializer(many=True)
|
||||||
|
|
||||||
|
self.AlbumSerializer = AlbumSerializer
|
||||||
|
|
||||||
|
def test_nested_validation_success(self):
|
||||||
|
"""
|
||||||
|
Correct nested serialization should return the input data.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = {
|
||||||
|
'album_name': 'Discovery',
|
||||||
|
'artist': 'Daft Punk',
|
||||||
|
'tracks': [
|
||||||
|
{'order': 1, 'title': 'One More Time', 'duration': 235},
|
||||||
|
{'order': 2, 'title': 'Aerodynamic', 'duration': 184},
|
||||||
|
{'order': 3, 'title': 'Digital Love', 'duration': 239}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
serializer = self.AlbumSerializer(data=data)
|
||||||
|
self.assertEqual(serializer.is_valid(), True)
|
||||||
|
self.assertEqual(serializer.object, data)
|
||||||
|
|
||||||
|
def test_nested_validation_error(self):
|
||||||
|
"""
|
||||||
|
Incorrect nested serialization should return appropriate error data.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = {
|
||||||
|
'album_name': 'Discovery',
|
||||||
|
'artist': 'Daft Punk',
|
||||||
|
'tracks': [
|
||||||
|
{'order': 1, 'title': 'One More Time', 'duration': 235},
|
||||||
|
{'order': 2, 'title': 'Aerodynamic', 'duration': 184},
|
||||||
|
{'order': 3, 'title': 'Digital Love', 'duration': 'foobar'}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
expected_errors = {
|
||||||
|
'tracks': [
|
||||||
|
{},
|
||||||
|
{},
|
||||||
|
{'duration': ['Enter a whole number.']}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
serializer = self.AlbumSerializer(data=data)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
||||||
|
|
||||||
|
def test_many_nested_validation_error(self):
|
||||||
|
"""
|
||||||
|
Incorrect nested serialization should return appropriate error data
|
||||||
|
when multiple entities are being deserialized.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'album_name': 'Russian Red',
|
||||||
|
'artist': 'I Love Your Glasses',
|
||||||
|
'tracks': [
|
||||||
|
{'order': 1, 'title': 'Cigarettes', 'duration': 121},
|
||||||
|
{'order': 2, 'title': 'No Past Land', 'duration': 198},
|
||||||
|
{'order': 3, 'title': 'They Don\'t Believe', 'duration': 191}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'album_name': 'Discovery',
|
||||||
|
'artist': 'Daft Punk',
|
||||||
|
'tracks': [
|
||||||
|
{'order': 1, 'title': 'One More Time', 'duration': 235},
|
||||||
|
{'order': 2, 'title': 'Aerodynamic', 'duration': 184},
|
||||||
|
{'order': 3, 'title': 'Digital Love', 'duration': 'foobar'}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
expected_errors = [
|
||||||
|
{},
|
||||||
|
{
|
||||||
|
'tracks': [
|
||||||
|
{},
|
||||||
|
{},
|
||||||
|
{'duration': ['Enter a whole number.']}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
serializer = self.AlbumSerializer(data=data)
|
||||||
|
self.assertEqual(serializer.is_valid(), False)
|
||||||
|
self.assertEqual(serializer.errors, expected_errors)
|
||||||
|
|
||||||
|
|
||||||
|
class WritableNestedSerializerObjectTests(TestCase):
|
||||||
|
"""
|
||||||
|
Tests for deserializing nested entities.
|
||||||
|
These tests use serializers that restore to concrete objects.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
# Couple of concrete objects that we're going to deserialize into
|
||||||
|
class Track(object):
|
||||||
|
def __init__(self, order, title, duration):
|
||||||
|
self.order, self.title, self.duration = order, title, duration
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
return (
|
||||||
|
self.order == other.order and
|
||||||
|
self.title == other.title and
|
||||||
|
self.duration == other.duration
|
||||||
|
)
|
||||||
|
|
||||||
|
class Album(object):
|
||||||
|
def __init__(self, album_name, artist, tracks):
|
||||||
|
self.album_name, self.artist, self.tracks = album_name, artist, tracks
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
return (
|
||||||
|
self.album_name == other.album_name and
|
||||||
|
self.artist == other.artist and
|
||||||
|
self.tracks == other.tracks
|
||||||
|
)
|
||||||
|
|
||||||
|
# And their corresponding serializers
|
||||||
|
class TrackSerializer(serializers.Serializer):
|
||||||
|
order = serializers.IntegerField()
|
||||||
|
title = serializers.CharField(max_length=100)
|
||||||
|
duration = serializers.IntegerField()
|
||||||
|
|
||||||
|
def restore_object(self, attrs, instance=None):
|
||||||
|
return Track(attrs['order'], attrs['title'], attrs['duration'])
|
||||||
|
|
||||||
|
class AlbumSerializer(serializers.Serializer):
|
||||||
|
album_name = serializers.CharField(max_length=100)
|
||||||
|
artist = serializers.CharField(max_length=100)
|
||||||
|
tracks = TrackSerializer(many=True)
|
||||||
|
|
||||||
|
def restore_object(self, attrs, instance=None):
|
||||||
|
return Album(attrs['album_name'], attrs['artist'], attrs['tracks'])
|
||||||
|
|
||||||
|
self.Album, self.Track = Album, Track
|
||||||
|
self.AlbumSerializer = AlbumSerializer
|
||||||
|
|
||||||
|
def test_nested_validation_success(self):
|
||||||
|
"""
|
||||||
|
Correct nested serialization should return a restored object
|
||||||
|
that corresponds to the input data.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = {
|
||||||
|
'album_name': 'Discovery',
|
||||||
|
'artist': 'Daft Punk',
|
||||||
|
'tracks': [
|
||||||
|
{'order': 1, 'title': 'One More Time', 'duration': 235},
|
||||||
|
{'order': 2, 'title': 'Aerodynamic', 'duration': 184},
|
||||||
|
{'order': 3, 'title': 'Digital Love', 'duration': 239}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
expected_object = self.Album(
|
||||||
|
album_name='Discovery',
|
||||||
|
artist='Daft Punk',
|
||||||
|
tracks=[
|
||||||
|
self.Track(order=1, title='One More Time', duration=235),
|
||||||
|
self.Track(order=2, title='Aerodynamic', duration=184),
|
||||||
|
self.Track(order=3, title='Digital Love', duration=239),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
serializer = self.AlbumSerializer(data=data)
|
||||||
|
self.assertEqual(serializer.is_valid(), True)
|
||||||
|
self.assertEqual(serializer.object, expected_object)
|
||||||
|
|
||||||
|
def test_many_nested_validation_success(self):
|
||||||
|
"""
|
||||||
|
Correct nested serialization should return multiple restored objects
|
||||||
|
that corresponds to the input data when multiple objects are
|
||||||
|
being deserialized.
|
||||||
|
"""
|
||||||
|
|
||||||
|
data = [
|
||||||
|
{
|
||||||
|
'album_name': 'Russian Red',
|
||||||
|
'artist': 'I Love Your Glasses',
|
||||||
|
'tracks': [
|
||||||
|
{'order': 1, 'title': 'Cigarettes', 'duration': 121},
|
||||||
|
{'order': 2, 'title': 'No Past Land', 'duration': 198},
|
||||||
|
{'order': 3, 'title': 'They Don\'t Believe', 'duration': 191}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'album_name': 'Discovery',
|
||||||
|
'artist': 'Daft Punk',
|
||||||
|
'tracks': [
|
||||||
|
{'order': 1, 'title': 'One More Time', 'duration': 235},
|
||||||
|
{'order': 2, 'title': 'Aerodynamic', 'duration': 184},
|
||||||
|
{'order': 3, 'title': 'Digital Love', 'duration': 239}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
expected_object = [
|
||||||
|
self.Album(
|
||||||
|
album_name='Russian Red',
|
||||||
|
artist='I Love Your Glasses',
|
||||||
|
tracks=[
|
||||||
|
self.Track(order=1, title='Cigarettes', duration=121),
|
||||||
|
self.Track(order=2, title='No Past Land', duration=198),
|
||||||
|
self.Track(order=3, title='They Don\'t Believe', duration=191),
|
||||||
|
]
|
||||||
|
),
|
||||||
|
self.Album(
|
||||||
|
album_name='Discovery',
|
||||||
|
artist='Daft Punk',
|
||||||
|
tracks=[
|
||||||
|
self.Track(order=1, title='One More Time', duration=235),
|
||||||
|
self.Track(order=2, title='Aerodynamic', duration=184),
|
||||||
|
self.Track(order=3, title='Digital Love', duration=239),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
serializer = self.AlbumSerializer(data=data)
|
||||||
|
self.assertEqual(serializer.is_valid(), True)
|
||||||
|
self.assertEqual(serializer.object, expected_object)
|
|
@ -1,13 +0,0 @@
|
||||||
"""Tests for the status module"""
|
|
||||||
from __future__ import unicode_literals
|
|
||||||
from django.test import TestCase
|
|
||||||
from rest_framework import status
|
|
||||||
|
|
||||||
|
|
||||||
class TestStatus(TestCase):
|
|
||||||
"""Simple sanity test to check the status module"""
|
|
||||||
|
|
||||||
def test_status(self):
|
|
||||||
"""Ensure the status module is present and correct."""
|
|
||||||
self.assertEqual(200, status.HTTP_200_OK)
|
|
||||||
self.assertEqual(404, status.HTTP_404_NOT_FOUND)
|
|
Loading…
Reference in New Issue
Block a user