Update an example to not use oppressive language (#7439)

* Update an example to use less oppressive language

For reference: https://tools.ietf.org/id/draft-knodel-terminology-00.html

* Code review update

Blocklisted -> blocked.
This commit is contained in:
Paul Watts 2020-07-29 12:21:13 -07:00 committed by GitHub
parent c252c3dfa5
commit 559088463b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -243,19 +243,19 @@ Custom permissions will raise a `PermissionDenied` exception if the test fails.
## Examples
The following is an example of a permission class that checks the incoming request's IP address against a blacklist, and denies the request if the IP has been blacklisted.
The following is an example of a permission class that checks the incoming request's IP address against a blocklist, and denies the request if the IP has been blocked.
from rest_framework import permissions
class BlacklistPermission(permissions.BasePermission):
class BlocklistPermission(permissions.BasePermission):
"""
Global permission check for blacklisted IPs.
Global permission check for blocked IPs.
"""
def has_permission(self, request, view):
ip_addr = request.META['REMOTE_ADDR']
blacklisted = Blacklist.objects.filter(ip_addr=ip_addr).exists()
return not blacklisted
blocked = Blocklist.objects.filter(ip_addr=ip_addr).exists()
return not blocked
As well as global permissions, that are run against all incoming requests, you can also create object-level permissions, that are only run against operations that affect a particular object instance. For example: