Skip to main content

Mock out responses from the requests package

Project description

https://badge.fury.io/py/requests-mock.png https://travis-ci.org/jamielennox/requests-mock.png?branch=master https://pypip.in/d/requests-mock/badge.png https://coveralls.io/repos/jamielennox/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 use the requests_mock.Mocker to get the adapter into place.

As a context manager:

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

Or as a decorator:

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

For more information checkout the docs.

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.2.0.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

requests_mock-0.2.0-py2.py3-none-any.whl (17.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for requests-mock-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a83526c7cee19601521c29809f7a8e253d2a05ce6a33860ebaabd07981e2b2e4
MD5 ce1ed1dd4c8d91a1da9c5e340f1bc04d
BLAKE2b-256 1d0300a36d053495bef439cd428b509e53b5c415d3f8e692105235531240a23d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for requests_mock-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3fb925ac15715e3ede1926be747f2e5773430133f7c1eaf5905a543eb3188488
MD5 0fd1a75ac687e49a4368381c89a72ec3
BLAKE2b-256 129a063948f2b033f3410a1a086164f031b2d6012d47a2668966a3ed986342e0

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