GeezerVison

name: Proxy integration tests

jobs:

unit:

runs-on: ubuntu-24.04

strategy:

fail-fast: false

matrix:

python-version: ["3.10", "3.15"]

steps:

- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

with:

- name: Set up Python

uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0

with:

python-version: "3.x"

python-version: ${{ matrix.python-version }}

- name: Install system dependencies (pycurl)

run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev

- name: Install package and test dependencies

- name: Install package and compatible client extras

run: |

- name: Run header security and httpx guard tests

run: python test_header_security.py && python test_httpx_guard.py

- name: Run private-hook tests

run: python test_client_internals.py

integration:

runs-on: ubuntu-24.04

- name: Set up Python

uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0

with:

python-version: "3.x"

python-version: "3.15"

- name: Install system dependencies (pycurl)

run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev

- name: Install package and test dependencies

- name: Install package and compatible client extras

run: |

- name: Require PROXY_URL Actions secret

env:

- Importing `python_proxy_headers.httpx_proxy` on httpx >= 1 raises `ImportError`. httpx 1.0 removed proxy support. The `[httpx]` extra is `httpx>=0.28,<1`.

- Optional extras pin the client ranges CI installs: `[urllib3]`, `[requests]`, `[httpx]`, `[aiohttp]`, `[pycurl]`, `[cloudscraper]`, and `[autoscraper]`.

- `requires-python` is `>=3.10`. Python 3.8 and 3.9 are no longer supported. Those clients require 3.10+, and the httpx adapter already uses `str | None`.

- Keywords, trove classifiers, and the changelog URL now point at this file.

pip install python-proxy-headers

Then install the HTTP library you want to use (e.g., `pip install requests`).

Or install the client extra you need. Each extra pins a range that CI tests:

pip install 'python-proxy-headers[requests]'

pip install 'python-proxy-headers[urllib3]'

pip install 'python-proxy-headers[httpx]'

pip install 'python-proxy-headers[aiohttp]'

pip install 'python-proxy-headers[pycurl]'

pip install 'python-proxy-headers[cloudscraper]'

pip install 'python-proxy-headers[autoscraper]'

The `httpx` extra is `httpx>=0.28,<1`. Importing `python_proxy_headers.httpx_proxy` on httpx 1.x raises `ImportError`. See the [httpx docs](https://python-proxy-headers.readthedocs.io/en/latest/httpx.html). Proxy header names are specific to your provider; ProxyMesh documents theirs at [docs.proxymesh.com](https://docs.proxymesh.com/).

A test harness is included to verify proxy header functionality:

python test_header_security.py

python test_httpx_guard.py

python test_client_internals.py

export PROXY_URL='http://user:[email protected]:8080'

- **Full Documentation:** [python-proxy-headers.readthedocs.io](https://python-proxy-headers.readthedocs.io/en/latest/)

- **Example Code:** [proxy-examples for Python](https://github.com/proxymesh/proxy-examples/tree/main/python)

- **[javascript-proxy-headers](https://github.com/proxymesh/javascript-proxy-headers)** - Send and read custom proxy headers on HTTPS CONNECT for Node.js HTTP clients

- **[ruby-proxy-headers](https://github.com/proxymesh/ruby-proxy-headers)** - Send and read custom proxy headers on HTTPS CONNECT for Ruby HTTP clients

- **[scrapy-proxy-headers](https://github.com/proxymesh/scrapy-proxy-headers)** - Proxy header support for Scrapy

If you are looking for `Scrapy <https://scrapy.org/>`_ support, please see our `scrapy-proxy-headers <https://github.com/proxymesh/scrapy-proxy-headers>`_ project.

The same CONNECT header support in other languages:

* `javascript-proxy-headers <https://github.com/proxymesh/javascript-proxy-headers>`_

* `ruby-proxy-headers <https://github.com/proxymesh/ruby-proxy-headers>`_

Installation

To use these extension modules, you must first do the following:

1. Install the package:

1. Install the package, optionally with the client you use:

.. code-block:: bash

2. Install the appropriate package based on the Python module you want to use.

2. Or install the HTTP library yourself. Extras pin the ranges we test. The ``httpx`` extra is ``httpx>=0.28,<1``. Importing it on httpx 1.x raises ``ImportError``; see :doc:`httpx`. Proxy-specific headers are documented by your provider. ProxyMesh's are at `docs.proxymesh.com <https://docs.proxymesh.com/>`_.

This package does not have any dependencies because we don't know which module you want to use.

This package does not have any required dependencies because we don't know which module you want to use.

You can also find more example code in our `proxy-examples for python <https://github.com/proxymesh/proxy-examples/tree/main/python>`_.

]

description = "Handle custom proxy headers for http & https requests in various python libraries"

readme = "README.md"

requires-python = ">=3.8"

requires-python = ">=3.10"

keywords = [

"proxy",

"proxy-headers",

"https-proxy",

"connect",

"tunnel",

"requests",

"urllib3",

"httpx",

"aiohttp",

"web-scraping",

"proxymesh",

]

classifiers = [

"Development Status :: 4 - Beta",

"Programming Language :: Python :: 3",

"Programming Language :: Python :: 3 :: Only",

"Programming Language :: Python :: 3.10",

"Programming Language :: Python :: 3.11",

"Programming Language :: Python :: 3.12",

"Programming Language :: Python :: 3.13",

"Programming Language :: Python :: 3.14",

"Programming Language :: Python :: 3.15",

"Operating System :: OS Independent",

"License :: OSI Approved :: MIT License",

"Intended Audience :: Developers",

"Topic :: Internet :: WWW/HTTP",

"License :: OSI Approved :: MIT License",

"Intended Audience :: Developers",

"Topic :: Internet :: WWW/HTTP",

"Topic :: Internet :: Proxy Servers",

"Topic :: Software Development :: Libraries :: Python Modules",

"Framework :: AsyncIO",

]

[project.optional-dependencies]

urllib3 = ["urllib3>=2.2,<3"]

requests = ["requests>=2.31,<3"]

httpx = ["httpx>=0.28,<1"]

aiohttp = ["aiohttp>=3.10,<4"]

pycurl = ["pycurl>=7.45,<8"]

cloudscraper = ["cloudscraper>=1.2.71,<2"]

autoscraper = ["autoscraper>=1.1.14,<2"]

[project.urls]

Homepage = "https://github.com/proxymesh/python-proxy-headers"

Changelog = "https://github.com/proxymesh/python-proxy-headers/commits/main/"

Changelog = "https://github.com/proxymesh/python-proxy-headers/blob/main/CHANGELOG.md"

Issues = "https://github.com/proxymesh/python-proxy-headers/issues"

Documentation = "https://python-proxy-headers.readthedocs.io/en/latest/"

ProxyMesh = "https://proxymesh.com"

import http.client

import inspect

import sys

import unittest

from aiohttp.connector import TCPConnector

from httpcore._async.http_proxy import AsyncHTTPProxy, AsyncTunnelHTTPConnection

from httpcore._sync.http_proxy import HTTPProxy, TunnelHTTPConnection

from urllib3.connectionpool import HTTPSConnectionPool

from python_proxy_headers.aiohttp_proxy import ProxyTCPConnector

from python_proxy_headers.httpx_proxy import (

AsyncHTTPProxyHeaders,

AsyncProxyTunnelHTTPConnection,

HTTPProxyHeaders,

ProxyTunnelHTTPConnection,

)

from python_proxy_headers.urllib3_proxy_manager import (

HTTPSProxyConnection,

HTTPSProxyConnectionPool,

)

class HookTests(unittest.TestCase):

def test_urllib3_prepare_proxy(self) -> None:

self.assertIsNot(

HTTPSProxyConnectionPool._prepare_proxy,

HTTPSConnectionPool._prepare_proxy,

)

self.assertEqual(

list(inspect.signature(HTTPSProxyConnectionPool._prepare_proxy).parameters),

list(inspect.signature(HTTPSConnectionPool._prepare_proxy).parameters),

)

self.assertTrue(callable(http.client._read_headers))

if sys.version_info < (3, 12):

self.assertTrue(callable(HTTPSProxyConnection._tunnel))

else:

self.assertTrue(callable(http.client.HTTPConnection._tunnel))

self.assertTrue(

callable(http.client.HTTPConnection.get_proxy_response_headers)

)

def test_httpx_handle_request(self) -> None:

self.assertIsNot(

ProxyTunnelHTTPConnection.handle_request,

TunnelHTTPConnection.handle_request,

)

self.assertIsNot(

AsyncProxyTunnelHTTPConnection.handle_async_request,

AsyncTunnelHTTPConnection.handle_async_request,

)

self.assertIsNot(

HTTPProxyHeaders.create_connection,

HTTPProxy.create_connection,

)

self.assertIsNot(

AsyncHTTPProxyHeaders.create_connection,

AsyncHTTPProxy.create_connection,

)

params = inspect.signature(TunnelHTTPConnection.__init__).parameters

for name in (

"proxy_origin",

"remote_origin",

"ssl_context",

"proxy_ssl_context",

"proxy_headers",

"keepalive_expiry",

"http1",

"http2",

"network_backend",

):

self.assertIn(name, params)

def test_aiohttp_create_proxy_connection(self) -> None:

self.assertEqual(

list(

inspect.signature(ProxyTCPConnector._create_proxy_connection).parameters

),

list(inspect.signature(TCPConnector._create_proxy_connection).parameters),

)

if __name__ == "__main__":

unittest.main()