HTTPretty

Warnings

• breaking HTTPretty dropped support for Python 2 in version 1.0.0. Projects still on Python 2 must use an older version.
  Fix: Upgrade to Python 3 or pin httpretty to a version less than 1.0.0.
• gotcha Failing to disable HTTPretty after tests can lead to unexpected behavior in subsequent code or tests, as it monkey-patches the global socket module. Always use the `@httpretty.activate` decorator for test functions or explicitly call `httpretty.enable()` and `httpretty.disable()` in a `try...finally` block.
  Fix: Use the `@httpretty.activate` decorator for unit tests or ensure `httpretty.enable()` is paired with `httpretty.disable()` in a controlled scope.
• gotcha URL matching with `httpretty.register_uri` can be very strict. Minor differences, such as a missing trailing slash, can prevent the mock from being matched, leading to an `httpretty.errors.UnmockedError` if `allow_net_connect` is `False`.
  Fix: Ensure exact URL matching or use regular expressions (e.g., `re.compile(r'http://example.com/api/data/?')`) for more flexible matching.
• breaking HTTPretty has known compatibility issues with `urllib3` versions 2.3.0 and higher when `allow_net_connect=False`. This can lead to `UnmockedError` or other unexpected networking issues, as `httpretty` may fail to intercept requests correctly.
  Fix: Pin `urllib3` to a version less than 2.3.0 (e.g., `<2.3.0`) or consider alternative mocking libraries if this is a blocker.
• gotcha In certain scenarios, HTTPretty may not correctly intercept requests made using Python's `http.client.HTTPConnection`, which can lead to `socket.gaierror` (getaddrinfo error) if the real network connection is attempted and fails.
  Fix: Verify that your specific HTTP client library and usage pattern are compatible with httpretty's monkey-patching. This may require reviewing `httpretty`'s issue tracker for known client-specific incompatibilities.

Install

• pip install httpretty Install stable version

Imports

• httpretty

  import httpretty

Quickstart

This example demonstrates how to use the `@httpretty.activate` decorator to mock an HTTP GET request to `http://example.com/api/data`. It registers a URI with a specific JSON response body and status code, then uses the `requests` library to make the call. Assertions verify both the received response and properties of the intercepted request. The `allow_net_connect=False` argument prevents accidental real network connections during tests.

import requests
import httpretty

# httpretty monkey-patches the socket module.
# The @httpretty.activate decorator ensures it's enabled for the test function
# and disabled afterwards, isolating the mock.
@httpretty.activate(verbose=False, allow_net_connect=False)
def quickstart_example():
    test_url = "http://example.com/api/data"
    mock_body = '{"message": "Hello from mock!"}'
    
    # Register a URI to mock with GET method and a JSON body
    httpretty.register_uri(
        httpretty.GET,
        test_url,
        body=mock_body,
        status=200,
        content_type="application/json"
    )

    # Make a request using a common HTTP client (e.g., requests)
    response = requests.get(test_url)

    # Assertions on the response
    assert response.status_code == 200
    assert response.json() == {"message": "Hello from mock!"}
    
    # Assertions on the intercepted request itself
    assert httpretty.last_request().method == "GET"
    assert httpretty.last_request().path == "/api/data"
    print("Mocked request successful!")

# To run the example (e.g., in a script or interactive session)
if __name__ == "__main__":
    quickstart_example()