requests-enhanced 0.1.18

An enhanced wrapper for the requests library with HTTP/2, HTTP/3, retry, timeout, and logging capabilities

Requests Enhanced

An enhanced wrapper for the popular requests library with additional features for improved reliability and convenience in Python HTTP requests.

Features

• HTTP/2 Support: Performance improvements with HTTP/2 protocol support
• HTTP/3 Support: Cutting-edge HTTP/3 protocol support for enhanced performance
• Automatic Retries: Built-in retry mechanism with configurable backoff strategy
• Timeout Handling: Enhanced timeout configuration and error handling
• Improved Logging: Customizable logging with formatted output
• Utility Functions: Simplified JSON request handling

Installation

# Basic installation from PyPI
pip install requests-enhanced

# With HTTP/2 support
pip install requests-enhanced[http2]

# With HTTP/3 support
pip install requests-enhanced[http3]

# From source (development)
git clone https://github.com/khollingworth/requests-enhanced.git
cd requests-enhanced
pip install -e ".[dev]"

Quick Start

from requests_enhanced import Session

# Create a session with default retry and timeout settings
session = Session()

# Simple GET request
response = session.get("https://api.example.com/resources")
print(response.json())

Documentation

• Tutorial: Comprehensive guide covering all features
• Quick Reference: Concise cheat sheet for common patterns
• Examples: Real-world code examples including:
  • Basic Usage
  • API Integration
  • Advanced Sessions
  • HTTP/2 Example
  • HTTP/3 Example
  • Retry Patterns

HTTP/2 Support

The library provides robust HTTP/2 support with significant performance improvements:

Performance Benefits

• 30-40% faster for multiple concurrent requests to the same host
• Multiplexed connections: Multiple requests share a single connection
• Header compression: Reduces overhead and improves load times
• Binary framing: More efficient data transfer
• Server push: Allows servers to preemptively send resources
• Automatic fallback: Gracefully falls back to HTTP/1.1 when needed

Compatibility

• Works with urllib3 versions 1.x and 2.x
• Compatible with Python 3.7+
• Requires TLS 1.2 or higher

See the HTTP/2 example for a performance comparison and the API Reference for configuration details.

Using HTTP/2

Enabling HTTP/2 is simple:

from requests_enhanced import Session, HTTP2_AVAILABLE

# Check if HTTP/2 support is available
if HTTP2_AVAILABLE:
    print("HTTP/2 support is enabled")
else:
    print("HTTP/2 dependencies not installed, install with: pip install requests-enhanced[http2]")

# Create a session with HTTP/2 support
session = Session(http_version="2")

# Make requests as usual - HTTP/2 will be used automatically for HTTPS connections
response = session.get("https://api.example.com/resources")

# HTTP/1.1 will still be used for HTTP connections or if server doesn't support HTTP/2

Manual Configuration

For advanced use cases, you can manually configure the HTTP/2 adapter:

from requests_enhanced import Session, HTTP2Adapter

session = Session()

# Mount HTTP/2 adapter for HTTPS URLs
http2_adapter = HTTP2Adapter()
session.mount("https://", http2_adapter)

# Keep standard adapter for HTTP URLs
from requests.adapters import HTTPAdapter
session.mount("http://", HTTPAdapter())

POST request with JSON data

data = {"name": "example", "value": 42}
response = session.post("https://api.example.com/resources", json=data)

Utility Functions

For quick, one-off requests:

from requests_enhanced.utils import json_get, json_post

# GET request that automatically returns JSON
data = json_get("https://api.example.com/resources")

# POST request with automatic JSON handling
result = json_post("https://api.example.com/resources", data={"name": "example"})

Error Handling

from requests_enhanced import Session
from requests_enhanced.exceptions import RequestTimeoutError, RequestRetryError

try:
    session = Session()
    response = session.get("https://api.example.com/resources")
except RequestTimeoutError as e:
    print(f"Request timed out: {e}")
    print(f"Original exception: {e.original_exception}")
except RequestRetryError as e:
    print(f"Retry failed: {e}")

Documentation

Detailed documentation is available in the docs directory:

• Quickstart Guide: Get up and running quickly
• Usage Guide: Detailed usage examples and patterns
• API Reference: Complete API documentation

Development

Setup Development Environment

# Clone the repository
git clone https://github.com/khollingworth/requests-enhanced.git
cd requests-enhanced

# Create a virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

Running Tests

# Run all tests
pytest

# Run with coverage report
pytest --cov=src/requests_enhanced --cov-report=term-missing

# Run specific test file
pytest tests/test_sessions.py

Code Style

This project uses black for code formatting and flake8 for linting:

# Format code
black src tests examples

# Check code style
flake8 src tests examples

License

This project is licensed under the MIT License - see the LICENSE file for details.