Skip to content

python: Read proxies from environment + no_proxy support #21394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,9 @@ conf = {{{packageName}}}.Configuration(
self.proxy: Optional[str] = None
"""Proxy URL
"""
self.no_proxy: Optional[str] = None
"""Hosts for which to bypass the proxy
"""
self.proxy_headers = None
"""Proxy headers
"""
Expand Down
43 changes: 39 additions & 4 deletions modules/openapi-generator/src/main/resources/python/rest.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import io
import json
import re
import ssl
from urllib.parse import urlparse
from urllib.request import getproxies, proxy_bypass

import urllib3

Expand Down Expand Up @@ -89,14 +91,23 @@ class RESTClientObject:
# https pool manager
self.pool_manager: urllib3.PoolManager

if configuration.proxy:
if is_socks_proxy_url(configuration.proxy):
parsed = urlparse(configuration.host)
proxy = getproxies().get(parsed.scheme) if configuration.proxy is None else configuration.proxy
if proxy:
if configuration.no_proxy is not None:
if _proxy_bypass(parsed.netloc, configuration.no_proxy):
proxy = None
elif proxy_bypass(parsed.netloc):
proxy = None

if proxy:
if is_socks_proxy_url(proxy):
from urllib3.contrib.socks import SOCKSProxyManager
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["headers"] = configuration.proxy_headers
self.pool_manager = SOCKSProxyManager(**pool_args)
else:
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["proxy_headers"] = configuration.proxy_headers
self.pool_manager = urllib3.ProxyManager(**pool_args)
else:
Expand Down Expand Up @@ -246,3 +257,27 @@ class RESTClientObject:
raise ApiException(status=0, reason=msg)

return RESTResponse(r)

# Adapted from urllib.request.proxy_bypass_environment
def _proxy_bypass(netloc: str, no_proxy: str):
if no_proxy == '*':
return True

host = netloc.lower()
if match := re.match(r'(.*):([0-9]*)', host):
hostonly, _port = match.groups()
else:
hostonly = host

for name in no_proxy.split(','):
name = name.strip()
if name:
name = name.lstrip('.')
name = name.lower()
if hostonly == name or host == name:
return True
name = '.' + name
if hostonly.endswith(name) or host.endswith(name):
return True

return False
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,9 @@ def __init__(
self.proxy: Optional[str] = None
"""Proxy URL
"""
self.no_proxy: Optional[str] = None
"""Hosts for which to bypass the proxy
"""
self.proxy_headers = None
"""Proxy headers
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
import json
import re
import ssl
from urllib.parse import urlparse
from urllib.request import getproxies, proxy_bypass

import urllib3

Expand Down Expand Up @@ -100,14 +102,23 @@ def __init__(self, configuration) -> None:
# https pool manager
self.pool_manager: urllib3.PoolManager

if configuration.proxy:
if is_socks_proxy_url(configuration.proxy):
parsed = urlparse(configuration.host)
proxy = getproxies().get(parsed.scheme) if configuration.proxy is None else configuration.proxy
if proxy:
if configuration.no_proxy is not None:
if _proxy_bypass(parsed.netloc, configuration.no_proxy):
proxy = None
elif proxy_bypass(parsed.netloc):
proxy = None

if proxy:
if is_socks_proxy_url(proxy):
from urllib3.contrib.socks import SOCKSProxyManager
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["headers"] = configuration.proxy_headers
self.pool_manager = SOCKSProxyManager(**pool_args)
else:
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["proxy_headers"] = configuration.proxy_headers
self.pool_manager = urllib3.ProxyManager(**pool_args)
else:
Expand Down Expand Up @@ -257,3 +268,27 @@ def request(
raise ApiException(status=0, reason=msg)

return RESTResponse(r)

# Adapted from urllib.request.proxy_bypass_environment
def _proxy_bypass(netloc: str, no_proxy: str):
if no_proxy == '*':
return True

host = netloc.lower()
if match := re.match(r'(.*):([0-9]*)', host):
hostonly, _port = match.groups()
else:
hostonly = host

for name in no_proxy.split(','):
name = name.strip()
if name:
name = name.lstrip('.')
name = name.lower()
if hostonly == name or host == name:
return True
name = '.' + name
if hostonly.endswith(name) or host.endswith(name):
return True

return False
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,9 @@ def __init__(
self.proxy: Optional[str] = None
"""Proxy URL
"""
self.no_proxy: Optional[str] = None
"""Hosts for which to bypass the proxy
"""
self.proxy_headers = None
"""Proxy headers
"""
Expand Down
43 changes: 39 additions & 4 deletions samples/client/echo_api/python/openapi_client/rest.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
import json
import re
import ssl
from urllib.parse import urlparse
from urllib.request import getproxies, proxy_bypass

import urllib3

Expand Down Expand Up @@ -100,14 +102,23 @@ def __init__(self, configuration) -> None:
# https pool manager
self.pool_manager: urllib3.PoolManager

if configuration.proxy:
if is_socks_proxy_url(configuration.proxy):
parsed = urlparse(configuration.host)
proxy = getproxies().get(parsed.scheme) if configuration.proxy is None else configuration.proxy
if proxy:
if configuration.no_proxy is not None:
if _proxy_bypass(parsed.netloc, configuration.no_proxy):
proxy = None
elif proxy_bypass(parsed.netloc):
proxy = None

if proxy:
if is_socks_proxy_url(proxy):
from urllib3.contrib.socks import SOCKSProxyManager
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["headers"] = configuration.proxy_headers
self.pool_manager = SOCKSProxyManager(**pool_args)
else:
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["proxy_headers"] = configuration.proxy_headers
self.pool_manager = urllib3.ProxyManager(**pool_args)
else:
Expand Down Expand Up @@ -257,3 +268,27 @@ def request(
raise ApiException(status=0, reason=msg)

return RESTResponse(r)

# Adapted from urllib.request.proxy_bypass_environment
def _proxy_bypass(netloc: str, no_proxy: str):
if no_proxy == '*':
return True

host = netloc.lower()
if match := re.match(r'(.*):([0-9]*)', host):
hostonly, _port = match.groups()
else:
hostonly = host

for name in no_proxy.split(','):
name = name.strip()
if name:
name = name.lstrip('.')
name = name.lower()
if hostonly == name or host == name:
return True
name = '.' + name
if hostonly.endswith(name) or host.endswith(name):
return True

return False
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,9 @@ def __init__(
self.proxy: Optional[str] = None
"""Proxy URL
"""
self.no_proxy: Optional[str] = None
"""Hosts for which to bypass the proxy
"""
self.proxy_headers = None
"""Proxy headers
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,9 @@ def __init__(
self.proxy: Optional[str] = None
"""Proxy URL
"""
self.no_proxy: Optional[str] = None
"""Hosts for which to bypass the proxy
"""
self.proxy_headers = None
"""Proxy headers
"""
Expand Down
43 changes: 39 additions & 4 deletions samples/openapi3/client/petstore/python/petstore_api/rest.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
import json
import re
import ssl
from urllib.parse import urlparse
from urllib.request import getproxies, proxy_bypass

import urllib3

Expand Down Expand Up @@ -99,14 +101,23 @@ def __init__(self, configuration) -> None:
# https pool manager
self.pool_manager: urllib3.PoolManager

if configuration.proxy:
if is_socks_proxy_url(configuration.proxy):
parsed = urlparse(configuration.host)
proxy = getproxies().get(parsed.scheme) if configuration.proxy is None else configuration.proxy
if proxy:
if configuration.no_proxy is not None:
if _proxy_bypass(parsed.netloc, configuration.no_proxy):
proxy = None
elif proxy_bypass(parsed.netloc):
proxy = None

if proxy:
if is_socks_proxy_url(proxy):
from urllib3.contrib.socks import SOCKSProxyManager
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["headers"] = configuration.proxy_headers
self.pool_manager = SOCKSProxyManager(**pool_args)
else:
pool_args["proxy_url"] = configuration.proxy
pool_args["proxy_url"] = proxy
pool_args["proxy_headers"] = configuration.proxy_headers
self.pool_manager = urllib3.ProxyManager(**pool_args)
else:
Expand Down Expand Up @@ -256,3 +267,27 @@ def request(
raise ApiException(status=0, reason=msg)

return RESTResponse(r)

# Adapted from urllib.request.proxy_bypass_environment
def _proxy_bypass(netloc: str, no_proxy: str):
if no_proxy == '*':
return True

host = netloc.lower()
if match := re.match(r'(.*):([0-9]*)', host):
hostonly, _port = match.groups()
else:
hostonly = host

for name in no_proxy.split(','):
name = name.strip()
if name:
name = name.lstrip('.')
name = name.lower()
if hostonly == name or host == name:
return True
name = '.' + name
if hostonly.endswith(name) or host.endswith(name):
return True

return False
Loading