WebKit2.NetworkProxySettings

Fields

None

Methods

class

new (default_proxy_uri, ignore_hosts)

add_proxy_for_scheme (scheme, proxy_uri)

copy ()

free ()

Details

class WebKit2.NetworkProxySettings

Configures network proxies.

WebKit2.NetworkProxySettings can be used to provide a custom proxy configuration to a WebKit2.WebContext. You need to call WebKit2.WebContext.set_network_proxy_settings() with WebKit2.NetworkProxyMode.CUSTOM and a WebKit2.NetworkProxySettings.

New in version 2.16.

classmethod new(default_proxy_uri, ignore_hosts)
Parameters:

  • default_proxy_uri (str or None) – the default proxy URI to use, or None.

  • ignore_hosts ([str] or None) – an optional list of hosts/IP addresses to not use a proxy for.

Returns:

A new WebKit2.NetworkProxySettings.

Return type:

WebKit2.NetworkProxySettings

Create a new WebKit2.NetworkProxySettings with the given default_proxy_uri and ignore_hosts.

The default proxy URI will be used for any URI that doesn’t match ignore_hosts, and doesn’t match any of the schemes added with WebKit2.NetworkProxySettings.add_proxy_for_scheme(). If default_proxy_uri starts with “socks://”, it will be treated as referring to all three of the socks5, socks4a, and socks4 proxy types.

ignore_hosts is 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 ignore_hosts contains only “192.168.1.1”, then a connection to “example.com” will use the proxy, and a connection to 192.168.1.1” will not.

New in version 2.16.

add_proxy_for_scheme(scheme, proxy_uri)
Parameters:

  • scheme (str) – the URI scheme to add a proxy for

  • proxy_uri (str) – the proxy URI to use for uri_scheme

Adds a URI-scheme-specific proxy.

URIs whose scheme matches uri_scheme will be proxied via proxy_uri. As with the default proxy URI, if proxy_uri starts with “socks://”, it will be treated as referring to all three of the socks5, socks4a, and socks4 proxy types.

New in version 2.16.

copy()
Returns:

A copy of passed in WebKit2.NetworkProxySettings

Return type:

WebKit2.NetworkProxySettings

Make a copy of the WebKit2.NetworkProxySettings.

New in version 2.16.

free()

Free the WebKit2.NetworkProxySettings.

New in version 2.16.