Selenium2+python自动化27-查看selenium API

前言

    前面都是点点滴滴的介绍selenium的一些api使用方法,那么selenium的api到底有多少呢?本篇就叫大家如何去查看selenium api,不求人,无需伸手找人要,在自己电脑就有。

    pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的、也可以生成WEB 页面的,还可以在服务器上以浏览器的方式呈现!

一、pydoc

    1.到底什么是pydoc? ,这个是准确的解释:Documentation generator and online help system. pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的、也可以生成WEB 页面的,还可以在服务器上以浏览器的方式呈现!简而言之,就是帮你从代码和注释自动生成文档的工具。

    2.举个栗子,我需要查看python里面open函数的功能和语法,打开cmd,输入:python -m pydoc open

    3.-m参数:python以脚本方法运行模块

>>python -m pydoc open

 

那么问题来了,这个是已经知道有这个函数,去查看它的功能,selenium里面不知道到底有多少个函数或方法,那如何查看呢?

二、启动server

    1.打开cmd命令行,输入:python -m pydoc -p 6666

    2.-p参数:这个表示在本机上启动服务

    3.6666参数:这个是服务端口号,随意设置

打开后,界面会出现一个地址:http://localhost:6666/,在浏览器直接打开

三、浏览器查看文档

    1.在浏览器输入:http://localhost:6666/

    2.Built-in Moudles :这个是python自带的模块

 

四、webdriver API

    1.找到这个路径:python2.7\lib\site-packages,点开selenium

    2.打开的selenium>webdriver>firefox>webdriver,最终路径:http://localhost:6666/selenium.webdriver.firefox.webdriver.html

    3.最终看到的这些就是selenium的webdriver API帮助文档啦

 

add_cookie(self, cookie_dict)
Adds a cookie to your current session.

:Args:
- cookie_dict: A dictionary object, with required keys - "name" and "value";
optional keys - "path", "domain", "secure", "expiry"

Usage:
driver.add_cookie({'name' : 'foo', 'value' : 'bar'})
driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/'})
driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/', 'secure':True})

back(self)
Goes one step backward in the browser history.

:Usage:
driver.back()

close(self)
Closes the current window.

:Usage:
driver.close()

create_web_element(self, element_id)
Creates a web element with the specified element_id.

delete_all_cookies(self)
Delete all cookies in the scope of the session.

:Usage:
driver.delete_all_cookies()

delete_cookie(self, name)
Deletes a single cookie with the given name.

:Usage:
driver.delete_cookie('my_cookie')

execute(self, driver_command, params=None)
Sends a command to be executed by a command.CommandExecutor.

:Args:
- driver_command: The name of the command to execute as a string.
- params: A dictionary of named parameters to send with the command.

:Returns:
The command's JSON response loaded into a dictionary object.

execute_async_script(self, script, *args)
Asynchronously Executes JavaScript in the current window/frame.

:Args:
- script: The JavaScript to execute.
- \*args: Any applicable arguments for your JavaScript.

:Usage:
driver.execute_async_script('document.title')

execute_script(self, script, *args)
Synchronously Executes JavaScript in the current window/frame.

:Args:
- script: The JavaScript to execute.
- \*args: Any applicable arguments for your JavaScript.

:Usage:
driver.execute_script('document.title')

file_detector_context(*args, **kwds)
Overrides the current file detector (if necessary) in limited context.
Ensures the original file detector is set afterwards.

Example:

with webdriver.file_detector_context(UselessFileDetector):
someinput.send_keys('/etc/hosts')

:Args:
- file_detector_class - Class of the desired file detector. If the class is different
from the current file_detector, then the class is instantiated with args and kwargs
and used as a file detector during the duration of the context manager.
- args - Optional arguments that get passed to the file detector class during
instantiation.
- kwargs - Keyword arguments, passed the same way as args.

find_element(self, by='id', value=None)
'Private' method used by the find_element_by_* methods.

:Usage:
Use the corresponding find_element_by_* instead of this.

:rtype: WebElement

find_element_by_class_name(self, name)
Finds an element by class name.

:Args:
- name: The class name of the element to find.

:Usage:
driver.find_element_by_class_name('foo')

find_element_by_css_selector(self, css_selector)
Finds an element by css selector.

:Args:
- css_selector: The css selector to use when finding elements.

:Usage:
driver.find_element_by_css_selector('#foo')

find_element_by_id(self, id_)
Finds an element by id.

:Args:
- id\_ - The id of the element to be found.

:Usage:
driver.find_element_by_id('foo')

find_element_by_link_text(self, link_text)
Finds an element by link text.

:Args:
- link_text: The text of the element to be found.

:Usage:
driver.find_element_by_link_text('Sign In')

find_element_by_name(self, name)
Finds an element by name.

:Args:
- name: The name of the element to find.

:Usage:
driver.find_element_by_name('foo')

find_element_by_partial_link_text(self, link_text)
Finds an element by a partial match of its link text.

:Args:
- link_text: The text of the element to partially match on.

:Usage:
driver.find_element_by_partial_link_text('Sign')

find_element_by_tag_name(self, name)
Finds an element by tag name.

:Args:
- name: The tag name of the element to find.

:Usage:
driver.find_element_by_tag_name('foo')

find_element_by_xpath(self, xpath)
Finds an element by xpath.

:Args:
- xpath - The xpath locator of the element to find.

:Usage:
driver.find_element_by_xpath('//div/td[1]')

find_elements(self, by='id', value=None)
'Private' method used by the find_elements_by_* methods.

:Usage:
Use the corresponding find_elements_by_* instead of this.

:rtype: list of WebElement

find_elements_by_class_name(self, name)
Finds elements by class name.

:Args:
- name: The class name of the elements to find.

:Usage:
driver.find_elements_by_class_name('foo')

find_elements_by_css_selector(self, css_selector)
Finds elements by css selector.

:Args:
- css_selector: The css selector to use when finding elements.

:Usage:
driver.find_elements_by_css_selector('.foo')

find_elements_by_id(self, id_)
Finds multiple elements by id.

:Args:
- id\_ - The id of the elements to be found.

:Usage:
driver.find_elements_by_id('foo')

find_elements_by_link_text(self, text)
Finds elements by link text.

:Args:
- link_text: The text of the elements to be found.

:Usage:
driver.find_elements_by_link_text('Sign In')

find_elements_by_name(self, name)
Finds elements by name.

:Args:
- name: The name of the elements to find.

:Usage:
driver.find_elements_by_name('foo')

find_elements_by_partial_link_text(self, link_text)
Finds elements by a partial match of their link text.

:Args:
- link_text: The text of the element to partial match on.

:Usage:
driver.find_element_by_partial_link_text('Sign')

find_elements_by_tag_name(self, name)
Finds elements by tag name.

:Args:
- name: The tag name the use when finding elements.

:Usage:
driver.find_elements_by_tag_name('foo')

find_elements_by_xpath(self, xpath)
Finds multiple elements by xpath.

:Args:
- xpath - The xpath locator of the elements to be found.

:Usage:
driver.find_elements_by_xpath("//div[contains(@class, 'foo')]")

forward(self)
Goes one step forward in the browser history.

:Usage:
driver.forward()

get(self, url)
Loads a web page in the current browser session.

get_cookie(self, name)
Get a single cookie by name. Returns the cookie if found, None if not.

:Usage:
driver.get_cookie('my_cookie')

get_cookies(self)
Returns a set of dictionaries, corresponding to cookies visible in the current session.

:Usage:
driver.get_cookies()

get_log(self, log_type)
Gets the log for a given log type

:Args:
- log_type: type of log that which will be returned

:Usage:
driver.get_log('browser')
driver.get_log('driver')
driver.get_log('client')
driver.get_log('server')

get_screenshot_as_base64(self)
Gets the screenshot of the current window as a base64 encoded string
which is useful in embedded images in HTML.

:Usage:
driver.get_screenshot_as_base64()

get_screenshot_as_file(self, filename)
Gets the screenshot of the current window. Returns False if there is
any IOError, else returns True. Use full paths in your filename.

:Args:
- filename: The full path you wish to save your screenshot to.

:Usage:
driver.get_screenshot_as_file('/Screenshots/foo.png')

get_screenshot_as_png(self)
Gets the screenshot of the current window as a binary data.

:Usage:
driver.get_screenshot_as_png()

get_window_position(self, windowHandle='current')
Gets the x,y position of the current window.

:Usage:
driver.get_window_position()

get_window_size(self, windowHandle='current')
Gets the width and height of the current window.

:Usage:
driver.get_window_size()

implicitly_wait(self, time_to_wait)
Sets a sticky timeout to implicitly wait for an element to be found,
or a command to complete. This method only needs to be called one
time per session. To set the timeout for calls to
execute_async_script, see set_script_timeout.

:Args:
- time_to_wait: Amount of time to wait (in seconds)

:Usage:
driver.implicitly_wait(30)

maximize_window(self)
Maximizes the current window that webdriver is using

refresh(self)
Refreshes the current page.

:Usage:
driver.refresh()

save_screenshot = get_screenshot_as_file(self, filename)
Gets the screenshot of the current window. Returns False if there is
any IOError, else returns True. Use full paths in your filename.

:Args:
- filename: The full path you wish to save your screenshot to.

:Usage:
driver.get_screenshot_as_file('/Screenshots/foo.png')

set_page_load_timeout(self, time_to_wait)
Set the amount of time to wait for a page load to complete
before throwing an error.

:Args:
- time_to_wait: The amount of time to wait

:Usage:
driver.set_page_load_timeout(30)

set_script_timeout(self, time_to_wait)
Set the amount of time that the script should wait during an
execute_async_script call before throwing an error.

:Args:
- time_to_wait: The amount of time to wait (in seconds)

:Usage:
driver.set_script_timeout(30)

set_window_position(self, x, y, windowHandle='current')
Sets the x,y position of the current window. (window.moveTo)

:Args:
- x: the x-coordinate in pixels to set the window position
- y: the y-coordinate in pixels to set the window position

:Usage:
driver.set_window_position(0,0)

set_window_size(self, width, height, windowHandle='current')
Sets the width and height of the current window. (window.resizeTo)

:Args:
- width: the width in pixels to set the window to
- height: the height in pixels to set the window to

:Usage:
driver.set_window_size(800,600)

start_client(self)
Called before starting a new session. This method may be overridden
to define custom startup behavior.

start_session(self, desired_capabilities, browser_profile=None)
Creates a new session with the desired capabilities.

:Args:
- browser_name - The name of the browser to request.
- version - Which browser version to request.
- platform - Which platform to request the browser on.
- javascript_enabled - Whether the new session should support JavaScript.
- browser_profile - A selenium.webdriver.firefox.firefox_profile.FirefoxProfile object. Only used if Firefox is requested.

stop_client(self)
Called after executing a quit command. This method may be overridden
to define custom shutdown behavior.

switch_to_active_element(self)
Deprecated use driver.switch_to.active_element

switch_to_alert(self)
Deprecated use driver.switch_to.alert

switch_to_default_content(self)
Deprecated use driver.switch_to.default_content

switch_to_frame(self, frame_reference)
Deprecated use driver.switch_to.frame

switch_to_window(self, window_name)
Deprecated use driver.switch_to.window

Data descriptors inherited from selenium.webdriver.remote.webdriver.WebDriver:

__dict__
dictionary for instance variables (if defined)

__weakref__
list of weak references to the object (if defined)

application_cache
Returns a ApplicationCache Object to interact with the browser app cache

current_url
Gets the URL of the current page.

:Usage:
driver.current_url

current_window_handle
Returns the handle of the current window.

:Usage:
driver.current_window_handle

desired_capabilities
returns the drivers current desired capabilities being used

file_detector

log_types
Gets a list of the available log types

:Usage:
driver.log_types

mobile

name
Returns the name of the underlying browser for this instance.

:Usage:
- driver.name

orientation
Gets the current orientation of the device

:Usage:
orientation = driver.orientation

page_source
Gets the source of the current page.

:Usage:
driver.page_source

switch_to

title
Returns the title of the current page.

:Usage:
driver.title

window_handles
Returns the handles of all windows within the current session.

:Usage:
driver.window_handles

 

小编后续有空再翻译下吧,英文水平有限。在学习过程中有遇到疑问的,可以加selenium(python+java) QQ群交流:646645429

《selenium+python高级教程》已出书:selenium webdriver基于Python源码案例

(购买此书送对应PDF版本)

 

python2.7\lib\site-packagespython2.7\lib\site-packages

时间: 2024-10-24 15:28:53

Selenium2+python自动化27-查看selenium API的相关文章

Selenium2+python自动化61-Chrome您使用的是不受支持的命令行标记:--ignore-certificate-errors

前言 您使用的是不受支持的命令行标记:--ignore-certificate-errors.稳定性和安全性会有所下降 selenium2启动Chrome浏览器是需要安装驱动包的,但是不同的Chrome浏览器版本号,对应的驱动文件版本号又不一样,如果版本号不匹配,是没法启动起来的.   一.Chrome遇到问题 1.如果在启动chrome浏览器时候,出现如下界面,无法打开网址,那么首先恭喜你,踩到了坑,接下来的内容或许对你有所帮助 >># coding:utf-8 >>from s

Selenium2+python自动化29-js处理多窗口

前言 在打开页面上链接的时候,经常会弹出另外一个窗口(多窗口情况前面这篇有讲解:Selenium2+python自动化13-多窗口.句柄(handle)),这样在多个窗口之间来回切换比较复杂,那么有没有办法让新打开的链接在一个窗口打开呢? 要解决这个问题,得从html源码上找到原因,然后修改元素属性才能解决.很显然js在这方面是万能的,于是本篇得依靠万能的js大哥了. 一.多窗口情况     1.在打baidu的网站链接时,会重新打开一个窗口     (注意:我的百度页面是已登录状态,没登录时候

Selenium2+python自动化7-xpath定位

前言     在上一篇简单的介绍了用工具查看目标元素的xpath地址,工具查看比较死板,不够灵活,有时候直接复制粘贴会定位不到.这个时候就需要自己手动的去写xpath了,这一篇详细讲解xpath的一些语法. 什么是xpath呢? 官方介绍:XPath即为XML路径语言,它是一种用来确定XML1(标准通用标记语言3的子集)文档中某部分位置的语言.反正小编看这个介绍是云里雾里的,通俗一点讲就是通过元素的路径来查找到这个元素的,相当于通过定位一个对象的坐标,来找到这个对象. 一.xpath:属性定位

Selenium2+python自动化33-文件上传(send_keys)

前言 文件上传是web页面上很常见的一个功能,自动化成功中操作起来却不是那么简单. 一般分两个场景:一种是input标签,这种可以用selenium提供的send_keys()方法轻松解决: 另外一种非input标签实现起来比较困难,可以借助autoit工具或者SendKeys第三方库. 本篇以博客园的上传图片为案例,通过send_keys()方法解决文件上传问题 一.识别上传按钮 1.点开博客园编辑器里的图片上传按钮,弹出"上传本地图片"框. 2.用firebug查看按钮属性,这种上

Selenium2+python自动化54-unittest生成测试报告(HTMLTestRunner)

前言 批量执行完用例后,生成的测试报告是文本形式的,不够直观,为了更好的展示测试报告,最好是生成HTML格式的. unittest里面是不能生成html格式报告的,需要导入一个第三方的模块:HTMLTestRunner   一.导入HTMLTestRunner 1.这个模块下载不能通过pip安装了,只能下载后手动导入,下载地址:http://tungwaiyip.info/software/HTMLTestRunner.html 2.Download下HTMLTestRunner.py文件就是我

Selenium2+python自动化41-绕过验证码(add_cookie)

前言 验证码这种问题是比较头疼的,对于验证码的处理,不要去想破解方法,这个验证码本来就是为了防止别人自动化登录的.如果你能破解,说明你们公司的验证码吗安全级别不高,那就需要提高级别了. 对于验证码,要么是让开发在测试环境弄个万能的验证码,如:1234,要么就是尽量绕过去,如本篇介绍的添加cookie的方法. 一.fiddler抓包 1.前一篇讲到,登录后会生成一个已登录状态的cookie,那么只需要直接把这个值添加到cookies里面就可以了. 2.可以先手动登录一次,然后抓取这个cookie,

Selenium2+python自动化28-table定位

前言     在web页面中经常会遇到table表格,特别是后台操作页面比较常见.本篇详细讲解table表格如何定位. 一.认识table     1.首先看下table长什么样,如下图,这种网状表格的都是table     2.源码如下:(用txt文本保存,后缀改成html) <!DOCTYPE html><meta charset="UTF-8"> <!-- for HTML5 --><meta http-equiv="Conte

Selenium2+python自动化23-富文本(自动发帖)

前言      富文本编辑框是做web自动化最常见的场景,有很多小伙伴遇到了不知道无从下手,本篇以博客园的编辑器为例,解决如何定位富文本,输入文本内容 一.加载配置     1.打开博客园写随笔,首先需要登录,这里为了避免透露个人账户信息,我直接加载配置文件,免登录了.       不懂如何加载配置文件的,看这篇Selenium2+python自动化18-加载Firefox配置 二.打开编辑界面     1.博客首页地址:bolgurl = "http://www.cnblogs.com/&qu

Selenium2+python自动化24-js处理富文本(带iframe)

前言     上一篇Selenium2+python自动化23-富文本(自动发帖)解决了富文本上iframe问题,其实没什么特别之处,主要是iframe的切换,本篇讲解通过js的方法处理富文本上iframe的问题 一.加载配置     1.打开博客园写随笔,首先需要登录,这里为了避免透露个人账户信息,我直接加载配置文件,免登录了.       不懂如何加载配置文件的,看这篇Selenium2+python自动化18-加载Firefox配置 二.打开编辑界面     1.博客首页地址:bolgur