Skip to content

Commit f19652f

Browse files
titusfortnertitusfortner
authored
Merge 3bc1889 into 5b1b449 
2 parents 5b1b449 + 3bc1889 commit f19652f

File tree

10 files changed

+219
-50
lines changed

10 files changed

+219
-50
lines changed

Diff for: ‎py/selenium/webdriver/chrome/remote_connection.py

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
from selenium.webdriver import DesiredCapabilities
2020
from selenium.webdriver.chromium.remote_connection import ChromiumRemoteConnection
21+
from selenium.webdriver.remote.client_config import ClientConfig
2122

2223

2324
class ChromeRemoteConnection(ChromiumRemoteConnection):
@@ -28,11 +29,13 @@ def __init__(
2829
remote_server_addr: str,
2930
keep_alive: bool = True,
3031
ignore_proxy: typing.Optional[bool] = False,
32+
client_config: ClientConfig = None,
3133
) -> None:
3234
super().__init__(
3335
remote_server_addr=remote_server_addr,
3436
vendor_prefix="goog",
3537
browser_name=ChromeRemoteConnection.browser_name,
3638
keep_alive=keep_alive,
3739
ignore_proxy=ignore_proxy,
40+
client_config=client_config,
3841
)

Diff for: ‎py/selenium/webdriver/chromium/remote_connection.py

+8-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# KIND, either express or implied. See the License for the
1515
# specific language governing permissions and limitations
1616
# under the License.
17-
17+
from selenium.webdriver.remote.client_config import ClientConfig
1818
from selenium.webdriver.remote.remote_connection import RemoteConnection
1919

2020

@@ -26,8 +26,14 @@ def __init__(
2626
browser_name: str,
2727
keep_alive: bool = True,
2828
ignore_proxy: bool = False,
29+
client_config: ClientConfig = None,
2930
) -> None:
30-
super().__init__(remote_server_addr, keep_alive, ignore_proxy)
31+
super().__init__(
32+
remote_server_addr=remote_server_addr,
33+
keep_alive=keep_alive,
34+
ignore_proxy=ignore_proxy,
35+
client_config=client_config,
36+
)
3137
self.browser_name = browser_name
3238
commands = self._remote_commands(vendor_prefix)
3339
for key, value in commands.items():

Diff for: ‎py/selenium/webdriver/common/options.py

+10
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
import typing
18+
import warnings
1819
from abc import ABCMeta
1920
from abc import abstractmethod
2021
from enum import Enum
@@ -432,6 +433,15 @@ def add_argument(self, argument):
432433
def ignore_local_proxy_environment_variables(self) -> None:
433434
"""By calling this you will ignore HTTP_PROXY and HTTPS_PROXY from
434435
being picked up and used."""
436+
warnings.warn(
437+
"using ignore_local_proxy_environment_variables in Options has been deprecated, "
438+
"instead, create a Proxy instance with ProxyType.DIRECT to ignore proxy settings, "
439+
"pass the proxy instance into a ClientConfig constructor, "
440+
"pass the client config instance into the Webdriver constructor",
441+
DeprecationWarning,
442+
stacklevel=2,
443+
)
444+
435445
self._ignore_local_proxy = True
436446

437447
def to_capabilities(self):

Diff for: ‎py/selenium/webdriver/edge/remote_connection.py

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
from selenium.webdriver import DesiredCapabilities
2020
from selenium.webdriver.chromium.remote_connection import ChromiumRemoteConnection
21+
from selenium.webdriver.remote.client_config import ClientConfig
2122

2223

2324
class EdgeRemoteConnection(ChromiumRemoteConnection):
@@ -28,11 +29,13 @@ def __init__(
2829
remote_server_addr: str,
2930
keep_alive: bool = True,
3031
ignore_proxy: typing.Optional[bool] = False,
32+
client_config: ClientConfig = None,
3133
) -> None:
3234
super().__init__(
3335
remote_server_addr=remote_server_addr,
3436
vendor_prefix="goog",
3537
browser_name=EdgeRemoteConnection.browser_name,
3638
keep_alive=keep_alive,
3739
ignore_proxy=ignore_proxy,
40+
client_config=client_config,
3841
)

Diff for: ‎py/selenium/webdriver/firefox/remote_connection.py

+15-2
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,29 @@
1414
# KIND, either express or implied. See the License for the
1515
# specific language governing permissions and limitations
1616
# under the License.
17+
import typing
1718

1819
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
20+
from selenium.webdriver.remote.client_config import ClientConfig
1921
from selenium.webdriver.remote.remote_connection import RemoteConnection
2022

2123

2224
class FirefoxRemoteConnection(RemoteConnection):
2325
browser_name = DesiredCapabilities.FIREFOX["browserName"]
2426

25-
def __init__(self, remote_server_addr, keep_alive=True, ignore_proxy=False) -> None:
26-
super().__init__(remote_server_addr, keep_alive, ignore_proxy)
27+
def __init__(
28+
self,
29+
remote_server_addr: str,
30+
keep_alive: bool = True,
31+
ignore_proxy: typing.Optional[bool] = False,
32+
client_config: ClientConfig = None,
33+
) -> None:
34+
super().__init__(
35+
remote_server_addr=remote_server_addr,
36+
keep_alive=keep_alive,
37+
ignore_proxy=ignore_proxy,
38+
client_config=client_config,
39+
)
2740

2841
self._commands["GET_CONTEXT"] = ("GET", "/session/$sessionId/moz/context")
2942
self._commands["SET_CONTEXT"] = ("POST", "/session/$sessionId/moz/context")

Diff for: ‎py/selenium/webdriver/remote/client_config.py

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Licensed to the Software Freedom Conservancy (SFC) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The SFC licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
import os
18+
from urllib import parse
19+
20+
from selenium.webdriver.common.proxy import Proxy
21+
from selenium.webdriver.common.proxy import ProxyType
22+
23+
24+
class ClientConfig:
25+
def __init__(
26+
self,
27+
remote_server_addr: str,
28+
keep_alive: bool = True,
29+
proxy=None,
30+
) -> None:
31+
self.remote_server_addr = remote_server_addr
32+
self.keep_alive = keep_alive
33+
self.proxy = proxy
34+
35+
@property
36+
def remote_server_addr(self) -> str:
37+
return self._remote_server_addr
38+
39+
@remote_server_addr.setter
40+
def remote_server_addr(self, value: str):
41+
self._remote_server_addr = value
42+
43+
@property
44+
def keep_alive(self) -> bool:
45+
""":Returns: The keep alive value."""
46+
return self._keep_alive
47+
48+
@keep_alive.setter
49+
def keep_alive(self, value: bool) -> None:
50+
"""Toggles the keep alive value.
51+
52+
:Args:
53+
- value: whether to keep the http connection alive
54+
"""
55+
self._keep_alive = value
56+
57+
@property
58+
def proxy(self) -> Proxy:
59+
""":Returns: The proxy used for communicating to the driver/server."""
60+
61+
self._proxy = self._proxy or Proxy(raw={"proxyType": ProxyType.SYSTEM})
62+
return self._proxy
63+
64+
@proxy.setter
65+
def proxy(self, proxy: Proxy) -> None:
66+
"""Provides the information for communicating with the driver or
67+
server.
68+
69+
:Args:
70+
- value: the proxy information to use to communicate with the driver or server
71+
"""
72+
self._proxy = proxy
73+
74+
def get_proxy_url(self):
75+
if self.proxy.proxy_type == ProxyType.DIRECT:
76+
return None
77+
elif self.proxy.proxy_type == ProxyType.SYSTEM:
78+
_no_proxy = os.environ.get("no_proxy", os.environ.get("NO_PROXY"))
79+
if _no_proxy:
80+
for npu in _no_proxy.split(","):
81+
npu = npu.strip()
82+
if npu == "*":
83+
return None
84+
n_url = parse.urlparse(npu)
85+
remote_add = parse.urlparse(self.remote_server_addr)
86+
if n_url.netloc:
87+
if remote_add.netloc == n_url.netloc:
88+
return None
89+
else:
90+
if n_url.path in remote_add.netloc:
91+
return None
92+
if self.remote_server_addr.startswith("https://"):
93+
return os.environ.get("https_proxy", os.environ.get("HTTPS_PROXY"))
94+
if self.remote_server_addr.startswith("http://"):
95+
return os.environ.get("http_proxy", os.environ.get("HTTP_PROXY"))
96+
elif self.proxy.proxy_type == ProxyType.MANUAL:
97+
if self.remote_server_addr.startswith("https://"):
98+
return self.proxy.sslProxy
99+
elif self.remote_server_addr.startswith("http://"):
100+
return self.proxy.http_proxy
101+
else:
102+
return None
103+
else:
104+
return None

Diff for: ‎py/selenium/webdriver/remote/remote_connection.py

+39-35
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import platform
2121
import socket
2222
import string
23+
import warnings
2324
from base64 import b64encode
2425
from urllib import parse
2526

@@ -29,6 +30,7 @@
2930
from selenium import __version__
3031

3132
from . import utils
33+
from .client_config import ClientConfig
3234
from .command import Command
3335
from .errorhandler import ErrorCode
3436

@@ -211,12 +213,6 @@ def get_remote_connection_headers(cls, parsed_url, keep_alive=False):
211213

212214
return headers
213215

214-
def _get_proxy_url(self):
215-
if self._url.startswith("https://"):
216-
return os.environ.get("https_proxy", os.environ.get("HTTPS_PROXY"))
217-
if self._url.startswith("http://"):
218-
return os.environ.get("http_proxy", os.environ.get("HTTP_PROXY"))
219-
220216
def _identify_http_proxy_auth(self):
221217
url = self._proxy_url
222218
url = url[url.find(":") + 3 :]
@@ -248,31 +244,40 @@ def _get_connection_manager(self):
248244

249245
return urllib3.PoolManager(**pool_manager_init_args)
250246

251-
def __init__(self, remote_server_addr: str, keep_alive: bool = False, ignore_proxy: bool = False):
252-
self.keep_alive = keep_alive
253-
self._url = remote_server_addr
254-
255-
# Env var NO_PROXY will override this part of the code
256-
_no_proxy = os.environ.get("no_proxy", os.environ.get("NO_PROXY"))
257-
if _no_proxy:
258-
for npu in _no_proxy.split(","):
259-
npu = npu.strip()
260-
if npu == "*":
261-
ignore_proxy = True
262-
break
263-
n_url = parse.urlparse(npu)
264-
remote_add = parse.urlparse(self._url)
265-
if n_url.netloc:
266-
if remote_add.netloc == n_url.netloc:
267-
ignore_proxy = True
268-
break
269-
else:
270-
if n_url.path in remote_add.netloc:
271-
ignore_proxy = True
272-
break
273-
274-
self._proxy_url = self._get_proxy_url() if not ignore_proxy else None
275-
if keep_alive:
247+
def __init__(
248+
self,
249+
remote_server_addr: str,
250+
keep_alive: bool = True,
251+
ignore_proxy: bool = False,
252+
client_config: ClientConfig = None,
253+
):
254+
self._client_config = client_config or ClientConfig(remote_server_addr, keep_alive)
255+
256+
if remote_server_addr:
257+
warnings.warn(
258+
"setting keep_alive in RemoteConnection() is deprecated, " "set in ClientConfig instance insttead",
259+
DeprecationWarning,
260+
stacklevel=2,
261+
)
262+
263+
if not keep_alive:
264+
warnings.warn(
265+
"setting keep_alive in RemoteConnection() is deprecated, " "set in ClientConfig instance insttead",
266+
DeprecationWarning,
267+
stacklevel=2,
268+
)
269+
270+
if ignore_proxy:
271+
warnings.warn(
272+
"setting keep_alive in RemoteConnection() is deprecated, " "set in ClientConfig instance insttead",
273+
DeprecationWarning,
274+
stacklevel=2,
275+
)
276+
self._proxy_url = None
277+
else:
278+
self._proxy_url = self._client_config.get_proxy_url()
279+
280+
if self._client_config.keep_alive:
276281
self._conn = self._get_connection_manager()
277282
self._commands = remote_commands
278283

@@ -296,7 +301,7 @@ def execute(self, command, params):
296301
for word in substitute_params:
297302
del params[word]
298303
data = utils.dump_json(params)
299-
url = f"{self._url}{path}"
304+
url = f"{self._client_config.remote_server_addr}{path}"
300305
return self._request(command_info[0], url, body=data)
301306

302307
def _request(self, method, url, body=None):
@@ -312,12 +317,11 @@ def _request(self, method, url, body=None):
312317
"""
313318
LOGGER.debug("%s %s %s", method, url, body)
314319
parsed_url = parse.urlparse(url)
315-
headers = self.get_remote_connection_headers(parsed_url, self.keep_alive)
316-
response = None
320+
headers = self.get_remote_connection_headers(parsed_url, self._client_config.keep_alive)
317321
if body and method not in ("POST", "PUT"):
318322
body = None
319323

320-
if self.keep_alive:
324+
if self._client_config.keep_alive:
321325
response = self._conn.request(method, url, body=body, headers=headers)
322326
statuscode = response.status
323327
else:

0 commit comments

Comments
 (0)