ProxyResolver

Added in version 2.26.

class ProxyResolver(*args, **kwargs)

Implementations: SimpleProxyResolver

GProxyResolver provides synchronous and asynchronous network proxy resolution. GProxyResolver is used within SocketClient through the method proxy_enumerate.

Implementations of GProxyResolver based on libproxy and GNOME settings can be found in glib-networking. GIO comes with an implementation for use inside Flatpak portals.

Methods

class ProxyResolver
get_default() → ProxyResolver

Gets the default ProxyResolver for the system.

Added in version 2.26.

is_supported() → bool

Checks if resolver can be used on this system. (This is used internally; get_default() will only return a proxy resolver that returns True for this method.)

Added in version 2.26.

lookup(uri: str, cancellable: Cancellable | None = None) → list[str]

Looks into the system proxy configuration to determine what proxy, if any, to use to connect to uri. The returned proxy URIs are of the form <protocol>://[user[:password]@]host[:port] or direct://, where <protocol> could be http, rtsp, socks or other proxying protocol.

If you don’t know what network protocol is being used on the socket, you should use none as the URI protocol. In this case, the resolver might still return a generic proxy type (such as SOCKS), but would not return protocol-specific proxy types (such as http).

direct:// is used when no proxy is needed. Direct connection should not be attempted unless it is part of the returned array of proxies.

Added in version 2.26.

Parameters:

  • uri – a URI representing the destination to connect to

  • cancellable – a Cancellable, or None

lookup_async(uri: str, cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: Any) → None

Asynchronous lookup of proxy. See lookup() for more details.

Added in version 2.26.

Parameters:

  • uri – a URI representing the destination to connect to

  • cancellable – a Cancellable, or None

  • callback – callback to call after resolution completes

  • user_data – data for callback

lookup_finish(result: AsyncResult) → list[str]

Call this function to obtain the array of proxy URIs when lookup_async() is complete. See lookup() for more details.

Added in version 2.26.

Parameters:

result – the result passed to your AsyncReadyCallback

Virtual Methods

class ProxyResolver
do_is_supported() → bool

Checks if resolver can be used on this system. (This is used internally; get_default() will only return a proxy resolver that returns True for this method.)

Added in version 2.26.

do_lookup(uri: str, cancellable: Cancellable | None = None) → list[str]

Looks into the system proxy configuration to determine what proxy, if any, to use to connect to uri. The returned proxy URIs are of the form <protocol>://[user[:password]@]host[:port] or direct://, where <protocol> could be http, rtsp, socks or other proxying protocol.

If you don’t know what network protocol is being used on the socket, you should use none as the URI protocol. In this case, the resolver might still return a generic proxy type (such as SOCKS), but would not return protocol-specific proxy types (such as http).

direct:// is used when no proxy is needed. Direct connection should not be attempted unless it is part of the returned array of proxies.

Added in version 2.26.

Parameters:

  • uri – a URI representing the destination to connect to

  • cancellable – a Cancellable, or None

do_lookup_async(uri: str, cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: Any) → None

Asynchronous lookup of proxy. See lookup() for more details.

Added in version 2.26.

Parameters:

  • uri – a URI representing the destination to connect to

  • cancellable – a Cancellable, or None

  • callback – callback to call after resolution completes

  • user_data – data for callback

do_lookup_finish(result: AsyncResult) → list[str]

Call this function to obtain the array of proxy URIs when lookup_async() is complete. See lookup() for more details.

Added in version 2.26.

Parameters:

result – the result passed to your AsyncReadyCallback