Skip to main content

Mock out responses from the requests package

Reason this release was yanked:

Incorrectly reports compatability with python 2.

Project description

https://badge.fury.io/py/requests-mock.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 adapter 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 be useful, so you can use requests_mock.Mocker to get the adapter into place.

As a context manager:

>>> with requests_mock.Mocker() as m:
...     m.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.get('http://test.com', text='data')
...     return requests.get('http://test.com').text
...
>>> test_func()
'data'

Or as a pytest fixture:

>>> def test_simple(requests_mock):
...    requests_mock.get('http://test.com', text='data')
...    assert 'data' == requests.get('http://test.com').text

For more information checkout the docs.

Reporting Bugs

Development and bug tracking is performed on GitHub.

Questions

There is a tag dedicated to requests-mock on StackOverflow where you can ask usage questions.

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

https://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-1.12.0.tar.gz (60.9 kB view details)

Uploaded Source

Built Distribution

requests_mock-1.12.0-py2.py3-none-any.whl (27.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: requests-mock-1.12.0.tar.gz
  • Upload date:
  • Size: 60.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for requests-mock-1.12.0.tar.gz
Algorithm Hash digest
SHA256 4e34f2a2752f0b78397fb414526605d95fcdeab021ac1f26d18960e7eb41f6a8
MD5 a8c42d0036bf6690c45e5afa6fd861d4
BLAKE2b-256 06899c723a87feaa5359b7893d5a2c9a8547659b96d23b740c1dd4f93c79e762

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for requests_mock-1.12.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4f6fdf956de568e0bac99eee4ad96b391c602e614cc0ad33e7f5c72edd699e70
MD5 aa5a5a916eff510e9f802f576d738bf9
BLAKE2b-256 28f33915c71e80385e6f82e1de7cbb52ffac8c97dcef5312916058eb0758e44e

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