Skip to main content

Mock out responses from the requests package

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 useful, so you can use requests_mock.mock to get the adapter into place.

As a context manager:

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

Or as a decorator:

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

For more information checkout the docs.

Reporting Bugs

Please report all bugs on LaunchPad.

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

Uploaded Source

Built Distribution

requests_mock-1.3.0-py2.py3-none-any.whl (33.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for requests-mock-1.3.0.tar.gz
Algorithm Hash digest
SHA256 bd86970d6c52cc97071f5185aa594de6a997a5ca63b3bb36aceb9bb9db49294b
MD5 d2efbaf16d19153b7d271628071b4d4b
BLAKE2b-256 8dcb1267d7294d97e9a3ef24bf1370791da4d2dc6abc0f67626f38f4bf25dfa3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for requests_mock-1.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 23edd6f7926aa13b88bf79cb467632ba2dd5a253034e9f41563f60ed305620c7
MD5 dcde5f7a1928a8487a1cdc83b03034fe
BLAKE2b-256 1caa9f820349943529551b5dc50412070a41456d37b3616e60cc0e6ccb3f7f47

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