Jamie Lennox 10c84747e0 Allow arbirtrary matcher to be add to match
To handle requests for additional features on matching add a callback
function that can match anything on the request object. This is easier
than adding every combination of matcher option - though we should still
add things that are commonly used.

Change-Id: I300f74a1f2103545eca60087b2352a535add188d
Closes-Bug: #1657308
2017-01-23 10:19:56 +11:00
2016-10-04 16:34:16 +11:00
2015-10-17 22:38:27 +00:00
2014-04-10 13:13:07 +10:00
2014-06-16 16:33:14 +10:00
2015-12-13 01:37:51 +00:00
2016-10-04 16:34:16 +11:00

requests-mock

image

Intro

requests-mock provides a building block to stub out the HTTP requests portions of your testing code. You should checkout the docs for more information.

The Basics

Everything in requests eventually goes through an adapter to do the transport work. requests-mock creates a custom adatper that allows you to predefine responses when certain URIs are called.

There are then a number of methods provided to get the adapter used.

A simple example:

>>> import requests
>>> import requests_mock

>>> session = requests.Session()
>>> adapter = requests_mock.Adapter()
>>> session.mount('mock', adapter)

>>> adapter.register_uri('GET', 'mock://test.com', text='data')
>>> resp = session.get('mock://test.com')
>>> resp.status_code, resp.text
(200, 'data')

Obviously having all URLs be mock:// prefixed isn't going to useful, so you can use requests_mock.mock to get the adapter into place.

As a context manager:

>>> with requests_mock.mock() as m:
...     m.get('http://test.com', text='data')
...     requests.get('http://test.com').text
...
'data'

Or as a decorator:

>>> @requests_mock.mock()
... def test_func(m):
...     m.get('http://test.com', text='data')
...     return requests.get('http://test.com').text
...
>>> test_func()
'data'

For more information checkout the docs.

Reporting Bugs

Please report all bugs on LaunchPad.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Description
RETIRED, continues at github.com:jamielennox/requests-mock
Readme 664 KiB