{"title":"View decorators","version":"4.0","locale":"en","docname":"topics/http/decorators","url":"/en/4.0/topics/http/decorators/","canonical":"https://djangodocs.dev/en/4.0/topics/http/decorators/","summary":"Django provides several decorators that can be applied to views to support various HTTP features. See Decorating the class for how to use these decorators with…","html":"

View decoratorsLink to this heading#

\n

Django provides several decorators that can be applied to views to support\nvarious HTTP features.

\n

See Decorating the class for how to use these decorators with\nclass-based views.

\n
\n

Allowed HTTP methodsLink to this heading#

\n

The decorators in django.views.decorators.http can be used to restrict\naccess to views based on the request method. These decorators will return\na django.http.HttpResponseNotAllowed if the conditions are not met.

\n
\n
\nrequire_http_methods(request_method_list)Link to this definition#
\n

Decorator to require that a view only accepts particular request\nmethods. Usage:

\n
Code
from django.views.decorators.http import require_http_methods\n\n@require_http_methods(["GET", "POST"])\ndef my_view(request):\n    # I can assume now that only GET or POST requests make it this far\n    # ...\n    pass\n
\n

Note that request methods should be in uppercase.

\n
\n\n
\n
\nrequire_GET()Link to this definition#
\n

Decorator to require that a view only accepts the GET method.

\n
\n\n
\n
\nrequire_POST()Link to this definition#
\n

Decorator to require that a view only accepts the POST method.

\n
\n\n
\n
\nrequire_safe()Link to this definition#
\n

Decorator to require that a view only accepts the GET and HEAD methods.\nThese methods are commonly considered “safe” because they should not have\nthe significance of taking an action other than retrieving the requested\nresource.

\n\n
\n\n
\n
\n

Conditional view processingLink to this heading#

\n

The following decorators in django.views.decorators.http can be used to\ncontrol caching behavior on particular views.

\n
\n
\ncondition(etag_func=None, last_modified_func=None)Link to this definition#
\n
\n\n
\n
\netag(etag_func)Link to this definition#
\n
\n\n
\n
\nlast_modified(last_modified_func)Link to this definition#
\n

These decorators can be used to generate ETag and Last-Modified\nheaders; see\nconditional view processing.

\n
\n\n
\n
\n

GZip compressionLink to this heading#

\n

The decorators in django.views.decorators.gzip control content\ncompression on a per-view basis.

\n
\n
\ngzip_page()Link to this definition#
\n

This decorator compresses content if the browser allows gzip compression.\nIt sets the Vary header accordingly, so that caches will base their\nstorage on the Accept-Encoding header.

\n
\n\n
\n
\n

Vary headersLink to this heading#

\n

The decorators in django.views.decorators.vary can be used to control\ncaching based on specific request headers.

\n
\n
\nvary_on_cookie(func)Link to this definition#
\n
\n\n
\n
\nvary_on_headers(*headers)Link to this definition#
\n

The Vary header defines which request headers a cache mechanism should take\ninto account when building its cache key.

\n

See using vary headers.

\n
\n\n
\n
\n

CachingLink to this heading#

\n

The decorators in django.views.decorators.cache control server and\nclient-side caching.

\n
\n
\ncache_control(**kwargs)Link to this definition#
\n

This decorator patches the response’s Cache-Control header by adding\nall of the keyword arguments to it. See\npatch_cache_control() for the details of the\ntransformation.

\n
\n\n
\n
\nnever_cache(view_func)Link to this definition#
\n

This decorator adds an Expires header to the current date/time.

\n

This decorator adds a Cache-Control: max-age=0, no-cache, no-store,\nmust-revalidate, private header to a response to indicate that a page\nshould never be cached.

\n

Each header is only added if it isn’t already set.

\n
\n\n
\n
\n

CommonLink to this heading#

\n\n

The decorators in django.views.decorators.common allow per-view\ncustomization of CommonMiddleware behavior.

\n
\n
\nno_append_slash()Link to this definition#
\n

This decorator allows individual views to be excluded from\nAPPEND_SLASH URL normalization.

\n
\n\n
","rootId":"module-django.views.decorators.http","toc":[{"title":"Allowed HTTP methods","anchor":"allowed-http-methods","children":[]},{"title":"Conditional view processing","anchor":"conditional-view-processing","children":[]},{"title":"GZip compression","anchor":"gzip-compression","children":[]},{"title":"Vary headers","anchor":"vary-headers","children":[]},{"title":"Caching","anchor":"caching","children":[]},{"title":"Common","anchor":"common","children":[]}],"breadcrumbs":[{"docname":"topics/index","title":"Using Django","url":"/en/4.0/topics/"},{"docname":"topics/http/index","title":"Handling HTTP requests","url":"/en/4.0/topics/http/"}],"prev":{"docname":"topics/http/views","title":"Writing views","url":"/en/4.0/topics/http/views/"},"next":{"docname":"topics/http/file-uploads","title":"File Uploads","url":"/en/4.0/topics/http/file-uploads/"},"formats":{"html":"/en/4.0/topics/http/decorators/","markdown":"/en/4.0/topics/http/decorators.md","json":"/en/4.0/topics/http/decorators.json"},"source":"https://github.com/django/django/blob/stable/4.0.x/docs/topics/http/decorators.txt","official":"https://docs.djangoproject.com/en/4.0/topics/http/decorators/","inVersions":["dev","6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9","1.8"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}