Skip to main content

TemplateResponse

This class represents an HTTP response that uses a template and a context to generate its content, specifically requiring a request object during initialization. It extends the basic template response functionality by maintaining a reference to the original request, which is used during the rendering process. This allows for more complex template rendering that can adapt based on request-specific data.

Attributes

AttributeTypeDescription
rendering_attrslistA list of attribute names that are tracked and used to determine the state of the template rendering process, including the current request object.

Constructor

Signature

def TemplateResponse(
request: [HttpRequest](../../http/request/httprequest.md?sid=django_http_request_httprequest),
template: string|list|Template,
context: dict = None,
content_type: string = None,
status: int = None,
charset: string = None,
using: string = None,
headers: dict
) - > null

Parameters

NameTypeDescription
request[HttpRequest](../../http/request/httprequest.md?sid=django_http_request_httprequest)The request instance used to render the template.
template`stringlist
contextdict = NoneA dictionary of values to add to the template context.
content_typestring = NoneThe HTTP Content-Type header value.
statusint = NoneThe HTTP status code for the response.
charsetstring = NoneThe charset to be used for encoding the response.
usingstring = NoneThe NAME of a template engine to use for loading the template.
headersdictA dictionary of HTTP headers to add to the response. (Django 3.2+)

Signature

def TemplateResponse(
request: [HttpRequest](../../http/request/httprequest.md?sid=django_http_request_httprequest),
template: string|list|Template,
context: dict = None,
content_type: string = None,
status: integer = None,
charset: string = None,
using: string = None,
headers: dict
) - > null

Parameters

NameTypeDescription
request[HttpRequest](../../http/request/httprequest.md?sid=django_http_request_httprequest)The current HTTP request object used to provide context and metadata during template rendering.
template`stringlist
contextdict = NoneA dictionary of values to add to the template context for variable interpolation.
content_typestring = NoneThe MIME type used for the Content-Type header of the HTTP response.
statusinteger = NoneThe HTTP status code for the response, such as 200 or 404.
charsetstring = NoneThe character encoding to be used for the response content.
usingstring = NoneThe NAME of the template engine to use for loading the template.
headersdictA dictionary of HTTP headers to include in the response. (default: None)