requests-mock

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.

Release files for requests-mock 1.12.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for requests-mock 1.12.1
File	Size	Uploaded
requests-mock-1.12.1.tar.gz	60.9 kB	Mar 29, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for requests-mock 1.12.1
File	Interpreter	ABI	Platform	Reset
requests_mock-1.12.1-py2.py3-none-any.whl 27.7 kB Mar 29, 2024	Python 3, Python 2	none	any	Details

Total release size: 88.6 kB

Release files / requests-mock-1.12.1.tar.gz

Download URL	requests-mock-1.12.1.tar.gz
Size	60.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`e9e12e333b525156e82a3c852f22016b9158220d2f47454de9cae8a77d371401`
BLAKE2b-256 checksum How to use checksums	`9232587625f91f9a0a3d84688bf9cfc4b2480a7e8ec327cefd0ff2ac891fd2cf`
Upload date	Mar 29, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`

Release files / requests_mock-1.12.1-py2.py3-none-any.whl

Download URL	requests_mock-1.12.1-py2.py3-none-any.whl
Size	27.7 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`b1e37054004cdd5e56c84454cc7df12b25f90f382159087f4b6915aaeef39563`
BLAKE2b-256 checksum How to use checksums	`97ec889fbc557727da0c34a33850950310240f2040f3b1955175fdb2b36a8910`
Upload date	Mar 29, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`