Skip to main content

Proxy auto-config and auto-discovery for Python.

Project description

https://img.shields.io/pypi/v/pypac.svg?maxAge=2592000 https://readthedocs.org/projects/pypac/badge/?version=latest https://img.shields.io/travis/carsonyl/pypac.svg?maxAge=2592000 https://ci.appveyor.com/api/projects/status/y7nxvu2feu87i39t/branch/master?svg=true https://img.shields.io/coveralls/carsonyl/pypac/HEAD.svg?maxAge=2592000 https://img.shields.io/codacy/grade/71ac103b491d44efb94976ca5ea5d89c.svg?maxAge=2592000

PyPAC is a pure-Python library for finding proxy auto-config (PAC) files and making HTTP requests that respect them. PAC files are often used in organizations that need fine-grained and centralized control of proxy settings.

PyPAC provides a subclass of a Requests Session, so you can start using it immediately, with any PAC file transparently discovered and honoured:

>>> from pypac import PACSession
>>> session = PACSession()
>>> session.get('http://example.org')
...

If a PAC file isn’t found, then PACSession acts exactly like a regular Session.

PyPAC can find PAC files according to the DNS portion of the Web Proxy Auto-Discovery (WPAD) protocol. On Windows, PyPAC can also obtain the PAC file URL from the Internet Options dialog, via the registry. On macOS, PyPAC can obtain the PAC file URL from System Preferences.

If you’re looking to add basic PAC functionality to a library that you’re using, try the pac_context_for_url() context manager:

from pypac import pac_context_for_url
import boto3

with pac_context_for_url('https://example.amazonaws.com'):
    client = boto3.client('sqs')
    client.list_queues()

This sets up proxy environment variables at the start of the scope, based on any auto-discovered PAC and the given URL. pac_context_for_url() should work for any library that honours proxy environment variables.

Features

  • The same Requests API that you already know and love
  • Honour PAC setting from Windows Internet Options and macOS System Preferences
  • Follow DNS Web Proxy Auto-Discovery protocol
  • Proxy authentication pass-through
  • Proxy failover and load balancing
  • Generic components for adding PAC support to other code

PyPAC supports Python 2.7 and 3.4+.

Installation

Install PyPAC using pip:

$ pip install pypac

Documentation

PyPAC’s documentation is available at http://pypac.readthedocs.io/.

0.9.0 (2018-06-02)

  • Add macOS support for PAC in System Preferences (#23). Thanks @LKleinNux.
  • The from_registry argument on pypac.get_pac() and pypac.collect_pac_urls() is now deprecated and will be removed in 1.0.0. Use from_os_settings instead.

0.8.1 (2018-03-01)

  • Defer Js2Py import until it’s needed. It uses a lot of memory. See #20 for details.

0.8.0 (2018-02-28)

  • Add support for file:// PAC URLs on Windows.

0.7.0 (2018-02-21)

  • Drop support for Python 3.3.
  • Add doc explaining how to use pac_context_for_url.
  • Internal changes to dev and test processes.

0.6.0 (2018-01-28)

  • Add pac_context_for_url, a context manager that adds basic PAC functionality through proxy environment variables.

0.5.0 (2018-01-18)

  • Accept PAC files served with no Content-Type header.

0.4.0 (2017-11-07)

  • Add recursion_limit keyword argument to PACSession and PACFile. The default is an arbitrarily high value (10000), which should cover most applications.
  • Exclude port numbers from host passed to FindProxyForURL(url, host).

0.3.1 (2017-06-23)

  • Update GitHub username.

0.3.0 (2017-04-12)

  • Windows: Get system auto-proxy config setting using winreg module.
  • Windows: Accept local filesystem paths from system proxy auto-config setting.
  • Raise PacComplexityError when recursion limit is hit while parsing PAC file.
  • Support setting PACSession.proxy_auth and ProxyResolver.proxy_auth after constructing an instance.
  • Narrative docs.

0.2.1 (2017-01-19)

  • Require Js2Py >= 0.43 for Python 3.6 support, and to avoid needing to monkeypatch out pyimport.

0.1.0 (2016-06-12)

  • First release.

Project details


Release history Release notifications

This version
History Node

0.9.0

History Node

0.8.1

History Node

0.8.0

History Node

0.7.0

History Node

0.6.0

History Node

0.5.0

History Node

0.4.0

History Node

0.3.1

History Node

0.3.0

History Node

0.2.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pypac-0.9.0-py2.py3-none-any.whl (26.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 3, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page