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

Public Member Functions

def __init__ (self, body="", headers=None, status=0, version=0, reason=None, strict=0, preload_content=True, decode_content=True, original_response=None, pool=None, connection=None, msg=None, retries=None, enforce_content_length=False, request_method=None, request_url=None, auto_close=True)
 
def get_redirect_location (self)
 
def release_conn (self)
 
def drain_conn (self)
 
def data (self)
 
def connection (self)
 
def isclosed (self)
 
def tell (self)
 
def read (self, amt=None, decode_content=None, cache_content=False)
 
def stream (self, amt=2 **16, decode_content=None)
 
def from_httplib (ResponseCls, r, **response_kw)
 
def getheaders (self)
 
def getheader (self, name, default=None)
 
def info (self)
 
def close (self)
 
def closed (self)
 
def fileno (self)
 
def flush (self)
 
def readable (self)
 
def readinto (self, b)
 
def supports_chunked_reads (self)
 
def read_chunked (self, amt=None, decode_content=None)
 
def geturl (self)
 
def __iter__ (self)
 

Data Fields

 headers
 
 status
 
 version
 
 reason
 
 strict
 
 decode_content
 
 retries
 
 enforce_content_length
 
 auto_close
 
 msg
 
 chunked
 
 chunk_left
 
 length_remaining
 

Static Public Attributes

 CONTENT_DECODERS
 
 REDIRECT_STATUSES
 
 DECODER_ERROR_CLASSES
 

Detailed Description

HTTP Response container.

Backwards-compatible with :class:`http.client.HTTPResponse` but the response ``body`` is
loaded and decoded on-demand when the ``data`` property is accessed.  This
class is also compatible with the Python standard library's :mod:`io`
module, and can hence be treated as a readable object in the context of that
framework.

Extra parameters for behaviour not present in :class:`http.client.HTTPResponse`:

:param preload_content:
    If True, the response's body will be preloaded during construction.

:param decode_content:
    If True, will attempt to decode the body based on the
    'content-encoding' header.

:param original_response:
    When this HTTPResponse wrapper is generated from an :class:`http.client.HTTPResponse`
    object, it's convenient to include the original for debug purposes. It's
    otherwise unused.

:param retries:
    The retries contains the last :class:`~urllib3.util.retry.Retry` that
    was used during the request.

:param enforce_content_length:
    Enforce content length checking. Body returned by server must match
    value of Content-Length header, if present. Otherwise, raise error.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  body = "",
  headers = None,
  status = 0,
  version = 0,
  reason = None,
  strict = 0,
  preload_content = True,
  decode_content = True,
  original_response = None,
  pool = None,
  connection = None,
  msg = None,
  retries = None,
  enforce_content_length = False,
  request_method = None,
  request_url = None,
  auto_close = True 
)

Member Function Documentation

◆ __iter__()

def __iter__ (   self)

◆ close()

def close (   self)

◆ closed()

def closed (   self)

◆ connection()

def connection (   self)

◆ data()

def data (   self)

◆ drain_conn()

def drain_conn (   self)
Read and discard any remaining HTTP response data in the response connection.

Unread data in the HTTPResponse connection blocks the connection from being released back to the pool.

◆ fileno()

def fileno (   self)

◆ flush()

def flush (   self)

◆ from_httplib()

def from_httplib (   ResponseCls,
  r,
**  response_kw 
)
Given an :class:`http.client.HTTPResponse` instance ``r``, return a
corresponding :class:`urllib3.response.HTTPResponse` object.

Remaining parameters are passed to the HTTPResponse constructor, along
with ``original_response=r``.

◆ get_redirect_location()

def get_redirect_location (   self)
Should we redirect and where to?

:returns: Truthy redirect location string if we got a redirect status
    code and valid location. ``None`` if redirect status and no
    location. ``False`` if not a redirect status code.

◆ getheader()

def getheader (   self,
  name,
  default = None 
)

◆ getheaders()

def getheaders (   self)

◆ geturl()

def geturl (   self)
Returns the URL that was the source of this response.
If the request that generated this response redirected, this method
will return the final redirect location.

◆ info()

def info (   self)

◆ isclosed()

def isclosed (   self)

◆ read()

def read (   self,
  amt = None,
  decode_content = None,
  cache_content = False 
)
Similar to :meth:`http.client.HTTPResponse.read`, but with two additional
parameters: ``decode_content`` and ``cache_content``.

:param amt:
    How much of the content to read. If specified, caching is skipped
    because it doesn't make sense to cache partial content as the full
    response.

:param decode_content:
    If True, will attempt to decode the body based on the
    'content-encoding' header.

:param cache_content:
    If True, will save the returned data such that the same result is
    returned despite of the state of the underlying file object. This
    is useful if you want the ``.data`` property to continue working
    after having ``.read()`` the file object. (Overridden if ``amt`` is
    set.)

◆ read_chunked()

def read_chunked (   self,
  amt = None,
  decode_content = None 
)
Similar to :meth:`HTTPResponse.read`, but with an additional
parameter: ``decode_content``.

:param amt:
    How much of the content to read. If specified, caching is skipped
    because it doesn't make sense to cache partial content as the full
    response.

:param decode_content:
    If True, will attempt to decode the body based on the
    'content-encoding' header.

◆ readable()

def readable (   self)

◆ readinto()

def readinto (   self,
  b 
)

◆ release_conn()

def release_conn (   self)

◆ stream()

def stream (   self,
  amt = 2 ** 16,
  decode_content = None 
)
A generator wrapper for the read() method. A call will block until
``amt`` bytes have been read from the connection or until the
connection is closed.

:param amt:
    How much of the content to read. The generator will return up to
    much data per iteration, but may return less. This is particularly
    likely when using compressed data. However, the empty string will
    never be returned.

:param decode_content:
    If True, will attempt to decode the body based on the
    'content-encoding' header.

◆ supports_chunked_reads()

def supports_chunked_reads (   self)
Checks if the underlying file-like object looks like a
:class:`http.client.HTTPResponse` object. We do this by testing for
the fp attribute. If it is present we assume it returns raw chunks as
processed by read_chunked().

◆ tell()

def tell (   self)
Obtain the number of bytes pulled over the wire so far. May differ from
the amount of content returned by :meth:``urllib3.response.HTTPResponse.read``
if bytes are encoded on the wire (e.g, compressed).

Field Documentation

◆ auto_close

auto_close

◆ chunk_left

chunk_left

◆ chunked

chunked

◆ CONTENT_DECODERS

CONTENT_DECODERS
static

◆ decode_content

decode_content

◆ DECODER_ERROR_CLASSES

DECODER_ERROR_CLASSES
static

◆ enforce_content_length

enforce_content_length

◆ headers

headers

◆ length_remaining

length_remaining

◆ msg

msg

◆ reason

reason

◆ REDIRECT_STATUSES

REDIRECT_STATUSES
static

◆ retries

retries

◆ status

status

◆ strict

strict

◆ version

version

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