SimpleProxyResolver
Added in version 2.36.
Superclasses: Object
Implemented Interfaces: ProxyResolver
GSimpleProxyResolver is a simple ProxyResolver implementation
that handles a single default proxy, multiple URI-scheme-specific
proxies, and a list of hosts that proxies should not be used for.
GSimpleProxyResolver is never the default proxy resolver, but it
can be used as the base class for another proxy resolver
implementation, or it can be created and used manually, such as
with set_proxy_resolver.
Methods
- class SimpleProxyResolver
- new(default_proxy: str | None = None, ignore_hosts: Sequence[str] | None = None) ProxyResolver
Creates a new
SimpleProxyResolver. SeeSimpleProxyResolver:default-proxy andSimpleProxyResolver:ignore-hosts for more details on how the arguments are interpreted.Added in version 2.36.
- Parameters:
default_proxy – the default proxy to use, eg “socks://192.168.1.1”
ignore_hosts – an optional list of hosts/IP addresses to not use a proxy for.
- set_default_proxy(default_proxy: str | None = None) None
Sets the default proxy on
resolver, to be used for any URIs that don’t matchSimpleProxyResolver:ignore-hosts or a proxy set viaset_uri_proxy().If
default_proxystarts with “socks://”,SimpleProxyResolverwill treat it as referring to all three of the socks5, socks4a, and socks4 proxy types.Added in version 2.36.
- Parameters:
default_proxy – the default proxy to use
- set_ignore_hosts(ignore_hosts: Sequence[str]) None
Sets the list of ignored hosts.
See
SimpleProxyResolver:ignore-hosts for more details on how theignore_hostsargument is interpreted.Added in version 2.36.
- Parameters:
ignore_hosts –
None-terminated list of hosts/IP addresses to not use a proxy for
- set_uri_proxy(uri_scheme: str, proxy: str) None
Adds a URI-scheme-specific proxy to
resolver; URIs whose scheme matchesuri_scheme(and which don’t matchSimpleProxyResolver:ignore-hosts) will be proxied viaproxy.As with
SimpleProxyResolver:default-proxy, ifproxystarts with “socks://”,SimpleProxyResolverwill treat it as referring to all three of the socks5, socks4a, and socks4 proxy types.Added in version 2.36.
- Parameters:
uri_scheme – the URI scheme to add a proxy for
proxy – the proxy to use for
uri_scheme
Properties
- class SimpleProxyResolver
- props.default_proxy: str
The default proxy URI that will be used for any URI that doesn’t match
SimpleProxyResolver:ignore-hosts, and doesn’t match any of the schemes set withset_uri_proxy().Note that as a special case, if this URI starts with “socks://”,
SimpleProxyResolverwill treat it as referring to all three of the socks5, socks4a, and socks4 proxy types.
- props.ignore_hosts: Sequence[str]
A list of hostnames and IP addresses that the resolver should allow direct connections to.
Entries can be in one of 4 formats:
A hostname, such as “example.com”, “.example.com”, or “*.example.com”, any of which match “example.com” or any subdomain of it.
An IPv4 or IPv6 address, such as “192.168.1.1”, which matches only that address.
A hostname or IP address followed by a port, such as “example.com:80”, which matches whatever the hostname or IP address would match, but only for URLs with the (explicitly) indicated port. In the case of an IPv6 address, the address part must appear in brackets: “[::1]:443”
An IP address range, given by a base address and prefix length, such as “fe80::/10”, which matches any address in that range.
Note that when dealing with Unicode hostnames, the matching is done against the ASCII form of the name.
Also note that hostname exclusions apply only to connections made to hosts identified by name, and IP address exclusions apply only to connections made to hosts identified by address. That is, if example.com has an address of 192.168.1.1, and the :ignore-hosts list contains only “192.168.1.1”, then a connection to “example.com” (eg, via a
NetworkAddress) will use the proxy, and a connection to “192.168.1.1” (eg, via aInetSocketAddress) will not.These rules match the “ignore-hosts”/”noproxy” rules most commonly used by other applications.