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

Uploaded Source

Built Distribution

requests_mock-0.3.0-py2.py3-none-any.whl (18.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: requests-mock-0.3.0.tar.gz
  • Upload date:
  • Size: 26.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for requests-mock-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f3344cf5ddef803d9c9b311e0e197ae768b4c275f6c2cb8500f5c6430cbbd228
MD5 6469b138820b2463a47f5804520479fc
BLAKE2b-256 ee385c2bd0c3bc718701fea04d68d2eb288a9007860d86346999c00f6d1d62d8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for requests_mock-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6100a3aefce951601b0a0e51e209f40d5040b6d383ff3fab5c009cff1c11df8e
MD5 11e641ecbacf7e8cc1222f872236d091
BLAKE2b-256 2fe2f83bc3fa83c2941fce57d2afa50492682bda35cbb1ac5df0b90006124845

See more details on using hashes here.

Supported by

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