OpenQuizz
Une application de gestion des contenus pédagogiques
PreparedRequest Class Reference
Inheritance diagram for PreparedRequest:
Collaboration diagram for PreparedRequest:

Public Member Functions

def __init__ (self)
 
def prepare (self, method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)
 
def __repr__ (self)
 
def copy (self)
 
def prepare_method (self, method)
 
def prepare_url (self, url, params)
 
def prepare_headers (self, headers)
 
def prepare_body (self, data, files, json=None)
 
def prepare_content_length (self, body)
 
def prepare_auth (self, auth, url='')
 
def prepare_cookies (self, cookies)
 
def prepare_hooks (self, hooks)
 
- Public Member Functions inherited from RequestEncodingMixin
def path_url (self)
 
- Public Member Functions inherited from RequestHooksMixin
def register_hook (self, event, hook)
 
def deregister_hook (self, event, hook)
 

Data Fields

 method
 
 url
 
 headers
 
 body
 
 hooks
 

Detailed Description

The fully mutable :class:`PreparedRequest <PreparedRequest>` object,
containing the exact bytes that will be sent to the server.

Instances are generated from a :class:`Request <Request>` object, and
should not be instantiated manually; doing so may produce undesirable
effects.

Usage::

  >>> import requests
  >>> req = requests.Request('GET', 'https://httpbin.org/get')
  >>> r = req.prepare()
  >>> r
  <PreparedRequest [GET]>

  >>> s = requests.Session()
  >>> s.send(r)
  <Response [200]>

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

Member Function Documentation

◆ __repr__()

def __repr__ (   self)

◆ copy()

def copy (   self)

◆ prepare()

def prepare (   self,
  method = None,
  url = None,
  headers = None,
  files = None,
  data = None,
  params = None,
  auth = None,
  cookies = None,
  hooks = None,
  json = None 
)
Prepares the entire request with the given parameters.

◆ prepare_auth()

def prepare_auth (   self,
  auth,
  url = '' 
)
Prepares the given HTTP auth data.

◆ prepare_body()

def prepare_body (   self,
  data,
  files,
  json = None 
)
Prepares the given HTTP body data.

◆ prepare_content_length()

def prepare_content_length (   self,
  body 
)
Prepare Content-Length header based on request method and body

◆ prepare_cookies()

def prepare_cookies (   self,
  cookies 
)
Prepares the given HTTP cookie data.

This function eventually generates a ``Cookie`` header from the
given cookies using cookielib. Due to cookielib's design, the header
will not be regenerated if it already exists, meaning this function
can only be called once for the life of the
:class:`PreparedRequest <PreparedRequest>` object. Any subsequent calls
to ``prepare_cookies`` will have no actual effect, unless the "Cookie"
header is removed beforehand.

◆ prepare_headers()

def prepare_headers (   self,
  headers 
)
Prepares the given HTTP headers.

◆ prepare_hooks()

def prepare_hooks (   self,
  hooks 
)
Prepares the given hooks.

◆ prepare_method()

def prepare_method (   self,
  method 
)
Prepares the given HTTP method.

◆ prepare_url()

def prepare_url (   self,
  url,
  params 
)
Prepares the given HTTP URL.

Field Documentation

◆ body

body

◆ headers

headers

◆ hooks

hooks

◆ method

method

◆ url

url

The documentation for this class was generated from the following file: