Skip to content

Commit af869c8

Browse files
committed
Tidy up the docs
1 parent 0757bd6 commit af869c8

File tree

3 files changed

+27
-16
lines changed

3 files changed

+27
-16
lines changed

seleniumbase/fixtures/base_case.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2716,8 +2716,7 @@ def get_new_driver(
27162716
servername - if using a Selenium Grid, set the host address here
27172717
port - if using a Selenium Grid, set the host port here
27182718
proxy - if using a proxy server, specify the "host:port" combo here
2719-
proxy_bypass_list - Semi-colon seperated string of domains to not
2720-
use a proxy for or * to bypass all
2719+
proxy_bypass_list - ";"-separated hosts to bypass (Eg. "*.foo.com")
27212720
switch_to - the option to switch to the new driver (default = True)
27222721
cap_file - the file containing desired capabilities for the browser
27232722
cap_string - the string with desired capabilities for the browser

seleniumbase/plugins/pytest_plugin.py

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ def pytest_addoption(parser):
3737
--cap-string=STRING (The web browser's desired capabilities to use.)
3838
--proxy=SERVER:PORT (Connect to a proxy server:port for tests.)
3939
--proxy=USERNAME:PASSWORD@SERVER:PORT (Use authenticated proxy server.)
40-
--proxy-bypass-list=STRING (Semi-colon seperated string of domains to not
41-
use a proxy for or * to bypass all)
40+
--proxy-bypass-list=STRING (";"-separated hosts to bypass, Eg "*.foo.com")
4241
--agent=STRING (Modify the web browser's User-Agent string.)
4342
--mobile (Use the mobile device emulator while running tests.)
4443
--metrics=STRING (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
@@ -388,14 +387,21 @@ def pytest_addoption(parser):
388387
)
389388
parser.addoption(
390389
"--proxy-bypass-list",
390+
"--proxy_bypass_list",
391391
action="store",
392392
dest="proxy_bypass_list",
393393
default=None,
394-
help="""Designates the domains or IP address to bypass the defined proxy.
395-
Format: example.test OR
396-
example.test,anothorexample.test OR
397-
*
398-
Default: ''.""",
394+
help="""Designates the hosts, domains, and/or IP addresses
395+
to bypass when using a proxy server with "--proxy".
396+
Format: A ";"-separated string.
397+
Example usage:
398+
pytest
399+
--proxy="username:password@servername:port"
400+
--proxy-bypass-list="*.foo.com;github.com"
401+
pytest
402+
--proxy="servername:port"
403+
--proxy-bypass-list="127.0.0.1:8080"
404+
Default: None.""",
399405
)
400406
parser.addoption(
401407
"--agent",

seleniumbase/plugins/selenium_plugin.py

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ class SeleniumBrowser(Plugin):
2121
--cap-string=STRING (The web browser's desired capabilities to use.)
2222
--proxy=SERVER:PORT (Connect to a proxy server:port for tests.)
2323
--proxy=USERNAME:PASSWORD@SERVER:PORT (Use authenticated proxy server.)
24-
--proxy-bypass-list=STRING (Semi-colon seperated string of domains to not
25-
use a proxy for or * to bypass all)
24+
--proxy-bypass-list=STRING (";"-separated hosts to bypass, Eg "*.foo.com")
2625
--agent=STRING (Modify the web browser's User-Agent string.)
2726
--mobile (Use the mobile device emulator while running tests.)
2827
--metrics=STRING (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
@@ -161,14 +160,21 @@ def options(self, parser, env):
161160
)
162161
parser.add_option(
163162
"--proxy-bypass-list",
163+
"--proxy_bypass_list",
164164
action="store",
165165
dest="proxy_bypass_list",
166166
default=None,
167-
help="""Designates the domains or IP address to bypass the defined proxy.
168-
Format: example.test OR
169-
example.test,anothorexample.test OR
170-
*
171-
Default: ''.""",
167+
help="""Designates the hosts, domains, and/or IP addresses
168+
to bypass when using a proxy server with "--proxy".
169+
Format: A ";"-separated string.
170+
Example usage:
171+
pytest
172+
--proxy="username:password@servername:port"
173+
--proxy-bypass-list="*.foo.com;github.com"
174+
pytest
175+
--proxy="servername:port"
176+
--proxy-bypass-list="127.0.0.1:8080"
177+
Default: None.""",
172178
)
173179
parser.add_option(
174180
"--agent",

0 commit comments

Comments
 (0)