:right-sidebar: True

NetworkProxySettings
===================================================================

.. currentmodule:: gi.repository.WebKit


.. versionadded:: 2.16




.. class:: NetworkProxySettings(**kwargs)
   :no-contents-entry:






Configures network proxies.

WebKitNetworkProxySettings can be used to provide a custom proxy configuration
to a :obj:`~gi.repository.WebKit.WebContext`\. You need to call webkit_web_context_set_network_proxy_settings()
with :const:`~gi.repository.WebKit.NetworkProxyMode.CUSTOM` and a WebKitNetworkProxySettings.


Constructors
------------

.. rst-class:: interim-class

.. class:: NetworkProxySettings
   :no-index:


   .. classmethod:: new(default_proxy_uri: str | None = None, ignore_hosts: list[str] | None = None) -> ~gi.repository.WebKit.NetworkProxySettings

      Create a new :obj:`~gi.repository.WebKit.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 :func:`~gi.repository.WebKit.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:
      <itemizedlist>
      <listitem><para>
      A hostname, such as "example.com", ".example.com", or "\*.example.com", any of which match "example.com" or
      any subdomain of it.
      </para></listitem>
      <listitem><para>
      An IPv4 or IPv6 address, such as "192.168.1.1", which matches only that address.
      </para></listitem>
      <listitem><para>
      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"
      </para></listitem>
      <listitem><para>
      An IP address range, given by a base address and prefix length, such as "fe80::/10", which matches any address in that range.
      </para></listitem>
      </itemizedlist>

      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.


      .. versionadded:: 2.16





      :param default_proxy_uri: the default proxy URI to use, or :const:`None`.

      :param ignore_hosts: an optional list of hosts/IP addresses to not use a proxy for.








Methods
-------

.. rst-class:: interim-class

.. class:: NetworkProxySettings
   :no-index:


   .. method:: add_proxy_for_scheme(scheme: str, proxy_uri: str) -> None

      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.


      .. versionadded:: 2.16





      :param scheme: the URI scheme to add a proxy for

      :param proxy_uri: the proxy URI to use for ``uri_scheme``




   .. method:: free() -> None

      Free the :obj:`~gi.repository.WebKit.NetworkProxySettings`\.


      .. versionadded:: 2.16