28bfbe23ad
pypip.in has been broken for a long time. Change-Id: I43766a841d1cc19a8911ee2c5f97646f6e2fa2f2
87 lines
2.4 KiB
ReStructuredText
87 lines
2.4 KiB
ReStructuredText
===============================
|
|
requests-mock
|
|
===============================
|
|
|
|
.. image:: https://badge.fury.io/py/requests-mock.png
|
|
:target: http://badge.fury.io/py/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 `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:
|
|
|
|
.. code:: python
|
|
|
|
>>> 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:
|
|
|
|
.. code:: python
|
|
|
|
>>> with requests_mock.mock() as m:
|
|
... m.get('http://test.com', text='data')
|
|
... requests.get('http://test.com').text
|
|
...
|
|
'data'
|
|
|
|
Or as a decorator:
|
|
|
|
.. code:: python
|
|
|
|
>>> @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.
|
|
|
|
.. _requests: http://python-requests.org
|
|
.. _docs: http://requests-mock.readthedocs.org
|
|
.. _LaunchPad: https://bugs.launchpad.net/requests-mock
|