django.http.HttpRequest

class documentation

class HttpRequest: (source)

Known subclasses: django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

View In Hierarchy

A basic HTTP request.

Method __init__ Undocumented
Method __iter__ Undocumented
Method __repr__ Undocumented
Method accepts Undocumented
Method build_absolute_uri Build an absolute URI from the location and the variables available in this request. If no ``location`` is specified, build the absolute URI using request.get_full_path(). If the location is absolute, convert it to an RFC 3987 compliant URI and return it...
Method close Undocumented
Method encoding.setter Set the encoding used for GET/POST accesses. If the GET or POST dictionary has already been created, remove and recreate it on the next access (so that it is decoded correctly).
Method get_full_path Undocumented
Method get_full_path_info Undocumented
Method get_host Return the HTTP host using the environment or request headers.
Method get_port Return the port number for the request as a string.
Method get_signed_cookie Attempt to return a signed cookie. If the signature fails or the cookie has expired, raise an exception, unless the `default` argument is provided, in which case return that value.
Method is_secure Undocumented
Method parse_file_upload Return a tuple of (POST QueryDict, FILES MultiValueDict).
Method read Undocumented
Method readline Undocumented
Method readlines Undocumented
Method upload_handlers.setter Undocumented
Instance Variable content_params Undocumented
Instance Variable content_type Undocumented
Instance Variable COOKIES Undocumented
Instance Variable FILES Undocumented
Instance Variable GET Undocumented
Instance Variable META Undocumented
Instance Variable method Undocumented
Instance Variable path Undocumented
Instance Variable path_info Undocumented
Instance Variable POST Undocumented
Instance Variable resolver_match Undocumented
Instance Variable upload_handlers Undocumented
Property accepted_types Return a list of MediaType instances.
Property body Undocumented
Property encoding Undocumented
Property headers Undocumented
Property scheme Undocumented
Method _get_full_path Undocumented
Method _get_raw_host Return the HTTP host using the environment or request headers. Skip allowed hosts protection, so may return an insecure host.
Method _get_scheme Hook for subclasses like WSGIRequest to implement. Return 'http' by default.
Method _initialize_handlers Undocumented
Method _load_post_and_files Populate self._post and self._files if the content-type is a form type
Method _mark_post_parse_error Undocumented
Method _set_content_type_params Set content_type, content_params, and encoding.
Instance Variable _encoding Undocumented
Instance Variable _files Undocumented
Instance Variable _post Undocumented
Instance Variable _read_started Undocumented
Instance Variable _upload_handlers Undocumented
Property _current_scheme_host Undocumented
def __init__(self): (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

def __iter__(self): (source)

Undocumented

def __repr__(self): (source)

Undocumented

def accepts(self, media_type): (source)

Undocumented

def build_absolute_uri(self, location=None): (source)

Build an absolute URI from the location and the variables available in this request. If no ``location`` is specified, build the absolute URI using request.get_full_path(). If the location is absolute, convert it to an RFC 3987 compliant URI and return it. If location is relative or is scheme-relative (i.e., ``//example.com/``), urljoin() it to a base URL constructed from the request variables.

def close(self): (source)

Undocumented

@encoding.setter
def encoding(self, val): (source)

Set the encoding used for GET/POST accesses. If the GET or POST dictionary has already been created, remove and recreate it on the next access (so that it is decoded correctly).

def get_full_path(self, force_append_slash=False): (source)

Undocumented

def get_full_path_info(self, force_append_slash=False): (source)

Undocumented

def get_host(self): (source)

Return the HTTP host using the environment or request headers.

def get_port(self): (source)

Return the port number for the request as a string.

def get_signed_cookie(self, key, default=RAISE_ERROR, salt='', max_age=None): (source)

Attempt to return a signed cookie. If the signature fails or the cookie has expired, raise an exception, unless the `default` argument is provided, in which case return that value.

def is_secure(self): (source)

Undocumented

def parse_file_upload(self, META, post_data): (source)

Return a tuple of (POST QueryDict, FILES MultiValueDict).

def read(self, *args, **kwargs): (source)

Undocumented

def readline(self, *args, **kwargs): (source)

Undocumented

def readlines(self): (source)

Undocumented

@upload_handlers.setter
def upload_handlers(self, upload_handlers): (source)

Undocumented

content_params = (source)

Undocumented

content_type = (source)

Undocumented

COOKIES: dict = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

FILES = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

GET = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

META: dict = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

method = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

path: str = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

path_info: str = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

POST = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

resolver_match = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

@property
upload_handlers = (source)

Undocumented

@cached_property
accepted_types = (source)

Return a list of MediaType instances.

@property
body = (source)

Undocumented

@property
encoding = (source)

Undocumented

@cached_property
headers = (source)

Undocumented

@property
scheme = (source)

Undocumented

def _get_full_path(self, path, force_append_slash): (source)

Undocumented

def _get_raw_host(self): (source)

Return the HTTP host using the environment or request headers. Skip allowed hosts protection, so may return an insecure host.

def _get_scheme(self): (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Hook for subclasses like WSGIRequest to implement. Return 'http' by default.

def _initialize_handlers(self): (source)

Undocumented

def _load_post_and_files(self): (source)

Populate self._post and self._files if the content-type is a form type

def _mark_post_parse_error(self): (source)

Undocumented

def _set_content_type_params(self, meta): (source)

Set content_type, content_params, and encoding.

_encoding = (source)

Undocumented

_files = (source)

Undocumented

_post = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

_read_started: bool = (source)
overridden in django.core.handlers.asgi.ASGIRequest, django.core.handlers.wsgi.WSGIRequest

Undocumented

_upload_handlers = (source)

Undocumented

@cached_property
_current_scheme_host = (source)

Undocumented