x402/python/legacy/tests/clients/test_requests.py
Carson Roscoe 30a847d7d1
feat: New Python SDK with v2 support (#841)
* chore: renamed python/x402 to python/legacy

* feat: initial Python core SDK

* feat: added core HTTP wrappers

* feat: added core types

* feat: added evm mechanism for exact v1/v2

* feat: added httpx client

* feat: added requests client

* feat: added fastapi middleware

* feat: added flask middleware

* feat: added integration tests

* feat: added Python SDK to e2e tests

* python-v2: fix workflow checks (#863)

* fix format

* fix lint

* fix build

* fix pytest

* Fix syntax errors and missing imports in manual integration example (#902)

- Add missing imports (base64, json, Response, JSONResponse, PaymentPayload, FacilitatorClient)
- Fix function signature syntax error
- Fix dict initialization syntax (colon to equals)
- Add missing return statement after successful payment
- Remove trailing whitespace

* feat: add Python SDK v2 server examples (FastAPI, Flask)  (#879)

* feat: add fastapi example project configuration

* feat: add fastapi example with x402 payment middleware

* docs: add comprehensive README for fastapi example

* feat: add flask example project configuration

* feat: add flask example with x402 payment middleware

* docs: add comprehensive README for flask example

* feat: add test clients for fastapi and flask examples

* docs: add test client usage to READMEs

* chore - remove python-version and test-client.py

* docs - remove test client guide from README.md

* chore - remove license and classifier

* feat - add description and mime type

* feat - update .env-local

* feat: add Python v2 client examples (httpx & requests) (#857)

* feat: add Python v2 client examples (httpx & requests)

Add simple client examples demonstrating httpx (async) and requests (sync) usage with the x402 Python v2 SDK.

- examples/python/clients/example.py - Simple example showing both httpx and requests
- Uses EthAccountSigner with register_exact_evm_client helper
- Minimal configuration required

* refactor: split Python client examples into separate directories

Address PR review feedback:
- Separate httpx/ and requests/ directories
- Add pyproject.toml for uv sync support
- Add environment variable validation
- Add payment response header extraction
- Use context manager for requests session cleanup

Tested on Base Sepolia testnet:
- httpx: tx 0xce49f668aba01c4b0b1af2eb0d9a381f4c62295506a91f20af479e0e834ef350
- requests: tx 0xb83b6feefa5a744b7779ba5b37df33f9c7241f58119454d66102acd97a92f024

* Update examples/python/clients/httpx/main.py

Co-authored-by: phdargen <pdargent@icloud.com>

* Update examples/python/clients/requests/main.py

Co-authored-by: phdargen <pdargent@icloud.com>

---------

Co-authored-by: phdargen <pdargent@icloud.com>

* feat(python): Make v2 framework and client dependencies optional extras (#901)

* python-v2: add svm mechanism (#904)

* add svm mechanism

* add unit tests

* add integration tests

* update server examples

* add e2e tests

* update clients

* make EVM/SVM dependencies optional extras

* fix legacy uv paths

* V2 python bazaar (#929)

* add bazaar extension

* strip query params for discovery

* fix 862

* updated e2e tests

* Add advanced Python client examples (#947)

* Add advanced Python client examples

Implements 5 advanced patterns demonstrating x402 SDK v2 features:
- hooks.py: Payment lifecycle hooks (before, after, failure)
- preferred_network.py: Custom network preference selector
- builder_pattern.py: Network-specific registration with wildcards
- error_recovery.py: Error classification and recovery strategies
- custom_transport.py: Custom httpx transport with retry/timing

Includes:
- CLI entry point (index.py) for running examples
- Comprehensive test suite (40 unit tests)
- E2E integration tests
- README documentation

All tests passing.

* Remove tests and examples beyond TypeScript SDK parity

Address PR review feedback:
- Remove tests directory (tests belong in SDK, not examples)
- Remove custom_transport.py (runtime error, beyond TS parity)
- Remove error_recovery.py (duplicate of hooks.py, beyond TS parity)
- Update index.py, README.md, pyproject.toml accordingly

* Address PR feedback: add SVM support and use optional deps

- Update pyproject.toml to use x402[evm,svm,httpx] instead of
  listing dependencies separately
- Add Solana/SVM network examples to preferred_network.py
- Support both EVM and SVM signers for cross-chain flexibility
- Update .env-local with SOLANA_PRIVATE_KEY option

* Python-v2: facilitator example + e2e (#950)

* add facilitator example

* improve svm signer

* add description to DiscoveredResource

* add facilitator e2e

* add paywall builder (#953)

* Add Python custom client example (#954)

Demonstrates manual x402 v2 payment flow without convenience wrappers.

Shows the 6-step process:
1. Initialize client and register payment schemes
2. Make initial request, receive 402
3. Decode PAYMENT-REQUIRED header
4. Create signed payment payload
5. Retry with PAYMENT-SIGNATURE header
6. Handle success/failure response

Useful for integrating with non-standard HTTP libraries or implementing
custom retry logic.

* feat(v2-sdk): support async dynamic hooks for price and metadata (#900)

* feat(http): implement dual class design for sync/async support

- Add x402HTTPResourceServer (async) for FastAPI/Starlette
- Add x402HTTPResourceServerSync (sync) for Flask/Django
- Share common logic via _x402HTTPServerBase
- Remove dynamic description/resource (keep only dynamic price/payTo)
- Update Flask middleware to use sync server directly
- Integrate with enrich_extensions for bazaar support
- Add per-route hook_timeout_seconds configuration

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(types): add missing Awaitable import and fix test import sorting

- Add Awaitable import to types.py for DynamicPayTo/DynamicPrice type hints
- Fix import block sorting in test_async_hooks.py and test_core.py

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor: simplify API by removing unused types and making timeout opt-in

Address reviewer feedback from @phdargen:
- Remove SyncDynamicPayTo/SyncDynamicPrice (unused types that would require SyncPaymentOption to be useful)
- Change hook_timeout_seconds default to None (opt-in, matching TS/Go parity)
- Export x402HTTPResourceServerSync from http/__init__.py

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

* python-v2: make create_facilitator_config work with both V1 and V2 (#968)

* make create_facilitator_config work with both V1 and V2

* fix lint

* feat: add Python SDK v2 server advanced example (FastAPI) (#952)

* feat - add pyproject.toml, uv.lock for advanced example

* feat - add bazaar extension

* feat - add hooks

* feat - add x402 extensions to pyproject.toml

* feat - add dynamic pricing feature

* feat - add dynamic pay-to and custom money parser features

* docs - add README for advanced server example

* style - apply lint

* chore - add comments for bazaar extension code

* fix: python v2 x402HTTPAdapter retry logic (#978)

* fix: fix consecutive payment bug in x402HTTPAdapter

- Replace instance-level _is_retry flag with per-request header
  to prevent state leakage between consecutive 402 requests.

* tests - add test case for consecutive payment with x402HTTPAdapter

* style - apply lint

* Python-v2: async lifecycle hooks (#975)

* add dual sync/async classes for server/client/facilitator

* update integration/e2e tests

* add unit tests for core, http and implement wrapHttpxWithPaymentFromConfig/wrapRequestsWithPayment

* refactor core server/client/facilitator

* refactor x402_http_server/facilitator_client/x402_http_client

* update exmamples

* add utility function that takes care of html-safe escaping

* add sdk readmes

* add retry unit tests to httpx client

* Update Python SDK Docs for v2 (#976)

* Porting docs and updating for v2 changes (#813)

* porting docs and updating for v2 changes

* update quickstart for sellers

* update quickstarts, miniapps, and mcp docs

* update doc links

* update FAQs

* fix getting started docs

* update core concepts

* remove miniapps guide

* update extensions

* fix bazaar code examples

* fix broken links and yaml file

* remove unnecessary protocol layer doc

* add migration guide

* update documentation for python v2 sdk

* testing pr preview

* docs(python): remove unused os imports and align with TS tab patterns

- Remove unused 'import os' from FastAPI and Flask examples in quickstart-for-sellers
- Update bazaar-discovery-layer Python example to use hardcoded '0xYourPrivateKey' to match TypeScript tab consistency

* update migration doc

* cleanup comments

* cleanup readme

* fix: Python facilitator e2e code

* fix: lint

---------

Co-authored-by: phdargen <p.dargent@cern.ch>
Co-authored-by: somesome <57699892+sohw400@users.noreply.github.com>
Co-authored-by: Logan Kang <kcs93023@gmail.com>
Co-authored-by: 1bcMax <viewitter@gmail.com>
Co-authored-by: phdargen <pdargent@icloud.com>
Co-authored-by: Vladimir Sotnikov <bubert9@gmail.com>
Co-authored-by: Shuhei <shuhei0866@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Faris Habib <faris.habib@coinbase.com>
2026-01-21 16:32:07 -08:00

311 lines
9.5 KiB
Python

import pytest
import json
import base64
from unittest.mock import MagicMock, patch
from requests import Response, PreparedRequest, Session
from eth_account import Account
from x402.clients.requests import (
x402HTTPAdapter,
x402_http_adapter,
x402_requests,
)
from x402.clients.base import (
PaymentError,
)
from x402.types import PaymentRequirements, x402PaymentRequiredResponse
@pytest.fixture
def account():
return Account.create()
@pytest.fixture
def session(account):
return x402_requests(account)
@pytest.fixture
def adapter(account):
return x402_http_adapter(account)
@pytest.fixture
def payment_requirements():
return PaymentRequirements(
scheme="exact",
network="base-sepolia",
asset="0x036CbD53842c5426634e7929541eC2318f3dCF7e",
pay_to="0x0000000000000000000000000000000000000000",
max_amount_required="10000",
resource="https://example.com",
description="test",
max_timeout_seconds=1000,
mime_type="text/plain",
output_schema=None,
extra={
"name": "USD Coin",
"version": "2",
},
)
def test_request_success(session):
# Test successful request (200)
mock_response = Response()
mock_response.status_code = 200
mock_response._content = b"success"
with patch.object(session, "send", return_value=mock_response) as mock_send:
response = session.request("GET", "https://example.com")
assert response.status_code == 200
assert response.content == b"success"
mock_send.assert_called_once()
def test_request_non_402(session):
# Test non-402 response
mock_response = Response()
mock_response.status_code = 404
mock_response._content = b"not found"
with patch.object(session, "send", return_value=mock_response) as mock_send:
response = session.request("GET", "https://example.com")
assert response.status_code == 404
assert response.content == b"not found"
mock_send.assert_called_once()
def test_adapter_send_success(adapter):
# Test adapter with successful response
mock_response = Response()
mock_response.status_code = 200
mock_response._content = b"success"
# Create a prepared request
request = PreparedRequest()
request.prepare("GET", "https://example.com")
with patch("requests.adapters.HTTPAdapter.send", return_value=mock_response):
response = adapter.send(request)
assert response.status_code == 200
assert response.content == b"success"
def test_adapter_send_non_402(adapter):
# Test adapter with non-402 response
mock_response = Response()
mock_response.status_code = 404
mock_response._content = b"not found"
# Create a prepared request
request = PreparedRequest()
request.prepare("GET", "https://example.com")
with patch("requests.adapters.HTTPAdapter.send", return_value=mock_response):
response = adapter.send(request)
assert response.status_code == 404
assert response.content == b"not found"
def test_adapter_retry(adapter):
# Test retry handling in adapter
mock_response = Response()
mock_response.status_code = 402
mock_response._content = b"payment required"
# Create a prepared request
request = PreparedRequest()
request.prepare("GET", "https://example.com")
# Set retry flag to true
adapter._is_retry = True
with patch("requests.adapters.HTTPAdapter.send", return_value=mock_response):
response = adapter.send(request)
assert response.status_code == 402
assert response.content == b"payment required"
# Verify retry flag is reset after call
assert not adapter._is_retry
def test_adapter_payment_flow(adapter, payment_requirements):
# Mock the payment required response
payment_response = x402PaymentRequiredResponse(
x402_version=1,
accepts=[payment_requirements],
error="Payment Required",
)
# Create initial 402 response
initial_response = Response()
initial_response.status_code = 402
initial_response._content = json.dumps(
payment_response.model_dump(by_alias=True)
).encode()
# Mock the retry response with payment response header
payment_result = {
"success": True,
"transaction": "0x1234",
"network": "base-sepolia",
"payer": "0x5678",
}
retry_response = Response()
retry_response.status_code = 200
retry_response.headers = {
"X-Payment-Response": base64.b64encode(
json.dumps(payment_result).encode()
).decode()
}
retry_response._content = b"success"
# Create a prepared request
request = PreparedRequest()
request.prepare("GET", "https://example.com")
request.headers = {}
# Mock client methods
adapter.client.select_payment_requirements = MagicMock(
return_value=payment_requirements
)
mock_header = "mock_payment_header"
adapter.client.create_payment_header = MagicMock(return_value=mock_header)
# Mock the send method to return different responses
def mock_send_impl(req, **kwargs):
if adapter._is_retry:
return retry_response
return initial_response
with patch(
"requests.adapters.HTTPAdapter.send", side_effect=mock_send_impl
) as mock_send:
response = adapter.send(request)
# Verify the result
assert response.status_code == 200
assert "X-Payment-Response" in response.headers
# Verify the mocked methods were called with correct arguments
adapter.client.select_payment_requirements.assert_called_once_with(
[payment_requirements]
)
adapter.client.create_payment_header.assert_called_once_with(
payment_requirements, 1
)
# Verify the retry request was made with correct headers
assert mock_send.call_count == 2
retry_call = mock_send.call_args_list[1]
retry_request = retry_call[0][0]
assert retry_request.headers["X-Payment"] == mock_header
assert (
retry_request.headers["Access-Control-Expose-Headers"]
== "X-Payment-Response"
)
def test_adapter_payment_error(adapter, payment_requirements):
# Mock the payment required response with unsupported scheme
payment_requirements.scheme = "unsupported"
payment_response = x402PaymentRequiredResponse(
x402_version=1,
accepts=[payment_requirements],
error="Payment Required",
)
# Create initial 402 response
initial_response = Response()
initial_response.status_code = 402
initial_response._content = json.dumps(
payment_response.model_dump(by_alias=True)
).encode()
# Create a prepared request
request = PreparedRequest()
request.prepare("GET", "https://example.com")
with patch("requests.adapters.HTTPAdapter.send", return_value=initial_response):
with pytest.raises(PaymentError):
adapter.send(request)
# Verify retry flag is reset
assert not adapter._is_retry
def test_adapter_general_error(adapter):
# Create initial 402 response with invalid JSON
initial_response = Response()
initial_response.status_code = 402
initial_response._content = b"invalid json"
# Create a prepared request
request = PreparedRequest()
request.prepare("GET", "https://example.com")
with patch("requests.adapters.HTTPAdapter.send", return_value=initial_response):
with pytest.raises(PaymentError):
adapter.send(request)
# Verify retry flag is reset
assert not adapter._is_retry
def test_x402_http_adapter(account):
# Test basic adapter creation
adapter = x402_http_adapter(account)
assert isinstance(adapter, x402HTTPAdapter)
assert adapter.client.account == account
assert adapter.client.max_value is None
# Test with max_value
adapter = x402_http_adapter(account, max_value=1000)
assert adapter.client.max_value == 1000
# Test with custom selector
def custom_selector(accepts, network_filter=None, scheme_filter=None):
return accepts[0]
adapter = x402_http_adapter(account, payment_requirements_selector=custom_selector)
assert (
adapter.client.select_payment_requirements
!= adapter.client.__class__.select_payment_requirements
)
# Test passing adapter kwargs
adapter = x402_http_adapter(account, pool_connections=10, pool_maxsize=100)
# Note: HTTPAdapter doesn't expose these properties, so we can't directly assert them
def test_x402_requests(account):
# Test session creation
session = x402_requests(account)
assert isinstance(session, Session)
# Check http adapter mounting
adapter = session.adapters.get("http://")
assert isinstance(adapter, x402HTTPAdapter)
assert adapter.client.account == account
# Check https adapter mounting
adapter = session.adapters.get("https://")
assert isinstance(adapter, x402HTTPAdapter)
assert adapter.client.account == account
# Test with max_value
session = x402_requests(account, max_value=1000)
adapter = session.adapters.get("http://")
assert adapter.client.max_value == 1000
# Test with custom selector
def custom_selector(accepts, network_filter=None, scheme_filter=None):
return accepts[0]
session = x402_requests(account, payment_requirements_selector=custom_selector)
adapter = session.adapters.get("http://")
assert (
adapter.client.select_payment_requirements
!= adapter.client.__class__.select_payment_requirements
)