Commit bf2711a

pmartinez1harsha509

and

authored

Update python drivers (options) docs with code examples (#1845)[deploy site]

* Update Ruby code-block to show .quit * Update python examples for Drivers - options docs Added/moved examples for python under the Drivers section * replace existing example url in python tests with selenium.dev --------- Co-authored-by: Sri Harsha <12621691+harsha509@users.noreply.github.com>

1 parent e0439d1 commit bf2711aCopy full SHA for bf2711a

File tree

9 files changed

+139

-127

lines changed

examples/python/tests/drivers
- test_options.py
website_and_docs/content/documentation/webdriver/drivers

9 files changed

+139

-127

lines changed

`‎examples/python/tests/drivers/test_options.py‎`

Lines changed: 71 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`	`1`	`from selenium import webdriver`
	`2`	`+from selenium.webdriver.common.proxy import Proxy`
	`3`	`+from selenium.webdriver.common.proxy import ProxyType`
`2`	`4`
`3`	`5`
`4`	`6`	`def test_page_load_strategy_normal():`
`@@ -7,7 +9,7 @@ def test_page_load_strategy_normal():`
`7`	`9`	`options.page_load_strategy = 'normal'`
`8`	`10`	`driver = webdriver.Chrome(options=options)`
`9`	`11`
`10`		`- driver.get("http://www.google.com")`
	`12`	`+ driver.get("https://www.selenium.dev/")`
`11`	`13`	`driver.quit()`
`12`	`14`
`13`	`15`
`@@ -17,7 +19,7 @@ def test_page_load_strategy_eager():`
`17`	`19`	`options.page_load_strategy = 'eager'`
`18`	`20`	`driver = webdriver.Chrome(options=options)`
`19`	`21`
`20`		`- driver.get("http://www.google.com")`
	`22`	`+ driver.get("https://www.selenium.dev/")`
`21`	`23`	`driver.quit()`
`22`	`24`
`23`	`25`
`@@ -27,5 +29,71 @@ def test_page_load_strategy_none():`
`27`	`29`	`options.page_load_strategy = 'none'`
`28`	`30`	`driver = webdriver.Chrome(options=options)`
`29`	`31`
`30`		`- driver.get("http://www.google.com")`
	`32`	`+ driver.get("https://www.selenium.dev/")`
`31`	`33`	`driver.quit()`
	`34`	`+`
	`35`	`+def test_capabilities():`
	`36`	`+ options = webdriver.ChromeOptions()`
	`37`	`+ options.browser_version = 'stable'`
	`38`	`+ options.platform_name = 'any'`
	`39`	`+ options.accept_insecure_certs = True`
	`40`	`+ driver = webdriver.Chrome(options=options)`
	`41`	`+`
	`42`	`+ driver.get("https://www.selenium.dev/")`
	`43`	`+ driver.quit()`
	`44`	`+`
	`45`	`+def test_timeouts_script():`
	`46`	`+ options = webdriver.ChromeOptions()`
	`47`	`+ options.timeouts = { 'script': 5000 }`
	`48`	`+ driver = webdriver.Chrome(options=options)`
	`49`	`+`
	`50`	`+ driver.get("https://www.selenium.dev/")`
	`51`	`+ driver.quit()`
	`52`	`+`
	`53`	`+def test_timeouts_page_load():`
	`54`	`+ options = webdriver.ChromeOptions()`
	`55`	`+ options.timeouts = { 'pageLoad': 5000 }`
	`56`	`+ driver = webdriver.Chrome(options=options)`
	`57`	`+`
	`58`	`+ driver.get("https://www.selenium.dev/")`
	`59`	`+ driver.quit()`
	`60`	`+`
	`61`	`+def test_timeouts_implicit_wait():`
	`62`	`+ options = webdriver.ChromeOptions()`
	`63`	`+ options.timeouts = { 'implicit': 5000 }`
	`64`	`+ driver = webdriver.Chrome(options=options)`
	`65`	`+`
	`66`	`+ driver.get("https://www.selenium.dev/")`
	`67`	`+ driver.quit()`
	`68`	`+`
	`69`	`+def test_unhandled_prompt():`
	`70`	`+ options = webdriver.ChromeOptions()`
	`71`	`+ options.unhandled_prompt_behavior = 'accept'`
	`72`	`+ driver = webdriver.Chrome(options=options)`
	`73`	`+`
	`74`	`+ driver.get("https://www.selenium.dev/")`
	`75`	`+ driver.quit()`
	`76`	`+`
	`77`	`+def test_set_window_rect():`
	`78`	`+ options = webdriver.FirefoxOptions()`
	`79`	`+ options.set_window_rect = True # Full support in Firefox`
	`80`	`+ driver = webdriver.Firefox(options=options)`
	`81`	`+`
	`82`	`+ driver.get("https://www.selenium.dev/")`
	`83`	`+ driver.quit()`
	`84`	`+`
	`85`	`+def test_strict_file_interactability():`
	`86`	`+ options = webdriver.ChromeOptions()`
	`87`	`+ options.strict_file_interactability = True`
	`88`	`+ driver = webdriver.Chrome(options=options)`
	`89`	`+`
	`90`	`+ driver.get("https://www.selenium.dev/")`
	`91`	`+ driver.quit()`
	`92`	`+`
	`93`	`+def test_proxy():`
	`94`	`+ options = webdriver.ChromeOptions()`
	`95`	`+ options.proxy = Proxy({ 'proxyType': ProxyType.MANUAL, 'httpProxy' : 'http.proxy:1234'})`
	`96`	`+ driver = webdriver.Chrome(options=options)`
	`97`	`+`
	`98`	`+ driver.get("https://www.selenium.dev/")`
	`99`	`+ driver.quit()`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.en.md‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ on the local machine.`
`30`	`30`	`{{< badge-code >}}`
`31`	`31`	`{{< /tab >}}`
`32`	`32`	`{{% tab header="Python" %}}`
`33`		`-{{< badge-code >}}`
	`33`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L10" >}}`
`34`	`34`	`{{% /tab %}}`
`35`	`35`	`{{< tab header="CSharp" >}}`
`36`	`36`	`{{< badge-code >}}`
@@ -64,13 +64,13 @@ and it is recommended to always use `quit` to end the session
`64`	`64`	`{{< badge-code >}}`
`65`	`65`	`{{< /tab >}}`
`66`	`66`	`{{% tab header="Python" %}}`
`67`		`-{{< badge-code >}}`
	`67`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L13" >}}`
`68`	`68`	`{{% /tab %}}`
`69`	`69`	`{{< tab header="CSharp" >}}`
`70`	`70`	`{{< badge-code >}}`
`71`	`71`	`{{< /tab >}}`
`72`	`72`	`{{< tab header="Ruby" >}}`
`73`		`-{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L15" >}}`
	`73`	`+{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L16" >}}`
`74`	`74`	`{{< /tab >}}`
`75`	`75`	`{{< tab header="JavaScript" >}}`
`76`	`76`	`{{< badge-code >}}`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.ja.md‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ weight: 3`
`30`	`30`	`{{< badge-code >}}`
`31`	`31`	`{{< /tab >}}`
`32`	`32`	`{{% tab header="Python" %}}`
`33`		`-{{< badge-code >}}`
	`33`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L10" >}}`
`34`	`34`	`{{% /tab %}}`
`35`	`35`	`{{< tab header="CSharp" >}}`
`36`	`36`	`{{< badge-code >}}`
`@@ -63,13 +63,13 @@ weight: 3`
`63`	`63`	`{{< badge-code >}}`
`64`	`64`	`{{< /tab >}}`
`65`	`65`	`{{% tab header="Python" %}}`
`66`		`-{{< badge-code >}}`
	`66`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L13" >}}`
`67`	`67`	`{{% /tab %}}`
`68`	`68`	`{{< tab header="CSharp" >}}`
`69`	`69`	`{{< badge-code >}}`
`70`	`70`	`{{< /tab >}}`
`71`	`71`	`{{< tab header="Ruby" >}}`
`72`		`-{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L15" >}}`
	`72`	`+{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L16" >}}`
`73`	`73`	`{{< /tab >}}`
`74`	`74`	`{{< tab header="JavaScript" >}}`
`75`	`75`	`{{< badge-code >}}`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.pt-br.md‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ on the local machine.`
`30`	`30`	`{{< badge-code >}}`
`31`	`31`	`{{< /tab >}}`
`32`	`32`	`{{% tab header="Python" %}}`
`33`		`-{{< badge-code >}}`
	`33`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L10" >}}`
`34`	`34`	`{{% /tab %}}`
`35`	`35`	`{{< tab header="CSharp" >}}`
`36`	`36`	`{{< badge-code >}}`
@@ -64,13 +64,13 @@ and it is recommended to always use `quit` to end the session
`64`	`64`	`{{< badge-code >}}`
`65`	`65`	`{{< /tab >}}`
`66`	`66`	`{{% tab header="Python" %}}`
`67`		`-{{< badge-code >}}`
	`67`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L13" >}}`
`68`	`68`	`{{% /tab %}}`
`69`	`69`	`{{< tab header="CSharp" >}}`
`70`	`70`	`{{< badge-code >}}`
`71`	`71`	`{{< /tab >}}`
`72`	`72`	`{{< tab header="Ruby" >}}`
`73`		`-{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L15" >}}`
	`73`	`+{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L16" >}}`
`74`	`74`	`{{< /tab >}}`
`75`	`75`	`{{< tab header="JavaScript" >}}`
`76`	`76`	`{{< badge-code >}}`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.zh-cn.md‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ weight: 3`
`30`	`30`	`{{< badge-code >}}`
`31`	`31`	`{{< /tab >}}`
`32`	`32`	`{{% tab header="Python" %}}`
`33`		`-{{< badge-code >}}`
	`33`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L10" >}}`
`34`	`34`	`{{% /tab %}}`
`35`	`35`	`{{< tab header="CSharp" >}}`
`36`	`36`	`{{< badge-code >}}`
`@@ -64,13 +64,13 @@ weight: 3`
`64`	`64`	`{{< badge-code >}}`
`65`	`65`	`{{< /tab >}}`
`66`	`66`	`{{% tab header="Python" %}}`
`67`		`-{{< badge-code >}}`
	`67`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L13" >}}`
`68`	`68`	`{{% /tab %}}`
`69`	`69`	`{{< tab header="CSharp" >}}`
`70`	`70`	`{{< badge-code >}}`
`71`	`71`	`{{< /tab >}}`
`72`	`72`	`{{< tab header="Ruby" >}}`
`73`		`-{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L15" >}}`
	`73`	`+{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L16" >}}`
`74`	`74`	`{{< /tab >}}`
`75`	`75`	`{{< tab header="JavaScript" >}}`
`76`	`76`	`{{< badge-code >}}`

`‎website_and_docs/content/documentation/webdriver/drivers/options.en.md‎`

Lines changed: 14 additions & 28 deletions

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ Browser name is set by default when using an Options class instance.`
`34`	`34`	`{{< badge-code >}}`
`35`	`35`	`{{< /tab >}}`
`36`	`36`	`{{% tab header="Python" %}}`
`37`		`-{{< badge-code >}}`
	`37`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L36" >}}`
`38`	`38`	`{{% /tab %}}`
`39`	`39`	`{{< tab header="CSharp" >}}`
`40`	`40`	`{{< badge-code >}}`
`@@ -61,7 +61,7 @@ it will be automatically downloaded by [Selenium Manager]({{< ref "../../seleniu`
`61`	`61`	`{{< badge-code >}}`
`62`	`62`	`{{< /tab >}}`
`63`	`63`	`{{% tab header="Python" %}}`
`64`		`-{{< badge-code >}}`
	`64`	`+{{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L37" >}}`
`65`	`65`	`{{% /tab %}}`
`66`	`66`	`{{< tab header="CSharp" >}}`
`67`	`67`	`{{< badge-code >}}`
`@@ -117,7 +117,7 @@ event fire is returned.`
`117`	`117`	`{{< gh-codeblock path="/examples/java/src/test/java/dev/selenium/drivers/OptionsTest.java#L14-L16">}}`
`118`	`118`	`{{< /tab >}}`
`119`	`119`	`{{< tab header="Python" text=true >}}`
`120`		`-{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L7-L9">}}`
	`120`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L9-L10">}}`
`121`	`121`	`{{< /tab >}}`
`122`	`122`	`{{< tab header="CSharp" >}}`
`123`	`123`	`using OpenQA.Selenium;`
`@@ -174,7 +174,7 @@ event fire is returned.`
`174`	`174`	`{{< gh-codeblock path="/examples/java/src/test/java/dev/selenium/drivers/OptionsTest.java#L27-L29">}}`
`175`	`175`	`{{< /tab >}}`
`176`	`176`	`{{< tab header="Python" text=true >}}`
`177`		`-{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L17-L18">}}`
	`177`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L19-L20">}}`
`178`	`178`	`{{< /tab >}}`
`179`	`179`	`{{< tab header="CSharp" >}}`
`180`	`180`	`using OpenQA.Selenium;`
`@@ -230,7 +230,7 @@ WebDriver only waits until the initial page is downloaded.`
`230`	`230`	`{{< gh-codeblock path="/examples/java/src/test/java/dev/selenium/drivers/OptionsTest.java#L40-L42">}}`
`231`	`231`	`{{< /tab >}}`
`232`	`232`	`{{< tab header="Python" text=true >}}`
`233`		`-{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L27-L28">}}`
	`233`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L29-L30">}}`
`234`	`234`	`{{< /tab >}}`
`235`	`235`	`{{< tab header="CSharp" >}}`
`236`	`236`	`using OpenQA.Selenium;`
@@ -290,7 +290,7 @@ setting `platformName` sets the OS at the remote-end.
`290`	`290`	`{{< badge-code >}}`
`291`	`291`	`{{< /tab >}}`
`292`	`292`	`{{% tab header="Python" %}}`
`293`		`-{{< badge-code >}}`
	`293`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L38">}}`
`294`	`294`	`{{% /tab %}}`
`295`	`295`	`{{< tab header="CSharp" >}}`
`296`	`296`	`{{< badge-code >}}`
`@@ -328,7 +328,7 @@ effect for the entire session.`
`328`	`328`	`{{< badge-code >}}`
`329`	`329`	`{{< /tab >}}`
`330`	`330`	`{{% tab header="Python" %}}`
`331`		`-{{< badge-code >}}`
	`331`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L39-40">}}`
`332`	`332`	`{{% /tab %}}`
`333`	`333`	`{{< tab header="CSharp" >}}`
`334`	`334`	`{{< badge-code >}}`
`@@ -363,7 +363,7 @@ is imposed when a new session is created by WebDriver.`
`363`	`363`	`{{< badge-code >}}`
`364`	`364`	`{{< /tab >}}`
`365`	`365`	`{{% tab header="Python" %}}`
`366`		`-{{< badge-code >}}`
	`366`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L47-48">}}`
`367`	`367`	`{{% /tab %}}`
`368`	`368`	`{{< tab header="CSharp" >}}`
`369`	`369`	`{{< badge-code >}}`
`@@ -392,7 +392,7 @@ _TimeoutException_.`
`392`	`392`	`{{< badge-code >}}`
`393`	`393`	`{{< /tab >}}`
`394`	`394`	`{{% tab header="Python" %}}`
`395`		`-{{< badge-code >}}`
	`395`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L55-56">}}`
`396`	`396`	`{{% /tab %}}`
`397`	`397`	`{{< tab header="CSharp" >}}`
`398`	`398`	`{{< badge-code >}}`
`@@ -419,7 +419,7 @@ is imposed when a new session is created by WebDriver.`
`419`	`419`	`{{< badge-code >}}`
`420`	`420`	`{{< /tab >}}`
`421`	`421`	`{{% tab header="Python" %}}`
`422`		`-{{< badge-code >}}`
	`422`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L63-64">}}`
`423`	`423`	`{{% /tab %}}`
`424`	`424`	`{{< tab header="CSharp" >}}`
`425`	`425`	`{{< badge-code >}}`
`@@ -457,7 +457,7 @@ user prompt encounters at the remote-end. This is defined by`
`457`	`457`	`{{< badge-code >}}`
`458`	`458`	`{{< /tab >}}`
`459`	`459`	`{{% tab header="Python" %}}`
`460`		`-{{< badge-code >}}`
	`460`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L71-72">}}`
`461`	`461`	`{{% /tab %}}`
`462`	`462`	`{{< tab header="CSharp" >}}`
`463`	`463`	`{{< badge-code >}}`
`@@ -482,7 +482,7 @@ Indicates whether the remote end supports all of the [resizing and repositioning`
`482`	`482`	`{{< badge-code >}}`
`483`	`483`	`{{< /tab >}}`
`484`	`484`	`{{% tab header="Python" %}}`
`485`		`-{{< badge-code >}}`
	`485`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L79-80">}}`
`486`	`486`	`{{% /tab %}}`
`487`	`487`	`{{< tab header="CSharp" >}}`
`488`	`488`	`{{< badge-code >}}`
`@@ -510,7 +510,7 @@ when using _Element Send Keys_ with hidden file upload controls.`
`510`	`510`	`{{< badge-code >}}`
`511`	`511`	`{{< /tab >}}`
`512`	`512`	`{{% tab header="Python" %}}`
`513`		`-{{< badge-code >}}`
	`513`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L87-88">}}`
`514`	`514`	`{{% /tab %}}`
`515`	`515`	`{{< tab header="CSharp" >}}`
`516`	`516`	`{{< badge-code >}}`
`@@ -571,21 +571,7 @@ public class ProxyTest {`
`571`	`571`	```
`572`	`572`	`{{% /tab %}}`
`573`	`573`	`{{% tab header="Python" %}}`
`574`		-```python
`575`		`-from selenium import webdriver`
`576`		`-`
`577`		`-PROXY = "<HOST:PORT>"`
`578`		`-webdriver.DesiredCapabilities.FIREFOX['proxy'] = {`
`579`		`-"httpProxy": PROXY,`
`580`		`-"ftpProxy": PROXY,`
`581`		`-"sslProxy": PROXY,`
`582`		`-"proxyType": "MANUAL",`
`583`		`-`
`584`		`-}`
`585`		`-`
`586`		`-with webdriver.Firefox() as driver:`
`587`		`- driver.get("https://selenium.dev")`
`588`		-```
	`574`	`+{{< gh-codeblock path="/examples/python/tests/drivers/test_options.py#L95-96">}}`
`589`	`575`	`{{% /tab %}}`
`590`	`576`	`{{% tab header="CSharp" %}}`
`591`	`577`	```CSharp

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit bf2711a

File tree

9 files changed

9 files changed

`‎examples/python/tests/drivers/test_options.py‎`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.en.md‎`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.ja.md‎`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.pt-br.md‎`

`‎website_and_docs/content/documentation/webdriver/drivers/_index.zh-cn.md‎`

`‎website_and_docs/content/documentation/webdriver/drivers/options.en.md‎`

0 commit comments