Python API Reference

Generated reference. This page is derived from proxywhirl.__all__, package metadata, and object docstrings during pnpm --dir web run docs:generate. Edit web/scripts/generate-docs.mjs, not this MDX file.

proxywhirl

Package

Version 0.3.3

>=3.10

Python

Supported runtime range

113

Public exports

Entries in proxywhirl.__all__

Modules

Top namespaces shown below

Core Surface

Export	Kind	Module	Use
`ProxyWhirl`	class	`proxywhirl.rotator.sync`	Main class for proxy rotation with automatic failover.
`AsyncProxyWhirl`	class	`proxywhirl.rotator.async_`	Async proxy rotator with automatic failover and intelligent rotation.
`Proxy`	class	`proxywhirl.models`	Represents a single proxy server with connection details and metadata.
`ProxyPool`	class	`proxywhirl.models`	Collection of proxies with management capabilities.
`BootstrapConfig`	class	`proxywhirl.models`	Configuration for the lazy bootstrap that runs on first request when the pool is empty.
`ProxyFetcher`	class	`proxywhirl.fetchers`	Fetch and parse proxies from multiple sources with validation and deduplication.
`ProxyValidator`	class	`proxywhirl.fetchers`	Validate proxy connectivity with detailed metrics and multiple test endpoints.
`StrategyRegistry`	class	`proxywhirl.strategies`	Singleton registry for custom rotation strategies.
`ALL_SOURCES`	value	`proxywhirl`	Built-in mutable sequence.
`RECOMMENDED_SOURCES`	value	`proxywhirl`	Built-in mutable sequence.

Export Shape

Kind	Count
class	83
function	23
value	7

Top Namespaces

Module	Exports
`proxywhirl.models`	21
`proxywhirl.exceptions`	18
`proxywhirl.strategies`	14
`proxywhirl.utils`	14
`proxywhirl.fetchers`	8
`proxywhirl`	7
`proxywhirl.safe_regex`	7
`proxywhirl.retry`	6
`proxywhirl.rate_limiting`	4
`proxywhirl.circuit_breaker`	3
`proxywhirl.sources`	2
`proxywhirl.storage`	2

Python API Reference

Python API Reference

Core Surface

Export Shape

Top Namespaces

On this page