Skip to main content

Mock out responses from the requests package

Project description

https://badge.fury.io/py/requests-mock.png https://pypip.in/d/requests-mock/badge.png

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

requests-mock-0.7.0.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

requests_mock-0.7.0-py2.py3-none-any.whl (26.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file requests-mock-0.7.0.tar.gz.

File metadata

File hashes

Hashes for requests-mock-0.7.0.tar.gz
Algorithm Hash digest
SHA256 ee2816992d4505596ec3c98c7b4ab57475539ac037d08dd3a81370b1e3cdd568
MD5 2486894022c6f60fa872bcf8939cadb0
BLAKE2b-256 a25c9313f3da98a7d744172da9df4280435bc3f3cd3913fb57c9b644cbcdf2b4

See more details on using hashes here.

Provenance

File details

Details for the file requests_mock-0.7.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for requests_mock-0.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e61056cdb809fcc6ed47771b74054fe3ab4c3659d7f66c32a5256e8cf013e0af
MD5 e02c67cc46b1e2013a1624d704b06be6
BLAKE2b-256 f6f6fcf3ae6c373cc64663c4f737c3feae511e786ad0680c679e058a90439754

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page