Skip to content

Commit

Permalink
Updating Chnagelog, api docs and bumping version number for python 2.30
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeis committed Feb 19, 2013
1 parent 2a69e3d commit d7de3b0
Show file tree
Hide file tree
Showing 33 changed files with 171 additions and 175 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ dist/
py/selenium/webdriver/firefox/amd64/
py/selenium/webdriver/firefox/webdriver.xpi
py/selenium/webdriver/firefox/x86/
py/docs/build/
selenium.egg-info/

*.user
Expand Down
24 changes: 14 additions & 10 deletions docs/api/py/_modules/selenium/webdriver/chrome/service.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ <h1>Source code for selenium.webdriver.chrome.service</h1><div class="highlight"
<span class="c"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c"># See the License for the specific language governing permissions and</span>
<span class="c"># limitations under the License.</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">from</span> <span class="nn">subprocess</span> <span class="kn">import</span> <span class="n">PIPE</span>
<span class="kn">import</span> <span class="nn">time</span>
Expand All @@ -77,10 +78,11 @@ <h1>Source code for selenium.webdriver.chrome.service</h1><div class="highlight"
<span class="sd"> Object that manages the starting and stopping of the ChromeDriver</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">executable_path</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">service_args</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">log_path</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">executable_path</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">service_args</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
<span class="n">log_path</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new instance of the Service</span>
<span class="sd"> </span>

<span class="sd"> :Args:</span>
<span class="sd"> - executable_path : Path to the ChromeDriver</span>
<span class="sd"> - port : Port the service is running on</span>
Expand All @@ -94,20 +96,22 @@ <h1>Source code for selenium.webdriver.chrome.service</h1><div class="highlight"
<span class="bp">self</span><span class="o">.</span><span class="n">service_args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;--log-path=</span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">log_path</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">port</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">port</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">free_port</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">env</span> <span class="o">=</span> <span class="n">env</span>

<div class="viewcode-block" id="Service.start"><a class="viewcode-back" href="../../../../webdriver_chrome/selenium.webdriver.chrome.service.html#selenium.webdriver.chrome.service.Service.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Starts the ChromeDriver Service. </span>
<span class="sd"> </span>
<span class="sd"> Starts the ChromeDriver Service.</span>

<span class="sd"> :Exceptions:</span>
<span class="sd"> - WebDriverException : Raised either when it can&#39;t start the service</span>
<span class="sd"> or when it can&#39;t connect to the service</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span>
<span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
<span class="s">&quot;--port=</span><span class="si">%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">port</span><span class="p">]</span> <span class="o">+</span>
<span class="bp">self</span><span class="o">.</span><span class="n">service_args</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">service_args</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="n">env</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">WebDriverException</span><span class="p">(</span>
<span class="s">&quot;ChromeDriver executable needs to be available in the path. </span><span class="se">\</span>
Expand All @@ -119,7 +123,7 @@ <h1>Source code for selenium.webdriver.chrome.service</h1><div class="highlight"
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="n">count</span> <span class="o">==</span> <span class="mi">30</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">WebDriverException</span><span class="p">(</span><span class="s">&quot;Can not connect to the ChromeDriver&quot;</span><span class="p">)</span>
</div>
</div>
<span class="nd">@property</span>
<div class="viewcode-block" id="Service.service_url"><a class="viewcode-back" href="../../../../webdriver_chrome/selenium.webdriver.chrome.service.html#selenium.webdriver.chrome.service.Service.service_url">[docs]</a> <span class="k">def</span> <span class="nf">service_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
Expand All @@ -128,7 +132,7 @@ <h1>Source code for selenium.webdriver.chrome.service</h1><div class="highlight"
<span class="k">return</span> <span class="s">&quot;http://localhost:</span><span class="si">%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">port</span>
</div>
<div class="viewcode-block" id="Service.stop"><a class="viewcode-back" href="../../../../webdriver_chrome/selenium.webdriver.chrome.service.html#selenium.webdriver.chrome.service.Service.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; </span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Tells the ChromeDriver to stop and cleans up the process</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c">#If its dead dont worry</span>
Expand All @@ -141,16 +145,16 @@ <h1>Source code for selenium.webdriver.chrome.service</h1><div class="highlight"
<span class="n">count</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">while</span> <span class="n">utils</span><span class="o">.</span><span class="n">is_connectable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">port</span><span class="p">):</span>
<span class="k">if</span> <span class="n">count</span> <span class="o">==</span> <span class="mi">30</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">break</span>
<span class="n">count</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

<span class="c">#Tell the Server to properly die in case</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">process</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process</span><span class="o">.</span><span class="n">kill</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">WindowsError</span><span class="p">:</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
<span class="c"># kill may not be available under windows environment</span>
<span class="k">pass</span></div></div>
</pre></div>
Expand Down
22 changes: 3 additions & 19 deletions docs/api/py/_modules/selenium/webdriver/chrome/webdriver.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ <h3>Navigation</h3>
<h1>Source code for selenium.webdriver.chrome.webdriver</h1><div class="highlight"><pre>
<span class="c">#!/usr/bin/python</span>
<span class="c">#</span>
<span class="c"># Copyright 2011 Webdriver_name committers</span>
<span class="c"># Copyright 2011 Google Inc.</span>
<span class="c"># Copyright 2011-2013 Software freedom conservancy</span>
<span class="c">#</span>
<span class="c"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c"># you may not use this file except in compliance with the License.</span>
Expand Down Expand Up @@ -118,6 +117,7 @@ <h1>Source code for selenium.webdriver.chrome.webdriver</h1><div class="highligh
<span class="k">except</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span>
<span class="k">raise</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_is_remote</span> <span class="o">=</span> <span class="bp">False</span>

<div class="viewcode-block" id="WebDriver.quit"><a class="viewcode-back" href="../../../../webdriver_chrome/selenium.webdriver.chrome.webdriver.html#selenium.webdriver.chrome.webdriver.WebDriver.quit">[docs]</a> <span class="k">def</span> <span class="nf">quit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
Expand All @@ -130,23 +130,7 @@ <h1>Source code for selenium.webdriver.chrome.webdriver</h1><div class="highligh
<span class="c"># We don&#39;t care about the message because something probably has gone wrong</span>
<span class="k">pass</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="WebDriver.save_screenshot"><a class="viewcode-back" href="../../../../webdriver_chrome/selenium.webdriver.chrome.webdriver.html#selenium.webdriver.chrome.webdriver.WebDriver.save_screenshot">[docs]</a> <span class="k">def</span> <span class="nf">save_screenshot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets the screenshot of the current window. Returns False if there is</span>
<span class="sd"> any IOError, else returns True. Use full paths in your filename.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">png</span> <span class="o">=</span> <span class="n">RemoteWebDriver</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">Command</span><span class="o">.</span><span class="n">SCREENSHOT</span><span class="p">)[</span><span class="s">&#39;value&#39;</span><span class="p">]</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s">&#39;wb&#39;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">base64</span><span class="o">.</span><span class="n">decodestring</span><span class="p">(</span><span class="n">png</span><span class="p">))</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">finally</span><span class="p">:</span>
<span class="k">del</span> <span class="n">png</span>
<span class="k">return</span> <span class="bp">True</span></div></div>
<span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span></div></div>
</pre></div>

</div>
Expand Down
Loading

0 comments on commit d7de3b0

Please sign in to comment.