Skip to content

Commit 421de23

Browse files
committed
More modifications to the Open Browser keyword documentation
1 parent 81f7d0c commit 421de23

File tree

2 files changed

+24
-17
lines changed

2 files changed

+24
-17
lines changed

src/SeleniumLibrary/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ class SeleniumLibrary(DynamicCore):
398398
Example the ``options`` argument can be used to launch Chomium-based
399399
applications which utilize the
400400
[https://bitbucket.org/chromiumembedded/cef/wiki/UsingChromeDriver|Chromium Embedded Framework]
401-
. To lauch Chomium-based application, use ``options`` to define
401+
. To launch Chromium-based application, use ``options`` to define
402402
`binary_location` attribute and use `add_argument` method to define
403403
`remote-debugging-port` port for the application. Once the browser
404404
is opened, the test can interact with the embedded web-content of

src/SeleniumLibrary/keywords/browsermanagement.py

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -159,37 +159,44 @@ def open_browser(
159159
options in two different formats: as a string and as Python object
160160
which is an instance of the Selenium options class.
161161
162-
The string format ...
162+
The string format uses a Python like syntax to define Selenium options
163+
methods or attributes.
164+
165+
Example when using
166+
[https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options|Chrome options]
167+
method:
168+
| `Open Browser` | http://example.com | Chrome | options=add_argument("--disable-popup-blocking"); add_argument("--ignore-certificate-errors") | # Sting format. |
169+
| `Open Browser` | None | Chrome | options=binary_location="/path/to/binary";add_argument("remote-debugging-port=port") | # Start Chomium-based application. |
170+
| `Open Browser` | None | Chrome | options=binary_location=r"C:\\\\path\\\\to\\\\binary" | # Windows OS path escaping. |
163171
164172
``options`` argument also supports receiving the Selenium
165-
options as Python class instance. ...
173+
options as Python class instance.
174+
175+
See the `Browser and Driver options` section for more details on how to use
176+
the either the string format or Python object syntax with the ``options`` argument.
166177
167-
Optional ``service_log_path`` argument defines the name of the
168-
file where to write the browser driver logs. If the
169-
``service_log_path`` argument contain a marker ``{index}``, it
178+
Optional ``service_log_path`` will be deprecated in the next release. Please
179+
use the browser specific ``service`` attribute instead. The ``service_log_path``
180+
argument defines the name of the file where to write the browser driver logs.
181+
If the ``service_log_path`` argument contains a marker ``{index}``, it
170182
will be automatically replaced with unique running
171183
index preventing files to be overwritten. Indices start's from 1,
172184
and how they are represented can be customized using Python's
173185
[https://docs.python.org/3/library/string.html#format-string-syntax|
174186
format string syntax].
175187
176-
Optional ``executable_path`` argument defines the path to the driver
188+
Optional ``executable_path`` will be deprecated in the next release. Please
189+
use the `executable_path` and, if needed, `port` attribute on the ``service``
190+
argument instead. The ``executable_path`` argument defines the path to the driver
177191
executable, example to a chromedriver or a geckodriver. If not defined
178192
it is assumed the executable is in the
179193
[https://en.wikipedia.org/wiki/PATH_(variable)|$PATH].
180194
181-
Example when using
182-
[https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options|Chrome options]
183-
method:
184-
| `Open Browser` | http://example.com | Chrome | options=add_argument("--disable-popup-blocking"); add_argument("--ignore-certificate-errors") | # Sting format. |
185-
| ${options} = | Get Options | | | # Selenium options instance. |
186-
| `Open Browser` | http://example.com | Chrome | options=${options} | |
187-
| `Open Browser` | None | Chrome | options=binary_location="/path/to/binary";add_argument("remote-debugging-port=port") | # Start Chomium-based application. |
188-
| `Open Browser` | None | Chrome | options=binary_location=r"C:\\\\path\\\\to\\\\binary" | # Windows OS path escaping. |
189-
190195
Optional ``service`` argument allows for managing the local drivers
191196
as well as setting some browser specific settings like logging. Service
192-
classes are not supported when ``remote_url`` argument is used.
197+
classes are not supported when ``remote_url`` argument is used. See the
198+
`Browser and Driver options` section for more details on how to use
199+
the ``service`` argument.
193200
194201
If the provided configuration options are not enough, it is possible
195202
to use `Create Webdriver` to customize browser initialization even

0 commit comments

Comments
 (0)