Mock out responses from the requests package
Project description
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').textFor 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
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 history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file requests-mock-1.9.2.tar.gz.
File metadata
- Download URL: requests-mock-1.9.2.tar.gz
- Upload date:
- Size: 67.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 33296f228d8c5df11a7988b741325422480baddfdf5dd9318fd0eb40c3ed8595 |
|
| MD5 | 6a10eadf7572fbacbd99c64d05e30448 |
|
| BLAKE2b-256 | 1894a5fffd28e1971639bb9a12a9f9f53a8548b2821eab65446d83fd7490b72c |
Provenance
File details
Details for the file requests_mock-1.9.2-py2.py3-none-any.whl.
File metadata
- Download URL: requests_mock-1.9.2-py2.py3-none-any.whl
- Upload date:
- Size: 26.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5c8ef0254c14a84744be146e9799dc13ebc4f6186058112d9aeed96b131b58e2 |
|
| MD5 | 5f9749933cd627af4d83b355cf8864d6 |
|
| BLAKE2b-256 | a893291e18f4008ee2a3daffe432d7f854b470849c12bad93e8ba552f99f09e6 |
