x/requests-mock
Code Issues Proposed changes
requests-mock/doc/source/history.rst
Jamie Lennox c3ed2aa479 Add hostname and port properties to request 
Using request.netloc can be confusing because you have to check whether
or not the port is included. We are going to want this seperation in
later patches so expose it on the request.

Change-Id: I2e4bad425fdbc2501727b295752900d4ce4086bc
2016-10-13 15:19:46 +11:00

2.4 KiB
Raw Blame History

Request History

The object returned from creating a mock or registering a URI in an adapter is capable of tracking and querying the history of requests that this mock responded to.

Called

The easiest way to test if a request hit the adapter is to simply check the called property or the call_count property.

>>> import requests >>> import requests_mock

>>> with requests_mock.mock() as m: ... m.get('http://test.com, text='resp') ... resp = requests.get('http://test.com') ... >>> m.called True >>> m.call_count 1

Request Objects

The history of objects that passed through the mocker/adapter can also be retrieved

>>> history = m.request_history >>> len(history) 1 >>> history[0].method 'GET' >>> history[0].url 'http://test.com/'

The alias last_request is also available for the last request to go through the mocker.

This request object is a wrapper around a standard :pyrequests.Request object with some additional information that make the interface more workable (as the :py~requests.Request object is generally not dealt with by users.

These additions include:

text

The data of the request converted into a unicode string.

json

The data of the request loaded from json into python objects.

qs

The query string of the request. See :pyurllib.parse.parse_qs for information on the return format.

hostname

The host name that the request was sent to.

port

The port the request was sent to.

>>> m.last_request.qs.scheme 'http' >>> m.last_request.qs.netloc 'test.com'

The following parameters of the :pyrequests.request call are also exposed via the request object:

timeout

How long to wait for the server to send data before giving up.

allow_redirects

Set to True if POST/PUT/DELETE redirect following is allowed.

proxies

Dictionary mapping protocol to the URL of the proxy.

verify

whether the SSL cert will be verified.

cert

The client certificate or cert/key tuple for this request.

Note: That the default value of these attributes are the values that are passed to the adapter and not what is passed to the request method. This means that the default for allow_redirects is None (even though that is interpretted as True) if unset, whereas the defautl for verify is True, and the default for proxies the empty dict.