summaryrefslogtreecommitdiff
path: root/django/middleware/common.py
diff options
context:
space:
mode:
authorAnton Samarchyan <anton.samarchyan@savoirfairelinux.com>2017-01-24 15:37:33 -0500
committerTim Graham <timograham@gmail.com>2017-03-04 10:02:06 -0500
commit86de930f413e0ad902e11d78ac988e6743202ea6 (patch)
tree790dcc4c38125b619ffee76b5531155d0d8232f4 /django/middleware/common.py
parent6ae1b04fb584db0fdb22b8e287784c4ed3ac62ac (diff)
Refs #27656 -- Updated remaining docstring verbs according to PEP 257.
Diffstat (limited to 'django/middleware/common.py')
-rw-r--r--django/middleware/common.py22
1 files changed, 9 insertions, 13 deletions
diff --git a/django/middleware/common.py b/django/middleware/common.py
index cab5279a73..d8cfb9a8b0 100644
--- a/django/middleware/common.py
+++ b/django/middleware/common.py
@@ -17,17 +17,16 @@ class CommonMiddleware(MiddlewareMixin):
"""
"Common" middleware for taking care of some basic operations:
- - Forbids access to User-Agents in settings.DISALLOWED_USER_AGENTS
+ - Forbid access to User-Agents in settings.DISALLOWED_USER_AGENTS
- URL rewriting: Based on the APPEND_SLASH and PREPEND_WWW settings,
- this middleware appends missing slashes and/or prepends missing
- "www."s.
+ append missing slashes and/or prepends missing "www."s.
- If APPEND_SLASH is set and the initial URL doesn't end with a
- slash, and it is not found in urlpatterns, a new URL is formed by
+ slash, and it is not found in urlpatterns, form a new URL by
appending a slash at the end. If this new URL is found in
- urlpatterns, then an HTTP-redirect is returned to this new URL;
- otherwise the initial URL is processed as usual.
+ urlpatterns, return an HTTP redirect to this new URL; otherwise
+ process the initial URL as usual.
This behavior can be customized by subclassing CommonMiddleware and
overriding the response_redirect_class attribute.
@@ -140,9 +139,7 @@ class CommonMiddleware(MiddlewareMixin):
return response
def needs_etag(self, response):
- """
- Return True if an ETag header should be added to response.
- """
+ """Return True if an ETag header should be added to response."""
cache_control_headers = cc_delim_re.split(response.get('Cache-Control', ''))
return all(header.lower() != 'no-store' for header in cache_control_headers)
@@ -150,9 +147,7 @@ class CommonMiddleware(MiddlewareMixin):
class BrokenLinkEmailsMiddleware(MiddlewareMixin):
def process_response(self, request, response):
- """
- Send broken link emails for relevant 404 NOT FOUND responses.
- """
+ """Send broken link emails for relevant 404 NOT FOUND responses."""
if response.status_code == 404 and not settings.DEBUG:
domain = request.get_host()
path = request.get_full_path()
@@ -173,7 +168,8 @@ class BrokenLinkEmailsMiddleware(MiddlewareMixin):
def is_internal_request(self, domain, referer):
"""
- Returns True if the referring URL is the same domain as the current request.
+ Return True if the referring URL is the same domain as the current
+ request.
"""
# Different subdomains are treated as different domains.
return bool(re.match("^https?://%s/" % re.escape(domain), referer))