mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-24 02:24:03 +03:00
Merge branch 'encode:master' into jsonencoder_ipaddress
This commit is contained in:
Corentin Garcia
GitHub
commit
a4f4dd065b
9
.github/ISSUE_TEMPLATE/1-issue.md
vendored
9
.github/ISSUE_TEMPLATE/1-issue.md
vendored
|
|
@ -5,6 +5,13 @@ about: Please only raise an issue if you've been advised to do so after discussi
|
|||
|
||||
## Checklist
|
||||
|
||||
<!--
|
||||
Note: REST framework is considered feature-complete. New functionality should be implemented outside the core REST framework. For details, please check the docs: https://www.django-rest-framework.org/community/third-party-packages/#about-third-party-packages
|
||||
-->
|
||||
|
||||
- [ ] Raised initially as discussion #...
|
||||
- [ ] This cannot be dealt with as a third party library. (We prefer new functionality to be [in the form of third party libraries](https://www.django-rest-framework.org/community/third-party-packages/#about-third-party-packages) where possible.)
|
||||
- [ ] This is not a feature request suitable for implementation outside this project. Please elaborate what it is:
|
||||
- [ ] compatibility fix for new Django/Python version ...
|
||||
- [ ] other type of bug fix
|
||||
- [ ] other type of improvement that does not touch existing code or change existing behavior (e.g. wrapper for new Django field)
|
||||
- [ ] I have reduced the issue to the simplest possible case.
|
||||
|
|
|
|||
11
.github/workflows/main.yml
vendored
11
.github/workflows/main.yml
vendored
|
|
@ -14,8 +14,6 @@ jobs:
|
|||
strategy:
|
||||
matrix:
|
||||
python-version:
|
||||
- '3.6'
|
||||
- '3.7'
|
||||
- '3.8'
|
||||
- '3.9'
|
||||
- '3.10'
|
||||
|
|
@ -37,18 +35,9 @@ jobs:
|
|||
- name: Install dependencies
|
||||
run: python -m pip install --upgrade codecov tox
|
||||
|
||||
- name: Install tox-py
|
||||
if: ${{ matrix.python-version == '3.6' }}
|
||||
run: python -m pip install --upgrade tox-py
|
||||
|
||||
- name: Run tox targets for ${{ matrix.python-version }}
|
||||
if: ${{ matrix.python-version != '3.6' }}
|
||||
run: tox run -f py$(echo ${{ matrix.python-version }} | tr -d .)
|
||||
|
||||
- name: Run tox targets for ${{ matrix.python-version }}
|
||||
if: ${{ matrix.python-version == '3.6' }}
|
||||
run: tox --py current
|
||||
|
||||
- name: Run extra tox targets
|
||||
if: ${{ matrix.python-version == '3.9' }}
|
||||
run: |
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
*Note*: Before submitting this pull request, please review our [contributing guidelines](https://www.django-rest-framework.org/community/contributing/#pull-requests).
|
||||
*Note*: Before submitting a code change, please review our [contributing guidelines](https://www.django-rest-framework.org/community/contributing/#pull-requests).
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
15
README.md
15
README.md
|
|
@ -28,8 +28,9 @@ The initial aim is to provide a single full-time position on REST framework.
|
|||
[![][cryptapi-img]][cryptapi-url]
|
||||
[![][fezto-img]][fezto-url]
|
||||
[![][svix-img]][svix-url]
|
||||
[![][zuplo-img]][zuplo-url]
|
||||
|
||||
Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry][sentry-url], [Stream][stream-url], [Spacinov][spacinov-url], [Retool][retool-url], [bit.io][bitio-url], [PostHog][posthog-url], [CryptAPI][cryptapi-url], [FEZTO][fezto-url], and [Svix][svix-url].
|
||||
Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry][sentry-url], [Stream][stream-url], [Spacinov][spacinov-url], [Retool][retool-url], [bit.io][bitio-url], [PostHog][posthog-url], [CryptAPI][cryptapi-url], [FEZTO][fezto-url], [Svix][svix-url], and [Zuplo][zuplo-url].
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -45,8 +46,6 @@ Some reasons you might want to use REST framework:
|
|||
* Customizable all the way down - just use [regular function-based views][functionview-section] if you don't need the [more][generic-views] [powerful][viewsets] [features][routers].
|
||||
* [Extensive documentation][docs], and [great community support][group].
|
||||
|
||||
There is a live example API for testing purposes, [available here][sandbox].
|
||||
|
||||
**Below**: *Screenshot from the browsable API*
|
||||
|
||||
![Screenshot][image]
|
||||
|
|
@ -55,8 +54,8 @@ There is a live example API for testing purposes, [available here][sandbox].
|
|||
|
||||
# Requirements
|
||||
|
||||
* Python 3.6+
|
||||
* Django 5.0, 4.2, 4.1, 4.0, 3.2, 3.1, 3.0
|
||||
* Python 3.8+
|
||||
* Django 5.0, 4.2
|
||||
|
||||
We **highly recommend** and only officially support the latest patch release of
|
||||
each Python and Django series.
|
||||
|
|
@ -174,8 +173,6 @@ Full documentation for the project is available at [https://www.django-rest-fram
|
|||
|
||||
For questions and support, use the [REST framework discussion group][group], or `#restframework` on libera.chat IRC.
|
||||
|
||||
You may also want to [follow the author on Twitter][twitter].
|
||||
|
||||
# Security
|
||||
|
||||
Please see the [security policy][security-policy].
|
||||
|
|
@ -186,9 +183,7 @@ Please see the [security policy][security-policy].
|
|||
[codecov]: https://codecov.io/github/encode/django-rest-framework?branch=master
|
||||
[pypi-version]: https://img.shields.io/pypi/v/djangorestframework.svg
|
||||
[pypi]: https://pypi.org/project/djangorestframework/
|
||||
[twitter]: https://twitter.com/starletdreaming
|
||||
[group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
|
||||
[sandbox]: https://restframework.herokuapp.com/
|
||||
|
||||
[funding]: https://fund.django-rest-framework.org/topics/funding/
|
||||
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
|
||||
|
|
@ -202,6 +197,7 @@ Please see the [security policy][security-policy].
|
|||
[cryptapi-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/cryptapi-readme.png
|
||||
[fezto-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/fezto-readme.png
|
||||
[svix-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/svix-premium.png
|
||||
[zuplo-img]: https://raw.githubusercontent.com/encode/django-rest-framework/master/docs/img/premium/zuplo-readme.png
|
||||
|
||||
[sentry-url]: https://getsentry.com/welcome/
|
||||
[stream-url]: https://getstream.io/?utm_source=DjangoRESTFramework&utm_medium=Webpage_Logo_Ad&utm_content=Developer&utm_campaign=DjangoRESTFramework_Jan2022_HomePage
|
||||
|
|
@ -212,6 +208,7 @@ Please see the [security policy][security-policy].
|
|||
[cryptapi-url]: https://cryptapi.io
|
||||
[fezto-url]: https://www.fezto.xyz/?utm_source=DjangoRESTFramework
|
||||
[svix-url]: https://www.svix.com/?utm_source=django-REST&utm_medium=sponsorship
|
||||
[zuplo-url]: https://zuplo.link/django-gh
|
||||
|
||||
[oauth1-section]: https://www.django-rest-framework.org/api-guide/authentication/#django-rest-framework-oauth
|
||||
[oauth2-section]: https://www.django-rest-framework.org/api-guide/authentication/#django-oauth-toolkit
|
||||
|
|
|
|||
|
|
@ -59,6 +59,29 @@ class PostView(APIView):
|
|||
return Response(content)
|
||||
```
|
||||
|
||||
|
||||
## Using cache with @api_view decorator
|
||||
|
||||
When using @api_view decorator, the Django-provided method-based cache decorators such as [`cache_page`][page],
|
||||
[`vary_on_cookie`][cookie] and [`vary_on_headers`][headers] can be called directly.
|
||||
|
||||
```python
|
||||
from django.views.decorators.cache import cache_page
|
||||
from django.views.decorators.vary import vary_on_cookie
|
||||
|
||||
from rest_framework.decorators import api_view
|
||||
from rest_framework.response import Response
|
||||
|
||||
|
||||
@cache_page(60 * 15)
|
||||
@vary_on_cookie
|
||||
@api_view(["GET"])
|
||||
def get_user_list(request):
|
||||
content = {"user_feed": request.user.get_user_feed()}
|
||||
return Response(content)
|
||||
```
|
||||
|
||||
|
||||
**NOTE:** The [`cache_page`][page] decorator only caches the
|
||||
`GET` and `HEAD` responses with status 200.
|
||||
|
||||
|
|
|
|||
|
|
@ -68,14 +68,6 @@ When serializing the instance, default will be used if the object attribute or d
|
|||
|
||||
Note that setting a `default` value implies that the field is not required. Including both the `default` and `required` keyword arguments is invalid and will raise an error.
|
||||
|
||||
Notes regarding default value propagation from model to serializer:
|
||||
|
||||
All the default values from model will pass as default to the serializer and the options method.
|
||||
|
||||
If the default is callable then it will be propagated to & evaluated every time in the serializer but not in options method.
|
||||
|
||||
If the value for given field is not given then default value will be present in the serializer and available in serializer's methods. Specified validation on given field will be evaluated on default value as that field will be present in the serializer.
|
||||
|
||||
### `allow_null`
|
||||
|
||||
Normally an error will be raised if `None` is passed to a serializer field. Set this keyword argument to `True` if `None` should be considered a valid value.
|
||||
|
|
|
|||
|
|
@ -173,12 +173,11 @@ This permission is suitable if you want to your API to allow read permissions to
|
|||
|
||||
This permission class ties into Django's standard `django.contrib.auth` [model permissions][contribauth]. This permission must only be applied to views that have a `.queryset` property or `get_queryset()` method. Authorization will only be granted if the user *is authenticated* and has the *relevant model permissions* assigned. The appropriate model is determined by checking `get_queryset().model` or `queryset.model`.
|
||||
|
||||
* `GET` requests require the user to have the `view` or `change` permission on the model
|
||||
* `POST` requests require the user to have the `add` permission on the model.
|
||||
* `PUT` and `PATCH` requests require the user to have the `change` permission on the model.
|
||||
* `DELETE` requests require the user to have the `delete` permission on the model.
|
||||
|
||||
The default behaviour can also be overridden to support custom model permissions.
|
||||
The default behavior can also be overridden to support custom model permissions. For example, you might want to include a `view` model permission for `GET` requests.
|
||||
|
||||
To use custom model permissions, override `DjangoModelPermissions` and set the `.perms_map` property. Refer to the source code for details.
|
||||
|
||||
|
|
|
|||
|
|
@ -283,7 +283,7 @@ By default this will include the following keys: `view`, `request`, `response`,
|
|||
|
||||
The following is an example plaintext renderer that will return a response with the `data` parameter as the content of the response.
|
||||
|
||||
from django.utils.encoding import smart_text
|
||||
from django.utils.encoding import smart_str
|
||||
from rest_framework import renderers
|
||||
|
||||
|
||||
|
|
@ -292,7 +292,7 @@ The following is an example plaintext renderer that will return a response with
|
|||
format = 'txt'
|
||||
|
||||
def render(self, data, accepted_media_type=None, renderer_context=None):
|
||||
return smart_text(data, encoding=self.charset)
|
||||
return smart_str(data, encoding=self.charset)
|
||||
|
||||
## Setting the character set
|
||||
|
||||
|
|
|
|||
|
|
@ -56,10 +56,11 @@ The following sections explain more.
|
|||
|
||||
### Install dependencies
|
||||
|
||||
pip install pyyaml uritemplate
|
||||
pip install pyyaml uritemplate inflection
|
||||
|
||||
* `pyyaml` is used to generate schema into YAML-based OpenAPI format.
|
||||
* `uritemplate` is used internally to get parameters in path.
|
||||
* `inflection` is used to pluralize operations more appropriately in the list endpoints.
|
||||
|
||||
### Generating a static schema with the `generateschema` management command
|
||||
|
||||
|
|
|
|||
|
|
@ -845,8 +845,6 @@ Here's an example of how you might choose to implement multiple updates:
|
|||
class Meta:
|
||||
list_serializer_class = BookListSerializer
|
||||
|
||||
It is possible that a third party package may be included alongside the 3.1 release that provides some automatic support for multiple update operations, similar to the `allow_add_remove` behavior that was present in REST framework 2.
|
||||
|
||||
#### Customizing ListSerializer initialization
|
||||
|
||||
When a serializer with `many=True` is instantiated, we need to determine which arguments and keyword arguments should be passed to the `.__init__()` method for both the child `Serializer` class, and for the parent `ListSerializer` class.
|
||||
|
|
|
|||
|
|
@ -31,10 +31,6 @@ The current minimum versions of Django still is 3.0 and Python 3.6.
|
|||
|
||||
`ModelSerializer` generates validators for [UniqueConstraint](https://docs.djangoproject.com/en/4.0/ref/models/constraints/#uniqueconstraint) (both UniqueValidator and UniqueTogetherValidator)
|
||||
|
||||
## ValidationErrors improvements
|
||||
|
||||
The `ValidationError` has been aligned with Django's, currently supporting the same style (signature) and nesting.
|
||||
|
||||
## SimpleRouter non-regex matching support
|
||||
|
||||
By default the URLs created by `SimpleRouter` use regular expressions. This behavior can be modified by setting the `use_regex_path` argument to `False` when instantiating the router.
|
||||
|
|
@ -47,10 +43,6 @@ Dependency on pytz has been removed and deprecation warnings have been added, Dj
|
|||
|
||||
Searches now may contain _quoted phrases_ with spaces, each phrase is considered as a single search term, and it will raise a validation error if any null-character is provided in search. See the [Filtering API guide](../api-guide/filtering.md) for more information.
|
||||
|
||||
## Default values propagation
|
||||
|
||||
Model fields' default values are now propagated to serializer fields, for more information see the [Serializer fields API guide](../api-guide/fields.md#default).
|
||||
|
||||
## Other fixes and improvements
|
||||
|
||||
There are a number of fixes and minor improvements in this release, ranging from documentation, internal infrastructure (typing, testing, requirements, deprecation, etc.), security and overall behaviour.
|
||||
|
|
|
|||
|
|
@ -6,11 +6,9 @@
|
|||
|
||||
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.
|
||||
|
||||
---
|
||||
!!! note
|
||||
|
||||
**Note**: At this point in it's lifespan we consider Django REST framework to be essentially feature-complete. We may accept pull requests that track the continued development of Django versions, but would prefer not to accept new features or code formatting changes.
|
||||
|
||||
---
|
||||
At this point in its lifespan we consider Django REST framework to be feature-complete. We focus on pull requests that track the continued development of Django versions, and generally do not accept new features or code formatting changes.
|
||||
|
||||
## Community
|
||||
|
||||
|
|
@ -36,10 +34,9 @@ Our contribution process is that the [GitHub discussions page](https://github.co
|
|||
|
||||
Some tips on good potential issue reporting:
|
||||
|
||||
* When describing issues try to phrase your ticket in terms of the *behavior* you think needs changing rather than the *code* you think need changing.
|
||||
* Django REST framework is considered feature-complete. Please do not file requests to change behavior, unless it is required for security reasons or to maintain compatibility with upcoming Django or Python versions.
|
||||
* Search the GitHub project page for related items, and make sure you're running the latest version of REST framework before reporting an issue.
|
||||
* Feature requests will often be closed with a recommendation that they be implemented outside of the core REST framework library. Keeping new feature requests implemented as third party libraries allows us to keep down the maintenance overhead of REST framework, so that the focus can be on continued stability, bugfixes, and great documentation. At this point in it's lifespan we consider Django REST framework to be essentially feature-complete.
|
||||
* Closing an issue doesn't necessarily mean the end of a discussion. If you believe your issue has been closed incorrectly, explain why and we'll consider if it needs to be reopened.
|
||||
* Feature requests will typically be closed with a recommendation that they be implemented outside the core REST framework library (e.g. as third-party libraries). This approach allows us to keep down the maintenance overhead of REST framework, so that the focus can be on continued stability and great documentation.
|
||||
|
||||
## Triaging issues
|
||||
|
||||
|
|
@ -48,8 +45,8 @@ Getting involved in triaging incoming issues is a good way to start contributing
|
|||
* Read through the ticket - does it make sense, is it missing any context that would help explain it better?
|
||||
* Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group?
|
||||
* If the ticket is a bug report, can you reproduce it? Are you able to write a failing test case that demonstrates the issue and that can be submitted as a pull request?
|
||||
* If the ticket is a feature request, do you agree with it, and could the feature request instead be implemented as a third party package?
|
||||
* If a ticket hasn't had much activity and it addresses something you need, then comment on the ticket and try to find out what's needed to get it moving again.
|
||||
* If the ticket is a feature request, could the feature request instead be implemented as a third party package?
|
||||
* If a ticket hasn't had much activity and addresses something you need, then comment on the ticket and try to find out what's needed to get it moving again.
|
||||
|
||||
# Development
|
||||
|
||||
|
|
|
|||
|
|
@ -13,55 +13,13 @@ The aim is to ensure that the project has a high
|
|||
|
||||
## Maintenance team
|
||||
|
||||
We have a quarterly maintenance cycle where new members may join the maintenance team. We currently cap the size of the team at 5 members, and may encourage folks to step out of the team for a cycle to allow new members to participate.
|
||||
[Participating actively in the REST framework project](contributing.md) **does not require being part of the maintenance team**. Almost every important part of issue triage and project improvement can be actively worked on regardless of your collaborator status on the repository.
|
||||
|
||||
#### Current team
|
||||
#### Composition
|
||||
|
||||
The [maintenance team for Q4 2015](https://github.com/encode/django-rest-framework/issues/2190):
|
||||
The composition of the maintenance team is handled by [@tomchristie](https://github.com/encode/). Team members will be added as collaborators to the repository.
|
||||
|
||||
* [@tomchristie](https://github.com/encode/)
|
||||
* [@xordoquy](https://github.com/xordoquy/) (Release manager.)
|
||||
* [@carltongibson](https://github.com/carltongibson/)
|
||||
* [@kevin-brown](https://github.com/kevin-brown/)
|
||||
* [@jpadilla](https://github.com/jpadilla/)
|
||||
|
||||
#### Maintenance cycles
|
||||
|
||||
Each maintenance cycle is initiated by an issue being opened with the `Process` label.
|
||||
|
||||
* To be considered for a maintainer role simply comment against the issue.
|
||||
* Existing members must explicitly opt-in to the next cycle by check-marking their name.
|
||||
* The final decision on the incoming team will be made by `@tomchristie`.
|
||||
|
||||
Members of the maintenance team will be added as collaborators to the repository.
|
||||
|
||||
The following template should be used for the description of the issue, and serves as the formal process for selecting the team.
|
||||
|
||||
This issue is for determining the maintenance team for the *** period.
|
||||
|
||||
Please see the [Project management](https://www.django-rest-framework.org/topics/project-management/) section of our documentation for more details.
|
||||
|
||||
---
|
||||
|
||||
#### Renewing existing members.
|
||||
|
||||
The following people are the current maintenance team. Please checkmark your name if you wish to continue to have write permission on the repository for the *** period.
|
||||
|
||||
- [ ] @***
|
||||
- [ ] @***
|
||||
- [ ] @***
|
||||
- [ ] @***
|
||||
- [ ] @***
|
||||
|
||||
---
|
||||
|
||||
#### New members.
|
||||
|
||||
If you wish to be considered for this or a future date, please comment against this or subsequent issues.
|
||||
|
||||
To modify this process for future maintenance cycles make a pull request to the [project management](https://www.django-rest-framework.org/topics/project-management/) documentation.
|
||||
|
||||
#### Responsibilities of team members
|
||||
#### Responsibilities
|
||||
|
||||
Team members have the following responsibilities.
|
||||
|
||||
|
|
@ -78,16 +36,12 @@ Further notes for maintainers:
|
|||
* Each issue/pull request should have exactly one label once triaged.
|
||||
* Search for un-triaged issues with [is:open no:label][un-triaged].
|
||||
|
||||
It should be noted that participating actively in the REST framework project clearly **does not require being part of the maintenance team**. Almost every import part of issue triage and project improvement can be actively worked on regardless of your collaborator status on the repository.
|
||||
|
||||
---
|
||||
|
||||
## Release process
|
||||
|
||||
The release manager is selected on every quarterly maintenance cycle.
|
||||
|
||||
* The manager should be selected by `@tomchristie`.
|
||||
* The manager will then have the maintainer role added to PyPI package.
|
||||
* The release manager is selected by `@tomchristie`.
|
||||
* The release manager will then have the maintainer role added to PyPI package.
|
||||
* The previous manager will then have the maintainer role removed from the PyPI package.
|
||||
|
||||
Our PyPI releases will be handled by either the current release manager, or by `@tomchristie`. Every release should have an open issue tagged with the `Release` label and marked against the appropriate milestone.
|
||||
|
|
@ -198,8 +152,7 @@ If `@tomchristie` ceases to participate in the project then `@j4mie` has respons
|
|||
|
||||
The following issues still need to be addressed:
|
||||
|
||||
* Ensure `@jamie` has back-up access to the `django-rest-framework.org` domain setup and admin.
|
||||
* Document ownership of the [live example][sandbox] API.
|
||||
* Ensure `@j4mie` has back-up access to the `django-rest-framework.org` domain setup and admin.
|
||||
* Document ownership of the [mailing list][mailing-list] and IRC channel.
|
||||
* Document ownership and management of the security mailing list.
|
||||
|
||||
|
|
@ -208,5 +161,4 @@ The following issues still need to be addressed:
|
|||
[transifex-project]: https://www.transifex.com/projects/p/django-rest-framework/
|
||||
[transifex-client]: https://pypi.org/project/transifex-client/
|
||||
[translation-memory]: http://docs.transifex.com/guides/tm#let-tm-automatically-populate-translations
|
||||
[sandbox]: https://restframework.herokuapp.com/
|
||||
[mailing-list]: https://groups.google.com/forum/#!forum/django-rest-framework
|
||||
|
|
|
|||
|
|
@ -2,11 +2,13 @@
|
|||
|
||||
## Versioning
|
||||
|
||||
Minor version numbers (0.0.x) are used for changes that are API compatible. You should be able to upgrade between minor point releases without any other code changes.
|
||||
- **Minor** version numbers (0.0.x) are used for changes that are API compatible. You should be able to upgrade between minor point releases without any other code changes.
|
||||
|
||||
Medium version numbers (0.x.0) may include API changes, in line with the [deprecation policy][deprecation-policy]. You should read the release notes carefully before upgrading between medium point releases.
|
||||
- **Medium** version numbers (0.x.0) may include API changes, in line with the [deprecation policy][deprecation-policy]. You should read the release notes carefully before upgrading between medium point releases.
|
||||
|
||||
Major version numbers (x.0.0) are reserved for substantial project milestones.
|
||||
- **Major** version numbers (x.0.0) are reserved for substantial project milestones.
|
||||
|
||||
As REST Framework is considered feature-complete, most releases are expected to be minor releases.
|
||||
|
||||
## Deprecation policy
|
||||
|
||||
|
|
@ -36,12 +38,29 @@ You can determine your currently installed version using `pip show`:
|
|||
|
||||
## 3.15.x series
|
||||
|
||||
### 3.15.2
|
||||
|
||||
**Date**: 14th June 2024
|
||||
|
||||
* Fix potential XSS vulnerability in browsable API. [#9435](https://github.com/encode/django-rest-framework/pull/9435)
|
||||
* Revert "Ensure CursorPagination respects nulls in the ordering field". [#9381](https://github.com/encode/django-rest-framework/pull/9381)
|
||||
* Use warnings rather than logging a warning for DecimalField. [#9367](https://github.com/encode/django-rest-framework/pull/9367)
|
||||
* Remove unused code. [#9393](https://github.com/encode/django-rest-framework/pull/9393)
|
||||
* Django < 4.2 and Python < 3.8 no longer supported. [#9393](https://github.com/encode/django-rest-framework/pull/9393)
|
||||
|
||||
### 3.15.1
|
||||
|
||||
Date: 22nd March 2024
|
||||
|
||||
* Fix `SearchFilter` handling of quoted and comma separated strings, when `.get_search_terms` is being called into by a custom class. See [[#9338](https://github.com/encode/django-rest-framework/issues/9338)]
|
||||
* Revert number of 3.15.0 issues which included unintended side-effects. See [[#9331](https://github.com/encode/django-rest-framework/issues/9331)]
|
||||
|
||||
### 3.15.0
|
||||
|
||||
Date: 15th March 2024
|
||||
|
||||
* Django 5.0 and Python 3.12 support [[#9157] (https://github.com/encode/django-rest-framework/pull/9157)]
|
||||
* Use POST method instead of GET to perform logout in browsable API [[9208] (https://github.com/encode/django-rest-framework/pull/9208)]
|
||||
* Django 5.0 and Python 3.12 support [[#9157](https://github.com/encode/django-rest-framework/pull/9157)]
|
||||
* Use POST method instead of GET to perform logout in browsable API [[9208](https://github.com/encode/django-rest-framework/pull/9208)]
|
||||
* Added jQuery 3.7.1 support & dropped previous version [[#9094](https://github.com/encode/django-rest-framework/pull/9094)]
|
||||
* Use str as default path converter [[#9066](https://github.com/encode/django-rest-framework/pull/9066)]
|
||||
* Document support for http.HTTPMethod in the @action decorator added in Python 3.11 [[#9067](https://github.com/encode/django-rest-framework/pull/9067)]
|
||||
|
|
@ -92,7 +111,7 @@ Date: 15th March 2024
|
|||
* Use autocomplete widget for user selection in Token admin [[#8534](https://github.com/encode/django-rest-framework/pull/8534)]
|
||||
* Make browsable API compatible with strong CSP [[#8784](https://github.com/encode/django-rest-framework/pull/8784)]
|
||||
* Avoid inline script execution for injecting CSRF token [[#7016](https://github.com/encode/django-rest-framework/pull/7016)]
|
||||
* Mitigate global dependency on inflection #8017 [[#8017](https://github.com/encode/django-rest-framework/pull/8017)] [[#8781](https://github.com/encode/django-rest-framework/pull/8781)]
|
||||
* Mitigate global dependency on inflection [[#8017](https://github.com/encode/django-rest-framework/pull/8017)] [[#8781](https://github.com/encode/django-rest-framework/pull/8781)]
|
||||
* Register Django urls [[#8778](https://github.com/encode/django-rest-framework/pull/8778)]
|
||||
* Implemented Verbose Name Translation for TokenProxy [[#8713](https://github.com/encode/django-rest-framework/pull/8713)]
|
||||
* Properly handle OverflowError in DurationField deserialization [[#8042](https://github.com/encode/django-rest-framework/pull/8042)]
|
||||
|
|
@ -110,7 +129,7 @@ Date: 15th March 2024
|
|||
* Add `__eq__` method for `OperandHolder` class [[#8710](https://github.com/encode/django-rest-framework/pull/8710)]
|
||||
* Avoid importing `django.test` package when not testing [[#8699](https://github.com/encode/django-rest-framework/pull/8699)]
|
||||
* Preserve exception messages for wrapped Django exceptions [[#8051](https://github.com/encode/django-rest-framework/pull/8051)]
|
||||
* Include `examples` and `format` to OpenAPI schema of CursorPagination [[#8687] (https://github.com/encode/django-rest-framework/pull/8687)] [[#8686](https://github.com/encode/django-rest-framework/pull/8686)]
|
||||
* Include `examples` and `format` to OpenAPI schema of CursorPagination [[#8687](https://github.com/encode/django-rest-framework/pull/8687)] [[#8686](https://github.com/encode/django-rest-framework/pull/8686)]
|
||||
* Fix infinite recursion with deepcopy on Request [[#8684](https://github.com/encode/django-rest-framework/pull/8684)]
|
||||
* Refactor: Replace try/except with contextlib.suppress() [[#8676](https://github.com/encode/django-rest-framework/pull/8676)]
|
||||
* Minor fix to SerializeMethodField docstring [[#8629](https://github.com/encode/django-rest-framework/pull/8629)]
|
||||
|
|
|
|||
|
|
@ -46,6 +46,10 @@ Check out a grid detailing all the packages and ecosystem around Django REST Fra
|
|||
|
||||
To submit new content, [open an issue][drf-create-issue] or [create a pull request][drf-create-pr].
|
||||
|
||||
## Async Support
|
||||
|
||||
* [adrf](https://github.com/em1208/adrf) - Async support, provides async Views, ViewSets, and Serializers.
|
||||
|
||||
### Authentication
|
||||
|
||||
* [djangorestframework-digestauth][djangorestframework-digestauth] - Provides Digest Access Authentication support.
|
||||
|
|
@ -125,6 +129,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque
|
|||
|
||||
### Misc
|
||||
|
||||
* [drf-sendables][drf-sendables] - User messages for Django REST Framework
|
||||
* [cookiecutter-django-rest][cookiecutter-django-rest] - A cookiecutter template that takes care of the setup and configuration so you can focus on making your REST apis awesome.
|
||||
* [djangorestrelationalhyperlink][djangorestrelationalhyperlink] - A hyperlinked serializer that can can be used to alter relationships via hyperlinks, but otherwise like a hyperlink model serializer.
|
||||
* [django-rest-framework-proxy][django-rest-framework-proxy] - Proxy to redirect incoming request to another API server.
|
||||
|
|
@ -157,6 +162,7 @@ To submit new content, [open an issue][drf-create-issue] or [create a pull reque
|
|||
* [drf-redesign][drf-redesign] - A project that gives a fresh look to the browse-able API using Bootstrap 5.
|
||||
* [drf-material][drf-material] - A project that gives a sleek and elegant look to the browsable API using Material Design.
|
||||
|
||||
[drf-sendables]: https://github.com/amikrop/drf-sendables
|
||||
[cite]: http://www.software-ecosystems.com/Software_Ecosystems/Ecosystems.html
|
||||
[cookiecutter]: https://github.com/jpadilla/cookiecutter-django-rest-framework
|
||||
[new-repo]: https://github.com/new
|
||||
|
|
|
|||
BIN
docs/img/premium/zuplo-readme.png
Normal file
BIN
docs/img/premium/zuplo-readme.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
|
|
@ -75,10 +75,11 @@ continued development by **[signing up for a paid plan][funding]**.
|
|||
<li><a href="https://cryptapi.io" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/cryptapi.png)">CryptAPI</a></li>
|
||||
<li><a href="https://www.fezto.xyz/?utm_source=DjangoRESTFramework" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/fezto.png)">FEZTO</a></li>
|
||||
<li><a href="https://www.svix.com/?utm_source=django-REST&utm_medium=sponsorship" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/svix.png)">Svix</a></li>
|
||||
<li><a href="https://zuplo.link/django-web" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/zuplo.png)">Zuplo</a></li>
|
||||
</ul>
|
||||
<div style="clear: both; padding-bottom: 20px;"></div>
|
||||
|
||||
*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=DjangoRESTFramework&utm_medium=Webpage_Logo_Ad&utm_content=Developer&utm_campaign=DjangoRESTFramework_Jan2022_HomePage), [Spacinov](https://www.spacinov.com/), [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship), [bit.io](https://bit.io/jobs?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), [PostHog](https://posthog.com?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), [CryptAPI](https://cryptapi.io), [FEZTO](https://www.fezto.xyz/?utm_source=DjangoRESTFramework), and [Svix](https://www.svix.com/?utm_source=django-REST&utm_medium=sponsorship).*
|
||||
*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=DjangoRESTFramework&utm_medium=Webpage_Logo_Ad&utm_content=Developer&utm_campaign=DjangoRESTFramework_Jan2022_HomePage), [Spacinov](https://www.spacinov.com/), [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship), [bit.io](https://bit.io/jobs?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), [PostHog](https://posthog.com?utm_source=DRF&utm_medium=sponsor&utm_campaign=DRF_sponsorship), [CryptAPI](https://cryptapi.io), [FEZTO](https://www.fezto.xyz/?utm_source=DjangoRESTFramework), [Svix](https://www.svix.com/?utm_source=django-REST&utm_medium=sponsorship), , and [Zuplo](https://zuplo.link/django-web).*
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -86,8 +87,8 @@ continued development by **[signing up for a paid plan][funding]**.
|
|||
|
||||
REST framework requires the following:
|
||||
|
||||
* Python (3.6, 3.7, 3.8, 3.9, 3.10, 3.11)
|
||||
* Django (3.0, 3.1, 3.2, 4.0, 4.1, 4.2, 5.0)
|
||||
* Django (4.2, 5.0)
|
||||
* Python (3.8, 3.9, 3.10, 3.11, 3.12)
|
||||
|
||||
We **highly recommend** and only officially support the latest patch release of
|
||||
each Python and Django series.
|
||||
|
|
@ -95,8 +96,8 @@ each Python and Django series.
|
|||
The following packages are optional:
|
||||
|
||||
* [PyYAML][pyyaml], [uritemplate][uriteemplate] (5.1+, 3.0.0+) - Schema generation support.
|
||||
* [Markdown][markdown] (3.0.0+) - Markdown support for the browsable API.
|
||||
* [Pygments][pygments] (2.4.0+) - Add syntax highlighting to Markdown processing.
|
||||
* [Markdown][markdown] (3.3.0+) - Markdown support for the browsable API.
|
||||
* [Pygments][pygments] (2.7.0+) - Add syntax highlighting to Markdown processing.
|
||||
* [django-filter][django-filter] (1.0.1+) - Filtering support.
|
||||
* [django-guardian][django-guardian] (1.1.1+) - Object level permissions support.
|
||||
|
||||
|
|
@ -184,7 +185,7 @@ Can't wait to get started? The [quickstart guide][quickstart] is the fastest way
|
|||
## Development
|
||||
|
||||
See the [Contribution guidelines][contributing] for information on how to clone
|
||||
the repository, run the test suite and contribute changes back to REST
|
||||
the repository, run the test suite and help maintain the code base of REST
|
||||
Framework.
|
||||
|
||||
## Support
|
||||
|
|
@ -247,7 +248,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|||
[serializer-section]: api-guide/serializers#serializers
|
||||
[modelserializer-section]: api-guide/serializers#modelserializer
|
||||
[functionview-section]: api-guide/views#function-based-views
|
||||
[sandbox]: https://restframework.herokuapp.com/
|
||||
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
|
||||
|
||||
[quickstart]: tutorial/quickstart.md
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ The tutorial is fairly in-depth, so you should probably get a cookie and a cup o
|
|||
|
||||
---
|
||||
|
||||
**Note**: The code for this tutorial is available in the [encode/rest-framework-tutorial][repo] repository on GitHub. The completed implementation is also online as a sandbox version for testing, [available here][sandbox].
|
||||
**Note**: The code for this tutorial is available in the [encode/rest-framework-tutorial][repo] repository on GitHub. Feel free to clone the repository and see the code in action.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -150,7 +150,7 @@ At this point we've translated the model instance into Python native datatypes.
|
|||
|
||||
content = JSONRenderer().render(serializer.data)
|
||||
content
|
||||
# b'{"id": 2, "title": "", "code": "print(\\"hello, world\\")\\n", "linenos": false, "language": "python", "style": "friendly"}'
|
||||
# b'{"id":2,"title":"","code":"print(\\"hello, world\\")\\n","linenos":false,"language":"python","style":"friendly"}'
|
||||
|
||||
Deserialization is similar. First we parse a stream into Python native datatypes...
|
||||
|
||||
|
|
@ -165,7 +165,7 @@ Deserialization is similar. First we parse a stream into Python native datatype
|
|||
serializer.is_valid()
|
||||
# True
|
||||
serializer.validated_data
|
||||
# OrderedDict([('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
|
||||
# {'title': '', 'code': 'print("hello, world")', 'linenos': False, 'language': 'python', 'style': 'friendly'}
|
||||
serializer.save()
|
||||
# <Snippet: Snippet object>
|
||||
|
||||
|
|
@ -175,7 +175,7 @@ We can also serialize querysets instead of model instances. To do so we simply
|
|||
|
||||
serializer = SnippetSerializer(Snippet.objects.all(), many=True)
|
||||
serializer.data
|
||||
# [OrderedDict([('id', 1), ('title', ''), ('code', 'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', ''), ('code', 'print("hello, world")'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]
|
||||
# [{'id': 1, 'title': '', 'code': 'foo = "bar"\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}, {'id': 2, 'title': '', 'code': 'print("hello, world")\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}, {'id': 3, 'title': '', 'code': 'print("hello, world")', 'linenos': False, 'language': 'python', 'style': 'friendly'}]
|
||||
|
||||
## Using ModelSerializers
|
||||
|
||||
|
|
@ -307,7 +307,7 @@ Quit out of the shell...
|
|||
Validating models...
|
||||
|
||||
0 errors found
|
||||
Django version 4.0, using settings 'tutorial.settings'
|
||||
Django version 5.0, using settings 'tutorial.settings'
|
||||
Starting Development server at http://127.0.0.1:8000/
|
||||
Quit the server with CONTROL-C.
|
||||
|
||||
|
|
@ -321,42 +321,50 @@ You can install httpie using pip:
|
|||
|
||||
Finally, we can get a list of all of the snippets:
|
||||
|
||||
http http://127.0.0.1:8000/snippets/
|
||||
http http://127.0.0.1:8000/snippets/ --unsorted
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
...
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"title": "",
|
||||
"code": "foo = \"bar\"\n",
|
||||
"linenos": false,
|
||||
"language": "python",
|
||||
"style": "friendly"
|
||||
},
|
||||
{
|
||||
{
|
||||
"id": 1,
|
||||
"title": "",
|
||||
"code": "foo = \"bar\"\n",
|
||||
"linenos": false,
|
||||
"language": "python",
|
||||
"style": "friendly"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"title": "",
|
||||
"code": "print(\"hello, world\")\n",
|
||||
"linenos": false,
|
||||
"language": "python",
|
||||
"style": "friendly"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"title": "",
|
||||
"code": "print(\"hello, world\")",
|
||||
"linenos": false,
|
||||
"language": "python",
|
||||
"style": "friendly"
|
||||
}
|
||||
]
|
||||
|
||||
Or we can get a particular snippet by referencing its id:
|
||||
|
||||
http http://127.0.0.1:8000/snippets/2/ --unsorted
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
...
|
||||
{
|
||||
"id": 2,
|
||||
"title": "",
|
||||
"code": "print(\"hello, world\")\n",
|
||||
"linenos": false,
|
||||
"language": "python",
|
||||
"style": "friendly"
|
||||
}
|
||||
]
|
||||
|
||||
Or we can get a particular snippet by referencing its id:
|
||||
|
||||
http http://127.0.0.1:8000/snippets/2/
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
...
|
||||
{
|
||||
"id": 2,
|
||||
"title": "",
|
||||
"code": "print(\"hello, world\")\n",
|
||||
"linenos": false,
|
||||
"language": "python",
|
||||
"style": "friendly"
|
||||
}
|
||||
|
||||
Similarly, you can have the same json displayed by visiting these URLs in a web browser.
|
||||
|
|
@ -371,7 +379,6 @@ We'll see how we can start to improve things in [part 2 of the tutorial][tut-2].
|
|||
|
||||
[quickstart]: quickstart.md
|
||||
[repo]: https://github.com/encode/rest-framework-tutorial
|
||||
[sandbox]: https://restframework.herokuapp.com/
|
||||
[venv]: https://docs.python.org/3/library/venv.html
|
||||
[tut-2]: 2-requests-and-responses.md
|
||||
[httpie]: https://github.com/httpie/httpie#installation
|
||||
|
|
|
|||
|
|
@ -15,7 +15,6 @@ Create a new Django project named `tutorial`, then start a new app called `quick
|
|||
source env/bin/activate # On Windows use `env\Scripts\activate`
|
||||
|
||||
# Install Django and Django REST framework into the virtual environment
|
||||
pip install django
|
||||
pip install djangorestframework
|
||||
|
||||
# Set up a new project with a single application
|
||||
|
|
|
|||
|
|
@ -439,3 +439,17 @@ ul.sponsor {
|
|||
display: inline-block !important;
|
||||
}
|
||||
|
||||
/* admonition */
|
||||
.admonition {
|
||||
border: .075rem solid #448aff;
|
||||
border-radius: .2rem;
|
||||
margin: 1.5625em 0;
|
||||
padding: 0 .6rem;
|
||||
}
|
||||
.admonition-title {
|
||||
background: #448aff1a;
|
||||
font-weight: 700;
|
||||
margin: 0 -.6rem 1em;
|
||||
padding: 0.4rem 0.6rem;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ theme:
|
|||
custom_dir: docs_theme
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- toc:
|
||||
anchorlink: True
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
# MkDocs to build our documentation.
|
||||
mkdocs==1.2.4
|
||||
jinja2>=2.10,<3.1.0 # contextfilter has been renamed
|
||||
mkdocs==1.6.0
|
||||
|
||||
# pylinkvalidator to check for broken links in documentation.
|
||||
pylinkvalidator==0.3
|
||||
|
|
|
|||
|
|
@ -6,5 +6,5 @@ django-guardian>=2.4.0,<2.5
|
|||
inflection==0.5.1
|
||||
markdown>=3.3.7
|
||||
psycopg2-binary>=2.9.5,<2.10
|
||||
pygments>=2.12.0,<2.14.0
|
||||
pygments~=2.17.0
|
||||
pyyaml>=5.3.1,<5.4
|
||||
|
|
|
|||
|
|
@ -7,10 +7,8 @@ ______ _____ _____ _____ __
|
|||
\_| \_\____/\____/ \_/ |_| |_| \__,_|_| |_| |_|\___| \_/\_/ \___/|_| |_|\_|
|
||||
"""
|
||||
|
||||
import django
|
||||
|
||||
__title__ = 'Django REST framework'
|
||||
__version__ = '3.15.0'
|
||||
__version__ = '3.15.2'
|
||||
__author__ = 'Tom Christie'
|
||||
__license__ = 'BSD 3-Clause'
|
||||
__copyright__ = 'Copyright 2011-2023 Encode OSS Ltd'
|
||||
|
|
@ -25,11 +23,7 @@ HTTP_HEADER_ENCODING = 'iso-8859-1'
|
|||
ISO_8601 = 'iso-8601'
|
||||
|
||||
|
||||
if django.VERSION < (3, 2):
|
||||
default_app_config = 'rest_framework.apps.RestFrameworkConfig'
|
||||
|
||||
|
||||
class RemovedInDRF315Warning(DeprecationWarning):
|
||||
class RemovedInDRF316Warning(DeprecationWarning):
|
||||
pass
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
import django
|
||||
|
||||
if django.VERSION < (3, 2):
|
||||
default_app_config = 'rest_framework.authtoken.apps.AuthTokenConfig'
|
||||
|
|
@ -28,7 +28,6 @@ class TokenAdmin(admin.ModelAdmin):
|
|||
search_help_text = _('Username')
|
||||
ordering = ('-created',)
|
||||
actions = None # Actions not compatible with mapped IDs.
|
||||
autocomplete_fields = ("user",)
|
||||
|
||||
def get_changelist(self, request, **kwargs):
|
||||
return TokenChangeList
|
||||
|
|
|
|||
|
|
@ -46,6 +46,12 @@ try:
|
|||
except ImportError:
|
||||
yaml = None
|
||||
|
||||
# inflection is optional
|
||||
try:
|
||||
import inflection
|
||||
except ImportError:
|
||||
inflection = None
|
||||
|
||||
|
||||
# requests is optional
|
||||
try:
|
||||
|
|
@ -145,30 +151,6 @@ else:
|
|||
return False
|
||||
|
||||
|
||||
if django.VERSION >= (4, 2):
|
||||
# Django 4.2+: use the stock parse_header_parameters function
|
||||
# Note: Django 4.1 also has an implementation of parse_header_parameters
|
||||
# which is slightly different from the one in 4.2, it needs
|
||||
# the compatibility shim as well.
|
||||
from django.utils.http import parse_header_parameters
|
||||
else:
|
||||
# Django <= 4.1: create a compatibility shim for parse_header_parameters
|
||||
from django.http.multipartparser import parse_header
|
||||
|
||||
def parse_header_parameters(line):
|
||||
# parse_header works with bytes, but parse_header_parameters
|
||||
# works with strings. Call encode to convert the line to bytes.
|
||||
main_value_pair, params = parse_header(line.encode())
|
||||
return main_value_pair, {
|
||||
# parse_header will convert *some* values to string.
|
||||
# parse_header_parameters converts *all* values to string.
|
||||
# Make sure all values are converted by calling decode on
|
||||
# any remaining non-string values.
|
||||
k: v if isinstance(v, str) else v.decode()
|
||||
for k, v in params.items()
|
||||
}
|
||||
|
||||
|
||||
if django.VERSION >= (5, 1):
|
||||
# Django 5.1+: use the stock ip_address_validators function
|
||||
# Note: Before Django 5.1, ip_address_validators returns a tuple containing
|
||||
|
|
|
|||
|
|
@ -144,30 +144,17 @@ class ValidationError(APIException):
|
|||
status_code = status.HTTP_400_BAD_REQUEST
|
||||
default_detail = _('Invalid input.')
|
||||
default_code = 'invalid'
|
||||
default_params = {}
|
||||
|
||||
def __init__(self, detail=None, code=None, params=None):
|
||||
def __init__(self, detail=None, code=None):
|
||||
if detail is None:
|
||||
detail = self.default_detail
|
||||
if code is None:
|
||||
code = self.default_code
|
||||
if params is None:
|
||||
params = self.default_params
|
||||
|
||||
# For validation failures, we may collect many errors together,
|
||||
# so the details should always be coerced to a list if not already.
|
||||
if isinstance(detail, str):
|
||||
detail = [detail % params]
|
||||
elif isinstance(detail, ValidationError):
|
||||
detail = detail.detail
|
||||
elif isinstance(detail, (list, tuple)):
|
||||
final_detail = []
|
||||
for detail_item in detail:
|
||||
if isinstance(detail_item, ValidationError):
|
||||
final_detail += detail_item.detail
|
||||
else:
|
||||
final_detail += [detail_item % params if isinstance(detail_item, str) else detail_item]
|
||||
detail = final_detail
|
||||
if isinstance(detail, tuple):
|
||||
detail = list(detail)
|
||||
elif not isinstance(detail, dict) and not isinstance(detail, list):
|
||||
detail = [detail]
|
||||
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@ import datetime
|
|||
import decimal
|
||||
import functools
|
||||
import inspect
|
||||
import logging
|
||||
import re
|
||||
import uuid
|
||||
import warnings
|
||||
from collections.abc import Mapping
|
||||
from enum import Enum
|
||||
|
||||
|
|
@ -44,8 +44,6 @@ from rest_framework.utils.formatting import lazy_format
|
|||
from rest_framework.utils.timezone import valid_datetime
|
||||
from rest_framework.validators import ProhibitSurrogateCharactersValidator
|
||||
|
||||
logger = logging.getLogger("rest_framework.fields")
|
||||
|
||||
|
||||
class empty:
|
||||
"""
|
||||
|
|
@ -989,9 +987,9 @@ class DecimalField(Field):
|
|||
self.min_value = min_value
|
||||
|
||||
if self.max_value is not None and not isinstance(self.max_value, decimal.Decimal):
|
||||
logger.warning("max_value in DecimalField should be Decimal type.")
|
||||
warnings.warn("max_value should be a Decimal instance.")
|
||||
if self.min_value is not None and not isinstance(self.min_value, decimal.Decimal):
|
||||
logger.warning("min_value in DecimalField should be Decimal type.")
|
||||
warnings.warn("min_value should be a Decimal instance.")
|
||||
|
||||
if self.max_digits is not None and self.decimal_places is not None:
|
||||
self.max_whole_digits = self.max_digits - self.decimal_places
|
||||
|
|
|
|||
|
|
@ -21,18 +21,20 @@ from rest_framework.settings import api_settings
|
|||
|
||||
|
||||
def search_smart_split(search_terms):
|
||||
"""generator that first splits string by spaces, leaving quoted phrases together,
|
||||
then it splits non-quoted phrases by commas.
|
||||
"""
|
||||
"""Returns sanitized search terms as a list."""
|
||||
split_terms = []
|
||||
for term in smart_split(search_terms):
|
||||
# trim commas to avoid bad matching for quoted phrases
|
||||
term = term.strip(',')
|
||||
if term.startswith(('"', "'")) and term[0] == term[-1]:
|
||||
# quoted phrases are kept together without any other split
|
||||
yield unescape_string_literal(term)
|
||||
split_terms.append(unescape_string_literal(term))
|
||||
else:
|
||||
# non-quoted tokens are split by comma, keeping only non-empty ones
|
||||
yield from (sub_term.strip() for sub_term in term.split(',') if sub_term)
|
||||
for sub_term in term.split(','):
|
||||
if sub_term:
|
||||
split_terms.append(sub_term.strip())
|
||||
return split_terms
|
||||
|
||||
|
||||
class BaseFilterBackend:
|
||||
|
|
@ -85,7 +87,8 @@ class SearchFilter(BaseFilterBackend):
|
|||
"""
|
||||
value = request.query_params.get(self.search_param, '')
|
||||
field = CharField(trim_whitespace=False, allow_blank=True)
|
||||
return field.run_validation(value)
|
||||
cleaned_value = field.run_validation(value)
|
||||
return search_smart_split(cleaned_value)
|
||||
|
||||
def construct_search(self, field_name, queryset):
|
||||
lookup = self.lookup_prefixes.get(field_name[0])
|
||||
|
|
@ -111,10 +114,6 @@ class SearchFilter(BaseFilterBackend):
|
|||
if hasattr(field, "path_infos"):
|
||||
# Update opts to follow the relation.
|
||||
opts = field.path_infos[-1].to_opts
|
||||
# django < 4.1
|
||||
elif hasattr(field, 'get_path_info'):
|
||||
# Update opts to follow the relation.
|
||||
opts = field.get_path_info()[-1].to_opts
|
||||
# Otherwise, use the field with icontains.
|
||||
lookup = 'icontains'
|
||||
return LOOKUP_SEP.join([field_name, lookup])
|
||||
|
|
@ -163,7 +162,7 @@ class SearchFilter(BaseFilterBackend):
|
|||
reduce(
|
||||
operator.or_,
|
||||
(models.Q(**{orm_lookup: term}) for orm_lookup in orm_lookups)
|
||||
) for term in search_smart_split(search_terms)
|
||||
) for term in search_terms
|
||||
)
|
||||
queryset = queryset.filter(reduce(operator.and_, conditions))
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ from django.http import Http404
|
|||
from django.utils.encoding import force_str
|
||||
|
||||
from rest_framework import exceptions, serializers
|
||||
from rest_framework.fields import empty
|
||||
from rest_framework.request import clone_request
|
||||
from rest_framework.utils.field_mapping import ClassLookupDict
|
||||
|
||||
|
|
@ -150,7 +149,4 @@ class SimpleMetadata(BaseMetadata):
|
|||
for choice_value, choice_name in field.choices.items()
|
||||
]
|
||||
|
||||
if getattr(field, 'default', None) and field.default != empty and not callable(field.default):
|
||||
field_info['default'] = field.default
|
||||
|
||||
return field_info
|
||||
|
|
|
|||
|
|
@ -4,8 +4,6 @@ Basic building blocks for generic class based views.
|
|||
We don't bind behaviour to http method handlers yet,
|
||||
which allows mixin classes to be composed in interesting ways.
|
||||
"""
|
||||
from django.db.models.query import prefetch_related_objects
|
||||
|
||||
from rest_framework import status
|
||||
from rest_framework.response import Response
|
||||
from rest_framework.settings import api_settings
|
||||
|
|
@ -69,13 +67,10 @@ class UpdateModelMixin:
|
|||
serializer.is_valid(raise_exception=True)
|
||||
self.perform_update(serializer)
|
||||
|
||||
queryset = self.filter_queryset(self.get_queryset())
|
||||
if queryset._prefetch_related_lookups:
|
||||
if getattr(instance, '_prefetched_objects_cache', None):
|
||||
# If 'prefetch_related' has been applied to a queryset, we need to
|
||||
# forcibly invalidate the prefetch cache on the instance,
|
||||
# and then re-prefetch related objects
|
||||
# forcibly invalidate the prefetch cache on the instance.
|
||||
instance._prefetched_objects_cache = {}
|
||||
prefetch_related_objects([instance], *queryset._prefetch_related_lookups)
|
||||
|
||||
return Response(serializer.data)
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ from urllib import parse
|
|||
|
||||
from django.core.paginator import InvalidPage
|
||||
from django.core.paginator import Paginator as DjangoPaginator
|
||||
from django.db.models import Q
|
||||
from django.template import loader
|
||||
from django.utils.encoding import force_str
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
|
|
@ -631,7 +630,7 @@ class CursorPagination(BasePagination):
|
|||
queryset = queryset.order_by(*self.ordering)
|
||||
|
||||
# If we have a cursor with a fixed position then filter by that.
|
||||
if str(current_position) != 'None':
|
||||
if current_position is not None:
|
||||
order = self.ordering[0]
|
||||
is_reversed = order.startswith('-')
|
||||
order_attr = order.lstrip('-')
|
||||
|
|
@ -642,12 +641,7 @@ class CursorPagination(BasePagination):
|
|||
else:
|
||||
kwargs = {order_attr + '__gt': current_position}
|
||||
|
||||
filter_query = Q(**kwargs)
|
||||
# If some records contain a null for the ordering field, don't lose them.
|
||||
# When reverse ordering, nulls will come last and need to be included.
|
||||
if (reverse and not is_reversed) or is_reversed:
|
||||
filter_query |= Q(**{order_attr + '__isnull': True})
|
||||
queryset = queryset.filter(filter_query)
|
||||
queryset = queryset.filter(**kwargs)
|
||||
|
||||
# If we have an offset cursor then offset the entire page by that amount.
|
||||
# We also always fetch an extra item in order to determine if there is a
|
||||
|
|
@ -720,7 +714,7 @@ class CursorPagination(BasePagination):
|
|||
# The item in this position and the item following it
|
||||
# have different positions. We can use this position as
|
||||
# our marker.
|
||||
has_item_with_unique_position = position is not None
|
||||
has_item_with_unique_position = True
|
||||
break
|
||||
|
||||
# The item in this position has the same position as the item
|
||||
|
|
@ -773,7 +767,7 @@ class CursorPagination(BasePagination):
|
|||
# The item in this position and the item following it
|
||||
# have different positions. We can use this position as
|
||||
# our marker.
|
||||
has_item_with_unique_position = position is not None
|
||||
has_item_with_unique_position = True
|
||||
break
|
||||
|
||||
# The item in this position has the same position as the item
|
||||
|
|
@ -896,7 +890,7 @@ class CursorPagination(BasePagination):
|
|||
attr = instance[field_name]
|
||||
else:
|
||||
attr = getattr(instance, field_name)
|
||||
return None if attr is None else str(attr)
|
||||
return str(attr)
|
||||
|
||||
def get_paginated_response(self, data):
|
||||
return Response({
|
||||
|
|
|
|||
|
|
@ -15,9 +15,9 @@ from django.http.multipartparser import ChunkIter
|
|||
from django.http.multipartparser import \
|
||||
MultiPartParser as DjangoMultiPartParser
|
||||
from django.http.multipartparser import MultiPartParserError
|
||||
from django.utils.http import parse_header_parameters
|
||||
|
||||
from rest_framework import renderers
|
||||
from rest_framework.compat import parse_header_parameters
|
||||
from rest_framework.exceptions import ParseError
|
||||
from rest_framework.settings import api_settings
|
||||
from rest_framework.utils import json
|
||||
|
|
|
|||
|
|
@ -54,6 +54,9 @@ class OperandHolder(OperationHolderMixin):
|
|||
self.op2_class == other.op2_class
|
||||
)
|
||||
|
||||
def __hash__(self):
|
||||
return hash((self.operator_class, self.op1_class, self.op2_class))
|
||||
|
||||
|
||||
class AND:
|
||||
def __init__(self, op1, op2):
|
||||
|
|
@ -186,9 +189,9 @@ class DjangoModelPermissions(BasePermission):
|
|||
# Override this if you need to also provide 'view' permissions,
|
||||
# or if you want to provide custom permission codes.
|
||||
perms_map = {
|
||||
'GET': ['%(app_label)s.view_%(model_name)s'],
|
||||
'GET': [],
|
||||
'OPTIONS': [],
|
||||
'HEAD': ['%(app_label)s.view_%(model_name)s'],
|
||||
'HEAD': [],
|
||||
'POST': ['%(app_label)s.add_%(model_name)s'],
|
||||
'PUT': ['%(app_label)s.change_%(model_name)s'],
|
||||
'PATCH': ['%(app_label)s.change_%(model_name)s'],
|
||||
|
|
@ -239,13 +242,8 @@ class DjangoModelPermissions(BasePermission):
|
|||
|
||||
queryset = self._queryset(view)
|
||||
perms = self.get_required_permissions(request.method, queryset.model)
|
||||
change_perm = self.get_required_permissions('PUT', queryset.model)
|
||||
|
||||
user = request.user
|
||||
if request.method == 'GET':
|
||||
return user.has_perms(perms) or user.has_perms(change_perm)
|
||||
|
||||
return user.has_perms(perms)
|
||||
return request.user.has_perms(perms)
|
||||
|
||||
|
||||
class DjangoModelPermissionsOrAnonReadOnly(DjangoModelPermissions):
|
||||
|
|
|
|||
|
|
@ -19,12 +19,13 @@ from django.core.paginator import Page
|
|||
from django.template import engines, loader
|
||||
from django.urls import NoReverseMatch
|
||||
from django.utils.html import mark_safe
|
||||
from django.utils.http import parse_header_parameters
|
||||
from django.utils.safestring import SafeString
|
||||
|
||||
from rest_framework import VERSION, exceptions, serializers, status
|
||||
from rest_framework.compat import (
|
||||
INDENT_SEPARATORS, LONG_SEPARATORS, SHORT_SEPARATORS, coreapi, coreschema,
|
||||
parse_header_parameters, pygments_css, yaml
|
||||
pygments_css, yaml
|
||||
)
|
||||
from rest_framework.exceptions import ParseError
|
||||
from rest_framework.request import is_form_media_type, override_method
|
||||
|
|
|
|||
|
|
@ -16,9 +16,9 @@ from django.conf import settings
|
|||
from django.http import HttpRequest, QueryDict
|
||||
from django.http.request import RawPostDataException
|
||||
from django.utils.datastructures import MultiValueDict
|
||||
from django.utils.http import parse_header_parameters
|
||||
|
||||
from rest_framework import exceptions
|
||||
from rest_framework.compat import parse_header_parameters
|
||||
from rest_framework.settings import api_settings
|
||||
|
||||
|
||||
|
|
@ -422,13 +422,6 @@ class Request:
|
|||
except AttributeError:
|
||||
return self.__getattribute__(attr)
|
||||
|
||||
@property
|
||||
def DATA(self):
|
||||
raise NotImplementedError(
|
||||
'`request.DATA` has been deprecated in favor of `request.data` '
|
||||
'since version 3.0, and has been fully removed as of version 3.2.'
|
||||
)
|
||||
|
||||
@property
|
||||
def POST(self):
|
||||
# Ensure that request.POST uses our request parsing.
|
||||
|
|
@ -447,13 +440,6 @@ class Request:
|
|||
self._load_data_and_files()
|
||||
return self._files
|
||||
|
||||
@property
|
||||
def QUERY_PARAMS(self):
|
||||
raise NotImplementedError(
|
||||
'`request.QUERY_PARAMS` has been deprecated in favor of `request.query_params` '
|
||||
'since version 3.0, and has been fully removed as of version 3.2.'
|
||||
)
|
||||
|
||||
def force_plaintext_errors(self, value):
|
||||
# Hack to allow our exception handler to force choice of
|
||||
# plaintext or html error responses.
|
||||
|
|
|
|||
|
|
@ -12,9 +12,9 @@ from django.db import models
|
|||
from django.utils.encoding import force_str
|
||||
|
||||
from rest_framework import (
|
||||
RemovedInDRF315Warning, exceptions, renderers, serializers
|
||||
RemovedInDRF316Warning, exceptions, renderers, serializers
|
||||
)
|
||||
from rest_framework.compat import uritemplate
|
||||
from rest_framework.compat import inflection, uritemplate
|
||||
from rest_framework.fields import _UnvalidatedField, empty
|
||||
from rest_framework.settings import api_settings
|
||||
|
||||
|
|
@ -247,9 +247,8 @@ class AutoSchema(ViewInspector):
|
|||
name = name[:-len(action)]
|
||||
|
||||
if action == 'list':
|
||||
from inflection import pluralize
|
||||
|
||||
name = pluralize(name)
|
||||
assert inflection, '`inflection` must be installed for OpenAPI schema support.'
|
||||
name = inflection.pluralize(name)
|
||||
|
||||
return name
|
||||
|
||||
|
|
@ -726,7 +725,7 @@ class AutoSchema(ViewInspector):
|
|||
def _get_reference(self, serializer):
|
||||
warnings.warn(
|
||||
"Method `_get_reference()` has been renamed to `get_reference()`. "
|
||||
"The old name will be removed in DRF v3.15.",
|
||||
RemovedInDRF315Warning, stacklevel=2
|
||||
"The old name will be removed in DRF v3.16.",
|
||||
RemovedInDRF316Warning, stacklevel=2
|
||||
)
|
||||
return self.get_reference(serializer)
|
||||
|
|
|
|||
|
|
@ -322,5 +322,5 @@ def break_long_headers(header):
|
|||
when possible (are comma separated)
|
||||
"""
|
||||
if len(header) > 160 and ',' in header:
|
||||
header = mark_safe('<br> ' + ', <br>'.join(header.split(',')))
|
||||
header = mark_safe('<br> ' + ', <br>'.join(escape(header).split(',')))
|
||||
return header
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
import io
|
||||
from importlib import import_module
|
||||
|
||||
import django
|
||||
from django.conf import settings
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
from django.core.handlers.wsgi import WSGIHandler
|
||||
|
|
@ -394,19 +393,7 @@ class URLPatternsTestCase(testcases.SimpleTestCase):
|
|||
|
||||
cls._override.enable()
|
||||
|
||||
if django.VERSION > (4, 0):
|
||||
cls.addClassCleanup(cls._override.disable)
|
||||
cls.addClassCleanup(cleanup_url_patterns, cls)
|
||||
cls.addClassCleanup(cls._override.disable)
|
||||
cls.addClassCleanup(cleanup_url_patterns, cls)
|
||||
|
||||
super().setUpClass()
|
||||
|
||||
if django.VERSION < (4, 0):
|
||||
@classmethod
|
||||
def tearDownClass(cls):
|
||||
super().tearDownClass()
|
||||
cls._override.disable()
|
||||
|
||||
if hasattr(cls, '_module_urlpatterns'):
|
||||
cls._module.urlpatterns = cls._module_urlpatterns
|
||||
else:
|
||||
del cls._module.urlpatterns
|
||||
|
|
|
|||
|
|
@ -9,7 +9,6 @@ from django.db import models
|
|||
from django.utils.text import capfirst
|
||||
|
||||
from rest_framework.compat import postgres_fields
|
||||
from rest_framework.fields import empty
|
||||
from rest_framework.validators import UniqueValidator
|
||||
|
||||
NUMERIC_FIELD_TYPES = (
|
||||
|
|
@ -128,9 +127,6 @@ def get_field_kwargs(field_name, model_field):
|
|||
kwargs['read_only'] = True
|
||||
return kwargs
|
||||
|
||||
if model_field.default is not None and model_field.default != empty and not callable(model_field.default):
|
||||
kwargs['default'] = model_field.default
|
||||
|
||||
if model_field.has_default() or model_field.blank or model_field.null:
|
||||
kwargs['required'] = False
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ Handling of media types, as found in HTTP Content-Type and Accept headers.
|
|||
|
||||
See https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
|
||||
"""
|
||||
from rest_framework.compat import parse_header_parameters
|
||||
from django.utils.http import parse_header_parameters
|
||||
|
||||
|
||||
def media_type_matches(lhs, rhs):
|
||||
|
|
|
|||
|
|
@ -119,16 +119,15 @@ class NamespaceVersioning(BaseVersioning):
|
|||
|
||||
def determine_version(self, request, *args, **kwargs):
|
||||
resolver_match = getattr(request, 'resolver_match', None)
|
||||
if resolver_match is not None and resolver_match.namespace:
|
||||
# Allow for possibly nested namespaces.
|
||||
possible_versions = resolver_match.namespace.split(':')
|
||||
for version in possible_versions:
|
||||
if self.is_allowed_version(version):
|
||||
return version
|
||||
if resolver_match is None or not resolver_match.namespace:
|
||||
return self.default_version
|
||||
|
||||
if not self.is_allowed_version(self.default_version):
|
||||
raise exceptions.NotFound(self.invalid_version_message)
|
||||
return self.default_version
|
||||
# Allow for possibly nested namespaces.
|
||||
possible_versions = resolver_match.namespace.split(':')
|
||||
for version in possible_versions:
|
||||
if self.is_allowed_version(version):
|
||||
return version
|
||||
raise exceptions.NotFound(self.invalid_version_message)
|
||||
|
||||
def reverse(self, viewname, args=None, kwargs=None, request=None, format=None, **extra):
|
||||
if request.version is not None:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ license_files = LICENSE.md
|
|||
|
||||
[tool:pytest]
|
||||
addopts=--tb=short --strict-markers -ra
|
||||
testspath = tests
|
||||
testpaths = tests
|
||||
filterwarnings = ignore:CoreAPI compatibility is deprecated*:rest_framework.RemovedInDRF317Warning
|
||||
|
||||
[flake8]
|
||||
|
|
|
|||
14
setup.py
14
setup.py
|
|
@ -1,4 +1,3 @@
|
|||
#!/usr/bin/env python3
|
||||
import os
|
||||
import re
|
||||
import shutil
|
||||
|
|
@ -8,7 +7,7 @@ from io import open
|
|||
from setuptools import find_packages, setup
|
||||
|
||||
CURRENT_PYTHON = sys.version_info[:2]
|
||||
REQUIRED_PYTHON = (3, 6)
|
||||
REQUIRED_PYTHON = (3, 8)
|
||||
|
||||
# This check and everything above must remain compatible with Python 2.7.
|
||||
if CURRENT_PYTHON < REQUIRED_PYTHON:
|
||||
|
|
@ -83,18 +82,13 @@ setup(
|
|||
author_email='tom@tomchristie.com', # SEE NOTE BELOW (*)
|
||||
packages=find_packages(exclude=['tests*']),
|
||||
include_package_data=True,
|
||||
install_requires=["django>=3.0", 'backports.zoneinfo;python_version<"3.9"'],
|
||||
python_requires=">=3.6",
|
||||
install_requires=["django>=4.2", 'backports.zoneinfo;python_version<"3.9"'],
|
||||
python_requires=">=3.8",
|
||||
zip_safe=False,
|
||||
classifiers=[
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'Environment :: Web Environment',
|
||||
'Framework :: Django',
|
||||
'Framework :: Django :: 3.0',
|
||||
'Framework :: Django :: 3.1',
|
||||
'Framework :: Django :: 3.2',
|
||||
'Framework :: Django :: 4.0',
|
||||
'Framework :: Django :: 4.1',
|
||||
'Framework :: Django :: 4.2',
|
||||
'Framework :: Django :: 5.0',
|
||||
'Intended Audience :: Developers',
|
||||
|
|
@ -102,8 +96,6 @@ setup(
|
|||
'Operating System :: OS Independent',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: 3.6',
|
||||
'Programming Language :: Python :: 3.7',
|
||||
'Programming Language :: Python :: 3.8',
|
||||
'Programming Language :: Python :: 3.9',
|
||||
'Programming Language :: Python :: 3.10',
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
import base64
|
||||
|
||||
import django
|
||||
import pytest
|
||||
from django.conf import settings
|
||||
from django.contrib.auth.models import User
|
||||
|
|
@ -235,21 +234,13 @@ class SessionAuthTests(TestCase):
|
|||
Ensure POSTing form over session authentication with CSRF token succeeds.
|
||||
Regression test for #6088
|
||||
"""
|
||||
# Remove this shim when dropping support for Django 3.0.
|
||||
if django.VERSION < (3, 1):
|
||||
from django.middleware.csrf import _get_new_csrf_token
|
||||
else:
|
||||
from django.middleware.csrf import (
|
||||
_get_new_csrf_string, _mask_cipher_secret
|
||||
)
|
||||
|
||||
def _get_new_csrf_token():
|
||||
return _mask_cipher_secret(_get_new_csrf_string())
|
||||
|
||||
self.csrf_client.login(username=self.username, password=self.password)
|
||||
|
||||
# Set the csrf_token cookie so that CsrfViewMiddleware._get_token() works
|
||||
token = _get_new_csrf_token()
|
||||
from django.middleware.csrf import (
|
||||
_get_new_csrf_string, _mask_cipher_secret
|
||||
)
|
||||
token = _mask_cipher_secret(_get_new_csrf_string())
|
||||
self.csrf_client.cookies[settings.CSRF_COOKIE_NAME] = token
|
||||
|
||||
# Post the token matching the cookie value
|
||||
|
|
|
|||
|
|
@ -13,8 +13,6 @@ def pytest_addoption(parser):
|
|||
def pytest_configure(config):
|
||||
from django.conf import settings
|
||||
|
||||
# USE_L10N is deprecated, and will be removed in Django 5.0.
|
||||
use_l10n = {"USE_L10N": True} if django.VERSION < (4, 0) else {}
|
||||
settings.configure(
|
||||
DEBUG_PROPAGATE_EXCEPTIONS=True,
|
||||
DATABASES={
|
||||
|
|
@ -64,7 +62,6 @@ def pytest_configure(config):
|
|||
PASSWORD_HASHERS=(
|
||||
'django.contrib.auth.hashers.MD5PasswordHasher',
|
||||
),
|
||||
**use_l10n,
|
||||
)
|
||||
|
||||
# guardian is optional
|
||||
|
|
@ -87,10 +84,7 @@ def pytest_configure(config):
|
|||
import rest_framework
|
||||
settings.STATIC_ROOT = os.path.join(os.path.dirname(rest_framework.__file__), 'static-root')
|
||||
backend = 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'
|
||||
if django.VERSION < (4, 2):
|
||||
settings.STATICFILES_STORAGE = backend
|
||||
else:
|
||||
settings.STORAGES['staticfiles']['BACKEND'] = backend
|
||||
settings.STORAGES['staticfiles']['BACKEND'] = backend
|
||||
|
||||
django.setup()
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ MARKDOWN_DOCSTRING = """<h2 id="an-example-docstring">an example docstring</h2>
|
|||
</code></pre>
|
||||
<p>indented</p>
|
||||
<h2 id="hash-style-header">hash style header</h2>
|
||||
<div class="highlight"><pre><span></span><span class="p">[{</span><span class="w"></span><br /><span class="w"> </span><span class="nt">"alpha"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span><br /><span class="w"> </span><span class="nt">"beta"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is a string"</span><span class="w"></span><br /><span class="p">}]</span><span class="w"></span><br /></pre></div>
|
||||
<div class="highlight"><pre><span></span><span class="p">[{</span><br /><span class="w"> </span><span class="nt">"alpha"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><br /><span class="w"> </span><span class="nt">"beta"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is a string"</span><br /><span class="p">}]</span><br /></pre></div>
|
||||
<p><br /></p>"""
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ import os
|
|||
import re
|
||||
import sys
|
||||
import uuid
|
||||
import warnings
|
||||
from decimal import ROUND_DOWN, ROUND_UP, Decimal
|
||||
from enum import auto
|
||||
from unittest.mock import patch
|
||||
|
|
@ -1254,15 +1255,19 @@ class TestMinMaxDecimalField(FieldValues):
|
|||
)
|
||||
|
||||
def test_warning_when_not_decimal_types(self, caplog):
|
||||
import logging
|
||||
serializers.DecimalField(
|
||||
max_digits=3, decimal_places=1,
|
||||
min_value=10, max_value=20
|
||||
)
|
||||
assert caplog.record_tuples == [
|
||||
("rest_framework.fields", logging.WARNING, "max_value in DecimalField should be Decimal type."),
|
||||
("rest_framework.fields", logging.WARNING, "min_value in DecimalField should be Decimal type.")
|
||||
]
|
||||
with warnings.catch_warnings(record=True) as w:
|
||||
warnings.simplefilter('always')
|
||||
|
||||
serializers.DecimalField(
|
||||
max_digits=3, decimal_places=1,
|
||||
min_value=10, max_value=20
|
||||
)
|
||||
|
||||
assert len(w) == 2
|
||||
assert all(issubclass(i.category, UserWarning) for i in w)
|
||||
|
||||
assert 'max_value should be a Decimal instance' in str(w[0].message)
|
||||
assert 'min_value should be a Decimal instance' in str(w[1].message)
|
||||
|
||||
|
||||
class TestAllowEmptyStrDecimalFieldWithValidators(FieldValues):
|
||||
|
|
@ -1628,7 +1633,7 @@ class TestCustomTimezoneForDateTimeField(TestCase):
|
|||
assert rendered_date == rendered_date_in_timezone
|
||||
|
||||
|
||||
@pytest.mark.skipif(pytz is None, reason="As Django 4.0 has deprecated pytz, this test should eventually be able to get removed.")
|
||||
@pytest.mark.skipif(pytz is None, reason="Django 5.0 has removed pytz; this test should eventually be able to get removed.")
|
||||
class TestPytzNaiveDayLightSavingTimeTimeZoneDateTimeField(FieldValues):
|
||||
"""
|
||||
Invalid values for `DateTimeField` with datetime in DST shift (non-existing or ambiguous) and timezone with DST.
|
||||
|
|
|
|||
|
|
@ -184,135 +184,6 @@ class TestMetadata:
|
|||
assert response.status_code == status.HTTP_200_OK
|
||||
assert response.data == expected
|
||||
|
||||
def test_actions_with_default(self):
|
||||
"""
|
||||
On generic views OPTIONS should return an 'actions' key with metadata
|
||||
on the fields with default that may be supplied to PUT and POST requests.
|
||||
"""
|
||||
class NestedField(serializers.Serializer):
|
||||
a = serializers.IntegerField(default=2)
|
||||
b = serializers.IntegerField()
|
||||
|
||||
class ExampleSerializer(serializers.Serializer):
|
||||
choice_field = serializers.ChoiceField(['red', 'green', 'blue'], default='red')
|
||||
integer_field = serializers.IntegerField(
|
||||
min_value=1, max_value=1000, default=1
|
||||
)
|
||||
char_field = serializers.CharField(
|
||||
min_length=3, max_length=40, default="example"
|
||||
)
|
||||
list_field = serializers.ListField(
|
||||
child=serializers.ListField(
|
||||
child=serializers.IntegerField(default=1)
|
||||
)
|
||||
)
|
||||
nested_field = NestedField()
|
||||
uuid_field = serializers.UUIDField(label="UUID field")
|
||||
|
||||
class ExampleView(views.APIView):
|
||||
"""Example view."""
|
||||
def post(self, request):
|
||||
pass
|
||||
|
||||
def get_serializer(self):
|
||||
return ExampleSerializer()
|
||||
|
||||
view = ExampleView.as_view()
|
||||
response = view(request=request)
|
||||
expected = {
|
||||
'name': 'Example',
|
||||
'description': 'Example view.',
|
||||
'renders': [
|
||||
'application/json',
|
||||
'text/html'
|
||||
],
|
||||
'parses': [
|
||||
'application/json',
|
||||
'application/x-www-form-urlencoded',
|
||||
'multipart/form-data'
|
||||
],
|
||||
'actions': {
|
||||
'POST': {
|
||||
'choice_field': {
|
||||
'type': 'choice',
|
||||
'required': False,
|
||||
'read_only': False,
|
||||
'label': 'Choice field',
|
||||
"choices": [
|
||||
{'value': 'red', 'display_name': 'red'},
|
||||
{'value': 'green', 'display_name': 'green'},
|
||||
{'value': 'blue', 'display_name': 'blue'}
|
||||
],
|
||||
'default': 'red'
|
||||
},
|
||||
'integer_field': {
|
||||
'type': 'integer',
|
||||
'required': False,
|
||||
'read_only': False,
|
||||
'label': 'Integer field',
|
||||
'min_value': 1,
|
||||
'max_value': 1000,
|
||||
'default': 1
|
||||
},
|
||||
'char_field': {
|
||||
'type': 'string',
|
||||
'required': False,
|
||||
'read_only': False,
|
||||
'label': 'Char field',
|
||||
'min_length': 3,
|
||||
'max_length': 40,
|
||||
'default': 'example'
|
||||
},
|
||||
'list_field': {
|
||||
'type': 'list',
|
||||
'required': True,
|
||||
'read_only': False,
|
||||
'label': 'List field',
|
||||
'child': {
|
||||
'type': 'list',
|
||||
'required': True,
|
||||
'read_only': False,
|
||||
'child': {
|
||||
'type': 'integer',
|
||||
'required': False,
|
||||
'read_only': False,
|
||||
'default': 1
|
||||
}
|
||||
}
|
||||
},
|
||||
'nested_field': {
|
||||
'type': 'nested object',
|
||||
'required': True,
|
||||
'read_only': False,
|
||||
'label': 'Nested field',
|
||||
'children': {
|
||||
'a': {
|
||||
'type': 'integer',
|
||||
'required': False,
|
||||
'read_only': False,
|
||||
'label': 'A',
|
||||
'default': 2
|
||||
},
|
||||
'b': {
|
||||
'type': 'integer',
|
||||
'required': True,
|
||||
'read_only': False,
|
||||
'label': 'B'
|
||||
}
|
||||
}
|
||||
},
|
||||
'uuid_field': {
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
'read_only': False,
|
||||
'label': 'UUID field'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
assert response.data == expected
|
||||
|
||||
def test_global_permissions(self):
|
||||
"""
|
||||
If a user does not have global permissions on an action, then any
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@ import re
|
|||
import sys
|
||||
import tempfile
|
||||
|
||||
import django
|
||||
import pytest
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
from django.core.serializers.json import DjangoJSONEncoder
|
||||
|
|
@ -174,7 +173,7 @@ class TestRegularFieldMappings(TestCase):
|
|||
TestSerializer\(\):
|
||||
auto_field = IntegerField\(read_only=True\)
|
||||
big_integer_field = IntegerField\(.*\)
|
||||
boolean_field = BooleanField\(default=False, required=False\)
|
||||
boolean_field = BooleanField\(required=False\)
|
||||
char_field = CharField\(max_length=100\)
|
||||
comma_separated_integer_field = CharField\(max_length=100, validators=\[<django.core.validators.RegexValidator object>\]\)
|
||||
date_field = DateField\(\)
|
||||
|
|
@ -183,7 +182,7 @@ class TestRegularFieldMappings(TestCase):
|
|||
email_field = EmailField\(max_length=100\)
|
||||
float_field = FloatField\(\)
|
||||
integer_field = IntegerField\(.*\)
|
||||
null_boolean_field = BooleanField\(allow_null=True, default=False, required=False\)
|
||||
null_boolean_field = BooleanField\(allow_null=True, required=False\)
|
||||
positive_integer_field = IntegerField\(.*\)
|
||||
positive_small_integer_field = IntegerField\(.*\)
|
||||
slug_field = SlugField\(allow_unicode=False, max_length=100\)
|
||||
|
|
@ -210,7 +209,7 @@ class TestRegularFieldMappings(TestCase):
|
|||
length_limit_field = CharField\(max_length=12, min_length=3\)
|
||||
blank_field = CharField\(allow_blank=True, max_length=10, required=False\)
|
||||
null_field = IntegerField\(allow_null=True,.*required=False\)
|
||||
default_field = IntegerField\(default=0,.*required=False\)
|
||||
default_field = IntegerField\(.*required=False\)
|
||||
descriptive_field = IntegerField\(help_text='Some help text', label='A label'.*\)
|
||||
choices_field = ChoiceField\(choices=(?:\[|\()\('red', 'Red'\), \('blue', 'Blue'\), \('green', 'Green'\)(?:\]|\))\)
|
||||
text_choices_field = ChoiceField\(choices=(?:\[|\()\('red', 'Red'\), \('blue', 'Blue'\), \('green', 'Green'\)(?:\]|\))\)
|
||||
|
|
@ -453,14 +452,11 @@ class TestPosgresFieldsMapping(TestCase):
|
|||
model = ArrayFieldModel
|
||||
fields = ['array_field', 'array_field_with_blank']
|
||||
|
||||
validators = ""
|
||||
if django.VERSION < (4, 1):
|
||||
validators = ", validators=[<django.core.validators.MaxLengthValidator object>]"
|
||||
expected = dedent("""
|
||||
TestSerializer():
|
||||
array_field = ListField(allow_empty=False, child=CharField(label='Array field'%s))
|
||||
array_field_with_blank = ListField(child=CharField(label='Array field with blank'%s), required=False)
|
||||
""" % (validators, validators))
|
||||
array_field = ListField(allow_empty=False, child=CharField(label='Array field'))
|
||||
array_field_with_blank = ListField(child=CharField(label='Array field with blank'), required=False)
|
||||
""")
|
||||
self.assertEqual(repr(TestSerializer()), expected)
|
||||
|
||||
@pytest.mark.skipif(hasattr(models, 'JSONField'), reason='has models.JSONField')
|
||||
|
|
|
|||
|
|
@ -972,24 +972,17 @@ class TestCursorPagination(CursorPaginationTestsMixin):
|
|||
def __init__(self, items):
|
||||
self.items = items
|
||||
|
||||
def filter(self, q):
|
||||
q_args = dict(q.deconstruct()[1])
|
||||
if not q_args:
|
||||
# django 3.0.x artifact
|
||||
q_args = dict(q.deconstruct()[2])
|
||||
created__gt = q_args.get('created__gt')
|
||||
created__lt = q_args.get('created__lt')
|
||||
|
||||
def filter(self, created__gt=None, created__lt=None):
|
||||
if created__gt is not None:
|
||||
return MockQuerySet([
|
||||
item for item in self.items
|
||||
if item.created is None or item.created > int(created__gt)
|
||||
if item.created > int(created__gt)
|
||||
])
|
||||
|
||||
assert created__lt is not None
|
||||
return MockQuerySet([
|
||||
item for item in self.items
|
||||
if item.created is None or item.created < int(created__lt)
|
||||
if item.created < int(created__lt)
|
||||
])
|
||||
|
||||
def order_by(self, *ordering):
|
||||
|
|
@ -1108,127 +1101,6 @@ class TestCursorPaginationWithValueQueryset(CursorPaginationTestsMixin, TestCase
|
|||
return (previous, current, next, previous_url, next_url)
|
||||
|
||||
|
||||
class NullableCursorPaginationModel(models.Model):
|
||||
created = models.IntegerField(null=True)
|
||||
|
||||
|
||||
class TestCursorPaginationWithNulls(TestCase):
|
||||
"""
|
||||
Unit tests for `pagination.CursorPagination` with ordering on a nullable field.
|
||||
"""
|
||||
|
||||
def setUp(self):
|
||||
class ExamplePagination(pagination.CursorPagination):
|
||||
page_size = 1
|
||||
ordering = 'created'
|
||||
|
||||
self.pagination = ExamplePagination()
|
||||
data = [
|
||||
None, None, 3, 4
|
||||
]
|
||||
for idx in data:
|
||||
NullableCursorPaginationModel.objects.create(created=idx)
|
||||
|
||||
self.queryset = NullableCursorPaginationModel.objects.all()
|
||||
|
||||
get_pages = TestCursorPagination.get_pages
|
||||
|
||||
def test_ascending(self):
|
||||
"""Test paginating one row at a time, current should go 1, 2, 3, 4, 3, 2, 1."""
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages('/')
|
||||
|
||||
assert previous is None
|
||||
assert current == [None]
|
||||
assert next == [None]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(next_url)
|
||||
|
||||
assert previous == [None]
|
||||
assert current == [None]
|
||||
assert next == [3]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(next_url)
|
||||
|
||||
assert previous == [3] # [None] paging artifact documented at https://github.com/ddelange/django-rest-framework/blob/3.14.0/rest_framework/pagination.py#L789
|
||||
assert current == [3]
|
||||
assert next == [4]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(next_url)
|
||||
|
||||
assert previous == [3]
|
||||
assert current == [4]
|
||||
assert next is None
|
||||
assert next_url is None
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
|
||||
assert previous == [None]
|
||||
assert current == [3]
|
||||
assert next == [4]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
|
||||
assert previous == [None]
|
||||
assert current == [None]
|
||||
assert next == [None] # [3] paging artifact documented at https://github.com/ddelange/django-rest-framework/blob/3.14.0/rest_framework/pagination.py#L731
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
|
||||
assert previous is None
|
||||
assert current == [None]
|
||||
assert next == [None]
|
||||
|
||||
def test_descending(self):
|
||||
"""Test paginating one row at a time, current should go 4, 3, 2, 1, 2, 3, 4."""
|
||||
self.pagination.ordering = ('-created',)
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages('/')
|
||||
|
||||
assert previous is None
|
||||
assert current == [4]
|
||||
assert next == [3]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(next_url)
|
||||
|
||||
assert previous == [None] # [4] paging artifact
|
||||
assert current == [3]
|
||||
assert next == [None]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(next_url)
|
||||
|
||||
assert previous == [None] # [3] paging artifact
|
||||
assert current == [None]
|
||||
assert next == [None]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(next_url)
|
||||
|
||||
assert previous == [None]
|
||||
assert current == [None]
|
||||
assert next is None
|
||||
assert next_url is None
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
|
||||
assert previous == [3]
|
||||
assert current == [None]
|
||||
assert next == [None]
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
|
||||
assert previous == [None]
|
||||
assert current == [3]
|
||||
assert next == [3] # [4] paging artifact documented at https://github.com/ddelange/django-rest-framework/blob/3.14.0/rest_framework/pagination.py#L731
|
||||
|
||||
# skip back artifact
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
|
||||
(previous, current, next, previous_url, next_url) = self.get_pages(previous_url)
|
||||
|
||||
assert previous is None
|
||||
assert current == [4]
|
||||
assert next == [3]
|
||||
|
||||
|
||||
def test_get_displayed_page_numbers():
|
||||
"""
|
||||
Test our contextual page display function.
|
||||
|
|
|
|||
|
|
@ -80,8 +80,7 @@ class ModelPermissionsIntegrationTests(TestCase):
|
|||
user.user_permissions.set([
|
||||
Permission.objects.get(codename='add_basicmodel'),
|
||||
Permission.objects.get(codename='change_basicmodel'),
|
||||
Permission.objects.get(codename='delete_basicmodel'),
|
||||
Permission.objects.get(codename='view_basicmodel')
|
||||
Permission.objects.get(codename='delete_basicmodel')
|
||||
])
|
||||
|
||||
user = User.objects.create_user('updateonly', 'updateonly@example.com', 'password')
|
||||
|
|
@ -140,15 +139,6 @@ class ModelPermissionsIntegrationTests(TestCase):
|
|||
response = get_queryset_list_view(request, pk=1)
|
||||
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
|
||||
|
||||
def test_has_get_permissions(self):
|
||||
request = factory.get('/', HTTP_AUTHORIZATION=self.permitted_credentials)
|
||||
response = root_view(request)
|
||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||
|
||||
request = factory.get('/1', HTTP_AUTHORIZATION=self.updateonly_credentials)
|
||||
response = root_view(request, pk=1)
|
||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||
|
||||
def test_has_put_permissions(self):
|
||||
request = factory.put('/1', {'text': 'foobar'}, format='json',
|
||||
HTTP_AUTHORIZATION=self.permitted_credentials)
|
||||
|
|
@ -166,15 +156,6 @@ class ModelPermissionsIntegrationTests(TestCase):
|
|||
response = root_view(request, pk=1)
|
||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||
|
||||
def test_does_not_have_get_permissions(self):
|
||||
request = factory.get('/', HTTP_AUTHORIZATION=self.disallowed_credentials)
|
||||
response = root_view(request)
|
||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||
|
||||
request = factory.get('/1', HTTP_AUTHORIZATION=self.disallowed_credentials)
|
||||
response = root_view(request, pk=1)
|
||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||
|
||||
def test_does_not_have_put_permissions(self):
|
||||
request = factory.put('/1', {'text': 'foobar'}, format='json',
|
||||
HTTP_AUTHORIZATION=self.disallowed_credentials)
|
||||
|
|
@ -735,3 +716,59 @@ class PermissionsCompositionTests(TestCase):
|
|||
composed_perm = (IsAuthenticatedUserOwner | permissions.IsAdminUser)
|
||||
hasperm = composed_perm().has_object_permission(request, None, None)
|
||||
assert hasperm is False
|
||||
|
||||
def test_operand_holder_is_hashable(self):
|
||||
assert hash((permissions.IsAuthenticated & permissions.IsAdminUser))
|
||||
|
||||
def test_operand_holder_hash_same_for_same_operands_and_operator(self):
|
||||
first_operand_holder = (
|
||||
permissions.IsAuthenticated & permissions.IsAdminUser
|
||||
)
|
||||
second_operand_holder = (
|
||||
permissions.IsAuthenticated & permissions.IsAdminUser
|
||||
)
|
||||
|
||||
assert hash(first_operand_holder) == hash(second_operand_holder)
|
||||
|
||||
def test_operand_holder_hash_differs_for_different_operands(self):
|
||||
first_operand_holder = (
|
||||
permissions.IsAuthenticated & permissions.IsAdminUser
|
||||
)
|
||||
second_operand_holder = (
|
||||
permissions.AllowAny & permissions.IsAdminUser
|
||||
)
|
||||
third_operand_holder = (
|
||||
permissions.IsAuthenticated & permissions.AllowAny
|
||||
)
|
||||
|
||||
assert hash(first_operand_holder) != hash(second_operand_holder)
|
||||
assert hash(first_operand_holder) != hash(third_operand_holder)
|
||||
assert hash(second_operand_holder) != hash(third_operand_holder)
|
||||
|
||||
def test_operand_holder_hash_differs_for_different_operators(self):
|
||||
first_operand_holder = (
|
||||
permissions.IsAuthenticated & permissions.IsAdminUser
|
||||
)
|
||||
second_operand_holder = (
|
||||
permissions.IsAuthenticated | permissions.IsAdminUser
|
||||
)
|
||||
|
||||
assert hash(first_operand_holder) != hash(second_operand_holder)
|
||||
|
||||
def test_filtering_permissions(self):
|
||||
unfiltered_permissions = [
|
||||
permissions.IsAuthenticated & permissions.IsAdminUser,
|
||||
permissions.IsAuthenticated & permissions.IsAdminUser,
|
||||
permissions.AllowAny,
|
||||
]
|
||||
expected_permissions = [
|
||||
permissions.IsAuthenticated & permissions.IsAdminUser,
|
||||
permissions.AllowAny,
|
||||
]
|
||||
|
||||
filtered_permissions = [
|
||||
perm for perm
|
||||
in dict.fromkeys(unfiltered_permissions)
|
||||
]
|
||||
|
||||
assert filtered_permissions == expected_permissions
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
from django.contrib.auth.models import Group, User
|
||||
from django.db.models.query import Prefetch
|
||||
from django.test import TestCase
|
||||
|
||||
from rest_framework import generics, serializers
|
||||
|
|
@ -9,84 +8,51 @@ factory = APIRequestFactory()
|
|||
|
||||
|
||||
class UserSerializer(serializers.ModelSerializer):
|
||||
permissions = serializers.SerializerMethodField()
|
||||
|
||||
def get_permissions(self, obj):
|
||||
ret = []
|
||||
for g in obj.groups.all():
|
||||
ret.extend([p.pk for p in g.permissions.all()])
|
||||
return ret
|
||||
|
||||
class Meta:
|
||||
model = User
|
||||
fields = ('id', 'username', 'email', 'groups', 'permissions')
|
||||
fields = ('id', 'username', 'email', 'groups')
|
||||
|
||||
|
||||
class UserRetrieveUpdate(generics.RetrieveUpdateAPIView):
|
||||
queryset = User.objects.exclude(username='exclude').prefetch_related(
|
||||
Prefetch('groups', queryset=Group.objects.exclude(name='exclude')),
|
||||
'groups__permissions',
|
||||
)
|
||||
serializer_class = UserSerializer
|
||||
|
||||
|
||||
class UserUpdateWithoutPrefetchRelated(generics.UpdateAPIView):
|
||||
queryset = User.objects.exclude(username='exclude')
|
||||
class UserUpdate(generics.UpdateAPIView):
|
||||
queryset = User.objects.exclude(username='exclude').prefetch_related('groups')
|
||||
serializer_class = UserSerializer
|
||||
|
||||
|
||||
class TestPrefetchRelatedUpdates(TestCase):
|
||||
def setUp(self):
|
||||
self.user = User.objects.create(username='tom', email='tom@example.com')
|
||||
self.groups = [Group.objects.create(name=f'group {i}') for i in range(10)]
|
||||
self.groups = [Group.objects.create(name='a'), Group.objects.create(name='b')]
|
||||
self.user.groups.set(self.groups)
|
||||
self.user.groups.add(Group.objects.create(name='exclude'))
|
||||
self.expected = {
|
||||
'id': self.user.pk,
|
||||
'username': 'tom',
|
||||
'groups': [group.pk for group in self.groups],
|
||||
'email': 'tom@example.com',
|
||||
'permissions': [],
|
||||
}
|
||||
self.view = UserRetrieveUpdate.as_view()
|
||||
|
||||
def test_prefetch_related_updates(self):
|
||||
self.groups.append(Group.objects.create(name='c'))
|
||||
request = factory.put(
|
||||
'/', {'username': 'new', 'groups': [group.pk for group in self.groups]}, format='json'
|
||||
)
|
||||
self.expected['username'] = 'new'
|
||||
self.expected['groups'] = [group.pk for group in self.groups]
|
||||
response = self.view(request, pk=self.user.pk)
|
||||
assert User.objects.get(pk=self.user.pk).groups.count() == 12
|
||||
assert response.data == self.expected
|
||||
# Update and fetch should get same result
|
||||
request = factory.get('/')
|
||||
response = self.view(request, pk=self.user.pk)
|
||||
assert response.data == self.expected
|
||||
view = UserUpdate.as_view()
|
||||
pk = self.user.pk
|
||||
groups_pk = self.groups[0].pk
|
||||
request = factory.put('/', {'username': 'new', 'groups': [groups_pk]}, format='json')
|
||||
response = view(request, pk=pk)
|
||||
assert User.objects.get(pk=pk).groups.count() == 1
|
||||
expected = {
|
||||
'id': pk,
|
||||
'username': 'new',
|
||||
'groups': [1],
|
||||
'email': 'tom@example.com'
|
||||
}
|
||||
assert response.data == expected
|
||||
|
||||
def test_prefetch_related_excluding_instance_from_original_queryset(self):
|
||||
"""
|
||||
Regression test for https://github.com/encode/django-rest-framework/issues/4661
|
||||
"""
|
||||
request = factory.put(
|
||||
'/', {'username': 'exclude', 'groups': [self.groups[0].pk]}, format='json'
|
||||
)
|
||||
response = self.view(request, pk=self.user.pk)
|
||||
assert User.objects.get(pk=self.user.pk).groups.count() == 2
|
||||
self.expected['username'] = 'exclude'
|
||||
self.expected['groups'] = [self.groups[0].pk]
|
||||
assert response.data == self.expected
|
||||
|
||||
def test_db_query_count(self):
|
||||
request = factory.put(
|
||||
'/', {'username': 'new'}, format='json'
|
||||
)
|
||||
with self.assertNumQueries(7):
|
||||
self.view(request, pk=self.user.pk)
|
||||
|
||||
request = factory.put(
|
||||
'/', {'username': 'new2'}, format='json'
|
||||
)
|
||||
with self.assertNumQueries(16):
|
||||
UserUpdateWithoutPrefetchRelated.as_view()(request, pk=self.user.pk)
|
||||
view = UserUpdate.as_view()
|
||||
pk = self.user.pk
|
||||
groups_pk = self.groups[0].pk
|
||||
request = factory.put('/', {'username': 'exclude', 'groups': [groups_pk]}, format='json')
|
||||
response = view(request, pk=pk)
|
||||
assert User.objects.get(pk=pk).groups.count() == 1
|
||||
expected = {
|
||||
'id': pk,
|
||||
'username': 'exclude',
|
||||
'groups': [1],
|
||||
'email': 'tom@example.com'
|
||||
}
|
||||
assert response.data == expected
|
||||
|
|
|
|||
|
|
@ -910,7 +910,7 @@ class TestDocumentationRenderer(TestCase):
|
|||
'link': coreapi.Link(url='/data/', action='get', fields=[]),
|
||||
}
|
||||
html = template.render(context)
|
||||
assert 'testcases list' in html
|
||||
assert 'testcases<span class="w"> </span>list' in html
|
||||
|
||||
|
||||
@pytest.mark.skipif(not coreapi, reason='coreapi is not installed')
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@ import itertools
|
|||
from io import BytesIO
|
||||
from unittest.mock import patch
|
||||
|
||||
import django
|
||||
from django.contrib.auth.models import User
|
||||
from django.http import HttpResponseRedirect
|
||||
from django.shortcuts import redirect
|
||||
|
|
@ -319,10 +318,6 @@ class TestAPIRequestFactory(TestCase):
|
|||
assert request.META['CONTENT_TYPE'] == 'application/json'
|
||||
|
||||
|
||||
def check_urlpatterns(cls):
|
||||
assert urlpatterns is not cls.urlpatterns
|
||||
|
||||
|
||||
class TestUrlPatternTestCase(URLPatternsTestCase):
|
||||
urlpatterns = [
|
||||
path('', view),
|
||||
|
|
@ -334,18 +329,11 @@ class TestUrlPatternTestCase(URLPatternsTestCase):
|
|||
super().setUpClass()
|
||||
assert urlpatterns is cls.urlpatterns
|
||||
|
||||
if django.VERSION > (4, 0):
|
||||
cls.addClassCleanup(
|
||||
check_urlpatterns,
|
||||
cls
|
||||
)
|
||||
|
||||
if django.VERSION < (4, 0):
|
||||
@classmethod
|
||||
def tearDownClass(cls):
|
||||
assert urlpatterns is cls.urlpatterns
|
||||
super().tearDownClass()
|
||||
assert urlpatterns is not cls.urlpatterns
|
||||
@classmethod
|
||||
def doClassCleanups(cls):
|
||||
assert urlpatterns is cls.urlpatterns
|
||||
super().doClassCleanups()
|
||||
assert urlpatterns is not cls.urlpatterns
|
||||
|
||||
def test_urlpatterns(self):
|
||||
assert self.client.get('/').status_code == 200
|
||||
|
|
|
|||
|
|
@ -109,89 +109,3 @@ class TestValidationErrorConvertsTuplesToLists(TestCase):
|
|||
assert len(error.detail) == 2
|
||||
assert str(error.detail[0]) == 'message1'
|
||||
assert str(error.detail[1]) == 'message2'
|
||||
|
||||
|
||||
class TestValidationErrorWithDjangoStyle(TestCase):
|
||||
def test_validation_error_details(self):
|
||||
error = ValidationError('Invalid value: %(value)s', params={'value': '42'})
|
||||
assert str(error.detail[0]) == 'Invalid value: 42'
|
||||
|
||||
def test_validation_error_details_tuple(self):
|
||||
error = ValidationError(
|
||||
detail=('Invalid value: %(value1)s', 'Invalid value: %(value2)s'),
|
||||
params={'value1': '42', 'value2': '43'},
|
||||
)
|
||||
assert isinstance(error.detail, list)
|
||||
assert len(error.detail) == 2
|
||||
assert str(error.detail[0]) == 'Invalid value: 42'
|
||||
assert str(error.detail[1]) == 'Invalid value: 43'
|
||||
|
||||
def test_validation_error_details_list(self):
|
||||
error = ValidationError(
|
||||
detail=['Invalid value: %(value1)s', 'Invalid value: %(value2)s', ],
|
||||
params={'value1': '42', 'value2': '43'}
|
||||
)
|
||||
assert isinstance(error.detail, list)
|
||||
assert len(error.detail) == 2
|
||||
assert str(error.detail[0]) == 'Invalid value: 42'
|
||||
assert str(error.detail[1]) == 'Invalid value: 43'
|
||||
|
||||
def test_validation_error_details_validation_errors(self):
|
||||
error = ValidationError(
|
||||
detail=ValidationError(
|
||||
detail='Invalid value: %(value1)s',
|
||||
params={'value1': '42'},
|
||||
),
|
||||
)
|
||||
assert isinstance(error.detail, list)
|
||||
assert len(error.detail) == 1
|
||||
assert str(error.detail[0]) == 'Invalid value: 42'
|
||||
|
||||
def test_validation_error_details_validation_errors_list(self):
|
||||
error = ValidationError(
|
||||
detail=[
|
||||
ValidationError(
|
||||
detail='Invalid value: %(value1)s',
|
||||
params={'value1': '42'},
|
||||
),
|
||||
ValidationError(
|
||||
detail='Invalid value: %(value2)s',
|
||||
params={'value2': '43'},
|
||||
),
|
||||
'Invalid value: %(value3)s'
|
||||
],
|
||||
params={'value3': '44'}
|
||||
)
|
||||
assert isinstance(error.detail, list)
|
||||
assert len(error.detail) == 3
|
||||
assert str(error.detail[0]) == 'Invalid value: 42'
|
||||
assert str(error.detail[1]) == 'Invalid value: 43'
|
||||
assert str(error.detail[2]) == 'Invalid value: 44'
|
||||
|
||||
def test_validation_error_details_validation_errors_nested_list(self):
|
||||
error = ValidationError(
|
||||
detail=[
|
||||
ValidationError(
|
||||
detail='Invalid value: %(value1)s',
|
||||
params={'value1': '42'},
|
||||
),
|
||||
ValidationError(
|
||||
detail=[
|
||||
'Invalid value: %(value2)s',
|
||||
ValidationError(
|
||||
detail='Invalid value: %(value3)s',
|
||||
params={'value3': '44'},
|
||||
)
|
||||
],
|
||||
params={'value2': '43'},
|
||||
),
|
||||
'Invalid value: %(value4)s'
|
||||
],
|
||||
params={'value4': '45'}
|
||||
)
|
||||
assert isinstance(error.detail, list)
|
||||
assert len(error.detail) == 4
|
||||
assert str(error.detail[0]) == 'Invalid value: 42'
|
||||
assert str(error.detail[1]) == 'Invalid value: 43'
|
||||
assert str(error.detail[2]) == 'Invalid value: 44'
|
||||
assert str(error.detail[3]) == 'Invalid value: 45'
|
||||
|
|
|
|||
|
|
@ -272,7 +272,7 @@ class TestInvalidVersion:
|
|||
assert response.status_code == status.HTTP_404_NOT_FOUND
|
||||
|
||||
|
||||
class TestAcceptHeaderAllowedAndDefaultVersion:
|
||||
class TestAllowedAndDefaultVersion:
|
||||
def test_missing_without_default(self):
|
||||
scheme = versioning.AcceptHeaderVersioning
|
||||
view = AllowedVersionsView.as_view(versioning_class=scheme)
|
||||
|
|
@ -318,97 +318,6 @@ class TestAcceptHeaderAllowedAndDefaultVersion:
|
|||
assert response.data == {'version': 'v2'}
|
||||
|
||||
|
||||
class TestNamespaceAllowedAndDefaultVersion:
|
||||
def test_no_namespace_without_default(self):
|
||||
class FakeResolverMatch:
|
||||
namespace = None
|
||||
|
||||
scheme = versioning.NamespaceVersioning
|
||||
view = AllowedVersionsView.as_view(versioning_class=scheme)
|
||||
|
||||
request = factory.get('/endpoint/')
|
||||
request.resolver_match = FakeResolverMatch
|
||||
response = view(request)
|
||||
assert response.status_code == status.HTTP_404_NOT_FOUND
|
||||
|
||||
def test_no_namespace_with_default(self):
|
||||
class FakeResolverMatch:
|
||||
namespace = None
|
||||
|
||||
scheme = versioning.NamespaceVersioning
|
||||
view = AllowedAndDefaultVersionsView.as_view(versioning_class=scheme)
|
||||
|
||||
request = factory.get('/endpoint/')
|
||||
request.resolver_match = FakeResolverMatch
|
||||
response = view(request)
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
assert response.data == {'version': 'v2'}
|
||||
|
||||
def test_no_match_without_default(self):
|
||||
class FakeResolverMatch:
|
||||
namespace = 'no_match'
|
||||
|
||||
scheme = versioning.NamespaceVersioning
|
||||
view = AllowedVersionsView.as_view(versioning_class=scheme)
|
||||
|
||||
request = factory.get('/endpoint/')
|
||||
request.resolver_match = FakeResolverMatch
|
||||
response = view(request)
|
||||
assert response.status_code == status.HTTP_404_NOT_FOUND
|
||||
|
||||
def test_no_match_with_default(self):
|
||||
class FakeResolverMatch:
|
||||
namespace = 'no_match'
|
||||
|
||||
scheme = versioning.NamespaceVersioning
|
||||
view = AllowedAndDefaultVersionsView.as_view(versioning_class=scheme)
|
||||
|
||||
request = factory.get('/endpoint/')
|
||||
request.resolver_match = FakeResolverMatch
|
||||
response = view(request)
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
assert response.data == {'version': 'v2'}
|
||||
|
||||
def test_with_default(self):
|
||||
class FakeResolverMatch:
|
||||
namespace = 'v1'
|
||||
|
||||
scheme = versioning.NamespaceVersioning
|
||||
view = AllowedAndDefaultVersionsView.as_view(versioning_class=scheme)
|
||||
|
||||
request = factory.get('/endpoint/')
|
||||
request.resolver_match = FakeResolverMatch
|
||||
response = view(request)
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
assert response.data == {'version': 'v1'}
|
||||
|
||||
def test_no_match_without_default_but_none_allowed(self):
|
||||
class FakeResolverMatch:
|
||||
namespace = 'no_match'
|
||||
|
||||
scheme = versioning.NamespaceVersioning
|
||||
view = AllowedWithNoneVersionsView.as_view(versioning_class=scheme)
|
||||
|
||||
request = factory.get('/endpoint/')
|
||||
request.resolver_match = FakeResolverMatch
|
||||
response = view(request)
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
assert response.data == {'version': None}
|
||||
|
||||
def test_no_match_with_default_and_none_allowed(self):
|
||||
class FakeResolverMatch:
|
||||
namespace = 'no_match'
|
||||
|
||||
scheme = versioning.NamespaceVersioning
|
||||
view = AllowedWithNoneAndDefaultVersionsView.as_view(versioning_class=scheme)
|
||||
|
||||
request = factory.get('/endpoint/')
|
||||
request.resolver_match = FakeResolverMatch
|
||||
response = view(request)
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
assert response.data == {'version': 'v2'}
|
||||
|
||||
|
||||
class TestHyperlinkedRelatedField(URLPatternsTestCase, APITestCase):
|
||||
included = [
|
||||
path('namespaced/<int:pk>/', dummy_pk_view, name='namespaced'),
|
||||
|
|
|
|||
15
tox.ini
15
tox.ini
|
|
@ -1,11 +1,9 @@
|
|||
[tox]
|
||||
envlist =
|
||||
{py36,py37,py38,py39}-django30
|
||||
{py36,py37,py38,py39}-django31
|
||||
{py36,py37,py38,py39,py310}-django32
|
||||
{py38,py39,py310}-{django40,django41,django42,djangomain}
|
||||
{py311}-{django41,django42,django50,djangomain}
|
||||
{py312}-{django42,djanggo50,djangomain}
|
||||
{py38,py39}-{django42}
|
||||
{py310}-{django42,django50,djangomain}
|
||||
{py311}-{django42,django50,djangomain}
|
||||
{py312}-{django42,django50,djangomain}
|
||||
base
|
||||
dist
|
||||
docs
|
||||
|
|
@ -17,11 +15,6 @@ setenv =
|
|||
PYTHONDONTWRITEBYTECODE=1
|
||||
PYTHONWARNINGS=once
|
||||
deps =
|
||||
django30: Django>=3.0,<3.1
|
||||
django31: Django>=3.1,<3.2
|
||||
django32: Django>=3.2,<4.0
|
||||
django40: Django>=4.0,<4.1
|
||||
django41: Django>=4.1,<4.2
|
||||
django42: Django>=4.2,<5.0
|
||||
django50: Django>=5.0,<5.1
|
||||
djangomain: https://github.com/django/django/archive/main.tar.gz
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user