HTTMock

1.4.0 · active · verified Fri Apr 10

HTTMock is a Python library designed for mocking the 'requests' library, enabling developers to simulate third-party API responses and test internal components that rely on HTTP interactions. The current version is 1.4.0, released in October 2020. While functional, its release cadence is slow, suggesting a mature but less actively developed project.

Warnings

gotcha The `httmock` library (patrys/httmock) has not seen updates since October 2020. While it specifies Python 2.7 and 3.4+ support, compatibility with newer Python versions (e.g., 3.9+) or very recent releases of the `requests` library may be untested or have subtle, undocumented issues.
Fix: Thoroughly test `httmock` with your specific Python and `requests` versions. Consider alternative mocking libraries like `requests-mock` or `respx` if you encounter compatibility problems with newer environments.
gotcha There are multiple HTTP mocking libraries across different languages (Rust, Go, Node.js) that share similar names like 'httpmock'. Ensure you are referencing documentation and examples specifically for the Python `httmock` library (github.com/patrys/httmock).
Fix: Always verify the library's GitHub repository or PyPI page to confirm it's the correct Python `httmock` (patrys/httmock).
gotcha `HTTMock` is designed to be used as a context manager (e.g., `with HTTMock(...)`). Not using it as such, or failing to properly manage its scope, can lead to mocks persisting longer than intended, interfering with other tests, or causing unexpected behavior in your application.
Fix: Always wrap your mocked HTTP requests within a `with HTTMock(...)` block to ensure mocks are applied and cleaned up correctly, limiting their scope to the test or function where they are needed.

Install

pip install httmock Install HTTMock

Imports

HTTMock
```
from httmock import HTTMock
```
urlmatch
```
from httmock import urlmatch
```
all_requests
```
from httmock import all_requests
```
response
```
from httmock import response
```

Quickstart

This quickstart demonstrates how to use `httmock` with the `urlmatch` decorator to intercept and respond to HTTP requests made by the `requests` library. The `HTTMock` context manager ensures that the mock is active only for the duration of the `with` block.

from httmock import urlmatch, HTTMock
import requests

@urlmatch(netloc=r'(.*\.)?example\.com$')
def example_mock(url, request):
    """Mocks requests to example.com."""
    print(f"Mocking request to: {url.geturl()} with method {request.method}")
    if request.path == '/data' and request.method == 'GET':
        return {'status': 'success', 'data': 'mocked content'}
    return {'status': 'error', 'message': 'Not found'}

# Use HTTMock as a context manager
with HTTMock(example_mock):
    # This request will be intercepted by example_mock
    r = requests.get('http://example.com/data')
    print(f"Response from mocked URL: {r.json()}")

    # This request will also be intercepted, but return 'Not found'
    r_post = requests.post('https://www.example.com/other')
    print(f"Response from another mocked URL: {r_post.json()}")

    # This request will NOT be mocked and will go to the actual internet
    r_google = requests.get('http://google.com/')
    print(f"Response from real Google (status: {r_google.status_code})")

view raw JSON →