mirror of
https://gitee.com/g1879/DrissionPage.git
synced 2024-12-10 04:00:23 +08:00
修改注释
This commit is contained in:
g1879
parent
f3b702f9a9
commit
9d0a587ece
@ -1,10 +1,10 @@
|
||||
[paths]
|
||||
chromedriver_path =
|
||||
tmp_path =
|
||||
chromedriver_path = D:\python\Google Chrome\Chrome\chromedriver75.exe
|
||||
tmp_path = D:\python\projects\DrissionPage\DrissionPage\tmp
|
||||
|
||||
[chrome_options]
|
||||
debugger_address = 127.0.0.1:9222
|
||||
binary_location =
|
||||
binary_location = D:\python\Google Chrome\Chrome\chrome.exe
|
||||
arguments = ['--no-sandbox', '--disable-gpu', '--ignore-certificate-errors', '--disable-infobars']
|
||||
extensions = []
|
||||
experimental_options = {'prefs': {'profile.default_content_settings.popups': 0, 'profile.default_content_setting_values': {'notifications': 2}, 'plugins.plugins_list': [{'enabled': False, 'name': 'Chrome PDF Viewer'}]}, 'useAutomationExtension': False, 'excludeSwitches': ['enable-automation']}
|
||||
|
||||
17
README.md
17
README.md
@ -6,10 +6,10 @@
|
||||
|
||||
DrissionPage，即 driver 和 session 组合而成的 page。
|
||||
是个基于 python 的 Web 自动化操作集成工具。
|
||||
它实现了 selenium 和 requests 之间的无缝切换。
|
||||
可以兼顾 selenium 的便利性和 requests 的高效率。
|
||||
它集成了页面常用功能，两种模式系统一致的 API，使用便捷。
|
||||
它用 POM 模式封装了页面元素常用的方法，适合自动化操作功能扩展。
|
||||
它用 POM 模式封装了页面和元素常用的方法，
|
||||
自带一套简洁直观优雅的元素定位语法，
|
||||
实现了 selenium 和 requests 之间的无缝切换，
|
||||
可兼顾 selenium 的便利性和 requests 的高效率，
|
||||
更棒的是，它的使用方式非常简洁和人性化，代码量少，对新手友好。
|
||||
|
||||
**示例地址：** [使用DrissionPage的网页自动化及爬虫示例](https://gitee.com/g1879/DrissionPage-demos)
|
||||
@ -37,7 +37,7 @@ requests 爬虫面对要登录的网站时，要分析数据包、JS 源码，
|
||||
- 两种模式提供一致的 API，使用体验一致。
|
||||
- 人性化设计，集成众多实用功能，大大降低开发工作量。
|
||||
|
||||
## 亮点
|
||||
## 亮点功能
|
||||
|
||||
- 每次运行程序可以反复使用已经打开的浏览器。如手动设置网页到某个状态，再用程序接管，或手动处理登录，再用程序爬内容。无须每次运行从头启动浏览器，超级方便。
|
||||
- 使用 ini 文件保存常用配置，自动调用，也提供便捷的设置api，远离繁杂的配置项。
|
||||
@ -287,3 +287,10 @@ Git 命令学习
|
||||
|
||||
请在 Wiki中查看：[点击查看APIs](https://gitee.com/g1879/DrissionPage/wikis/Drission%20%E7%B1%BB?sort_id=3159323)
|
||||
|
||||
# 请我喝咖啡
|
||||
|
||||
如果本项目对您有所帮助，不妨请作者我喝杯咖啡 ：）
|
||||
|
||||
|  |  |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
|
||||
|
||||
@ -1,111 +0,0 @@
|
||||
## class Drission()
|
||||
|
||||
Drission 类用于管理 WebDriver 对象和 Session 对象，是驱动器的角色。
|
||||
|
||||
参数说明：
|
||||
|
||||
- driver_or_options: [WebDriver, dict, Options, DriverOptions] - WebDriver 对象或 chrome 配置参数。
|
||||
- session_or_options: [Session, dict] - Session 对象配置参数
|
||||
- ini_path: str - ini 文件路径，默认为 DrissionPage 文件夹下的ini文件
|
||||
- proxy: dict - 代理设置
|
||||
|
||||
## session
|
||||
|
||||
返回 Session 对象，自动按配置信息初始化。
|
||||
|
||||
返回： Session - 管理的 Session 对象
|
||||
|
||||
## driver
|
||||
|
||||
返回 WebDriver 对象，自动按配置信息初始化。
|
||||
|
||||
返回： WebDriver - 管理的 WebDriver 对象
|
||||
|
||||
## driver_options
|
||||
|
||||
返回或设置 driver 配置。
|
||||
|
||||
返回： dict
|
||||
|
||||
## session_options
|
||||
|
||||
返回 session 配置。
|
||||
|
||||
返回： dict
|
||||
|
||||
## proxy
|
||||
|
||||
返回代理配置。
|
||||
|
||||
返回： dict
|
||||
|
||||
## debugger_progress
|
||||
|
||||
调试浏览器进程，当浏览器是自动创建时才能返回，否则返回 None。
|
||||
|
||||
返回：浏览器进程
|
||||
|
||||
## session_options()
|
||||
|
||||
设置 session 配置。
|
||||
|
||||
返回： None
|
||||
|
||||
## cookies_to_session()
|
||||
|
||||
把 driver 对象的 cookies 复制到 session 对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- copy_user_agent: bool - 是否复制 user_agent 到 session
|
||||
- driver: WebDriver - 复制 cookies 的 WebDriver 对象
|
||||
- session: Session - 接收 cookies 的 Session 对象
|
||||
|
||||
返回： None
|
||||
|
||||
## cookies_to_driver()
|
||||
|
||||
把 cookies 从 session 复制到 driver。
|
||||
|
||||
参数说明：
|
||||
|
||||
- url: str - cookies 的域
|
||||
- driver: WebDriver - 接收 cookies 的 WebDriver 对象
|
||||
- session: Session - 复制 cookies 的 Session 对象
|
||||
|
||||
返回： None
|
||||
|
||||
## user_agent_to_session()
|
||||
|
||||
把 user agent 从 driver 复制到 session。
|
||||
|
||||
参数说明：
|
||||
|
||||
- driver: WebDriver - WebDriver 对象，复制 user agent
|
||||
- session: Session - Session 对象，接收 user agent
|
||||
|
||||
返回： None
|
||||
|
||||
## close_driver()
|
||||
|
||||
关闭浏览器，driver 置为 None。
|
||||
|
||||
返回： None
|
||||
|
||||
## close_session()
|
||||
|
||||
关闭 session 并置为 None。
|
||||
|
||||
返回： None
|
||||
|
||||
## close()
|
||||
|
||||
关闭 driver 和 session。
|
||||
|
||||
返回： None
|
||||
|
||||
## kill_browser()
|
||||
|
||||
关闭浏览器进程（如果可以）。
|
||||
|
||||
返回： None
|
||||
@ -1,453 +0,0 @@
|
||||
## class DriverElement()
|
||||
|
||||
driver 模式的元素对象，包装了一个 WebElement 对象，并封装了常用功能。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele: WebElement - WebElement 对象
|
||||
- page: DriverPage - 元素所在的页面对象
|
||||
|
||||
## inner_ele
|
||||
|
||||
被包装的 WebElement 对象。
|
||||
|
||||
返回： WebElement
|
||||
|
||||
## html
|
||||
|
||||
返回元素 outerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## json
|
||||
|
||||
当返回内容是json格式时，返回对应的字典。
|
||||
|
||||
返回： dict
|
||||
|
||||
## inner_html
|
||||
|
||||
返回元素 innerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## tag
|
||||
|
||||
返回元素标签名。
|
||||
|
||||
返回： str
|
||||
|
||||
## attrs
|
||||
|
||||
以字典方式返回元素所有属性及值。
|
||||
|
||||
返回： dict
|
||||
|
||||
## text
|
||||
|
||||
返回元素内的文本，已格式化处理。
|
||||
|
||||
返回： str
|
||||
|
||||
## raw_text
|
||||
|
||||
返回元素内的文本，未格式化处理。
|
||||
|
||||
返回： str
|
||||
|
||||
## comments
|
||||
|
||||
返回元素内注释列表。
|
||||
|
||||
返回： list
|
||||
|
||||
## link
|
||||
|
||||
返回元素 href 或 src 绝对 url。
|
||||
|
||||
返回： str
|
||||
|
||||
## css_path
|
||||
|
||||
返回元素 css selector 绝对路径。
|
||||
|
||||
返回： str
|
||||
|
||||
## xpath
|
||||
|
||||
返回元素 xpath 绝对路径。
|
||||
|
||||
返回： str
|
||||
|
||||
## parent
|
||||
|
||||
返回父级元素对象。
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## next
|
||||
|
||||
返回下一个兄弟元素对象。
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## prev
|
||||
|
||||
返回上一个兄弟元素对象。
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## size
|
||||
|
||||
以字典方式返回元素大小。
|
||||
|
||||
返回： dict
|
||||
|
||||
## location
|
||||
|
||||
以字典方式放回元素坐标。
|
||||
|
||||
返回： dict
|
||||
|
||||
## shadow_root
|
||||
|
||||
返回当前元素的 shadow_root 元素对象
|
||||
|
||||
返回： ShadowRoot
|
||||
|
||||
## before
|
||||
|
||||
返回当前元素的 ::before 伪元素内容
|
||||
|
||||
返回： str
|
||||
|
||||
## after
|
||||
|
||||
返回当前元素的 ::after 伪元素内容
|
||||
|
||||
返回： str
|
||||
|
||||
## select
|
||||
|
||||
如果是 select 元素，返回 Select 对象，否则返回 None。
|
||||
|
||||
返回：Union[Select, None]
|
||||
|
||||
## wait__ele
|
||||
|
||||
等待子元素从dom删除、显示、隐藏。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_ele:Union[str, tuple, DrissionElement, WebElement] - 可以是元素、查询字符串、loc元组
|
||||
|
||||
- mode:str - 等待方式，可选：'del', 'display', 'hidden'
|
||||
|
||||
- timeout:float - 等待超时时间
|
||||
|
||||
返回： 等待是否成功
|
||||
|
||||
## texts()
|
||||
|
||||
返回元素内所有直接子节点的文本，包括元素和文本节点
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_node_only:bool - 是否只返回文本节点
|
||||
|
||||
返回： List[str]
|
||||
|
||||
## parents()
|
||||
|
||||
返回第 N 层父级元素对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 第几层父元素
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## nexts()
|
||||
|
||||
返回后面第 num 个兄弟元素或节点文本。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 后面第几个兄弟元素或节点
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [DriverElement, str]
|
||||
|
||||
## prevs()
|
||||
|
||||
返回前面第 num 个兄弟元素或节点文本。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 前面第几个兄弟元素或节点
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [DriverElement, str]
|
||||
|
||||
## attr()
|
||||
|
||||
获取元素某个属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 属性名称
|
||||
|
||||
返回： str
|
||||
|
||||
## prop()
|
||||
|
||||
获取元素某个property属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- prop: str - 属性名称
|
||||
|
||||
返回： str
|
||||
|
||||
## ele()
|
||||
|
||||
返回当前元素下级符合条件的子元素、属性或节点文本。
|
||||
如查询参数是字符串，可选 '@属性名:'、'tag:'、'text:'、'css:'、'xpath:'、'.'、'#' 方式。无控制方式时默认用 text 方式查找。
|
||||
如是loc，直接按照内容查询。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 元素的定位信息，可以是 loc 元组，或查询字符串
|
||||
- mode: str - 'single' 或 'all'，对应查找一个或全部
|
||||
- timeout: float - 查找元素超时时间
|
||||
|
||||
返回： [DriverElement, str]
|
||||
|
||||
## eles()
|
||||
|
||||
根据查询参数获取符合条件的元素列表。查询参数使用方法和 ele 方法一致。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
- timeout: float - 查找元素超时时间
|
||||
|
||||
返回： List[DriverElement or str]
|
||||
|
||||
## s_ele()
|
||||
|
||||
查找第一个符合条件的元素以SessionElement形式返回。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 元素的定位信息，可以是 loc 元组，或查询字符串
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## s_eles()
|
||||
|
||||
查找所有符合条件的元素以SessionElement列表形式返回。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
返回： List[SessionElement or str]
|
||||
|
||||
## style()
|
||||
|
||||
返回元素样式属性值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- style: str - 样式属性名称
|
||||
- pseudo_ele: str - 伪元素名称
|
||||
|
||||
返回： str
|
||||
|
||||
## click()
|
||||
|
||||
点击元素，如不成功则用 js 方式点击，可指定是否用 js 方式点击。
|
||||
|
||||
参数说明：
|
||||
|
||||
- by_js: bool - 是否用js方式点击
|
||||
|
||||
返回： bool
|
||||
|
||||
## click_at()
|
||||
|
||||
带偏移量点击本元素，相对于左上角坐标。不传入x或y值时点击元素中点。
|
||||
|
||||
参数说明：
|
||||
|
||||
- x: Union[int, str] - 相对元素左上角坐标的x轴偏移量
|
||||
- y: Union[int, str] - 相对元素左上角坐标的y轴偏移量
|
||||
- by_js: bool - 是否用js方式点击
|
||||
|
||||
返回： None
|
||||
|
||||
## r_click()
|
||||
|
||||
右键单击。
|
||||
|
||||
返回： None
|
||||
|
||||
## r_click_at()
|
||||
|
||||
带偏移量右键单击本元素，相对于左上角坐标。不传入x或y值时点击元素中点。
|
||||
|
||||
参数说明：
|
||||
|
||||
- x: Union[int, str] - 相对元素左上角坐标的x轴偏移量
|
||||
- y: Union[int, str] - 相对元素左上角坐标的y轴偏移量
|
||||
|
||||
返回： None
|
||||
|
||||
## input()
|
||||
|
||||
输入文本或组合键，返回是否成功输入。insure_input 为 False 时始终返回 True。
|
||||
|
||||
参数说明：
|
||||
|
||||
- vals: Union[str, tuple] - 文本值或按键组合
|
||||
- clear: bool - 输入前是否清除文本框
|
||||
- insure_input: bool - 是否自动检测并确保输入正确
|
||||
- timeout: folat - 尝试输入的超时时间，不指定则使用父页面的超时时间，只在insure_input为True时生效
|
||||
|
||||
返回： bool，是否成功输入。insure_input 为 False 时始终返回 True。
|
||||
|
||||
## run_script()
|
||||
|
||||
执行 js 代码，传入自己为第一个参数。
|
||||
|
||||
参数说明：
|
||||
|
||||
- script: str - JavaScript文本
|
||||
- *args - 传入的参数
|
||||
|
||||
返回： Any
|
||||
|
||||
## submit()
|
||||
|
||||
提交表单。
|
||||
|
||||
返回： None
|
||||
|
||||
## clear()
|
||||
|
||||
清空文本框。
|
||||
|
||||
参数说明：
|
||||
|
||||
- insure_clear: bool - 是否确保清空
|
||||
|
||||
返回： bool - 是否清空成功，不能清空的元素返回None
|
||||
|
||||
## is_selected()
|
||||
|
||||
元素是否被选中。
|
||||
|
||||
返回： bool
|
||||
|
||||
## is_enabled()
|
||||
|
||||
元素在页面中是否可用。
|
||||
|
||||
返回： bool
|
||||
|
||||
## is_displayed()
|
||||
|
||||
元素是否可见。
|
||||
|
||||
返回： bool
|
||||
|
||||
## is_valid()
|
||||
|
||||
元素是否还在 DOM 内。该方法用于判断页面跳转元素不能用的情况
|
||||
|
||||
返回： bool
|
||||
|
||||
## screenshot()
|
||||
|
||||
网页截图，返回截图文件路径。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - 截图保存路径，默认为 ini 文件中指定的临时文件夹
|
||||
- filename: str - 截图文件名，默认为页面 title 为文件名
|
||||
|
||||
返回： str
|
||||
|
||||
## select()
|
||||
|
||||
在下拉列表中选择。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text: str - 选项文本
|
||||
|
||||
返回： bool - 是否成功
|
||||
|
||||
## set_prop()
|
||||
|
||||
设置元素property属性。
|
||||
|
||||
参数说明：
|
||||
|
||||
- prop: str - 属性名
|
||||
- value: str - 属性值
|
||||
|
||||
返回： bool -是否成功
|
||||
|
||||
## set_attr()
|
||||
|
||||
设置元素attribute参数。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 参数名
|
||||
- value: str - 参数值
|
||||
|
||||
返回： bool -是否成功
|
||||
|
||||
## remove_attr()
|
||||
|
||||
删除元素属性。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 参数名
|
||||
|
||||
返回： bool -是否成功
|
||||
|
||||
## drag()
|
||||
|
||||
拖拽当前元素一段距离，返回是否拖拽成功。
|
||||
|
||||
参数说明：
|
||||
|
||||
- x: int - 拖拽x方向距离
|
||||
- y: int - 拖拽y方向距离
|
||||
- speed: int - 拖拽速度
|
||||
- shake: bool - 是否随机抖动
|
||||
|
||||
返回： bool
|
||||
|
||||
## drag_to()
|
||||
|
||||
拖拽当前元素，目标为另一个元素或坐标元组，返回是否拖拽成功。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele_or_loc[tuple, WebElement, DrissionElement] - 另一个元素或相对当前位置，坐标为元素中点坐标。
|
||||
- speed: int - 拖拽速度
|
||||
- shake: bool - 是否随机抖动
|
||||
|
||||
返回： bool
|
||||
|
||||
## hover()
|
||||
|
||||
在元素上悬停鼠标。
|
||||
|
||||
返回： None
|
||||
@ -1,142 +0,0 @@
|
||||
### class DriverOptions()
|
||||
|
||||
chrome 浏览器配置类，继承自 selenium.webdriver.chrome.options 的 Options 类，增加了删除配置和保存到文件方法。
|
||||
|
||||
参数说明：
|
||||
|
||||
- read_file: bool - 创建时是否从 ini 文件读取配置信息
|
||||
- ini_path: str - ini 文件路径，为None则读取默认 ini 文件
|
||||
|
||||
### driver_path
|
||||
|
||||
chromedriver.exe 的路径。
|
||||
|
||||
返回： str
|
||||
|
||||
### chrome_path
|
||||
|
||||
chrome.exe 的路径
|
||||
|
||||
返回： str
|
||||
|
||||
### save()
|
||||
|
||||
保存设置到文件，返回自己，用于链式操作。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini 文件的路径，传入 'default' 保存到默认ini文件
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### remove_argument()
|
||||
|
||||
移除一个设置。
|
||||
|
||||
参数说明：
|
||||
|
||||
- value: str - 要移除的属性值
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### remove_experimental_option()
|
||||
|
||||
移除一个实验设置，传入 key 值删除。
|
||||
|
||||
参数说明：
|
||||
|
||||
- key: str - 要移除的实验设置 key 值
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### remove_all_extensions()
|
||||
|
||||
移除所有插件，因插件是以整个文件储存，难以移除其中一个，故如须设置则全部移除再重设。
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_argument()
|
||||
|
||||
设置 chrome 属性，无值的属性可设置开关，有值的属性可设置属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- arg: str - 属性名
|
||||
- value[bool, str] - 属性值，有值的属性传入值，没有的传入 bool
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_headless()
|
||||
|
||||
打开或关闭无界面模式。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_no_imgs()
|
||||
|
||||
是否加载图片。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_no_js()
|
||||
|
||||
是否禁用 js。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_mute()
|
||||
|
||||
是否静音。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_user_agent()
|
||||
|
||||
设置浏览器 user agent。
|
||||
|
||||
参数说明：
|
||||
|
||||
- user_agent: str - user agent 字符串
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_proxy()
|
||||
|
||||
设置代理。
|
||||
|
||||
参数说明：
|
||||
|
||||
- proxy: str - 代理地址
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_paths()
|
||||
|
||||
设置浏览器相关的路径。
|
||||
|
||||
参数说明：
|
||||
|
||||
- driver_path: str - chromedriver.exe 的路径
|
||||
- chrome_path: str - chrome.exe 的路径
|
||||
- debugger_address: str - 调试浏览器地址，例：127.0.0.1:9222
|
||||
- download_path: str - 下载文件路径
|
||||
- user_data_path: str - 用户数据路径
|
||||
- cache_path: str - 缓存路径
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
@ -1,458 +0,0 @@
|
||||
## class MixPage()
|
||||
|
||||
MixPage 封装了页面操作的常用功能，可在 driver 和 session 模式间无缝切换。切换的时候会自动同步 cookies。
|
||||
获取信息功能为两种模式共有，操作页面元素功能只有 d 模式有。调用某种模式独有的功能，会自动切换到该模式。
|
||||
它继承自 DriverPage 和 SessionPage 类，这些功能由这两个类实现，MixPage 作为调度的角色存在。
|
||||
|
||||
参数说明：
|
||||
|
||||
- drission: Drission - Drission 对象，如没传入则创建一个。传入 's' 或 'd' 时快速配置相应模式
|
||||
- mode: str - 模式，可选 'd' 或 's'，默认为'd'
|
||||
- timeout: float - 超时时间，driver 模式为查找元素时间，session 模式为连接等待时间
|
||||
|
||||
## url
|
||||
|
||||
返回 MixPage 对象当前访问的 url。
|
||||
|
||||
返回： str
|
||||
|
||||
## mode
|
||||
|
||||
返回当前模式（ 's' 或 'd' ）。
|
||||
|
||||
返回： str
|
||||
|
||||
## drission
|
||||
|
||||
返回当前使用的 Dirssion 对象。
|
||||
|
||||
返回： Drission
|
||||
|
||||
## driver
|
||||
|
||||
返回driver对象，如没有则创建，调用时会切换到 driver 模式。
|
||||
|
||||
返回： WebDriver
|
||||
|
||||
## session
|
||||
|
||||
返回 session 对象，如没有则创建。
|
||||
|
||||
返回： Session
|
||||
|
||||
## response
|
||||
|
||||
返回s模式获取到的 Response 对象，调用时会切换到s模式。
|
||||
|
||||
返回： Response
|
||||
|
||||
## cookies
|
||||
|
||||
返回 cookies，从当前模式获取。
|
||||
|
||||
返回： [dict, list]
|
||||
|
||||
## html
|
||||
|
||||
返回页面 html 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## json
|
||||
|
||||
当返回内容是json格式时，返回对应的字典。
|
||||
|
||||
返回： dict
|
||||
|
||||
## title
|
||||
|
||||
返回页面 title。
|
||||
|
||||
返回： str
|
||||
|
||||
## url_available
|
||||
|
||||
返回当前 url 有效性。
|
||||
|
||||
返回： bool
|
||||
|
||||
## retry_times
|
||||
|
||||
连接失败时重试次数。
|
||||
|
||||
返回： int
|
||||
|
||||
## retry_interval
|
||||
|
||||
重试连接的间隔。
|
||||
|
||||
返回： int
|
||||
|
||||
## wait_object
|
||||
|
||||
返回WebDriverWait对象，重用避免每次新建对象。
|
||||
|
||||
返回： WebDriverWait
|
||||
|
||||
## set_cookies()
|
||||
|
||||
设置 cookies。
|
||||
|
||||
参数说明：
|
||||
|
||||
- cookies: Union[RequestsCookieJar, list, tuple, str, dict] - cookies 信息，可为CookieJar, list, tuple, str, dict
|
||||
- refresh: bool - 设置cookies后是否刷新页面
|
||||
|
||||
返回： None
|
||||
|
||||
## get_cookies()
|
||||
|
||||
返回 cookies。
|
||||
|
||||
参数说明：
|
||||
|
||||
- as_dict: bool - 是否以 dict 方式返回，默认以 list 返回完整的 cookies
|
||||
- all_domains: bool - 是否返回所有域名的 cookies，只有 s 模式下生效
|
||||
|
||||
返回：cookies 字典或列表
|
||||
|
||||
## change_mode()
|
||||
|
||||
切换模式，'d' 或 's'。切换时会把当前模式的 cookies 复制到目标模式。
|
||||
|
||||
参数说明：
|
||||
|
||||
- mode: str - 指定目标模式，'d' 或 's'。
|
||||
- go: bool - 切换模式后是否跳转到当前 url
|
||||
|
||||
返回： None
|
||||
|
||||
## ele()
|
||||
|
||||
返回页面中符合条件的元素，默认返回第一个。
|
||||
如查询参数是字符串，可选 '@属性名:'、'tag:'、'text:'、'css:'、'xpath:'、'.'、'#' 方式。无控制方式时默认用 text 方式查找。
|
||||
如是loc，直接按照内容查询。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str, DriverElement, SessionElement, WebElement] - 元素的定位信息，可以是元素对象，loc 元组，或查询字符串
|
||||
- timeout: float - 查找元素超时时间，driver 模式下有效
|
||||
|
||||
返回： [DriverElement, SessionElement, str] - 元素对象或属性、文本节点文本
|
||||
|
||||
## eles()
|
||||
|
||||
根据查询参数获取符合条件的元素列表。查询参数使用方法和 ele 方法一致。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
- timeout: float - 查找元素超时时间，driver 模式下有效
|
||||
|
||||
返回： [List[DriverElement or str], List[SessionElement or str]] - 元素对象或属性、文本节点文本组成的列表
|
||||
|
||||
## s_ele()
|
||||
|
||||
查找第一个符合条件的元素以SessionElement形式返回。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_ele: [Tuple[str, str], str] - 元素的定位信息，可以是 loc 元组，或查询字符串
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## s_eles()
|
||||
|
||||
查找所有符合条件的元素以SessionElement列表形式返回。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_ele: [Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
返回： List[SessionElement or str]
|
||||
|
||||
## cookies_to_session()
|
||||
|
||||
从 WebDriver 对象复制 cookies 到 Session 对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- copy_user_agent: bool - 是否同时复制 user agent
|
||||
|
||||
返回： None
|
||||
|
||||
## cookies_to_driver()
|
||||
|
||||
从 Session 对象复制 cookies 到 WebDriver 对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- url: str - cookies 的域或 url
|
||||
|
||||
返回： None
|
||||
|
||||
## get()
|
||||
|
||||
跳转到一个url，跳转前先同步 cookies，跳转后返回目标 url 是否可用。
|
||||
|
||||
参数说明：
|
||||
|
||||
- url: str - 目标 url
|
||||
- go_anyway: bool - 是否强制跳转。若目标 url 和当前 url 一致，默认不跳转。
|
||||
- show_errmsg: bool - 是否显示和抛出异常
|
||||
- retry: int - 连接出错时重试次数
|
||||
- interval: float - 重试间隔（秒）
|
||||
- **kwargs - 用于 requests 的连接参数
|
||||
|
||||
返回： [bool, None] - url 是否可用
|
||||
|
||||
## post()
|
||||
|
||||
以 post 方式跳转，调用时自动切换到 session 模式。
|
||||
|
||||
参数说明：
|
||||
|
||||
- url: str - 目标 url
|
||||
- data: dict - 提交的数据
|
||||
- go_anyway: bool - 是否强制跳转。若目标 url 和当前 url 一致，默认不跳转。
|
||||
- show_errmsg: bool - 是否显示和抛出异常
|
||||
- retry: int - 连接出错时重试次数
|
||||
- interval: float - 重试间隔（秒）
|
||||
- **kwargs - 用于 requests 的连接参数
|
||||
|
||||
返回： [bool, None] - url 是否可用
|
||||
|
||||
## download()
|
||||
|
||||
下载一个文件，返回是否成功和下载信息字符串。改方法会自动避免和目标路径现有文件重名。
|
||||
|
||||
参数说明：
|
||||
|
||||
- file_url: str - 文件 url
|
||||
- goal_path: str - 存放路径，默认为 ini 文件中指定的临时文件夹
|
||||
- rename: str - 重命名文件，不改变扩展名
|
||||
- file_exists: str - 若存在同名文件，可选择 'rename', 'overwrite', 'skip' 方式处理
|
||||
- post_data: dict - post 方式时提交的数据
|
||||
- show_msg: bool - 是否显示下载信息
|
||||
- show_errmsg: bool - 是否显示和抛出异常
|
||||
- **kwargs - 用于 requests 的连接参数
|
||||
|
||||
返回： Tuple[bool, str] - 下载是否成功（bool）和状态信息（成功时信息为文件路径）的元组
|
||||
|
||||
以下方法和属性只有 driver 模式下生效，调用时会自动切换到 driver 模式
|
||||
|
||||
***
|
||||
|
||||
## tabs_count
|
||||
|
||||
返回标签页数量。
|
||||
|
||||
返回： int
|
||||
|
||||
## tab_handles
|
||||
|
||||
返回所有标签页 handle 列表。
|
||||
|
||||
返回： list
|
||||
|
||||
## current_tab_num
|
||||
|
||||
返回当前标签页序号。
|
||||
|
||||
返回： int
|
||||
|
||||
## current_tab_handle
|
||||
|
||||
返回当前标签页 handle。
|
||||
|
||||
返回： str
|
||||
|
||||
## wait_ele()
|
||||
|
||||
等待元素从 dom 删除、显示、隐藏。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_ele: [str, tuple, DriverElement, WebElement] - 元素查找方式，与ele()相同
|
||||
- mode: str - 等待方式，可选：'del', 'display', 'hidden'
|
||||
- timeout: float - 等待超时时间
|
||||
|
||||
返回： bool - 等待是否成功
|
||||
|
||||
## check_page()
|
||||
|
||||
d 模式时检查网页是否符合预期。默认由 response 状态检查，可重载实现针对性检查。
|
||||
|
||||
参数说明：
|
||||
|
||||
- by_requests:bool - 强制使用内置 response 进行检查
|
||||
|
||||
返回： [bool, None] - bool 为是否可用，None 为未知
|
||||
|
||||
## run_script()
|
||||
|
||||
执行JavaScript代码。
|
||||
|
||||
参数说明：
|
||||
|
||||
- script: str - JavaScript 代码文本
|
||||
- *args - 传入的参数
|
||||
|
||||
返回： Any
|
||||
|
||||
## create_tab()
|
||||
|
||||
新建并定位到一个标签页,该标签页在最后面。
|
||||
|
||||
参数说明：
|
||||
|
||||
- url: str - 新标签页跳转到的网址
|
||||
|
||||
返回： None
|
||||
|
||||
## close_current_tab()
|
||||
|
||||
关闭当前标签页。
|
||||
|
||||
返回： None
|
||||
|
||||
## close_other_tabs()
|
||||
|
||||
关闭传入的标签页以外标签页，默认保留当前页。可传入列表或元组。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num_or_handles:[int, str] - 要保留的标签页序号或 handle，可传入 handle 组成的列表或元组
|
||||
|
||||
返回： None
|
||||
|
||||
## to_tab()
|
||||
|
||||
跳转到标签页。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num_or_handle:[int, str] - 标签页序号或handle字符串，序号第一个为0，最后为-1
|
||||
|
||||
返回： None
|
||||
|
||||
## to_frame()
|
||||
|
||||
跳转到 frame，默认跳转到最高层级，兼容 selenium 原生参数。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_ele: [int, str, tuple, WebElement, DriverElement] - 查找 iframe 元素的条件，可接收 iframe 序号（0开始）、id 或
|
||||
name、查询字符串、loc参数、WebElement对象、DriverElement 对象，传入 'main' 跳到最高层，传入 'parent' 跳到上一层
|
||||
|
||||
示例：
|
||||
|
||||
- to_iframe('tag:iframe') - 通过传入 iframe 的查询字符串定位
|
||||
- to_iframe('iframe_id') - 通过 iframe 的 id 属性定位
|
||||
- to_iframe('iframe_name') - 通过 iframe 的 name 属性定位
|
||||
- to_iframe(iframe_element) - 通过传入元素对象定位
|
||||
- to_iframe(0) - 通过 iframe 的序号定位
|
||||
- to_iframe('main') - 跳到最高层
|
||||
- to_iframe('parent') - 跳到上一层
|
||||
|
||||
返回： 自己，用于链式操作进行下一步元素查找
|
||||
|
||||
## scroll_to_see()
|
||||
|
||||
滚动直到元素可见。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_ele: [str, tuple, WebElement, DriverElement] - 查找元素的条件，和 ele() 方法的查找条件一致。
|
||||
|
||||
返回： None
|
||||
|
||||
## scroll_to()
|
||||
|
||||
滚动页面，按照参数决定如何滚动。
|
||||
|
||||
参数说明：
|
||||
|
||||
- mode: str - 滚动的方向，top、bottom、rightmost、leftmost、up、down、left、right
|
||||
- pixel: int - 滚动的像素
|
||||
|
||||
返回： None
|
||||
|
||||
## refresh()
|
||||
|
||||
刷新页面。
|
||||
|
||||
返回： None
|
||||
|
||||
## back()
|
||||
|
||||
页面后退。
|
||||
|
||||
返回： None
|
||||
|
||||
## set_window_size()
|
||||
|
||||
设置窗口大小，默认最大化。
|
||||
|
||||
参数说明：
|
||||
|
||||
- x: int - 目标宽度
|
||||
- y: int - 目标高度
|
||||
|
||||
返回： None
|
||||
|
||||
## screenshot()
|
||||
|
||||
网页截图，返回截图文件路径。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - 截图保存路径，默认为 ini 文件中指定的临时文件夹
|
||||
- filename: str - 截图文件名，默认为页面 title 为文件名
|
||||
|
||||
返回： str
|
||||
|
||||
## chrome_downloading()
|
||||
|
||||
返回浏览器下载中的文件列表。
|
||||
|
||||
参数说明：
|
||||
|
||||
- download_path: str - 下载文件夹路径
|
||||
|
||||
返回：list
|
||||
|
||||
## process_alert()
|
||||
|
||||
处理提示框。
|
||||
|
||||
参数说明：
|
||||
|
||||
- mode: str - 'ok' 或 'cancel'，若输入其它值，不会按按钮但依然返回文本值
|
||||
- text: str - 处理 prompt 提示框时可输入文本
|
||||
|
||||
返回： [str, None] - 提示框内容文本
|
||||
|
||||
## close_driver()
|
||||
|
||||
关闭 driver 及浏览器。
|
||||
|
||||
返回： None
|
||||
|
||||
## close_session()
|
||||
|
||||
关闭 session。
|
||||
|
||||
返回： None
|
||||
|
||||
## hide_browser()
|
||||
|
||||
隐藏浏览器窗口。
|
||||
|
||||
返回： None
|
||||
|
||||
## show_browser()
|
||||
|
||||
显示浏览器窗口。
|
||||
|
||||
返回： None
|
||||
@ -1,68 +0,0 @@
|
||||
### class OptionsManager()
|
||||
|
||||
管理配置文件内容的类。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini文件路径，不传入则默认读取当前文件夹下的 configs.ini 文件
|
||||
|
||||
### paths
|
||||
|
||||
返回 paths 设置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
### chrome_options
|
||||
|
||||
返回 chrome 设置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
### session_options
|
||||
|
||||
返回 session 设置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
### get_value()
|
||||
|
||||
获取配置的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- section: str - 段落名称
|
||||
- item: str - 配置项名称
|
||||
|
||||
返回： Any
|
||||
|
||||
### get_option()
|
||||
|
||||
以字典的格式返回整个段落的配置信息。
|
||||
|
||||
参数说明：
|
||||
|
||||
- section: str - 段落名称
|
||||
|
||||
返回： dict
|
||||
|
||||
### set_item()
|
||||
|
||||
设置配置值，返回自己，用于链式操作。
|
||||
|
||||
参数说明：
|
||||
|
||||
- section: str - 段落名称
|
||||
- item: str - 配置项名称
|
||||
- value: Any - 值内容
|
||||
|
||||
返回： OptionsManager - 返回自己
|
||||
|
||||
### save()
|
||||
|
||||
保存设置到文件，返回自己，用于链式操作。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini 文件的路径，传入 'default' 保存到默认ini文件
|
||||
|
||||
返回： OptionsManager - 返回自己
|
||||
@ -1,78 +0,0 @@
|
||||
## class Select()
|
||||
|
||||
Select 类专门用于处理 d 模式下 select 标签。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele: select 元素对象
|
||||
|
||||
## is_multi
|
||||
|
||||
返回：是否多选列表
|
||||
|
||||
## options
|
||||
|
||||
返回：所有被选中的option元素列表
|
||||
|
||||
## selected_option
|
||||
|
||||
返回：第一个被选中的option元素
|
||||
|
||||
## selected_options
|
||||
|
||||
返回：所有被选中的option元素列表
|
||||
|
||||
## clear()
|
||||
|
||||
清除所有已选项。
|
||||
|
||||
## select()
|
||||
|
||||
选定或取消选定下拉列表中子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号择选项，若允许多选，传入list或tuple可多选
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
- deselect：是否取消选择
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## select_multi()
|
||||
|
||||
选定或取消选定下拉列表中多个子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号择选多项
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
- deselect：是否取消选择
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## deselect()
|
||||
|
||||
选定或取消选定下拉列表中子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号取消择选项，若允许多选，传入list或tuple可多选
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## deselect_multi()
|
||||
|
||||
选定或取消选定下拉列表中多个子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号取消择选多项
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## invert()
|
||||
|
||||
反选。
|
||||
|
||||
@ -1,196 +0,0 @@
|
||||
# class SessionElement()
|
||||
|
||||
session 模式的元素对象，包装了一个Element对象，并封装了常用功能。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele: HtmlElement - lxml 库的 HtmlElement 对象
|
||||
- page: SessionPage - 元素所在页面对象
|
||||
|
||||
## inner_ele
|
||||
|
||||
被包装的 HTMLElement 对象。
|
||||
|
||||
返回： HtmlElement
|
||||
|
||||
## page
|
||||
|
||||
元素所在页面对象，如果是从 html 文本生成的元素，则为 None。
|
||||
|
||||
返回：SessionElement 或 None
|
||||
|
||||
## tag
|
||||
|
||||
返回元素标签名。
|
||||
|
||||
返回： str
|
||||
|
||||
## html
|
||||
|
||||
返回元素 outerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## inner_html
|
||||
|
||||
返回元素 innerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## attrs
|
||||
|
||||
以字典格式返回元素所有属性的名称和值。
|
||||
|
||||
返回： dict
|
||||
|
||||
## text
|
||||
|
||||
返回元素内文本，已格式化处理。
|
||||
|
||||
返回： str
|
||||
|
||||
## raw_text
|
||||
|
||||
返回元素内未格式化处理的原始文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## comments
|
||||
|
||||
以 list 方式返回元素内所有注释文本。
|
||||
|
||||
返回： list
|
||||
|
||||
## link
|
||||
|
||||
返回元素 href 或 src 绝对 url。
|
||||
|
||||
返回： str
|
||||
|
||||
## css_path
|
||||
|
||||
返回元素 css selector 绝对路径。
|
||||
|
||||
返回： srt
|
||||
|
||||
## xpath
|
||||
|
||||
返回元素 xpath 绝对路径。
|
||||
|
||||
返回： srt
|
||||
|
||||
## parent
|
||||
|
||||
返回父级元素对象。
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## next
|
||||
|
||||
返回下一个兄弟元素对象。
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## prev
|
||||
|
||||
返回上一个兄弟元素对象。
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## parents()
|
||||
|
||||
返回第N层父级元素对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num:int - 第几层父元素
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## nexts()
|
||||
|
||||
返回后面第 num 个兄弟元素或节点文本。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num - 后面第几个兄弟元素
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## prevs()
|
||||
|
||||
返回前 N 个兄弟元素对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num - 前面第几个兄弟元素
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## attr()
|
||||
|
||||
获取元素某个属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 属性名称
|
||||
|
||||
返回： str
|
||||
|
||||
## texts()
|
||||
|
||||
返回元素内所有直接子节点的文本，包括元素和文本节点。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_node_only: 是否只返回文本节点
|
||||
|
||||
返回： 文本组成的 list
|
||||
|
||||
## ele()
|
||||
|
||||
根据查询参数获取元素。
|
||||
如查询参数是字符串，可选 '@属性名:'、'tag:'、'text:'、'css:'、'xpath:'、'.'、'#' 方式。无控制方式时默认用 text 方式查找。
|
||||
如是loc，直接按照内容查询。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str:[Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
- timeout: float -不起实际作用，用于和父类对应
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## eles()
|
||||
|
||||
根据查询参数获取符合条件的元素列表。查询参数使用方法和ele方法一致。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
- timeout: float -不起实际作用，用于和父类对应
|
||||
|
||||
返回： List[SessionElement or str]
|
||||
|
||||
## s_ele()
|
||||
|
||||
功能与 ele() 一致，这里仅用于和 DriverElement 匹配。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str:[Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## s_eles()
|
||||
|
||||
功能与 eles() 一致，这里仅用于和 DriverElement 匹配。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
返回： List[SessionElement or str]
|
||||
@ -1,129 +0,0 @@
|
||||
# class SessionOptions()
|
||||
|
||||
Session 对象配置类。
|
||||
|
||||
参数说明：
|
||||
|
||||
- read_file: bool - 创建时是否从 ini 文件读取配置信息
|
||||
- ini_path: str - ini 文件路径，为None则读取默认 ini 文件
|
||||
|
||||
## headers
|
||||
|
||||
headers 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## cookies
|
||||
|
||||
cookies 配置信息。
|
||||
|
||||
返回： list
|
||||
|
||||
## auth
|
||||
|
||||
auth 配置信息。
|
||||
|
||||
返回： tuple
|
||||
|
||||
## proxies
|
||||
|
||||
proxies 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## hooks
|
||||
|
||||
hooks 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## params
|
||||
|
||||
params 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## verify
|
||||
|
||||
verify 配置信息。
|
||||
|
||||
返回： bool
|
||||
|
||||
## cert
|
||||
|
||||
cert 配置信息。
|
||||
|
||||
返回： [str, tuple]
|
||||
|
||||
## adapters
|
||||
|
||||
adapters 配置信息。
|
||||
|
||||
返回： adapters
|
||||
|
||||
## stream
|
||||
|
||||
stream 配置信息。
|
||||
|
||||
返回： bool
|
||||
|
||||
## trust_env
|
||||
|
||||
srust_env 配置信息。
|
||||
|
||||
返回： bool
|
||||
|
||||
## max_redirects
|
||||
|
||||
max_redirect 配置信息。
|
||||
|
||||
返回： int
|
||||
|
||||
## set_a_header()
|
||||
|
||||
设置 headers 中一个项。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 配置项名称
|
||||
- value: str - 配置的值
|
||||
|
||||
返回： 当前对象
|
||||
|
||||
## remove_a_header()
|
||||
|
||||
从 headers 中删除一个设置。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 要删除的配置名称
|
||||
|
||||
返回：当前对象
|
||||
|
||||
## set_proxies()
|
||||
|
||||
设置proxies参数
|
||||
|
||||
{'http': 'http://xx.xx.xx.xx:xxxx', 'https': 'http://xx.xx.xx.xx:xxxx'}
|
||||
|
||||
参数说明：
|
||||
|
||||
- proxies: dict - 代理信息字典
|
||||
|
||||
返回：当前对象
|
||||
|
||||
## save()
|
||||
|
||||
保存设置到文件。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini文件的路径，传入 'default' 保存到默认ini文件
|
||||
|
||||
返回：当前对象
|
||||
|
||||
## as_dict()
|
||||
|
||||
以字典形式返回当前对象。
|
||||
|
||||
返回： dict
|
||||
@ -1,96 +0,0 @@
|
||||
### class ShadowRootElement()
|
||||
|
||||
元素内 shadow-root 元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- inner_ele: WebElement - selenium 获取到的 shadow-root 元素
|
||||
- parent_ele: DriverElement - shadow-root 所依附的元素
|
||||
|
||||
### tag
|
||||
|
||||
元素标签名。
|
||||
|
||||
返回：'shadow-root' 字符串。
|
||||
|
||||
### html
|
||||
|
||||
内部html文本。
|
||||
|
||||
返回：str
|
||||
|
||||
### parent
|
||||
|
||||
shadow-root 所依赖的父元素。
|
||||
|
||||
返回：DriverElement
|
||||
|
||||
### next
|
||||
|
||||
返回后一个兄弟元素。
|
||||
|
||||
返回：DriverElement
|
||||
|
||||
### parents()
|
||||
|
||||
返回上面第 num 级父元素
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 第几层父元素
|
||||
|
||||
返回：DriverElement
|
||||
|
||||
### nexts()
|
||||
|
||||
返回后面第 num 个兄弟元素
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 第几个兄弟元素
|
||||
|
||||
返回：DriverElement
|
||||
|
||||
### ele()
|
||||
|
||||
返回第一个符合条件的子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: Union[Tuple[str, str], str] - 元素定位条件
|
||||
- mode: str - 'single' 或 'all'，对应获取一个和全部
|
||||
- timeout: float - 超时时间
|
||||
|
||||
返回：DriverElement - 第一个符合条件的元素
|
||||
|
||||
### eles()
|
||||
|
||||
返回所有符合条件的子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: Union[Tuple[str, str], str] - 元素定位条件
|
||||
- timeout: float - 超时时间
|
||||
|
||||
返回：List[DriverElement] - 所有符合条件的元素组成的列表
|
||||
|
||||
### run_script()
|
||||
|
||||
对元素执行 js 代码。
|
||||
|
||||
参数说明：
|
||||
|
||||
- scrpit: str - js 代码
|
||||
- *args - 传入的对象
|
||||
|
||||
### is_enabled()
|
||||
|
||||
返回元素是否可用。
|
||||
|
||||
返回：bool
|
||||
|
||||
### is_valid()
|
||||
|
||||
返回元素是否仍在 dom 内。
|
||||
|
||||
返回：bool
|
||||
@ -1,129 +0,0 @@
|
||||
chrome 配置太复杂，所以把常用的配置写成简单的方法，调用会修改 ini 文件相关内容。
|
||||
|
||||
### get_match_driver()
|
||||
|
||||
自动识别 chrome 版本并下载匹配的driver。获取 ini 文件记录的 chrome.exe 路径，若没有则获取系统变量中的。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ini_path: str - 要读取和修改的 ini 文件路径
|
||||
- save_path: str - chromedriver 保存路径
|
||||
|
||||
返回： None
|
||||
|
||||
### show_settings()
|
||||
|
||||
打印 ini 文件中所有配置信息。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ini_path: str - ini 文件路径，为 None 则读取默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### set_paths()
|
||||
|
||||
便捷的设置路径方法，把传入的路径保存到 ini 文件，并检查 chrome 和 chromedriver 版本是否匹配。
|
||||
|
||||
参数说明：
|
||||
|
||||
- driver_path: str - chromedriver.exe 路径
|
||||
- chrome_path: str - chrome.exe 路径
|
||||
- debugger_address: str - 调试浏览器地址，例：127.0.0.1:9222
|
||||
- download_path: str - 下载文件路径
|
||||
- tmp_path: str - 临时文件夹路径
|
||||
- user_data_path: str - 用户数据路径
|
||||
- cache_path: str - 缓存路径
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
- check_version: bool - 是否检查 chromedriver 和 chrome 是否匹配
|
||||
|
||||
返回： None
|
||||
|
||||
### set_argument()
|
||||
|
||||
设置属性。若属性无值（如 'zh_CN.UTF-8' ），value 传入 bool 表示开关；否则把 value 赋值给属性，当 value 为 '' 或 False，删除该属性项。
|
||||
|
||||
参数说明：
|
||||
|
||||
- arg: str - 属性名
|
||||
- value: [bool, str] - 属性值，有值的属性传入值，没有的传入 bool
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### set_headless()
|
||||
|
||||
开启或关闭 headless 模式。
|
||||
|
||||
参数说明：
|
||||
|
||||
- on_off: bool - 是否开启 headless 模式
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### set_no_imgs()
|
||||
|
||||
开启或关闭图片显示。
|
||||
|
||||
参数说明：
|
||||
|
||||
- on_off: bool - 是否开启无图模式
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### set_no_js()
|
||||
|
||||
开启或关闭禁用 JS 模式。
|
||||
|
||||
参数说明：
|
||||
|
||||
- on_off: bool - 是否开启禁用 JS 模式
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### set_mute()
|
||||
|
||||
开启或关闭静音模式。
|
||||
|
||||
参数说明：
|
||||
|
||||
- on_off: bool - 是否开启静音模式
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### set_user_agent()
|
||||
|
||||
设置 user_agent。
|
||||
|
||||
参数说明：
|
||||
|
||||
- user_agent: str - user_agent 值
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### set_proxy()
|
||||
|
||||
设置代理。
|
||||
|
||||
参数说明：
|
||||
|
||||
- proxy: str - 代理值
|
||||
- ini_path: str - ini 文件路径，为 None 则保存到默认 ini 文件
|
||||
|
||||
返回： None
|
||||
|
||||
### check_driver_version()
|
||||
|
||||
检查 chrome 与 chromedriver 版本是否匹配。
|
||||
|
||||
参数说明：
|
||||
|
||||
- driver_path: bool - chromedriver.exe 路径
|
||||
- chrome_path: bool - chrome.exe 路径
|
||||
|
||||
返回： bool
|
||||
@ -1,26 +0,0 @@
|
||||
## 全局
|
||||
|
||||
- 切换模式时会自动复制 cookies 到目标模式，并在目标模式下重新访问当前网址，可在参数中禁止自动访问。
|
||||
- 访问网址时如遇到异常，会自动重试3次，也可在对象属性或连接参数里设置重试次数和间隔时间。d 模式这个功能要重载了 check_page() 方法才有效。
|
||||
- 获取到的文本会自动替换 & nbsp; 为空格。
|
||||
- 可以在元素下直接使用 > 以 css selector 方式获取当前元素直接子元素。如 ele1.ele('css:>div')。原生不支持这种写法。
|
||||
- 用 xpath 获取元素的子元素时，可省略前面的 .。如 ele1.ele('div') 和 ele1.ele('.//div'） 是一致的。
|
||||
- 保存空的配置对象时，如没有指定路径，会保存到默认 ini 文件。
|
||||
- download() 方法会自动创建 goal_path 参数的文件夹，因此可直接传入不存在的文件夹路径。
|
||||
- set_cookies()可以接收RequestsCookieJar, list, tuple, str, dict，只要格式对扔进去它会自动调整。其中 list 和 tuple 的内容可为 Cookie对象、dict、str。
|
||||
|
||||
## s 模式
|
||||
|
||||
- 在创建 MixPage 对象时传入的 Session 配置是全局有效的，一般无须每次连接传入。
|
||||
- ini 文件里设置了默认 s 模式的 headers，一般情况可直接使用，也可手动设置。
|
||||
- s 模式访问网页时会自动纠正编码，具体为先从 headers 获取，再从页面 meta 标签获取，都找不到就执行 r.apparent_encoding。因此无须手动设置。
|
||||
- 如果没有传入 referer 和 host 值，s 模式在连接时会自动根据当前域名自动填写 Host 和 Referer 属性。
|
||||
|
||||
## d 模式
|
||||
|
||||
- d 模式查找元素默认设置等待超时10秒，10秒内找到立即返回元素，超时返回 None。也可指定超时时间。
|
||||
- cilck() 方法用 selenium 点击失败时会用 js 方式重试，也可在参数里指定直接用 js 或不用 js 重试。
|
||||
- click() 方法可设置 timeout 参数，在时间内会不断重试点击目标，click(by_js=False) 可用于等待覆盖在元素上的遮罩层消失。
|
||||
- 可以用 xpath 直接获取元素属性或文本节点内容，如ele1.ele('xpath://div/@class')或ele1.ele('xpath://div/text()[2]')。原生不支持这种用法。
|
||||
- 在 MixPage 对象设置 timeout 后，该页面下所有元素的查找都会遵循该设置，该值默认为 10。也可以每次查找元素时单独设置，单独设置不影响页面对象的 timeout 属性。
|
||||
- 若设置了 debugger_address，创建 driver 时程序会自动检测该端口，如为空，则自动在该端口启动一个浏览器进程并接入。程序完毕该浏览器不自动关闭，以便后续使用。
|
||||
@ -1,42 +0,0 @@
|
||||
chrome 的配置很繁琐，为简化使用，本库提供了常用配置的设置方法。
|
||||
|
||||
# DriverOptions 对象
|
||||
|
||||
DriverOptions 对象继承自 selenium.webdriver.chrome.options 的 Options 对象，在其基础上增加了以下方法：
|
||||
|
||||
```python
|
||||
options.remove_argument(value) # 删除某 argument 值
|
||||
options.remove_experimental_option(key) # 删除某 experimental_option 设置
|
||||
options.remove_all_extensions() # 删除全部插件
|
||||
options.save() # 保存当前打开的 ini 文件
|
||||
options.save('D:\\settings.ini') # 保存到指定路径 ini 文件
|
||||
options.save('default') # 保存当前设置到默认 ini 文件
|
||||
options.set_argument(arg, value) # 设置 argument 属性
|
||||
options.set_headless(on_off) # 设置是否使用无界面模式
|
||||
options.set_no_imgs(on_off) # 设置是否加载图片
|
||||
options.set_no_js(on_off) # 设置是否禁用 js
|
||||
options.set_mute(on_off) # 设置是否静音
|
||||
options.set_user_agent(user_agent) # 设置 user agent
|
||||
options.set_proxy(proxy) # 设置代理地址
|
||||
options.set_paths(driver_path, chrome_path, debugger_address, download_path, user_data_path, cache_path) # 设置浏览器相关的路径
|
||||
```
|
||||
|
||||
# 使用方法
|
||||
|
||||
```python
|
||||
do = DriverOptions() # 读取默认 ini 文件创建 DriverOptions 对象
|
||||
do = DriverOptions('D:\\settings.ini') # 读取指定 ini 文件创建 DriverOptions 对象
|
||||
do = DriverOptions(read_file=False) # 不读取 ini 文件，创建空的 DriverOptions 对象
|
||||
|
||||
do.set_headless(False) # 显示浏览器界面
|
||||
do.set_no_imgs(True) # 不加载图片
|
||||
do.set_paths(driver_path='D:\\chromedriver.exe', chrome_path='D:\\chrome.exe') # 设置路径
|
||||
do.set_headless(False).set_no_imgs(True) # 支持链式操作
|
||||
|
||||
drission = Drission(driver_options=do) # 用配置对象创建 Drission 对象
|
||||
page = MixPage(driver_options=do) # 用配置对象创建 MixPage 对象
|
||||
|
||||
do.save() # 保存当前打开的 ini 文件
|
||||
do.save('D:\\settings.ini') # 保存到指定的 ini 文件
|
||||
do.save('default') # 保存当前设置到默认 ini 文件
|
||||
```
|
||||
@ -1,43 +0,0 @@
|
||||
> 创建驱动器的步骤不是必须，若想快速上手，可跳过本节。MixPage 会自动创建该对象。
|
||||
|
||||
Drission 对象用于管理 driver 和 session 对象。在多个页面协同工作时，Drission 对象用于传递驱动器，使多个页面类可控制同一个浏览器或 Session 对象。
|
||||
可直接读取 ini 文件配置信息创建，也可以在初始化时传入配置信息。
|
||||
|
||||
```python
|
||||
# 由默认 ini 文件创建
|
||||
drission = Drission()
|
||||
|
||||
# 由其它 ini 文件创建
|
||||
drission = Drission(ini_path='D:\\settings.ini')
|
||||
|
||||
# 不从 ini 文件创建
|
||||
drission = Drission(read_file=False)
|
||||
```
|
||||
|
||||
若要手动传入配置（不使用 ini 文件）：
|
||||
|
||||
```python
|
||||
from DrissionPage.config import DriverOptions
|
||||
|
||||
# 创建 driver 配置对象，read_file = False 表示不读取 ini 文件
|
||||
do = DriverOptions(read_file=False)
|
||||
|
||||
# 设置路径，若已在系统变量设置，可忽略
|
||||
do.set_paths(chrome_path='D:\\chrome\\chrome.exe',
|
||||
driver_path='D:\\chrome\\chromedriver.exe')
|
||||
|
||||
# 用于 s 模式的设置
|
||||
session_options = {'headers': {'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)'}}
|
||||
|
||||
# 代理设置，可选
|
||||
proxy = {'http': '127.0.0.1:1080', 'https': '127.0.0.1:1080'}
|
||||
|
||||
# 传入配置，driver_options 和 session_options 都是可选的，须要使用对应模式才须要传入
|
||||
drission = Drission(driver_options, session_options, proxy=proxy)
|
||||
|
||||
|
||||
# 关闭浏览器，debug 模式下须要显式调用这句，浏览器才能关掉
|
||||
drission.kill_browser()
|
||||
```
|
||||
|
||||
DriverOptions 和 SessionOptions 用法详见下文。
|
||||
@ -1,142 +0,0 @@
|
||||
### class DriverOptions()
|
||||
|
||||
chrome 浏览器配置类，继承自 selenium.webdriver.chrome.options 的 Options 类，增加了删除配置和保存到文件方法。
|
||||
|
||||
参数说明：
|
||||
|
||||
- read_file: bool - 创建时是否从 ini 文件读取配置信息
|
||||
- ini_path: str - ini 文件路径，为None则读取默认 ini 文件
|
||||
|
||||
### driver_path
|
||||
|
||||
chromedriver.exe 的路径。
|
||||
|
||||
返回： str
|
||||
|
||||
### chrome_path
|
||||
|
||||
chrome.exe 的路径
|
||||
|
||||
返回： str
|
||||
|
||||
### save()
|
||||
|
||||
保存设置到文件，返回自己，用于链式操作。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini 文件的路径，传入 'default' 保存到默认ini文件
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### remove_argument()
|
||||
|
||||
移除一个设置。
|
||||
|
||||
参数说明：
|
||||
|
||||
- value: str - 要移除的属性值
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### remove_experimental_option()
|
||||
|
||||
移除一个实验设置，传入 key 值删除。
|
||||
|
||||
参数说明：
|
||||
|
||||
- key: str - 要移除的实验设置 key 值
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### remove_all_extensions()
|
||||
|
||||
移除所有插件，因插件是以整个文件储存，难以移除其中一个，故如须设置则全部移除再重设。
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_argument()
|
||||
|
||||
设置 chrome 属性，无值的属性可设置开关，有值的属性可设置属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- arg: str - 属性名
|
||||
- value[bool, str] - 属性值，有值的属性传入值，没有的传入 bool
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_headless()
|
||||
|
||||
打开或关闭无界面模式。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_no_imgs()
|
||||
|
||||
是否加载图片。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_no_js()
|
||||
|
||||
是否禁用 js。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_mute()
|
||||
|
||||
是否静音。
|
||||
|
||||
参数说明：
|
||||
|
||||
on_off: bool - 打开或关闭
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_user_agent()
|
||||
|
||||
设置浏览器 user agent。
|
||||
|
||||
参数说明：
|
||||
|
||||
- user_agent: str - user agent 字符串
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_proxy()
|
||||
|
||||
设置代理。
|
||||
|
||||
参数说明：
|
||||
|
||||
- proxy: str - 代理地址
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
|
||||
### set_paths()
|
||||
|
||||
设置浏览器相关的路径。
|
||||
|
||||
参数说明：
|
||||
|
||||
- driver_path: str - chromedriver.exe 的路径
|
||||
- chrome_path: str - chrome.exe 的路径
|
||||
- debugger_address: str - 调试浏览器地址，例：127.0.0.1:9222
|
||||
- download_path: str - 下载文件路径
|
||||
- user_data_path: str - 用户数据路径
|
||||
- cache_path: str - 缓存路径
|
||||
|
||||
返回： DriverOptions - 返回自己
|
||||
@ -1,16 +0,0 @@
|
||||
如果无须切换模式，可根据需要只使用 DriverPage 或 SessionPage，用法和 MixPage 一致。
|
||||
|
||||
```python
|
||||
from DrissionPage.session_page import SessionPage
|
||||
from DrissionPage.drission import Drission
|
||||
|
||||
session = Drission().session
|
||||
page = SessionPage(session) # 传入 Session 对象
|
||||
page.get('http://www.baidu.com')
|
||||
print(page.ele('@id:su').text) # 输出：百度一下
|
||||
|
||||
driver = Drission().driver
|
||||
page = DriverPage(driver) # 传入 Driver 对象
|
||||
page.get('http://www.baidu.com')
|
||||
print(page.ele('@id:su').text) # 输出：百度一下
|
||||
```
|
||||
@ -1,188 +0,0 @@
|
||||
MixPage 页面对象封装了常用的网页操作，并实现 driver 和 session 模式之间的切换。
|
||||
MixPage 须控制一个 Drission 对象并使用其中的 driver 或 session，如没有传入，MixPage 会自己创建一个（使用传入的配置信息或从默认 ini 文件读取）。
|
||||
|
||||
Tips: 多对象协同工作时，可将一个 MixPage 中的 Drission 对象传递给另一个，使多个对象共享登录信息或操作同一个页面。
|
||||
|
||||
## 创建对象
|
||||
|
||||
创建对象方式有3种：简易、传入 Drission 对象、传入配置。可根据实际需要选择。
|
||||
参数说明：
|
||||
drission: Drission对象,如没传入则创建一个。
|
||||
mode: 'd' 或 's' 即driver模式和session模式,默认是d模式
|
||||
timeout: 超时时间。d模式时为寻找元素时间,s模式时为连接时间
|
||||
driver_options: 浏览器设置，没有传入drission参数时会用这个设置新建Drission对象
|
||||
session_options: requests设置，没有传入drission参数时会用这个设置新建Drission对象
|
||||
|
||||
```python
|
||||
# 简易创建方式，以 ini 文件默认配置自动创建 Drission 对象
|
||||
page = MixPage()
|
||||
page = MixPage('s')
|
||||
|
||||
# 以传入 Drission 对象创建
|
||||
page = MixPage(drission=drission)
|
||||
page = MixPage(mode='s', drission=drission, timeout=5) # session 模式，等待时间5秒（默认10秒）
|
||||
|
||||
# 传入配置信息，MixPage 根据配置在内部创建 Drission
|
||||
page = MixPage(driver_options=do, session_options=so) # 默认 d 模式
|
||||
```
|
||||
|
||||
## 访问网页
|
||||
|
||||
```python
|
||||
# 默认方式
|
||||
page.get(url)
|
||||
# 指定重试次数和间隔
|
||||
page.get(url, retry=5, interval=0.5) #若连接出错，程序会自动重试若干次，可指定重试次数和等待间隔
|
||||
|
||||
page.post(url, data, **kwargs) # 只有 session 模式才有 post 方法
|
||||
```
|
||||
|
||||
## 切换模式
|
||||
在 s 和 d 模式之间切换，切换时会自动同步 cookies 和正在访问的 url。
|
||||
|
||||
```python
|
||||
page.change_mode(mode,go)
|
||||
切换模式，'d' 或 's'。切换时会把当前模式的 cookies 复制到目标模式。
|
||||
参数说明：
|
||||
mode: str - 指定目标模式，'d' 或 's'。
|
||||
go: bool - 切换模式后是否跳转到当前 url
|
||||
返回： None
|
||||
```
|
||||
Tips：使用某种模式独有的方法时会自动跳转到该模式。
|
||||
|
||||
## 页面属性
|
||||
|
||||
```python
|
||||
page.url # 当前访问的 url
|
||||
page.mode # 当前模式
|
||||
page.drission # 当前使用的 Dirssion 对象
|
||||
page.driver # 当前使用的 WebDirver 对象
|
||||
page.session # 当前使用的 Session 对象
|
||||
page.cookies # 获取 cookies 信息
|
||||
page.html # 页面源代码
|
||||
page.json # 当返回内容是json格式时，返回对应的字典
|
||||
page.title # 当前页面标题
|
||||
|
||||
# d 模式独有：
|
||||
page.tabs_count # 返回标签页数量
|
||||
page.tab_handles # 返回所有标签页 handle 列表
|
||||
page.current_tab_num # 返回当前标签页序号
|
||||
page.current_tab_handle # 返回当前标签页 handle
|
||||
```
|
||||
|
||||
## 页面操作
|
||||
|
||||
调用只属于 d 模式的方法，会自动切换到 d 模式。
|
||||
|
||||
```python
|
||||
page.set_cookies() # 设置cookies
|
||||
page.get_cookies() # 获取 cookies，可以 list 或 dict 方式返回
|
||||
page.change_mode() # 切换模式，会自动复制 cookies
|
||||
page.cookies_to_session() # 从 WebDriver 对象复制 cookies 到 Session 对象
|
||||
page.cookies_to_driver() # 从 Session 对象复制 cookies 到 WebDriver 对象
|
||||
page.get(url, retry, interval, **kwargs) # 用 get 方式访问网页，可指定重试次数及间隔时间
|
||||
page.ele(loc_or_ele, timeout) # 返回页面中符合条件的元素，默认返回第一个。如查询参数是字符串，可选 '@属性名:'、'tag:'、'text:'、'css:'、'xpath:'、'.'、'#' 方式。无控制方式时默认用 text 方式查找。如是loc，直接按照内容查询。
|
||||
参数说明：
|
||||
loc_or_ele: [Tuple[str, str], str, DriverElement, SessionElement, WebElement] - 元素的定位信息，可以是元素对象，loc 元组，或查询字符串
|
||||
timeout: float - 查找元素超时时间，driver 模式下有效
|
||||
返回： [DriverElement, SessionElement, str] - 元素对象或属性、文本节点文本
|
||||
page.eles(loc_or_ele, timeout) # 获取所有符合条件的元素、节点或属性
|
||||
page.download(url, save_path, rename, file_exists, **kwargs) # 下载一个文件，返回是否成功和下载信息字符串。改方法会自动避免和目标路径现有文件重名。
|
||||
参数说明：
|
||||
url: str - 文件 url
|
||||
save_path: str - 存放路径，默认为 ini 文件中指定的临时文件夹
|
||||
rename: str - 重命名文件，不改变扩展名
|
||||
file_exists: str - 若存在同名文件，可选择 'rename', 'overwrite', 'skip' 方式处理
|
||||
**kwargs - 用于 requests 的连接参数
|
||||
返回： Tuple[bool, str] - 下载是否成功（bool）和状态信息（成功时信息为文件路径）的元组
|
||||
|
||||
以下方法和属性只有 driver 模式下生效，调用时会自动切换到 driver 模式
|
||||
page.close_driver() # 关闭 WebDriver 对象
|
||||
page.close_session() # 关闭 Session 对象
|
||||
|
||||
# s 模式独有：
|
||||
page.post(url, data, retry, interval, **kwargs) ##以 post 方式跳转，调用时自动切换到 session 模式。
|
||||
参数说明：
|
||||
url: str - 目标 url
|
||||
data: dict - 提交的数据
|
||||
go_anyway: bool - 是否强制跳转。若目标 url 和当前 url 一致，默认不跳转。
|
||||
show_errmsg: bool - 是否显示和抛出异常
|
||||
retry: int - 连接出错时重试次数
|
||||
interval: float - 重试间隔（秒）
|
||||
**kwargs - 用于 requests 的连接参数
|
||||
返回： [bool, None] - url 是否可用
|
||||
# d 模式独有：
|
||||
page.wait_ele(loc_or_ele, mode, timeout) # 等待元素从 dom 删除、显示、隐藏
|
||||
参数说明：
|
||||
loc_or_ele: [str, tuple, DriverElement, WebElement] - 元素查找方式，与ele()相同
|
||||
mode: str - 等待方式，可选：'del', 'display', 'hidden'
|
||||
timeout: float - 等待超时时间
|
||||
返回： bool - 等待是否成功
|
||||
page.run_script(js, *args) 执行JavaScript代码。
|
||||
参数说明：
|
||||
script: str - JavaScript 代码文本
|
||||
*args - 传入的参数
|
||||
返回： Any
|
||||
page.create_tab(url) # 新建并定位到一个标签页,该标签页在最后面。
|
||||
参数说明：
|
||||
url: str - 新标签页跳转到的网址
|
||||
返回： None
|
||||
page.to_tab(num_or_handle) # 跳转到标签页
|
||||
参数说明：
|
||||
num_or_handle:[int, str] - 标签页序号或handle字符串，序号第一个为0，最后为-1
|
||||
返回： None
|
||||
page.close_current_tab() # 关闭当前标签页
|
||||
page.close_other_tabs(num_or_handles) # 关闭传入的标签页以外标签页，默认保留当前页。可传入列表或元组。
|
||||
page.to_iframe(loc_or_ele) # 跳转到 iframe，默认跳转到最高层级，兼容 selenium 原生参数。
|
||||
参数说明:
|
||||
loc_or_ele: [int, str, tuple, WebElement, DriverElement] - 查找 iframe 元素的条件，可接收 iframe 序号（0开始）、id 或
|
||||
name、查询字符串、loc参数、WebElement对象、DriverElement 对象，传入 'main' 跳到最高层，传入 'parent' 跳到上一层
|
||||
示例:
|
||||
to_iframe('tag:iframe') - 通过传入 iframe 的查询字符串定位
|
||||
to_iframe('iframe_id') - 通过 iframe 的 id 属性定位
|
||||
to_iframe('iframe_name') - 通过 iframe 的 name 属性定位
|
||||
to_iframe(iframe_element) - 通过传入元素对象定位
|
||||
to_iframe(0) - 通过 iframe 的序号定位
|
||||
to_iframe('main') - 跳到最高层
|
||||
to_iframe('parent') - 跳到上一层
|
||||
返回: None
|
||||
page.screenshot(path,filename) # 网页截图，返回截图文件路径。
|
||||
参数说明：
|
||||
path: str - 截图保存路径，默认为 ini 文件中指定的临时文件夹
|
||||
filename: str - 截图文件名，默认为页面 title 为文件名
|
||||
返回： str
|
||||
page.scroll_to_see(loc_or_ele) # 滚动直到某元素可见
|
||||
参数说明：
|
||||
loc_or_ele: [str, tuple, WebElement, DriverElement] - 查找元素的条件，和 ele() 方法的查找条件一致。
|
||||
返回： None
|
||||
page.scroll_to(mode, pixel) # 按参数指示方式滚动页面，可选滚动方向：'top', 'bottom', 'rightmost', 'leftmost', 'up', 'down', 'left', 'right', 'half'
|
||||
page.refresh() # 刷新当前页面
|
||||
page.back() # 浏览器后退
|
||||
page.set_window_size(x, y) # 设置浏览器窗口大小，默认最大化
|
||||
page.check_page() # 检测页面是否符合预期
|
||||
page.chrome_downloading(download_path) # 获取 chrome 正在下载的文件列表
|
||||
参数说明：
|
||||
download_path: str - 下载文件夹路径
|
||||
返回：list
|
||||
page.process_alert(mode, text) # 处理提示框。
|
||||
参数说明：
|
||||
mode: str - 'ok' 或 'cancel'，若输入其它值，不会按按钮但依然返回文本值
|
||||
text: str - 处理 prompt 提示框时可输入文本
|
||||
返回： [str, None] - 提示框内容文本
|
||||
```
|
||||
|
||||
## cookies 的使用
|
||||
|
||||
MixPage 支持获取和设置 cookies，具体使用方法如下：
|
||||
|
||||
```python
|
||||
page.cookies # 以字典形式返回 cookies，只会返回当前域名可用的 cookies
|
||||
page.get_cookies(as_dict=False) # 以列表形式返回当前域名可用 cookies，每个 cookie 包含所有详细信息
|
||||
page.get_cookies(all_domains=True) # 以列表形式返回所有 cookies，只有 s 模式有效
|
||||
page.set_cookies(cookies) # 设置 cookies，可传入 RequestsCookieJar, list, tuple, str, dict
|
||||
```
|
||||
|
||||
Tips:
|
||||
|
||||
- d 模式设置 cookies 后要刷新页面才能看到效果。
|
||||
- s 模式可在 ini 文件、SessionOptions、配置字典中设置 cookies，在 MixPage 初始化时即可传入，d 模式只能用 set_cookies() 函数设置。
|
||||
@ -1,68 +0,0 @@
|
||||
### class OptionsManager()
|
||||
|
||||
管理配置文件内容的类。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini文件路径，不传入则默认读取当前文件夹下的 configs.ini 文件
|
||||
|
||||
### paths
|
||||
|
||||
返回 paths 设置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
### chrome_options
|
||||
|
||||
返回 chrome 设置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
### session_options
|
||||
|
||||
返回 session 设置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
### get_value()
|
||||
|
||||
获取配置的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- section: str - 段落名称
|
||||
- item: str - 配置项名称
|
||||
|
||||
返回： Any
|
||||
|
||||
### get_option()
|
||||
|
||||
以字典的格式返回整个段落的配置信息。
|
||||
|
||||
参数说明：
|
||||
|
||||
- section: str - 段落名称
|
||||
|
||||
返回： dict
|
||||
|
||||
### set_item()
|
||||
|
||||
设置配置值，返回自己，用于链式操作。
|
||||
|
||||
参数说明：
|
||||
|
||||
- section: str - 段落名称
|
||||
- item: str - 配置项名称
|
||||
- value: Any - 值内容
|
||||
|
||||
返回： OptionsManager - 返回自己
|
||||
|
||||
### save()
|
||||
|
||||
保存设置到文件，返回自己，用于链式操作。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini 文件的路径，传入 'default' 保存到默认ini文件
|
||||
|
||||
返回： OptionsManager - 返回自己
|
||||
@ -1,66 +0,0 @@
|
||||
MixPage 封装了常用的页面操作，可方便地用于扩展。
|
||||
|
||||
例：扩展一个列表页面读取类
|
||||
|
||||
```python
|
||||
import re
|
||||
from time import sleep
|
||||
from DrissionPage import *
|
||||
|
||||
class ListPage(MixPage):
|
||||
"""本类封装读取列表页面的方法，根据必须的4个元素，可读取同构的列表页面
|
||||
（中文变量真香）"""
|
||||
def __init__(self, drission: Drission, url: str = None, **xpaths):
|
||||
super().__init__(drission)
|
||||
self._url = url
|
||||
self.xpath_栏目名 = xpaths['栏目名'] # [xpath字符串, 正则表达式]
|
||||
self.xpath_下一页 = xpaths['下一页']
|
||||
self.xpath_行s = xpaths['行']
|
||||
self.xpath_页数 = xpaths['页数'] # [xpath字符串, 正则表达式]
|
||||
self.总页数 = self.get_总页数()
|
||||
if url:
|
||||
self.get(url)
|
||||
|
||||
def get_栏目名称(self) -> str:
|
||||
if self.xpath_栏目名[1]:
|
||||
s = self.ele(f'xpath:{self.xpath_栏目名[0]}').text
|
||||
r = re.search(self.xpath_栏目名[1], s)
|
||||
return r.group(1)
|
||||
else:
|
||||
return self.ele(f'xpath:{self.xpath_栏目名[0]}').text
|
||||
|
||||
def get_总页数(self) -> int:
|
||||
if self.xpath_页数[1]:
|
||||
s = self.ele(f'xpath:{self.xpath_页数[0]}').text
|
||||
r = re.search(self.xpath_页数[1], s)
|
||||
return int(r.group(1))
|
||||
else:
|
||||
return int(self.ele(f'xpath:{self.xpath_页数[0]}').text)
|
||||
|
||||
def click_下一页(self, wait: float = None):
|
||||
self.ele(f'xpath:{self.xpath_下一页}').click()
|
||||
if wait:
|
||||
sleep(wait)
|
||||
|
||||
def get_当前页列表(self, 待爬内容: list) -> list:
|
||||
"""
|
||||
待爬内容格式：[[xpath1,参数1],[xpath2,参数2]...]
|
||||
返回列表格式：[[参数1,参数2...],[参数1,参数2...]...]
|
||||
"""
|
||||
结果列表 = []
|
||||
行s = self.eles(f'xpath:{self.xpath_行s}')
|
||||
for 行 in 行s:
|
||||
行结果 = []
|
||||
for j in 待爬内容:
|
||||
行结果.append(行.ele(f'xpath:{j[0]}').attr(j[1]))
|
||||
结果列表.append(行结果)
|
||||
print(行结果)
|
||||
return 结果列表
|
||||
|
||||
def get_列表(self, 待爬内容: list, wait: float = None) -> list:
|
||||
列表 = self.get_当前页列表(待爬内容)
|
||||
for _ in range(self.总页数 - 1):
|
||||
self.click_下一页(wait)
|
||||
列表.extend(self.get_当前页列表(待爬内容))
|
||||
return 列表
|
||||
```
|
||||
@ -1,28 +0,0 @@
|
||||
# SessionOPtions 对象
|
||||
|
||||
SessionOptions 对象用于管理 Session 的配置信息。它创建时默认读取默认 ini 文件配置信息，也可手动设置所需信息。
|
||||
|
||||
可配置的属性：
|
||||
|
||||
headers、cookies、auth、proxies、hooks、params、verify、cert、adapters、stream、trust_env、max_redirects。
|
||||
|
||||
**Tips:** cookies 可接收 dict、list、tuple、str、RequestsCookieJar 等格式的信息。
|
||||
|
||||
# 使用方法
|
||||
|
||||
```python
|
||||
so = SessionOptions() # 读取默认 ini 文件创建 SessionOptions 对象
|
||||
so = SessionOptions('D:\\settings.ini') # 读取指定 ini 文件创建 SessionOptions 对象
|
||||
so = SessionOptions(read_file=False) # 不读取 ini 文件，创建空的 SessionOptions 对象
|
||||
|
||||
so.cookies = ['key1=val1; domain=xxxx', 'key2=val2; domain=xxxx'] # 设置 cookies
|
||||
so.headers = {'User-Agent': 'xxxx', 'Accept-Charset': 'xxxx'}
|
||||
so.set_a_header('Connection', 'keep-alive')
|
||||
|
||||
drission = Drission(session_options=so) # 用配置对象创建 Drission 对象
|
||||
page = MixPage(session_options=so) # 用配置对象创建 MixPage 对象
|
||||
|
||||
so.save() # 保存当前打开的 ini 文件
|
||||
so.save('D:\\settings.ini') # 保存到指定的 ini 文件
|
||||
so.save('default') # 保存当前设置到默认 ini 文件
|
||||
```
|
||||
@ -1,453 +0,0 @@
|
||||
## class DriverElement()
|
||||
|
||||
driver 模式的元素对象，包装了一个 WebElement 对象，并封装了常用功能。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele: WebElement - WebElement 对象
|
||||
- page: DriverPage - 元素所在的页面对象
|
||||
|
||||
## inner_ele
|
||||
|
||||
被包装的 WebElement 对象。
|
||||
|
||||
返回： WebElement
|
||||
|
||||
## html
|
||||
|
||||
返回元素 outerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## json
|
||||
|
||||
当返回内容是json格式时，返回对应的字典。
|
||||
|
||||
返回： dict
|
||||
|
||||
## inner_html
|
||||
|
||||
返回元素 innerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## tag
|
||||
|
||||
返回元素标签名。
|
||||
|
||||
返回： str
|
||||
|
||||
## attrs
|
||||
|
||||
以字典方式返回元素所有属性及值。
|
||||
|
||||
返回： dict
|
||||
|
||||
## text
|
||||
|
||||
返回元素内的文本，已格式化处理。
|
||||
|
||||
返回： str
|
||||
|
||||
## raw_text
|
||||
|
||||
返回元素内的文本，未格式化处理。
|
||||
|
||||
返回： str
|
||||
|
||||
## comments
|
||||
|
||||
返回元素内注释列表。
|
||||
|
||||
返回： list
|
||||
|
||||
## link
|
||||
|
||||
返回元素 href 或 src 绝对 url。
|
||||
|
||||
返回： str
|
||||
|
||||
## css_path
|
||||
|
||||
返回元素 css selector 绝对路径。
|
||||
|
||||
返回： str
|
||||
|
||||
## xpath
|
||||
|
||||
返回元素 xpath 绝对路径。
|
||||
|
||||
返回： str
|
||||
|
||||
## parent
|
||||
|
||||
返回父级元素对象。
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## next
|
||||
|
||||
返回下一个兄弟元素对象。
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## prev
|
||||
|
||||
返回上一个兄弟元素对象。
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## size
|
||||
|
||||
以字典方式返回元素大小。
|
||||
|
||||
返回： dict
|
||||
|
||||
## location
|
||||
|
||||
以字典方式放回元素坐标。
|
||||
|
||||
返回： dict
|
||||
|
||||
## shadow_root
|
||||
|
||||
返回当前元素的 shadow_root 元素对象
|
||||
|
||||
返回： ShadowRoot
|
||||
|
||||
## before
|
||||
|
||||
返回当前元素的 ::before 伪元素内容
|
||||
|
||||
返回： str
|
||||
|
||||
## after
|
||||
|
||||
返回当前元素的 ::after 伪元素内容
|
||||
|
||||
返回： str
|
||||
|
||||
## select
|
||||
|
||||
如果是 select 元素，返回 Select 对象，否则返回 None。
|
||||
|
||||
返回：Union[Select, None]
|
||||
|
||||
## wait__ele
|
||||
|
||||
等待子元素从dom删除、显示、隐藏。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_ele:Union[str, tuple, DrissionElement, WebElement] - 可以是元素、查询字符串、loc元组
|
||||
|
||||
- mode:str - 等待方式，可选：'del', 'display', 'hidden'
|
||||
|
||||
- timeout:float - 等待超时时间
|
||||
|
||||
返回： 等待是否成功
|
||||
|
||||
## texts()
|
||||
|
||||
返回元素内所有直接子节点的文本，包括元素和文本节点
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_node_only:bool - 是否只返回文本节点
|
||||
|
||||
返回： List[str]
|
||||
|
||||
## parents()
|
||||
|
||||
返回第 N 层父级元素对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 第几层父元素
|
||||
|
||||
返回： DriverElement
|
||||
|
||||
## nexts()
|
||||
|
||||
返回后面第 num 个兄弟元素或节点文本。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 后面第几个兄弟元素或节点
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [DriverElement, str]
|
||||
|
||||
## prevs()
|
||||
|
||||
返回前面第 num 个兄弟元素或节点文本。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num: int - 前面第几个兄弟元素或节点
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [DriverElement, str]
|
||||
|
||||
## attr()
|
||||
|
||||
获取元素某个属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 属性名称
|
||||
|
||||
返回： str
|
||||
|
||||
## prop()
|
||||
|
||||
获取元素某个property属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- prop: str - 属性名称
|
||||
|
||||
返回： str
|
||||
|
||||
## ele()
|
||||
|
||||
返回当前元素下级符合条件的子元素、属性或节点文本。
|
||||
如查询参数是字符串，可选 '@属性名:'、'tag:'、'text:'、'css:'、'xpath:'、'.'、'#' 方式。无控制方式时默认用 text 方式查找。
|
||||
如是loc，直接按照内容查询。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 元素的定位信息，可以是 loc 元组，或查询字符串
|
||||
- mode: str - 'single' 或 'all'，对应查找一个或全部
|
||||
- timeout: float - 查找元素超时时间
|
||||
|
||||
返回： [DriverElement, str]
|
||||
|
||||
## eles()
|
||||
|
||||
根据查询参数获取符合条件的元素列表。查询参数使用方法和 ele 方法一致。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
- timeout: float - 查找元素超时时间
|
||||
|
||||
返回： List[DriverElement or str]
|
||||
|
||||
## s_ele()
|
||||
|
||||
查找第一个符合条件的元素以SessionElement形式返回。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 元素的定位信息，可以是 loc 元组，或查询字符串
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## s_eles()
|
||||
|
||||
查找所有符合条件的元素以SessionElement列表形式返回。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
返回： List[SessionElement or str]
|
||||
|
||||
## style()
|
||||
|
||||
返回元素样式属性值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- style: str - 样式属性名称
|
||||
- pseudo_ele: str - 伪元素名称
|
||||
|
||||
返回： str
|
||||
|
||||
## click()
|
||||
|
||||
点击元素，如不成功则用 js 方式点击，可指定是否用 js 方式点击。
|
||||
|
||||
参数说明：
|
||||
|
||||
- by_js: bool - 是否用js方式点击
|
||||
|
||||
返回： bool
|
||||
|
||||
## click_at()
|
||||
|
||||
带偏移量点击本元素，相对于左上角坐标。不传入x或y值时点击元素中点。
|
||||
|
||||
参数说明：
|
||||
|
||||
- x: Union[int, str] - 相对元素左上角坐标的x轴偏移量
|
||||
- y: Union[int, str] - 相对元素左上角坐标的y轴偏移量
|
||||
- by_js: bool - 是否用js方式点击
|
||||
|
||||
返回： None
|
||||
|
||||
## r_click()
|
||||
|
||||
右键单击。
|
||||
|
||||
返回： None
|
||||
|
||||
## r_click_at()
|
||||
|
||||
带偏移量右键单击本元素，相对于左上角坐标。不传入x或y值时点击元素中点。
|
||||
|
||||
参数说明：
|
||||
|
||||
- x: Union[int, str] - 相对元素左上角坐标的x轴偏移量
|
||||
- y: Union[int, str] - 相对元素左上角坐标的y轴偏移量
|
||||
|
||||
返回： None
|
||||
|
||||
## input()
|
||||
|
||||
输入文本或组合键，返回是否成功输入。insure_input 为 False 时始终返回 True。
|
||||
|
||||
参数说明：
|
||||
|
||||
- vals: Union[str, tuple] - 文本值或按键组合
|
||||
- clear: bool - 输入前是否清除文本框
|
||||
- insure_input: bool - 是否自动检测并确保输入正确
|
||||
- timeout: folat - 尝试输入的超时时间，不指定则使用父页面的超时时间，只在insure_input为True时生效
|
||||
|
||||
返回： bool，是否成功输入。insure_input 为 False 时始终返回 True。
|
||||
|
||||
## run_script()
|
||||
|
||||
执行 js 代码，传入自己为第一个参数。
|
||||
|
||||
参数说明：
|
||||
|
||||
- script: str - JavaScript文本
|
||||
- *args - 传入的参数
|
||||
|
||||
返回： Any
|
||||
|
||||
## submit()
|
||||
|
||||
提交表单。
|
||||
|
||||
返回： None
|
||||
|
||||
## clear()
|
||||
|
||||
清空文本框。
|
||||
|
||||
参数说明：
|
||||
|
||||
- insure_clear: bool - 是否确保清空
|
||||
|
||||
返回： bool - 是否清空成功，不能清空的元素返回None
|
||||
|
||||
## is_selected()
|
||||
|
||||
元素是否被选中。
|
||||
|
||||
返回： bool
|
||||
|
||||
## is_enabled()
|
||||
|
||||
元素在页面中是否可用。
|
||||
|
||||
返回： bool
|
||||
|
||||
## is_displayed()
|
||||
|
||||
元素是否可见。
|
||||
|
||||
返回： bool
|
||||
|
||||
## is_valid()
|
||||
|
||||
元素是否还在 DOM 内。该方法用于判断页面跳转元素不能用的情况
|
||||
|
||||
返回： bool
|
||||
|
||||
## screenshot()
|
||||
|
||||
网页截图，返回截图文件路径。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - 截图保存路径，默认为 ini 文件中指定的临时文件夹
|
||||
- filename: str - 截图文件名，默认为页面 title 为文件名
|
||||
|
||||
返回： str
|
||||
|
||||
## select()
|
||||
|
||||
在下拉列表中选择。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text: str - 选项文本
|
||||
|
||||
返回： bool - 是否成功
|
||||
|
||||
## set_prop()
|
||||
|
||||
设置元素property属性。
|
||||
|
||||
参数说明：
|
||||
|
||||
- prop: str - 属性名
|
||||
- value: str - 属性值
|
||||
|
||||
返回： bool -是否成功
|
||||
|
||||
## set_attr()
|
||||
|
||||
设置元素attribute参数。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 参数名
|
||||
- value: str - 参数值
|
||||
|
||||
返回： bool -是否成功
|
||||
|
||||
## remove_attr()
|
||||
|
||||
删除元素属性。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 参数名
|
||||
|
||||
返回： bool -是否成功
|
||||
|
||||
## drag()
|
||||
|
||||
拖拽当前元素一段距离，返回是否拖拽成功。
|
||||
|
||||
参数说明：
|
||||
|
||||
- x: int - 拖拽x方向距离
|
||||
- y: int - 拖拽y方向距离
|
||||
- speed: int - 拖拽速度
|
||||
- shake: bool - 是否随机抖动
|
||||
|
||||
返回： bool
|
||||
|
||||
## drag_to()
|
||||
|
||||
拖拽当前元素，目标为另一个元素或坐标元组，返回是否拖拽成功。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele_or_loc[tuple, WebElement, DrissionElement] - 另一个元素或相对当前位置，坐标为元素中点坐标。
|
||||
- speed: int - 拖拽速度
|
||||
- shake: bool - 是否随机抖动
|
||||
|
||||
返回： bool
|
||||
|
||||
## hover()
|
||||
|
||||
在元素上悬停鼠标。
|
||||
|
||||
返回： None
|
||||
@ -1,35 +0,0 @@
|
||||
可快速地修改常用设置的方法。全部用于 driver 模式的设置。调用 easy_set 方法会修改默认 ini 文件相关内容。
|
||||
|
||||
```python
|
||||
get_match_driver() # 识别chrome版本并自动下载匹配的chromedriver.exe
|
||||
show_settings() # 打印所有设置
|
||||
set_headless(True) # 开启 headless 模式
|
||||
set_no_imgs(True) # 开启无图模式
|
||||
set_no_js(True) # 禁用 JS
|
||||
set_mute(True) # 开启静音模式
|
||||
set_user_agent('Mozilla/5.0 (Macintosh; Int......') # 设置 user agent
|
||||
set_proxy('127.0.0.1:8888') # 设置代理
|
||||
set_paths(paths) # 见 [初始化] 一节
|
||||
set_argument(arg, value) # 设置属性，若属性无值（如'zh_CN.UTF-8'），value 为 bool 表示开关；否则value为str，当 value为''或 False，删除该属性项
|
||||
check_driver_version() # 检查chrome和chromedriver版本是否匹配
|
||||
```
|
||||
举例场景：我在本地项目 要覆盖默认的configs.ini文件相关内容,具体写法流程。
|
||||
1:新建一个py文件
|
||||
2:导入easy_set
|
||||
from DrissionPage.easy_set import set_paths
|
||||
3:调set_path方法设置相关的参数值
|
||||
set_paths(
|
||||
driver_path=r"E:\flying-soft-package\chrome75\chrome75\chromedriver75.exe",
|
||||
chrome_path=r"E:\flying-soft-package\chrome75\chrome75\chrome.exe",
|
||||
user_data_path=r"E:\flying-soft-package\chrome75\chrome75\user_data",
|
||||
debugger_address='127.0.0.1:9222',
|
||||
check_version=True
|
||||
)
|
||||
参数含义:
|
||||
driver_path:chromedriver.exe路径
|
||||
chrome_path: chrome.exe路径
|
||||
user_data_path: 用户数据路径
|
||||
debugger_address: 调试浏览器地址，例：127.0.0.1:9222
|
||||
check_version: 是否检查chromedriver和chrome是否匹配(若不设置,默认是true)
|
||||
4:执行这个py文件 右击run。
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
# 连接参数
|
||||
|
||||
除了在创建时传入配置信息及连接参数，如有必要，s 模式下也可在每次访问网址时设置连接参数。
|
||||
|
||||
```python
|
||||
headers = {'User-Agent': '......', }
|
||||
cookies = {'name': 'value', }
|
||||
proxies = {'http': '127.0.0.1:1080', 'https': '127.0.0.1:1080'}
|
||||
page.get(url, headers=headers, cookies=cookies, proxies=proxies)
|
||||
```
|
||||
|
||||
Tips：
|
||||
|
||||
- 如果连接参数内没有指定，s 模式会根据当前域名自动填写 Host 和 Referer 属性
|
||||
- 在创建 MixPage 时传入的 Session 配置是全局有效的
|
||||
|
||||
# Response 对象
|
||||
|
||||
requests 获取到的 Response 对象存放在 page.response，可直接使用。如：
|
||||
|
||||
```python
|
||||
print(page.response.status_code)
|
||||
print(page.response.headers)
|
||||
```
|
||||
@ -1,78 +0,0 @@
|
||||
## class Select()
|
||||
|
||||
Select 类专门用于处理 d 模式下 select 标签。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele: select 元素对象
|
||||
|
||||
## is_multi
|
||||
|
||||
返回：是否多选列表
|
||||
|
||||
## options
|
||||
|
||||
返回：所有被选中的option元素列表
|
||||
|
||||
## selected_option
|
||||
|
||||
返回：第一个被选中的option元素
|
||||
|
||||
## selected_options
|
||||
|
||||
返回：所有被选中的option元素列表
|
||||
|
||||
## clear()
|
||||
|
||||
清除所有已选项。
|
||||
|
||||
## select()
|
||||
|
||||
选定或取消选定下拉列表中子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号择选项，若允许多选，传入list或tuple可多选
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
- deselect：是否取消选择
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## select_multi()
|
||||
|
||||
选定或取消选定下拉列表中多个子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号择选多项
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
- deselect：是否取消选择
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## deselect()
|
||||
|
||||
选定或取消选定下拉列表中子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号取消择选项，若允许多选，传入list或tuple可多选
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## deselect_multi()
|
||||
|
||||
选定或取消选定下拉列表中多个子元素。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_value_index：根据文本、值选或序号取消择选多项
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
## invert()
|
||||
|
||||
反选。
|
||||
|
||||
@ -1,196 +0,0 @@
|
||||
# class SessionElement()
|
||||
|
||||
session 模式的元素对象，包装了一个Element对象，并封装了常用功能。
|
||||
|
||||
参数说明：
|
||||
|
||||
- ele: HtmlElement - lxml 库的 HtmlElement 对象
|
||||
- page: SessionPage - 元素所在页面对象
|
||||
|
||||
## inner_ele
|
||||
|
||||
被包装的 HTMLElement 对象。
|
||||
|
||||
返回： HtmlElement
|
||||
|
||||
## page
|
||||
|
||||
元素所在页面对象，如果是从 html 文本生成的元素，则为 None。
|
||||
|
||||
返回：SessionElement 或 None
|
||||
|
||||
## tag
|
||||
|
||||
返回元素标签名。
|
||||
|
||||
返回： str
|
||||
|
||||
## html
|
||||
|
||||
返回元素 outerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## inner_html
|
||||
|
||||
返回元素 innerHTML 文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## attrs
|
||||
|
||||
以字典格式返回元素所有属性的名称和值。
|
||||
|
||||
返回： dict
|
||||
|
||||
## text
|
||||
|
||||
返回元素内文本，已格式化处理。
|
||||
|
||||
返回： str
|
||||
|
||||
## raw_text
|
||||
|
||||
返回元素内未格式化处理的原始文本。
|
||||
|
||||
返回： str
|
||||
|
||||
## comments
|
||||
|
||||
以 list 方式返回元素内所有注释文本。
|
||||
|
||||
返回： list
|
||||
|
||||
## link
|
||||
|
||||
返回元素 href 或 src 绝对 url。
|
||||
|
||||
返回： str
|
||||
|
||||
## css_path
|
||||
|
||||
返回元素 css selector 绝对路径。
|
||||
|
||||
返回： srt
|
||||
|
||||
## xpath
|
||||
|
||||
返回元素 xpath 绝对路径。
|
||||
|
||||
返回： srt
|
||||
|
||||
## parent
|
||||
|
||||
返回父级元素对象。
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## next
|
||||
|
||||
返回下一个兄弟元素对象。
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## prev
|
||||
|
||||
返回上一个兄弟元素对象。
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## parents()
|
||||
|
||||
返回第N层父级元素对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num:int - 第几层父元素
|
||||
|
||||
返回： SessionElement
|
||||
|
||||
## nexts()
|
||||
|
||||
返回后面第 num 个兄弟元素或节点文本。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num - 后面第几个兄弟元素
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## prevs()
|
||||
|
||||
返回前 N 个兄弟元素对象。
|
||||
|
||||
参数说明：
|
||||
|
||||
- num - 前面第几个兄弟元素
|
||||
- mode: str - 'ele', 'node' 或 'text'，匹配元素、节点、或文本节点
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## attr()
|
||||
|
||||
获取元素某个属性的值。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 属性名称
|
||||
|
||||
返回： str
|
||||
|
||||
## texts()
|
||||
|
||||
返回元素内所有直接子节点的文本，包括元素和文本节点。
|
||||
|
||||
参数说明：
|
||||
|
||||
- text_node_only: 是否只返回文本节点
|
||||
|
||||
返回： 文本组成的 list
|
||||
|
||||
## ele()
|
||||
|
||||
根据查询参数获取元素。
|
||||
如查询参数是字符串，可选 '@属性名:'、'tag:'、'text:'、'css:'、'xpath:'、'.'、'#' 方式。无控制方式时默认用 text 方式查找。
|
||||
如是loc，直接按照内容查询。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str:[Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
- timeout: float -不起实际作用，用于和父类对应
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## eles()
|
||||
|
||||
根据查询参数获取符合条件的元素列表。查询参数使用方法和ele方法一致。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
- timeout: float -不起实际作用，用于和父类对应
|
||||
|
||||
返回： List[SessionElement or str]
|
||||
|
||||
## s_ele()
|
||||
|
||||
功能与 ele() 一致，这里仅用于和 DriverElement 匹配。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str:[Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
返回： [SessionElement, str]
|
||||
|
||||
## s_eles()
|
||||
|
||||
功能与 eles() 一致，这里仅用于和 DriverElement 匹配。
|
||||
|
||||
参数说明：
|
||||
|
||||
- loc_or_str: [Tuple[str, str], str] - 查询条件参数
|
||||
|
||||
返回： List[SessionElement or str]
|
||||
@ -1,129 +0,0 @@
|
||||
# class SessionOptions()
|
||||
|
||||
Session 对象配置类。
|
||||
|
||||
参数说明：
|
||||
|
||||
- read_file: bool - 创建时是否从 ini 文件读取配置信息
|
||||
- ini_path: str - ini 文件路径，为None则读取默认 ini 文件
|
||||
|
||||
## headers
|
||||
|
||||
headers 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## cookies
|
||||
|
||||
cookies 配置信息。
|
||||
|
||||
返回： list
|
||||
|
||||
## auth
|
||||
|
||||
auth 配置信息。
|
||||
|
||||
返回： tuple
|
||||
|
||||
## proxies
|
||||
|
||||
proxies 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## hooks
|
||||
|
||||
hooks 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## params
|
||||
|
||||
params 配置信息。
|
||||
|
||||
返回： dict
|
||||
|
||||
## verify
|
||||
|
||||
verify 配置信息。
|
||||
|
||||
返回： bool
|
||||
|
||||
## cert
|
||||
|
||||
cert 配置信息。
|
||||
|
||||
返回： [str, tuple]
|
||||
|
||||
## adapters
|
||||
|
||||
adapters 配置信息。
|
||||
|
||||
返回： adapters
|
||||
|
||||
## stream
|
||||
|
||||
stream 配置信息。
|
||||
|
||||
返回： bool
|
||||
|
||||
## trust_env
|
||||
|
||||
srust_env 配置信息。
|
||||
|
||||
返回： bool
|
||||
|
||||
## max_redirects
|
||||
|
||||
max_redirect 配置信息。
|
||||
|
||||
返回： int
|
||||
|
||||
## set_a_header()
|
||||
|
||||
设置 headers 中一个项。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 配置项名称
|
||||
- value: str - 配置的值
|
||||
|
||||
返回： 当前对象
|
||||
|
||||
## remove_a_header()
|
||||
|
||||
从 headers 中删除一个设置。
|
||||
|
||||
参数说明：
|
||||
|
||||
- attr: str - 要删除的配置名称
|
||||
|
||||
返回：当前对象
|
||||
|
||||
## set_proxies()
|
||||
|
||||
设置proxies参数
|
||||
|
||||
{'http': 'http://xx.xx.xx.xx:xxxx', 'https': 'http://xx.xx.xx.xx:xxxx'}
|
||||
|
||||
参数说明：
|
||||
|
||||
- proxies: dict - 代理信息字典
|
||||
|
||||
返回：当前对象
|
||||
|
||||
## save()
|
||||
|
||||
保存设置到文件。
|
||||
|
||||
参数说明：
|
||||
|
||||
- path: str - ini文件的路径，传入 'default' 保存到默认ini文件
|
||||
|
||||
返回：当前对象
|
||||
|
||||
## as_dict()
|
||||
|
||||
以字典形式返回当前对象。
|
||||
|
||||
返回： dict
|
||||
@ -1,31 +0,0 @@
|
||||
d 模式独有，支持获取 shadow-root 及内部元素，获取到的 shadow-root 元素类型为 ShadowRootElement，用法和正常元素类似，但功能有所简化。
|
||||
|
||||
**注意：**
|
||||
|
||||
- 只能获取 open 的 shadow-root
|
||||
- 查找 shadow-root 内部元素不能使用 xpath 方式
|
||||
|
||||
获取依附在普通元素内的 shadow-root 元素
|
||||
|
||||
```python
|
||||
shadow_root_element = element.shadow_root # element 为含有 shadow-root 的普通元素
|
||||
```
|
||||
|
||||
属性及方法
|
||||
|
||||
```python
|
||||
shadow_root_element.tag # 返回 'shadow-root'
|
||||
shadow_root_element.html # html 内容
|
||||
shadow_root_element.parent # 父元素
|
||||
shadow_root_element.next # 下一个兄弟元素
|
||||
|
||||
shadow_root_element.parents(num) # 获取向上 num 级父元素
|
||||
shadow_root_element.nexts(num) # 获取向后 num 个兄弟元素
|
||||
shadow_root_element.ele(loc_or_str) # 获取第一个符合条件的内部元素
|
||||
shadow_root_element.eles(loc_or_str) # 获取全部符合条件的内部元素
|
||||
shadow_root_element.run_scrpit(js_text) # 运行 js 脚本
|
||||
shadow_root_element.is_enabled() # 返回元素是否可用
|
||||
shadow_root_element.is_valid() # 返回元素是否还在 dom 内
|
||||
```
|
||||
|
||||
**Tips:** 以上属性或方法获取到的元素是普通的 DriverElement，用法参考上文所述。
|
||||
@ -1,23 +0,0 @@
|
||||
selenium 缺乏对浏览器下载文件的有效管理，难以进行检测下载状态、重命名、失败管理。
|
||||
使用 requests 下载文件能较好实现以上功能，但代码较为繁琐。
|
||||
因此 DrissionPage 封装了 download 方法，整合了两者优点，可从 selenium 获取登录信息，用 requests 进行下载。
|
||||
弥补了 selenium 的不足，使下载简洁高效。
|
||||
|
||||
## 功能
|
||||
|
||||
- 指定下载路径
|
||||
- 重命名文件，可不填写扩展名，程序自动补充
|
||||
- 存在同名文件时，可选择重命名、覆盖、跳过等处理方式
|
||||
- 显示下载进度
|
||||
- 支持 post 方式
|
||||
- 支持自定义连接参数
|
||||
|
||||
## 演示
|
||||
|
||||
```python
|
||||
url = 'https://www.baidu.com/img/flexible/logo/pc/result.png' # 文件 url
|
||||
save_path = r'C:\download' # 存放路径
|
||||
|
||||
# 重命名为img.png，存在重名时自动在文件名末尾加上序号，显示下载进度
|
||||
page.download(url, save_path, 'img', 'rename', show_msg=True)
|
||||
```
|
||||
@ -1,12 +0,0 @@
|
||||
目前设置功能只支持 Chrome 浏览器，如要使用其它浏览器，可使用 selenium 原生方法创建 driver，然后用 Drission 对象接收即可。 注意：本库所有功能暂时只对 Chrome 做了完整测试。
|
||||
|
||||
```python
|
||||
from selenium import webdriver
|
||||
from DrissionPage import Drission, MixPage
|
||||
|
||||
driver = webdriver.Firefox()
|
||||
drission = Drission(driver_or_options=driver)
|
||||
|
||||
page = MixPage(drission)
|
||||
page.get('https://www.baidu.com')
|
||||
```
|
||||
@ -1,89 +0,0 @@
|
||||
因 chrome 和 headers 配置繁多，故设置一个 ini 文件专门用于保存常用配置，你可使用 OptionsManager 对象获取和保存配置，用 DriverOptions 对象修改 chrome 配置。你也可以保存多个 ini
|
||||
文件，按不同项目须要调用。
|
||||
|
||||
Tips：建议把常用配置文件保存到别的路径，以防本库升级时配置被重置。
|
||||
|
||||
# ini 文件内容
|
||||
|
||||
ini 文件默认拥有三部分配置：paths、chrome_options、session_options，初始内容如下。
|
||||
|
||||
```ini
|
||||
[paths]
|
||||
; chromedriver.exe路径
|
||||
chromedriver_path =
|
||||
; 临时文件夹路径，用于保存截图、文件下载等
|
||||
tmp_path =
|
||||
|
||||
[chrome_options]
|
||||
; 已打开的浏览器地址和端口，如127.0.0.1:9222
|
||||
debugger_address =
|
||||
; chrome.exe路径
|
||||
binary_location =
|
||||
; 配置信息
|
||||
arguments = [
|
||||
; 静音
|
||||
'--mute-audio',
|
||||
; 不使用沙盒
|
||||
'--no-sandbox',
|
||||
; 谷歌文档提到需要加上这个属性来规避bug
|
||||
'--disable-gpu',
|
||||
; 忽略警告
|
||||
'ignore-certificate-errors',
|
||||
; 不显示信息栏
|
||||
'--disable-infobars'
|
||||
]
|
||||
; 插件
|
||||
extensions = []
|
||||
; 实验性配置
|
||||
experimental_options = {
|
||||
'prefs': {
|
||||
; 下载不弹出窗口
|
||||
'profile.default_content_settings.popups': 0,
|
||||
; 无弹窗
|
||||
'profile.default_content_setting_values': {'notifications': 2},
|
||||
; 禁用PDF插件
|
||||
'plugins.plugins_list': [{"enabled": False, "name": "Chrome PDF Viewer"}]
|
||||
},
|
||||
; 设置为开发者模式，防反爬虫
|
||||
'excludeSwitches': ["enable-automation"],
|
||||
'useAutomationExtension': False
|
||||
}
|
||||
|
||||
[session_options]
|
||||
headers = {
|
||||
"User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/603.3.8 (KHTML, like Gecko) Version/10.1.2 Safari/603.3.8",
|
||||
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
|
||||
"Connection": "keep-alive",
|
||||
"Accept-Charset": "utf-8;q=0.7,*;q=0.7"
|
||||
}
|
||||
```
|
||||
|
||||
# OptionsManager 对象
|
||||
|
||||
OptionsManager 对象用于读取、设置和保存配置。
|
||||
|
||||
```python
|
||||
manager.paths # 以字典形式返回路径设置
|
||||
manager.chrome_options # 以字典形式返回chrome设置
|
||||
manager.session_options # 以字典形式返回session设置
|
||||
manager.get_value(section, item) # 获取某个配置的值
|
||||
manager.get_option(section) # 以字典格式返回配置全部属性
|
||||
manager.set_item(section, item, value) # 设置配置属性
|
||||
manager.manager.save() # 保存当前打开的 ini 文件
|
||||
manager.save('D:\\settings.ini') # 保存到指定路径 ini 文件
|
||||
manager.save('default') # 保存当前设置到默认 ini 文件
|
||||
```
|
||||
|
||||
# 使用示例
|
||||
|
||||
```python
|
||||
from DrissionPage.configs import *
|
||||
|
||||
options_manager = OptionsManager() # 从默认ini文件创建OptionsManager对象
|
||||
options_manager = OptionsManager('D:\\settings.ini') # 从其它ini文件创建OptionsManager对象
|
||||
driver_path = options_manager.get_value('paths', 'chromedriver_path') # 读取路径信息
|
||||
options_manager.save() # 保存当前打开的 ini 文件
|
||||
options_manager.save('D:\\settings.ini') # 保存到指定路径 ini 文件
|
||||
|
||||
drission = Drission(ini_path='D:\\settings.ini') # 使用指定 ini 文件创建对象
|
||||
```
|
||||
@ -1,21 +0,0 @@
|
||||
# 施工中。。。
|
||||
|
||||
# 创建页面对象
|
||||
|
||||
DrissionPage 库的页面对象有三种，分别是 DriverPage、SessionPage 和 MixPage。
|
||||
DriverPage 专门用于控制浏览器，类似于 selenium 的 WebDriver 对象。对应于 d 模式。
|
||||
SeesionPage 专门用于处理用数据包方式获取的页面，类似于 requests 的 Response 对象。对应于 s 模式。
|
||||
MixPage 整合了上面两者，实现了两种模式间的状态共享，可在两种模式间任意切换。是功能最强且最常用的页面类，这里只对 MixPage 进行介绍。
|
||||
|
||||
## 简易方式
|
||||
|
||||
简易方式代码最简洁，它从 ini 文件中读取配置，自动生成页面对象。
|
||||
|
||||
```python
|
||||
# 默认以 d 模式创建页面对象
|
||||
page = MixPage()
|
||||
|
||||
# 指定以 s 模式创建页面对象
|
||||
|
||||
```
|
||||
|
||||
@ -1,96 +0,0 @@
|
||||
> 如果你只使用 s 模式（即requests），可跳过本节。
|
||||
|
||||
使用 selenium 前，必须配置 chrome.exe 和 chromedriver.exe 的路径，并确保它们版本匹配。
|
||||
|
||||
配置路径有四种方法：
|
||||
|
||||
- 使用 easy_set 工具的 get_match_driver() 方法（推荐）
|
||||
- 将路径写入本库的 ini 文件
|
||||
- 将两个路径写入系统变量
|
||||
- 在代码中填写路径
|
||||
|
||||
## 使用 get_match_driver() 方法
|
||||
|
||||
若你选择第一种方式，请在第一次使用前，运行以下代码，程序会自动检测电脑安装的 chrome 版本，下载对应 driver，并记录到 ini 文件。
|
||||
|
||||
```python
|
||||
from DrissionPage.easy_set import get_match_driver
|
||||
get_match_driver()
|
||||
```
|
||||
|
||||
输出：
|
||||
|
||||
```
|
||||
ini文件中chrome.exe路径 D:\Google Chrome\Chrome\chrome.exe
|
||||
|
||||
version 75.0.3770.100
|
||||
|
||||
chromedriver_win32.zip
|
||||
Downloading to: D:\python\projects\DrissionPage\DrissionPage
|
||||
100% Success.
|
||||
|
||||
解压路径 D:\python\projects\chromedriver.exe
|
||||
|
||||
正在检测可用性...
|
||||
版本匹配，可正常使用。
|
||||
```
|
||||
|
||||
然后就可以开始使用了。
|
||||
|
||||
若你想使用指定的 chrome.exe（绿色版），及指定 ini 文件和 chromedriver.exe 的保存路径，可以这样写：
|
||||
|
||||
```python
|
||||
get_match_driver(ini_path='ini文件路径', save_path='保存路径', chrome_path='chrome路径')
|
||||
```
|
||||
|
||||
Tips：当指定 chrome_path 时，检测成功后程序会把这个路径写进 ini 文件。
|
||||
|
||||
## 使用 set_paths() 方法
|
||||
|
||||
若上一种方法失败，可自行下载 chromedriver.exe，然后运行以下代码，把路径记录到 ini 文件中。
|
||||
|
||||
```python
|
||||
from DrissionPage.easy_set import set_paths
|
||||
driver_path = 'D:\\chrome\\chromedriver.exe' # 你的 chromedriver.exe 路径，若不填写会在系统变量中查找
|
||||
chrome_path = 'D:\\chrome\\chrome.exe' # 你的 chrome.exe 路径，若不填写会在系统变量中查找
|
||||
set_paths(driver_path, chrome_path)
|
||||
```
|
||||
|
||||
该方法还会检查 chrome 和 chromedriver 版本是否匹配，显示：
|
||||
|
||||
```
|
||||
正在检测可用性...
|
||||
版本匹配，可正常使用。
|
||||
```
|
||||
|
||||
或
|
||||
|
||||
```
|
||||
出现异常：
|
||||
Message: session not created: Chrome version must be between 70 and 73
|
||||
(Driver info: chromedriver=73.0.3683.68 (47787ec04b6e38e22703e856e101e840b65afe72),platform=Windows NT 10.0.19631 x86_64)
|
||||
可执行easy_set.get_match_driver()自动下载匹配的版本。
|
||||
或自行从以下网址下载：https://chromedriver.chromium.org/downloads
|
||||
```
|
||||
|
||||
检查通过后，即可正常使用 driver 模式。
|
||||
|
||||
除了上述两个路径，该方法还可以设置以下路径：
|
||||
|
||||
```python
|
||||
debugger_address # 调试浏览器地址，如：127.0.0.1:9222
|
||||
download_path # 下载文件路径
|
||||
tmp_path # 临时文件夹路径
|
||||
user_data_path # 用户数据路径
|
||||
cache_path # 缓存路径
|
||||
```
|
||||
|
||||
Tips：
|
||||
|
||||
- 不同项目可能须要不同版本的 chrome 和 chromedriver，你还可保存多个 ini 文件，按须使用。
|
||||
- 推荐使用绿色版 chrome，并手动设置路径，避免浏览器升级造成与 chromedriver 版本不匹配。
|
||||
- 调试项目时推荐设置 debugger_address，使用手动打开的浏览器，再用程序接管，好处多多。
|
||||
|
||||
## 其它方法
|
||||
|
||||
若你不想使用 ini 文件（如要打包项目时），可在系统路径写入以上两个路径，或在程序中填写。后者的使用方法见下一节。
|
||||
@ -1,15 +0,0 @@
|
||||
# 安装
|
||||
|
||||
```
|
||||
pip install DrissionPage
|
||||
```
|
||||
|
||||
只支持 python3.6 及以上版本，目前只在 Windows 环境下作了测试，支持所有selenium支持的浏览器，但对chrome支持最全面。
|
||||
若要使用 driver 模式，须配置 chrome 和 **对应版本** 的 chromedriver。[[chromedriver下载]](http://npm.taobao.org/mirrors/chromedriver)
|
||||
easy_set 工具中的 get_match_driver() 方法可自动识别 chrome 版本并下载匹配的 driver 。
|
||||
|
||||
# 导入模块
|
||||
|
||||
```python
|
||||
from DrissionPage import MixPage
|
||||
```
|
||||
@ -1,42 +0,0 @@
|
||||
DrissionPage 代码可与 selenium 及 requests 代码无缝拼接。既可直接使用 selenium 的 WebDriver 对象，也可导出自身的 WebDriver 给 selenium 代码使用。requests 的
|
||||
Session 对象也可直接传递。使已有项目的迁移非常方便。
|
||||
|
||||
# selenium 转 DrissionPage
|
||||
|
||||
```python
|
||||
driver = webdriver.Chrome()
|
||||
driver.get('https://www.baidu.com')
|
||||
|
||||
page = MixPage(Drission(driver)) # 把 driver 传递给 Drission，创建 MixPage 对象
|
||||
print(page.title) # 打印结果：百度一下，你就知道
|
||||
```
|
||||
|
||||
# DrissionPage 转 selenium
|
||||
|
||||
```python
|
||||
page = MixPage()
|
||||
page.get('https://www.baidu.com')
|
||||
|
||||
driver = page.driver # 从 MixPage 对象中获取 WebDriver 对象
|
||||
print(driver.title) # 打印结果：百度一下，你就知道
|
||||
element = driver.find_element_by_xpath('//div') # 使用 selenium 原生功能
|
||||
```
|
||||
|
||||
# requests 转 DrissionPage
|
||||
|
||||
``` python
|
||||
session = requets.Session()
|
||||
drission = Drission(session_or_options=session)
|
||||
page = MixPage(drission, mode='s')
|
||||
|
||||
page.get('https://www.baidu.com')
|
||||
```
|
||||
|
||||
# DrissionPage 转 requests
|
||||
|
||||
```python
|
||||
page = MixPage('s')
|
||||
session = page.session
|
||||
|
||||
response = session.get('https://www.baidu.com')
|
||||
```
|
||||
@ -1,29 +0,0 @@
|
||||
程序如直接打包为exe文件，运行会遇到报错。这是可能因为程序在默认路径找不到ini文件引起的。解决的方法有两种：
|
||||
|
||||
1. **把ini文件放到打包的程序文件夹**
|
||||
这样程序运行时会根据相对路径查找ini文件，避免找不到默认文件的问题
|
||||
|
||||
```python
|
||||
from DrissionPage import Drission, MixPage
|
||||
|
||||
drission = Drission(ini_path=r'.\configs.ini') # ini文件放在程序相同路径下
|
||||
page = MixPage(drission=drission)
|
||||
```
|
||||
|
||||
2. **把配置写到程序中，不使用ini文件**
|
||||
|
||||
```python
|
||||
from DrissionPage.config import DriverOptions, SessionOptions
|
||||
from DrissionPage import Drission, MixPage
|
||||
|
||||
do = DriverOptions(read_file=False)
|
||||
so = SessionOptions(read_file=False)
|
||||
drission = Drission(driver_or_options=do, session_or_options=so)
|
||||
page = MixPage(drission=drission)
|
||||
```
|
||||
|
||||
**注意** ，这个时候Drission的两个参数都要输入内容，如果其中一个不需要设置可以输入False，如：
|
||||
|
||||
```python
|
||||
drission = Drission(driver_or_options=do, session_or_options=False)
|
||||
```
|
||||
@ -1,475 +0,0 @@
|
||||
# 操作页面元素
|
||||
|
||||
d 模式下的 DriverElement 对象可以对浏览器相应元素进行控制。
|
||||
|
||||
# 一览表
|
||||
|
||||
以下为元素操作方法一览表，然后再详细介绍每个方法。
|
||||
|
||||
```python
|
||||
# 点击元素
|
||||
click()
|
||||
|
||||
# 带偏移量的点击元素
|
||||
click_at(x, y)
|
||||
|
||||
# 右键单击元素
|
||||
r_click()
|
||||
|
||||
# 带偏移量的右键单击元素
|
||||
r_click_at(x, y)
|
||||
|
||||
# 输入内容到元素
|
||||
input('...')
|
||||
|
||||
# 对元素执行 js 脚本
|
||||
run_script('...')
|
||||
|
||||
# 清空元素
|
||||
clear()
|
||||
|
||||
# 对元素截图
|
||||
screenshot()
|
||||
|
||||
# 设置元素某个 property 属性值
|
||||
set_prop('prop', 'value')
|
||||
|
||||
# 设置元素某个 attribute 属性值
|
||||
set_attr('attr', 'value')
|
||||
|
||||
# 删除元素某个 attribute 属性
|
||||
remove_attr('attr')
|
||||
|
||||
# 提交表单
|
||||
submit()
|
||||
|
||||
# 按偏移量拖拽元素
|
||||
drag(x, y)
|
||||
|
||||
# 拖拽元素到某个元素或坐标
|
||||
drag_to(other_ele_or_location)
|
||||
|
||||
# 在元素上悬停鼠标，可带偏移量
|
||||
hover(x, y)
|
||||
|
||||
# 执行下来列表操作，详见下面 Select 类部分
|
||||
select
|
||||
```
|
||||
|
||||
# 元素操作方法
|
||||
|
||||
## click()
|
||||
|
||||
此方法用于点击元素。可以选择是否用 js 方式点击，可以在点击失败时自动重试。默认情况下，使用 selenium 原生的点击方法，如果重试超过限定时间，自动改用 js 方式点击。可通过 by_js 参数设置点击方式。
|
||||
此设计除了可保证点击成功，还可以用于检测页面上的遮罩层是否消失。遮罩层经常出现在 js 方式翻页的时候，它出现的时候会阻碍 selenium
|
||||
的原生点击，所以可以通过对其下面的元素不断重试点击，来判断遮罩层是否存在。当然，这个方法是否可行要看具体网页设计。
|
||||
而如果直接使用 js 进行点击，则可无视任何遮挡，只要元素在 DOM 内，就能点击得到，这样可以根据须要灵活地对元素进行操作。
|
||||
|
||||
注意：使用 js 方式点击时，是不会进行重试的。
|
||||
|
||||
参数：
|
||||
|
||||
- by_js：是否用 js 方式点击，为 None 时先用 selenium 原生方法点击，重试失败超时后改为 用 js 点击；为 True 时直接用 js 点击；为 False 时即使重试超时也不会改用 js。
|
||||
- timeout：点击失败重试超时时间，为 None 时使用父页面 timeout 设置。
|
||||
|
||||
返回：bool，表示是否点击成功。
|
||||
|
||||
```python
|
||||
# 点击一个元素，重试超时根据所在页面元素而定，都失败就改用 js 点击
|
||||
ele.click()
|
||||
|
||||
# 点击一个元素，重试 5 秒，都失败也不改用 js 点击
|
||||
ele.click(by_js=False, timeout=5)
|
||||
|
||||
# 假设遮罩层出现，ele 是遮罩层下方的元素
|
||||
ele.click(timeout = 10) # 不断重试点击，直到遮罩层消失，或到达 10 秒
|
||||
ele.click(by_js=True) # 无视遮罩层，直接用 js 点击下方元素
|
||||
```
|
||||
|
||||
|
||||
|
||||
## click_at()
|
||||
|
||||
此方法用于带偏移量点击元素，偏移量相对于元素左上角坐标。不传入x或y值时点击元素中点。可选择是否用 js 方式点击，但不会进行重试。
|
||||
可用于点击一些奇怪的东西，比如用 before 表示的控件。
|
||||
点击的目标不一定在元素上，可以传入负值，或大于元素大小的值，点击元素附近的区域。向右和向下为正值，向左和向上为负值。
|
||||
|
||||
参数：
|
||||
|
||||
- x：相对元素左上角坐标的x轴偏移量
|
||||
- y：相对元素左上角坐标的y轴偏移量
|
||||
- by_js：是否用js点击
|
||||
|
||||
返回：None
|
||||
|
||||
```python
|
||||
# 点击元素右上方 50*50 的位置
|
||||
ele.click_at(50, -50)
|
||||
|
||||
# 点击元素上中部，x 相对左上角向右偏移50，y 保持在元素中点
|
||||
ele.click_at(x=50)
|
||||
|
||||
# 点击元素中点，和 click() 相似，但没有重试功能
|
||||
ele.click_at()
|
||||
```
|
||||
|
||||
## r_click()
|
||||
|
||||
此方法实现右键单击元素。
|
||||
|
||||
无参数。
|
||||
|
||||
返回：None
|
||||
|
||||
```python
|
||||
ele.r_click()
|
||||
```
|
||||
|
||||
## r_click_at()
|
||||
|
||||
此方法用于带偏移量右键点击元素，用法和 click_at() 相似，但没有 by_js 参数。
|
||||
|
||||
参数：
|
||||
|
||||
- x：相对元素左上角坐标的x轴偏移量
|
||||
- y：相对元素左上角坐标的y轴偏移量
|
||||
|
||||
返回：None
|
||||
|
||||
```python
|
||||
# 点击距离元素左上角 50*50 的位置（位于元素内部）
|
||||
ele.r_click_at(50, 50)
|
||||
```
|
||||
|
||||
## input()
|
||||
|
||||
此方法用于向元素输入文本或组合键，也可用于输入文件路径到input元素（文件间用\n间隔）。可选择输入前是否清空元素。
|
||||
insure_input 参数为 True 时可自动确保输入正确。该功能是为了应对 selenium 原生输入在某些i情况下会失效的问题。
|
||||
接收组合键的时候可接收 selenium 的 Keys 对象的值。组合键要放在一个 tuple 中传入。
|
||||
注意：insure_input 为 True 时不能用于接收组合键。
|
||||
**Tips:** 有些文本框可以接收回车代替点击按钮，可以直接在文本末尾加上 '\n'。
|
||||
|
||||
参数：
|
||||
|
||||
- vals：文本值或按键组合
|
||||
- clear：输入前是否清空文本框
|
||||
- insure_input：是否确保输入正确，不能用于输入组合键
|
||||
- timeout：尝试输入的超时时间，不指定则使用父页面的超时时间，只在 insure_input 参数为 True 时生效
|
||||
|
||||
返回：bool，表示是否成功输入。insure_input 为 False 时始终返回 True。
|
||||
|
||||
```python
|
||||
# 输入文本
|
||||
ele.input('Hello world!')
|
||||
|
||||
# 输入文本并回车
|
||||
ele.input('Hello world!\n')
|
||||
|
||||
# 输入组合键
|
||||
from selenium.webdriver import Keys
|
||||
ele.input((Keys.CONTROL, 'a'), insure_input=False)
|
||||
|
||||
# 向上传文本控件输入文本路径（传入多个路径）
|
||||
ele.input('D:\\test1.txt\nD:\\test2.txt')
|
||||
```
|
||||
|
||||
## run_script()
|
||||
|
||||
此方法用于对元素执行 js 代码。
|
||||
|
||||
参数：
|
||||
|
||||
- script：js 文本
|
||||
- *args：传入 js 的参数
|
||||
|
||||
返回：js 执行的结果
|
||||
|
||||
```python
|
||||
# 用执行 js 的方式点击元素
|
||||
ele.run_script('arguments[0].click()')
|
||||
```
|
||||
|
||||
## clear()
|
||||
|
||||
此方法用于清空元素文本，可使用确保清空的方式，若元素是不可编辑的，返回 None。
|
||||
|
||||
参数：
|
||||
|
||||
- insure_clear：是否确保清空。为 True 则用 input() 确保值变成 ''，为 False 则用 selenium 元素 clear() 方法
|
||||
|
||||
返回：bool，是否清空成功，不能清空的元素返回 None
|
||||
|
||||
```python
|
||||
ele.clear()
|
||||
```
|
||||
|
||||
## screenshot()
|
||||
|
||||
此方法用于对元素进行截图。
|
||||
如果是图片元素，会自动等待加载结束才截图。
|
||||
此方法能自动获取能够使用的文件名，避免重名覆盖原有文件。并返回保存路径。
|
||||
保存格式为 png。
|
||||
|
||||
参数：
|
||||
|
||||
- path：图片保持路径
|
||||
- filename：图片文件名，不传入时以元素 tag 标签命名
|
||||
|
||||
返回：图片的完整路径
|
||||
|
||||
```python
|
||||
path = ele.screenshot(r'D:\tmp', 'img_name')
|
||||
```
|
||||
|
||||
## set_prop()
|
||||
|
||||
此方法用于设置元素 property 属性。
|
||||
|
||||
参数：
|
||||
|
||||
- prop： 属性名
|
||||
- value： 属性值
|
||||
|
||||
返回：bool，是否设置成功
|
||||
|
||||
```python
|
||||
ele.set_prop('value', 'Hello world!')
|
||||
```
|
||||
|
||||
## set_attr()
|
||||
|
||||
此方法用于设置元素 attribute 属性。
|
||||
|
||||
参数：
|
||||
|
||||
- attr：属性名
|
||||
- value：属性值
|
||||
|
||||
返回：bool，是否设置成功
|
||||
|
||||
```python
|
||||
ele.set_attr('href', 'http://www.gitee.com')
|
||||
```
|
||||
|
||||
## remove_attr()
|
||||
|
||||
此方法用于删除元素 attribute 属性。
|
||||
|
||||
参数：
|
||||
|
||||
- attr：属性名
|
||||
|
||||
返回：bool，是否删除成功
|
||||
|
||||
```python
|
||||
ele.remove_attr('href')
|
||||
```
|
||||
|
||||
## submit()
|
||||
|
||||
此方法用于提交表单，若元素不在表单内，返回 None，否则返回 True。
|
||||
|
||||
无参数。
|
||||
|
||||
返回：True 或 None
|
||||
|
||||
```python
|
||||
ele.submit()
|
||||
```
|
||||
|
||||
## drag()
|
||||
|
||||
此方法用于拖拽元素到相对于当前的一个新位置，可以设置速度，可以选择是否随机抖动。
|
||||
|
||||
参数：
|
||||
|
||||
- x：x 变化值
|
||||
- y：y 变化值
|
||||
- speed：拖动的速度，传入 0 即瞬间到达
|
||||
- shake：是否随机抖动
|
||||
|
||||
返回：bool，表示是否拖动成功
|
||||
|
||||
```python
|
||||
# 拖动当前元素到距离 50*50 的位置，速度为 100，不随机抖动
|
||||
ele.drag(50, 50, 100, False)
|
||||
```
|
||||
|
||||
## drag_to()
|
||||
|
||||
此方法用于拖拽元素到另一个元素上或一个坐标上。
|
||||
|
||||
参数：
|
||||
|
||||
- ele_or_loc： 另一个元素或坐标元组，接收元素时坐标是元素中点的坐标。可接收 selenium 的 WebElement 或本库的 DriverElement
|
||||
- speed： 拖动的速度，传入 0 即瞬间到达
|
||||
- shake： 是否随机抖动
|
||||
|
||||
返回：bool，表示是否拖动成功
|
||||
|
||||
```python
|
||||
# 把 ele1 拖拽到 ele2 上
|
||||
ele1 = page.ele('#div1')
|
||||
ele2 = page.ele('#div2')
|
||||
ele1.drag_to(ele2)
|
||||
|
||||
# 把 ele1 拖拽到网页 50, 50 的位置
|
||||
ele1.drag_to((50, 50))
|
||||
```
|
||||
|
||||
## hover()
|
||||
|
||||
此方法用于模拟鼠标悬停在元素上，可接受偏移量，偏移量相对于元素左上角坐标。不传入 x 或 y 值时悬停在元素中点。x 和 y 值可接受负值。
|
||||
|
||||
参数：
|
||||
|
||||
- x：相对元素左上角坐标的x轴偏移量
|
||||
- y：相对元素左上角坐标的y轴偏移量
|
||||
|
||||
返回：None
|
||||
|
||||
```python
|
||||
# 悬停在元素右上方 50*50 的位置
|
||||
ele.hover(50, -50)
|
||||
|
||||
# 悬停在元素上中部，x 相对左上角向右偏移50，y 保持在元素中点
|
||||
ele.hover(x=50)
|
||||
|
||||
# 悬停在元素中点
|
||||
ele.hover()
|
||||
```
|
||||
|
||||
# Select 类
|
||||
|
||||
select 元素的操作较为复杂，因此专门做了一个类用于处理它。每个 DriverElement 都有 select 属性，如果是 select 元素，该属性是一个 Select 类，否则该属性为 False。
|
||||
select 元素要操作列表时，实际上是对这个 Select 对象进行操作。
|
||||
|
||||
```python
|
||||
ele.select
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
### is_multi
|
||||
|
||||
该属性表示当前 select 元素是否多选列表。
|
||||
|
||||
```python
|
||||
ele.select.is_multi
|
||||
```
|
||||
|
||||
### options
|
||||
|
||||
该属性以列表形式返回当前 select 元素下所有列表项元素对象，这些对象是 DriverElement。
|
||||
|
||||
```python
|
||||
options = ele.select.options
|
||||
```
|
||||
|
||||
### selected_option
|
||||
|
||||
该属性返回第一个被选中的元素对象。
|
||||
|
||||
```python
|
||||
option_ele = ele.select.selected_option
|
||||
```
|
||||
|
||||
### selected_options
|
||||
|
||||
该属性以列表形式返回第所有被选中的元素对象。如果是单选列表，返回一个列表
|
||||
|
||||
```python
|
||||
options = ele.select.select.selected_options
|
||||
```
|
||||
|
||||
## 方法
|
||||
|
||||
### select()
|
||||
|
||||
该方法用于选定或取消选定下拉列表中子元素。Select 类的 \_\_call\_\_() 方法直接调用这个方法，因此可以直接`ele.select()`来替代这个方法。写法更直观。
|
||||
当元素是多选列表时，可以接受 list 或 tuple，同时选择多个项。
|
||||
|
||||
参数：
|
||||
|
||||
- text_value_index：根据文本、值选或序号择选项，若允许多选，传入list或tuple可多选
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'，默认根据文本选择
|
||||
- deselect：是否取消选择
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
```python
|
||||
# 根据文本选择下拉列表项
|
||||
ele.select('text')
|
||||
|
||||
# 根据 value 选择下拉列表项
|
||||
ele.select(value, 'value')
|
||||
|
||||
# 根据序号选择下拉列表项
|
||||
ele.select(index, 'index')
|
||||
|
||||
# 选择多个文本项
|
||||
ele.select(('text1', 'text2'))
|
||||
|
||||
# 选择多个 value 项
|
||||
ele.select(('value1', 'value2'), 'value')
|
||||
|
||||
# 选择多个序号
|
||||
ele.select(('index1', 'index2'), 'index')
|
||||
```
|
||||
|
||||
### deselect()
|
||||
|
||||
此方法用于取消选定下拉列表中子元素。当元素是多选列表时，可以接受 list 或 tuple，同时取消选择多个项。
|
||||
|
||||
参数：
|
||||
|
||||
- text_value_index：根据文本、值选或序号择选项，若允许多选，传入list或tuple可多选
|
||||
- para_type：参数类型，可选 'text'、'value'、'index'
|
||||
|
||||
返回：是否选择成功
|
||||
|
||||
```python
|
||||
# 根据文本取消选择下拉列表项
|
||||
ele.select.deselect('text')
|
||||
|
||||
# 根据 value 取消选择下拉列表项
|
||||
ele.select.deselect(value, 'value')
|
||||
|
||||
# 根据序号取消选择下拉列表项
|
||||
ele.select.deselect(index, 'index')
|
||||
|
||||
# 取消选择多个文本项
|
||||
ele.select.deselect(('text1', 'text2'))
|
||||
|
||||
# 取消选择多个 value 项
|
||||
ele.select.deselect(('value1', 'value2'), 'value')
|
||||
|
||||
# 取消选择多个序号
|
||||
ele.select.deselect(('index1', 'index2'), 'index')
|
||||
```
|
||||
|
||||
## 多项列表独有功能
|
||||
|
||||
### clear()
|
||||
|
||||
此方法用于清空多选列表选项。
|
||||
|
||||
无参数。
|
||||
|
||||
返回：None
|
||||
|
||||
```python
|
||||
ele.select.clear()
|
||||
```
|
||||
|
||||
### invert
|
||||
|
||||
此方法用于反选多选列表选项。
|
||||
|
||||
无参数。
|
||||
|
||||
返回：None
|
||||
|
||||
```python
|
||||
ele.select.invert()
|
||||
```
|
||||
@ -1,416 +0,0 @@
|
||||
# 获取元素信息
|
||||
|
||||
获取到须要的页面元素后，可以使用元素对象获取元素的信息。
|
||||
|
||||
本库有三种元素对象，分别是 DriverElement、ShadowRootElement、SessionElement，前两者是 d 模式下通过浏览器页面元素生成，后者由静态文本生成。DriverElement 和
|
||||
SessionElement 的基本属性一致。
|
||||
|
||||
ShadowRootElement 由于是 shadow dom 元素，属性比较其余两种少，下文单独介绍。
|
||||
|
||||
## 实际示例：
|
||||
|
||||
```python
|
||||
from DrissionPage import MixPage
|
||||
|
||||
page = MixPage('s')
|
||||
page.get('https://gitee.com/explore')
|
||||
|
||||
# 获取推荐目录下所有 a 元素
|
||||
li_eles = page('tag:ul@@text():全部推荐项目').eles('t:a')
|
||||
|
||||
for i in li_eles: # 遍历列表
|
||||
print(i.tag, i.text, i.attr('href')) # 获取并打印标签名、文本、href 属性
|
||||
|
||||
"""输出：
|
||||
a 全部推荐项目 https://gitee.com/explore/all
|
||||
a 前沿技术 https://gitee.com/explore/new-tech
|
||||
a 智能硬件 https://gitee.com/explore/hardware
|
||||
a IOT/物联网/边缘计算 https://gitee.com/explore/iot
|
||||
a 车载应用 https://gitee.com/explore/vehicle
|
||||
以下省略……
|
||||
"""
|
||||
```
|
||||
|
||||
# 一览表
|
||||
|
||||
以下为元素信息一览表，然后再详细介绍每个信息。
|
||||
|
||||
```python
|
||||
# ============ 基本属性（DriverElement 和 SessionElement 都拥有）============
|
||||
# 元素 html 文本
|
||||
html
|
||||
|
||||
# 元素内部 html 文本
|
||||
inner_html
|
||||
|
||||
# 元素标签名
|
||||
tag
|
||||
|
||||
# 元素内部经格式化的文本
|
||||
text
|
||||
|
||||
# 元素内部未经格式化的文本
|
||||
raw_text
|
||||
|
||||
# 元素内所有文本节点组成的列表
|
||||
texts()
|
||||
|
||||
# 元素内部所有注释组成的列表
|
||||
comments
|
||||
|
||||
# 元素所有属性值
|
||||
attrs
|
||||
|
||||
# 元素某个属性值
|
||||
attr('...')
|
||||
|
||||
# 元素 href 或 src 属性
|
||||
link
|
||||
|
||||
# 元素所在页面对象
|
||||
page
|
||||
|
||||
# 元素内包装的真正执行功能的元素对象
|
||||
inner_ele
|
||||
|
||||
# 元素绝对 xpath 路径
|
||||
xpath
|
||||
|
||||
# 元素绝对 css selector 路径
|
||||
css_path
|
||||
|
||||
# 元素可用性
|
||||
is_valid()
|
||||
|
||||
# ============ DriverElement 独有属性 ============
|
||||
# 元素尺寸
|
||||
size
|
||||
|
||||
# 元素在页面上的位置
|
||||
location
|
||||
|
||||
# 元素的 before 伪元素内容
|
||||
before
|
||||
|
||||
# 元素的 after 伪元素内容
|
||||
after
|
||||
|
||||
# 获取元素某个 css 样式属性的方法
|
||||
style('...')
|
||||
|
||||
# 获取元素某个 property 属性值的方面
|
||||
prop('...')
|
||||
|
||||
# 元素处理下来列表的 Select 对象，仅 select 元素可用
|
||||
select
|
||||
|
||||
# 元素是否别选中
|
||||
is_select()
|
||||
|
||||
# 元素是否生效
|
||||
is_enablede()
|
||||
|
||||
# 元素是否显示
|
||||
is_displayed()
|
||||
```
|
||||
|
||||
# 基本属性
|
||||
|
||||
假设 ele 为以下 div 元素的对象：
|
||||
|
||||
```html
|
||||
<div id="div1">Hello World!
|
||||
<p>行元素</p>
|
||||
<!--这是注释-->
|
||||
</div>
|
||||
```
|
||||
|
||||
|
||||
|
||||
## html
|
||||
|
||||
此属性返回元素的 outerHTML 文本。
|
||||
|
||||
```python
|
||||
html = ele.html
|
||||
"""返回：
|
||||
<div id="div1">Hello World!
|
||||
<p>行元素</p>
|
||||
<!--这是注释-->
|
||||
</div>
|
||||
"""
|
||||
```
|
||||
|
||||
|
||||
|
||||
## inner_html
|
||||
|
||||
此属性返回元素的 innerHTML 文本。
|
||||
|
||||
```python
|
||||
inner_html = ele.inner_html
|
||||
"""返回：
|
||||
Hello World!
|
||||
<p>行元素</p>
|
||||
<!--这是注释-->
|
||||
"""
|
||||
```
|
||||
|
||||
|
||||
|
||||
## tag
|
||||
|
||||
此属性返回元素的标签名。
|
||||
|
||||
```python
|
||||
tag = ele.tag
|
||||
# 返回：div
|
||||
```
|
||||
|
||||
## text
|
||||
|
||||
此属性返回元素内所有文本组合成的字符串。
|
||||
该字符串已格式化，即已转码，已去除多余换行符，符合人读取习惯，便于直接使用。无须重复写处理代码。
|
||||
|
||||
```python
|
||||
text = ele.text
|
||||
"""返回：
|
||||
Hello World!
|
||||
行元素
|
||||
"""
|
||||
```
|
||||
|
||||
## raw_text
|
||||
|
||||
此属性返回元素内原始文本。
|
||||
|
||||
```python
|
||||
text = ele.raw_text
|
||||
"""返回（注意保留了元素间的空格和换行）：
|
||||
Hello World!
|
||||
行元素
|
||||
|
||||
|
||||
"""
|
||||
```
|
||||
|
||||
## texts()
|
||||
|
||||
此方法返回元素内所有直接子节点的文本，包括元素和文本节点。 它有一个参数 text_node_only，为True 时则只获取只返回文本节点。这个方法适用于获取文本节点和元素节点混排的情况。
|
||||
|
||||
```python
|
||||
texts = ele.texts()
|
||||
print(e.texts(text_node_only=True))
|
||||
# 输出：['Hello World!', '行元素']
|
||||
|
||||
print(e.texts())
|
||||
# 输出：['Hello World!']
|
||||
```
|
||||
|
||||
## comments
|
||||
|
||||
```python
|
||||
comments = ele.comments
|
||||
# 返回：[<!--这是注释-->]
|
||||
```
|
||||
|
||||
## attrs
|
||||
|
||||
此属性以字典形式返回元素所有属性及值。
|
||||
|
||||
```python
|
||||
attrs = ele.attrs
|
||||
# 返回：{'id': 'div1'}
|
||||
```
|
||||
|
||||
## attr()
|
||||
|
||||
此方法返回元素某个 attribute 属性值。它接收一个字符串参数 attr，返回该属性值文本，无该属性时返回 None。
|
||||
此属性返回的 src、href 属性为已补充完整的路径。text 属性为已格式化文本，innerText 属性为未格式化文本，
|
||||
|
||||
```python
|
||||
ele_id = ele.attr('id')
|
||||
# 返回：div1
|
||||
```
|
||||
|
||||
## link
|
||||
|
||||
此方法返回元素的 href 属性或 src 属性，没有这两个属性则返回 None。
|
||||
|
||||
```html
|
||||
<a href='http://www.baidu.com'>百度</a>
|
||||
```
|
||||
|
||||
假设 a_ele 为以上元素的对象：
|
||||
|
||||
```python
|
||||
link = a_ele.link
|
||||
# 返回：http://www.baidu.com
|
||||
```
|
||||
|
||||
## page
|
||||
|
||||
此属性返回元素所在的页面对象。
|
||||
|
||||
- 由页面对象生成的元素返回该页面对象，如 MixPage，DriverPage，SessionPage
|
||||
- 由 html 文本直接生成的 SessionElement 的 page 属性为 None。
|
||||
|
||||
```python
|
||||
page = ele.page
|
||||
```
|
||||
|
||||
## inner_ele
|
||||
|
||||
此属性返回被当前元素包装的对应模式原本的元素对象。
|
||||
d 模式包装的是一个 selenium 的 WebElement 对象，s 模式包装的是一个 lxml 的 HtmlElement 对象。
|
||||
获取该对象，可直接使用该对象以该库的原生代码来执行须要的操作，便于不同项目的对接，及使用本库没有封装的功能。
|
||||
|
||||
```python
|
||||
# 获取元素的 WebElement 对象
|
||||
web_ele = ele.inner_ele
|
||||
# 使用 selenium 原生的元素点击方法
|
||||
web_ele.find_element(By.ID, 'ele_id').click()
|
||||
```
|
||||
|
||||
## xpath
|
||||
|
||||
此属性返回当前元素在页面中 xpath 的绝对路径。
|
||||
|
||||
```python
|
||||
xpath = ele.xpath
|
||||
# 返回：/html/body/div
|
||||
```
|
||||
|
||||
## css_path
|
||||
|
||||
此属性返回当前元素在页面中 css selector 的绝对路径。
|
||||
|
||||
```python
|
||||
css = ele.css_path
|
||||
# 返回：:nth-child(1)>:nth-child(1)>:nth-child(1)
|
||||
```
|
||||
|
||||
## is_valid()
|
||||
|
||||
此方法返回当前元素是否可用。SessionElement 始终返回 True，DriverElement 视乎元素是否还在 DOM 内返回布尔值。
|
||||
|
||||
```python
|
||||
is_valid = ele.is_valid()
|
||||
```
|
||||
|
||||
# DriverElement 独有属性
|
||||
|
||||
## size
|
||||
|
||||
此属性以字典形式返回元素的大小。
|
||||
|
||||
```python
|
||||
size = ele.size
|
||||
# 返回：{'height': 50, 'width': 50}
|
||||
```
|
||||
|
||||
## location
|
||||
|
||||
此属性以字典形式返回元素坐标。
|
||||
|
||||
```python
|
||||
loc = ele.location
|
||||
# 返回：{'x': 50, 'y': 50}
|
||||
```
|
||||
|
||||
## before
|
||||
|
||||
此属性以文本形式返回当前元素的 ::before 伪元素内容。
|
||||
|
||||
```python
|
||||
before_txt = ele.before
|
||||
```
|
||||
|
||||
## after
|
||||
|
||||
此属性以文本形式返回当前元素的 ::after 伪元素内容。
|
||||
|
||||
```python
|
||||
after_txt = ele.after
|
||||
```
|
||||
|
||||
## style()
|
||||
|
||||
该方法返回元素 css 样式属性值，可获取伪元素的属性。它有两个参数，style 参数输入样式属性名称，pseudo_ele 参数输入伪元素名称，省略则获取普通元素的 css 样式属性。
|
||||
|
||||
```python
|
||||
prop = ele.style('color', 'first-letter')
|
||||
```
|
||||
|
||||
## prop()
|
||||
|
||||
此方法返回 property 属性值。它接收一个字符串参数，返回该参数的属性值。
|
||||
|
||||
```python
|
||||
prop = ele.peop('value')
|
||||
```
|
||||
|
||||
## select
|
||||
|
||||
此属性返回 select 元素用于处理下拉列表的 Select 类（下一节说明），非下拉列表元素返回 False。
|
||||
|
||||
```python
|
||||
select = ele.select
|
||||
```
|
||||
|
||||
## is_selected()
|
||||
|
||||
此方法以布尔值返回元素是否选中。
|
||||
|
||||
```python
|
||||
selected = ele.is_selected()
|
||||
```
|
||||
|
||||
## is_enabled()
|
||||
|
||||
此方法以布尔值返回元素是否可用。
|
||||
|
||||
```python
|
||||
enable = ele.is_enabled()
|
||||
```
|
||||
|
||||
## is_displayed()
|
||||
|
||||
此方法以布尔值返回元素是否可见。
|
||||
|
||||
```python
|
||||
displayed = ele.is_displayed()
|
||||
```
|
||||
|
||||
# ShadowRootElement 属性
|
||||
|
||||
本库把 shadow dom 的 root 看作一个元素处理，可以获取属性，也可以执行其下级的查找，但其属性比较少。有如下这些：
|
||||
|
||||
## tag
|
||||
|
||||
元素标签名
|
||||
|
||||
## html
|
||||
|
||||
shadow-root 内的 html 文本，与其余两种元素不一样，其余两种的 html 属性获取的是 outerHTML，ShadowRootElement 的 html 属性获取的是内部的。
|
||||
|
||||
## page
|
||||
|
||||
元素所在页面对象。
|
||||
|
||||
## inner_ele
|
||||
|
||||
从 js 中获取到的 shadow-root 元素。
|
||||
|
||||
## parent_ele
|
||||
|
||||
这是 ShadowRootElement 独有的属性，返回它所依附的普通元素对象。
|
||||
|
||||
## is_enabled()
|
||||
|
||||
与 DriverElement 一致。
|
||||
|
||||
## is_valid()
|
||||
|
||||
与 DriverElement 一致。
|
||||
|
||||
@ -1,531 +0,0 @@
|
||||
# 获取页面元素
|
||||
|
||||
本节介绍如何从页面对象或元素对象中获取须要的元素对象。
|
||||
|
||||
页面对象（MixPage）和元素对象（DriverElement 或 SessionElement）都可通过 ele()、eles()、s_ele()、s_eles()方法定位到其后代元素。
|
||||
DriverElement 还有专门用于获取shadow-root 的 shadow_root 属性。获取到的元素可继续用这些方法获取后代元素，支持链式操作。
|
||||
|
||||
除了以上方法，元素还有 next、prev、parent、nexts()、prevs()、parents() 等相对定位方法。
|
||||
|
||||
d 模式获取元素的方法内置了等待，默认使用元素所属页面的超时设置，也可用在每次获取元素时单独设置等待时间。
|
||||
|
||||
|
||||
|
||||
## 简单示例：
|
||||
|
||||
```html
|
||||
<html>
|
||||
<body>
|
||||
<div id="one">
|
||||
<p class="p_cls" name="row1">第一行</p>
|
||||
<p class="p_cls" name="row2">第二行</p>
|
||||
<p class="p_cls">第三行</p>
|
||||
</div>
|
||||
<div id="two">
|
||||
第二个div
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
假设 page 为以上页面的 MixPage 对象，我们可以用这些方法获取其中的元素：
|
||||
|
||||
```python
|
||||
# 获取 id 为 one 的元素
|
||||
div1 = page.ele('#one')
|
||||
|
||||
# 获取 div1 元素内所有 p 元素组成的列表
|
||||
p_eles = div1.eles('tag:p')
|
||||
|
||||
# 获取 name 属性为 row1 的元素
|
||||
row1 = page.ele('@name=row1')
|
||||
|
||||
# 获取 name 属性为 row2 且包含“第二”文本的 p 元素
|
||||
p_ele = page.ele('tag:p@@text():第二@@name=row2')
|
||||
|
||||
# 获取包含“第二个div”文本的元素
|
||||
div2 = page.ele('第二个div')
|
||||
|
||||
# 用 xpath 查找
|
||||
div2 = page.ele('x://div[@id="tow"]')
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 实际示例：
|
||||
|
||||
```python
|
||||
from DrissionPage import MixPage
|
||||
|
||||
page = MixPage('s')
|
||||
page.get('https://gitee.com/explore')
|
||||
|
||||
ul_ele = page.ele('tag:ul@@text():全部推荐项目') # 获取包含“全部推荐项目”文本的 ul 元素
|
||||
titles = ul_ele.eles('tag:a') # 获取该 ul 元素下所有 a 元素
|
||||
|
||||
for i in titles: # 遍历列表，打印每个 a 元素的文本
|
||||
print(i.text)
|
||||
|
||||
"""输出：
|
||||
全部推荐项目
|
||||
前沿技术
|
||||
智能硬件
|
||||
IOT/物联网/边缘计算
|
||||
车载应用
|
||||
以下省略……
|
||||
"""
|
||||
```
|
||||
|
||||
# 一览表
|
||||
|
||||
以下为获取元素方法一览表，然后再详细介绍每个方法。
|
||||
|
||||
```python
|
||||
# 在页面或元素内部查找一个元素
|
||||
ele1 = page.ele('...')
|
||||
ele2 = ele1.ele('...')
|
||||
|
||||
# 在页面或元素内部查找多个元素
|
||||
ele_list1 = page.eles('...')
|
||||
ele_list2 = ele1.eles('...')
|
||||
|
||||
# 在页面或元素内部查找一个元素并返回其 SessionElement 形式的对象
|
||||
ele1 = page.s_ele('...')
|
||||
ele2 = ele1.s_ele('...')
|
||||
|
||||
# 在页面或元素内部查找多个元素并返回它们的 SessionElement 形式的对象
|
||||
ele1 = page.s_eles('...')
|
||||
ele2 = ele1.s_eles('...')
|
||||
|
||||
# 获取元素后面一个兄弟元素
|
||||
ele2 = ele1.next
|
||||
|
||||
# 获取元素前面一个兄弟元素
|
||||
ele2 = ele1.prev
|
||||
|
||||
# 获取元素的父元素
|
||||
ele2 = ele1.parent
|
||||
|
||||
# 获取元素后面第 2 个兄弟元素
|
||||
ele2 = ele1.nexts(2)
|
||||
|
||||
# 获取元素前面第 2 个兄弟元素
|
||||
ele2 = ele1.prevs(2)
|
||||
|
||||
# 获取元素的第 2 层父元素
|
||||
ele2 = ele1.parents(2)
|
||||
|
||||
# 获取元素内部的 shadow_root 并以 ShadowRootElement 对象返回
|
||||
ele_sr = shadow_root
|
||||
```
|
||||
|
||||
# 定位方法
|
||||
|
||||
## ele()
|
||||
|
||||
此方法用于查找并返回第一个匹配的元素，d 模式下返回 DriverElement，s 模式下返回 SessionElement，用 xpath 获取元素属性时，直接返回属性文本。查找不到结果则返回 None。
|
||||
|
||||
```python
|
||||
# 在页面内查找元素
|
||||
ele1 = page.ele('search text')
|
||||
|
||||
# 在元素内查找后代元素
|
||||
ele2 = ele1.ele('search text')
|
||||
```
|
||||
|
||||
|
||||
|
||||
## eles()
|
||||
|
||||
此方法与 ele() 相似，但返回的是匹配到的所有元素组成的列表，用 xpath 获取元素属性时，返回属性文本组成的列表。
|
||||
|
||||
```python
|
||||
# 获取 ele 元素内的所有 p 元素
|
||||
p_eles = ele.eles('tag:p')
|
||||
# 打印第一个 p 元素
|
||||
print(p_eles[0])
|
||||
```
|
||||
|
||||
|
||||
|
||||
## s_ele()
|
||||
|
||||
此方法用于在一个元素下查找后代元素，以 SessionElement 形式返回结果（xpath 获取属性值时依然是返回 str），也可以直接将一个元素转换为 SessionElement 版本。
|
||||
|
||||
这是为了 d 模式处理速度的提升，当爬取复杂页面信息而且不须要和元素进行交互时，生成整个页面或者主要容器元素的 SessionElement ，再在其中获取信息，可以将速度提升几个数量级。
|
||||
|
||||
s 模式下这个方法和 ele() 是一样的。
|
||||
|
||||
```python
|
||||
# 获取 ele1 元素的 SessionElement 版本
|
||||
ele2 = ele1.s_ele()
|
||||
|
||||
# 在 ele1 元素下查找元素，并以 SessionElemnet 返回
|
||||
ele2 = ele1.s_ele('search text')
|
||||
|
||||
# 在页面下查找元素，并以 SessionElemnet 返回
|
||||
ele = page.s_ele('search text')
|
||||
```
|
||||
|
||||
## s_eles()
|
||||
|
||||
此方法与 s_ele() 相似，但返回的是匹配到的所有元素组成的列表，或属性值组成的列表。页面对象没有此方法。
|
||||
|
||||
## next
|
||||
|
||||
此属性返回当前元素的后一个兄弟元素。
|
||||
|
||||
```python
|
||||
# 获取 ele1 后面一个兄弟元素
|
||||
ele2 = ele1.next
|
||||
```
|
||||
|
||||
|
||||
|
||||
## prev
|
||||
|
||||
此属性返回当前元素的前一个兄弟元素。
|
||||
|
||||
```python
|
||||
# 获取 ele1 前面一个兄弟元素
|
||||
ele2 = ele1.prev
|
||||
```
|
||||
|
||||
|
||||
|
||||
## parent
|
||||
|
||||
此属性返回当前元素的父元素。
|
||||
|
||||
注：ShadowRootElement 的这个属性返回其所属元素。
|
||||
|
||||
```python
|
||||
# 获取 ele1 的父元素
|
||||
ele2 = ele1.parent
|
||||
```
|
||||
|
||||
|
||||
|
||||
## nexts()
|
||||
|
||||
此方法返回当前元素后面第若干个兄弟元素。
|
||||
|
||||
```python
|
||||
# 获取 ele1 后面第三个兄弟元素
|
||||
ele2 = ele1.nexts(3)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## prevs()
|
||||
|
||||
此方法返回当前元素前面第若干个兄弟元素。
|
||||
|
||||
```python
|
||||
# 获取 ele1 前面第三个兄弟元素
|
||||
ele2 = ele1.prevs(3)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## parents()
|
||||
|
||||
此方法返回当前元素第若干层祖先元素。
|
||||
|
||||
```python
|
||||
# 获取 ele1 上面 3 层父元素
|
||||
ele2 = ele1.parents(3)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## shadow_root
|
||||
|
||||
DriverElement 元素除了以上方法和属性外，还有 shadow_root 属性，用于获取其内部的 shadow_root 元素。
|
||||
该属性返回的是一个 ShadowRootElement，类似于 DriverElement，功能比 DriverElement 少。但也有 ele() 和 eles() 方法，可直接搜索其下的元素，返回 DriverElement 元素。
|
||||
该 DriverElement 和普通的没有区别。
|
||||
|
||||
```python
|
||||
# 获取一个元素下是 shadow root
|
||||
shadow_ele = ele.shadow_root
|
||||
# 获取该 shadow root 下的一个元素
|
||||
ele1 = shadow_ele.ele('search text')
|
||||
# 点击获取到的元素
|
||||
ele1.click()
|
||||
```
|
||||
|
||||
## active_ele
|
||||
|
||||
该属性返回当前页面焦点所在元素。
|
||||
|
||||
```python
|
||||
ele = page.active_ele
|
||||
```
|
||||
|
||||
# 查找语法
|
||||
|
||||
我们使用一套简洁高效的语法去定位元素，大大简化了定位元素的代码量，增强了功能，也兼容 css selector、xpath、selenium 原生的 loc 元组（s 模式也能用）。d 模式和 s
|
||||
模式定位元素的语法是完全一样的，便于模式切换时平滑过渡。
|
||||
|
||||
**关键字** 是出现在定位语句最左边，用于指明该语句以哪种方式去查找元素，有以下这些：
|
||||
|
||||
## =
|
||||
|
||||
表示精确匹配，匹配完全符合的文本或属性。
|
||||
|
||||
## :
|
||||
|
||||
表示模糊匹配，匹配含有某个字符串的文本或属性。
|
||||
|
||||
|
||||
|
||||
## \#
|
||||
|
||||
表示 id 属性，只在语句最前面且单独使用时生效，可配合 = 或 :。
|
||||
|
||||
```python
|
||||
# 在页面中查找 id 属性为 ele_id 的元素
|
||||
ele1 = page.ele('#ele_id')
|
||||
|
||||
# 在 ele1 元素内查找 id 属性包含 ele_id 文本的元素
|
||||
ele2 = ele1.ele('#:ele_id')
|
||||
```
|
||||
|
||||
## .
|
||||
|
||||
表示 class 属性，只在语句最前面且单独使用时生效，可配合 = 或 :。
|
||||
|
||||
```python
|
||||
# 查找 class 属性为 ele_class 的元素
|
||||
ele2 = ele1.ele('.ele_class')
|
||||
|
||||
# 查找 class 属性包含 ele_class 文本的元素
|
||||
ele2 = ele1.ele('.:ele_class')
|
||||
```
|
||||
|
||||
## @
|
||||
|
||||
表示某个属性，只匹配一个属性。
|
||||
@ 关键字只有一个简单功能，就是匹配 @ 后面的内容，不再对后面的字符串进行解析。因此即使后面的字符串也存在 @ 或 @@，也作为要匹配的内容对待。
|
||||
|
||||
```python
|
||||
# 查找 name 属性为 ele_name 的元素
|
||||
ele2 = ele1.ele('@name=ele_name')
|
||||
|
||||
# 查找 name 属性包含 ele_name 文本的元素
|
||||
ele2 = ele1.ele('@name:ele_name')
|
||||
|
||||
# 查找有 name 属性的元素
|
||||
ele2 = ele1.ele('@name')
|
||||
|
||||
# 查找没有任何属性的元素
|
||||
ele2 = ele1.ele('@')
|
||||
|
||||
# 查找 emaile 属性为 abc@def.com 的元素，有多个 @ 也不会重复处理
|
||||
ele2 = ele1.ele('@email=abc@def.com')
|
||||
```
|
||||
|
||||
## @@
|
||||
|
||||
表示某个属性，多属性匹配时使用，个数不限。还能匹配要忽略的元素，匹配文本时也和 @ 不一样。
|
||||
@@ 后跟 - 时，表示 not。如：
|
||||
|
||||
- `@@-name`表示匹配没有 name 属性的元素
|
||||
|
||||
- `@@-name=ele_name`表示匹配 name 属性不为 ele_name 的元素
|
||||
|
||||
如有以下情况，不能使用此方式，须改用 xpath的方式：
|
||||
|
||||
- 匹配文本或属性中出现 @@
|
||||
|
||||
- 属性名本身以 - 开头
|
||||
|
||||
```python
|
||||
# 查找 name 属性为 name 且 class 属性包含 cls 文本的元素
|
||||
ele2 = ele1.ele('@@name=name@@class:cls')
|
||||
|
||||
# 查找没有 class 属性的元素
|
||||
ele2 = ele1.ele('@@-class')
|
||||
|
||||
# 查找 name 属性不包含 ele_name 的元素
|
||||
ele2 = ele1.ele('@@-name:ele_name')
|
||||
```
|
||||
|
||||
## text
|
||||
|
||||
要匹配的文本，查询字符串如开头没有任何关键字，也表示根据 text 作模糊查找。
|
||||
如果元素内有多个直接的文本节点，精确查找时可匹配所有文本节点拼成的字符串，模糊查找时可匹配每个文本节点。
|
||||
|
||||
```python
|
||||
# 查找文本为 some text 的元素
|
||||
ele2 = ele1.ele('text=some text')
|
||||
|
||||
# 查找文本包含 some text 的元素
|
||||
ele2 = ele1.ele('text:some text')
|
||||
|
||||
# 与上一行一致
|
||||
ele2 = ele1.ele('some text')
|
||||
```
|
||||
|
||||
## text()
|
||||
|
||||
作为查找属性时使用的文本关键字，必须与 @ 或 @@ 配合使用。
|
||||
与 @ 配合和与 @@ 配合使用时，text() 的意义是有差别的。
|
||||
|
||||
@text() 表示在元素的直接子文本节点中匹配，且多个节点不能合并匹配。 @@text() 表示在元素内部所有文本中匹配，且会把元素内部所有文本拼成一个总字符串再进行匹配，因此可以模糊匹配元素里面任意文本。
|
||||
|
||||
```python
|
||||
# 查找文本为 some text 的元素
|
||||
ele2 = ele1.ele('@text()=some text')
|
||||
|
||||
# 查找文本包含 some text 的元素
|
||||
ele2 = ele1.ele('@text():some text')
|
||||
|
||||
# 查找文本为 some text 且 class 属性为 cls 的元素
|
||||
ele2 = ele1.ele('@@text()=some text@@class=cls')
|
||||
|
||||
# 查找文本为 some text 且没有任何属性的元素（因第一个 @@ 后为空）
|
||||
ele2 = ele1.ele('@@@@text():some text')
|
||||
|
||||
# 查找直接子文本包含 some text 字符串的元素，和 text 关键字没有区别
|
||||
ele = page.ele('@text():some text')
|
||||
ele = page.ele('text:some text')
|
||||
|
||||
# 查找元素内部包含 some text 字符串的元素
|
||||
ele = page.ele('@@text():some text')
|
||||
```
|
||||
|
||||
## tag
|
||||
|
||||
表示元素的标签，只在语句最前面且单独使用时生效，可与 @ 或 @@ 配合使用。tag: 与 tag= 效果一致。
|
||||
|
||||
```python
|
||||
# 定位 div 元素
|
||||
ele2 = ele1.ele('tag:div')
|
||||
|
||||
# 定位 class 属性为 cls 的 div 元素
|
||||
ele2 = ele1.ele('tag:div@class=cls')
|
||||
|
||||
# 定位文本为 text 的 div 元素
|
||||
ele2 = ele1.ele('tag:div@text()=text')
|
||||
|
||||
# 定位 class 属性为 cls 且文本为 text 的 div 元素
|
||||
ele2 = ele1.ele('tag:div@@class=cls@@text()=text')
|
||||
|
||||
# 查找直接文本节点包含 text 字符串的 div 元素
|
||||
ele2 = ele1.ele('tag:div@text():text')
|
||||
|
||||
# 查找内部文本节点包含 text 字符串的 div 元素
|
||||
ele2 = ele1.ele('tag:div@@text():text')
|
||||
```
|
||||
|
||||
**Tips:** 注意， `'tag:div@text():text'` 和 `'tag:div@@text():text'` 是有区别的，前者只在 div 的直接文本节点搜索，后者搜索 div 的整个内部。
|
||||
|
||||
## css
|
||||
|
||||
表示用 css selector 方式查找元素。css: 与 css= 效果一致。
|
||||
|
||||
```python
|
||||
# 查找 div 元素
|
||||
ele2 = ele1.ele('css:.div')
|
||||
|
||||
# 查找 div 子元素元素，这个写法是本库特有，原生不支持
|
||||
ele2 = ele1.ele('css:>div')
|
||||
```
|
||||
|
||||
## xpath
|
||||
|
||||
表示用 xpath 方式查找元素。xpath: 与 xpath= 效果一致。
|
||||
该方法支持完整的 xpath 语法，能使用 xpath 直接获取元素属性，selenium 不支持这种用法。
|
||||
|
||||
```python
|
||||
# 查找 div 元素
|
||||
ele2 = ele1.ele('xpath:.//div')
|
||||
|
||||
# 和上面一行一样，查找元素的后代时，// 前面的 . 可以省略
|
||||
ele2 = ele1.ele('xpath://div')
|
||||
|
||||
# 获取 div 元素的 class 属性，返回字符串
|
||||
txt = ele1.ele('xpath://div/@class')
|
||||
```
|
||||
|
||||
**Tips:**
|
||||
查找元素的后代时，selenium 原生代码要求 xpath 前面必须加 . ，否则会变成在全个页面中查找。笔者觉得这个设计是画蛇添足，既然已经通过元素查找了，自然应该只查找这个元素内部的元素。所以，用xpath 在元素下查找时，最前面
|
||||
// 或 / 前面的 . 可以省略。
|
||||
|
||||
## selenium 的 loc 元组
|
||||
|
||||
查找方法能直接接收 selenium 原生定位元组进行查找，s 模式下也支持这种写法。
|
||||
|
||||
```python
|
||||
# 查找 id 为 ele_id 的元素
|
||||
loc1 = By.ID, 'ele_id'
|
||||
ele = page.ele(loc1)
|
||||
|
||||
# 按 xpath 查找
|
||||
loc2 = By.XPATH, '//div[@class="ele_class"]'
|
||||
ele = page.ele(loc2)
|
||||
```
|
||||
|
||||
# 等待
|
||||
|
||||
d 模式下所有查找元素操作都自带等待，默认为 10 秒，也可以在每次查找时单独设置。元素等待时间默认继承其所在页面时间。单独设置的等待时间不会改变页面原来设置。
|
||||
|
||||
```python
|
||||
# 页面初始化时设置查找元素超时时间为 15 秒
|
||||
page = MixPage(timeout=15)
|
||||
# 设置查找元素超时时间为 5 秒
|
||||
page.timeout = 5
|
||||
|
||||
# 使用页面超时时间来查找元素（5 秒）
|
||||
ele1 = page.ele('some text')
|
||||
# 为这次查找页面独立设置等待时间（1 秒）
|
||||
ele1 = page.ele('some text', timeout=1)
|
||||
# 查找后代元素，使用页面超时时间（5 秒）
|
||||
ele2 = ele1.ele('some text')
|
||||
# 查找后代元素，使用单独设置的超时时间（1 秒）
|
||||
ele2 = ele1.ele('some text', timeout=1)
|
||||
```
|
||||
|
||||
# 简化写法
|
||||
|
||||
为进一步精简代码，对语法进行了精简
|
||||
|
||||
- 定位语法都有其简化形式。
|
||||
- 页面和元素对象都实现了 \_\_call\_\_() 方法，可直接调用。
|
||||
- 所有查找方法都支持链式操作
|
||||
|
||||
示例：
|
||||
|
||||
```python
|
||||
# 定位到页面中 id 为 table_id 的元素，然后获取它的所有 tr 元素
|
||||
eles = page('#table_id').eles('t:tr')
|
||||
|
||||
# 定位到 class 为 cls 的元素，然后在它里面查找文本为 text 的元素
|
||||
ele2 = ele1('.cls1')('tx=text')
|
||||
|
||||
# 获取 ele1 的 shadow_root 元素，再在里面查找 class 属性为 cls 的元素
|
||||
ele2 = ele1.sr('.cls')
|
||||
|
||||
# 按xpath 查找元素
|
||||
ele2 = ele1('x://div[@class="ele_class"]')
|
||||
```
|
||||
|
||||
简化写法对应列表
|
||||
|
||||
| 原写法 | 简化写法 |
|
||||
| :---------: | :------: |
|
||||
| text | tx |
|
||||
| text() | tx() |
|
||||
| tag | t |
|
||||
| xpath | x |
|
||||
| css | c |
|
||||
| shadow_root | sr |
|
||||
|
||||
# Tips
|
||||
|
||||
- 从一个 DriverElement 元素获取到的 SessionElement 版本，依然能够使用相对定位方法定位祖先或兄弟元素。
|
||||
- SessionElement 和 SessionPage 的 ele() 和 eles() 方法也有 timeout 参数，但它是不生效的，仅用于保持与 d 模式元素书写一致，便于无差别的调用。
|
||||
- ShadowRootElement 的 ele() 不支持 xpath 关键字。
|
||||
- 定位语句内容与关键字重复时，可使用 xpath 或 css selector。
|
||||
|
||||
@ -1,2 +0,0 @@
|
||||
# 施工中。。。
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
# 施工中。。。
|
||||
|
||||
# 概念
|
||||
|
||||
本节讲解 DrissionPage 的一些基本概念。了解它大概的构成和运作原理。
|
||||
默认读者对网络协议、html、selenium、requests 等有基本认识。
|
||||
|
||||
## 网页自动化
|
||||
|
||||
网页自动化的形式通常有两种：
|
||||
|
||||
- 控制浏览器跟网页进行交互
|
||||
- 直接向服务器发送数据包，获取需要的数据
|
||||
|
||||
这两种方式
|
||||
198
docs/版本历史.md
198
docs/版本历史.md
@ -1,198 +0,0 @@
|
||||
# v1.11.7
|
||||
|
||||
- SessionOptions增加set_headers()
|
||||
- 调整MixPage初始化参数
|
||||
- click()增加timeout参数，修改逻辑为在超时时间内不断重试点击。可用于监视遮罩层是否消失
|
||||
- 处理process_alert()增加timeout参数
|
||||
- 其他优化和问题修复
|
||||
|
||||
# v1.11.0
|
||||
|
||||
- set_property属性改名为set_prop
|
||||
- 增加prop()
|
||||
- clear()改用selenium原生
|
||||
- 增加r_click()和r_click_at()
|
||||
- input()返回None
|
||||
- 增加input_txt()
|
||||
|
||||
# v1.10.0
|
||||
|
||||
- 优化启动浏览器的逻辑
|
||||
- 用debug模式启动时可读取启动参数
|
||||
- 完善select标签处理功能
|
||||
- MixPage类的to_iframe()改名为to_frame()
|
||||
- MixPage类的scroll_to()增加'half'方式，滚动半页
|
||||
- Drission类增加kill_browser()方法
|
||||
|
||||
# v1.9.0
|
||||
|
||||
- 元素增加click_at()方法，支持点击偏移量
|
||||
- download()支持重试
|
||||
- 元素input()允许接收组合键，如ctrl+a
|
||||
- 其它优化
|
||||
|
||||
# v1.8.0
|
||||
|
||||
- 添加retry_times和retry_interval属性，可统一指定重连次数
|
||||
- 元素对象增加raw_text属性
|
||||
- 元素查找字符串支持极简模式，用x表示xpath、c表示css、t表示tag、tx表示text
|
||||
- s模式元素text尽量与d模式保持一致
|
||||
- 其它完善和问题修复
|
||||
|
||||
# v1.7.7
|
||||
|
||||
- 创建driver时可自动下载chromedriver.exe
|
||||
- 修复获取不到content-type时会出现的问题
|
||||
|
||||
# v1.7.1
|
||||
|
||||
- d模式如指定了调试端口，可自动启动浏览器进程并接入
|
||||
- 去除对cssselect库依赖
|
||||
- 提高查找元素效率
|
||||
- 调整获取元素xpath和css_path逻辑
|
||||
|
||||
# v1.7.0
|
||||
|
||||
- 优化cookies相关逻辑
|
||||
- MixPage增加get_cookies()和set_cookies()方法
|
||||
- 增加SessionOptions类
|
||||
- 浏览文件 DriverElement增加remove_attr()方法
|
||||
- 修复MixPage初始化时Session导入cookies时的问题
|
||||
- MixPage的close_other_tabs()方法现在可以接收列表或元组以保留多个tab
|
||||
- 其它优化
|
||||
|
||||
# v1.6.1
|
||||
|
||||
- 增加.和#方式用于查找元素，相当于@Class和@id
|
||||
- easy_set增加识别chrome版本并自动下载匹配的driver功能
|
||||
- 改进配置功能
|
||||
- 修复shadow-root方面的问题
|
||||
|
||||
# v1.5.4
|
||||
|
||||
- 优化获取编码的逻辑
|
||||
- 修复下载不能显示进度的问题
|
||||
|
||||
# v1.5.2
|
||||
|
||||
- 修复获取html时会把元素后面的文本节点带上的问题
|
||||
- 修复获取编码可能出现的错误
|
||||
- 优化download()和获取编码代码
|
||||
|
||||
# v1.5.1
|
||||
|
||||
- 修复获取编码可能出现的bug
|
||||
|
||||
# v1.5.0
|
||||
|
||||
- s模式使用lxml库代替requests_html库
|
||||
- 可直接调用页面对象和元素对象获取下级元素，element('@id=ele_id')等价于element.ele('@id=ele_id')
|
||||
- nexts()、prevs()方法可获取文本节点
|
||||
- 可获取伪元素属性及文本
|
||||
- 元素对象增加link和inner_html属性
|
||||
- 各种优化
|
||||
|
||||
# v1.4.0
|
||||
|
||||
- d模式使用js通过evaluate方法处理xpath，放弃使用selenium原生的方法，以支持用xpath直接获取文本节点、元素属性
|
||||
- d模式增加支持用xpath获取元素文本、属性
|
||||
- 优化和修复小问题
|
||||
|
||||
# v1.3.0
|
||||
|
||||
- 可与selenium代码无缝对接
|
||||
- 下载功能支持post方式
|
||||
- 元素添加texts属性，返回元素内每个文本节点内容
|
||||
- s模式增加支持用xpath获取元素文本、属性
|
||||
|
||||
# v1.2.1
|
||||
|
||||
- 优化修复网页编码逻辑
|
||||
- download函数优化获取文件名逻辑
|
||||
- 优化download()获取文件大小逻辑
|
||||
- 优化MixPage对象关闭session逻辑
|
||||
|
||||
# v1.2.0
|
||||
|
||||
- 增加对shadow-root的支持
|
||||
- 增加自动重试连接功能
|
||||
- MixPage可直接接收配置
|
||||
- 修复一些bug
|
||||
|
||||
# v1.1.3
|
||||
|
||||
- 连接有关函数增加是否抛出异常参数
|
||||
- session模式判断编码优化
|
||||
- driver模式check_page()优化
|
||||
- 修复run_script()遗漏args参数的问题
|
||||
|
||||
# v1.1.1
|
||||
|
||||
- 删除get_tabs_sum()和get_tab_num()函数，以属性tabs_count和current_tab_num代替
|
||||
- 增加current_tab_handle、tab_handles属性
|
||||
- to_tab()和close_other_tabs()函数可接收handle值
|
||||
- create_tab可接收一个url在新标签页打开
|
||||
- 其它优化和bug修复
|
||||
|
||||
# v1.1.0
|
||||
|
||||
- 元素对象增加xpath和css path路径属性
|
||||
- 修复driver模式下元素对象用css方式不能获取直接子元素的问题（selenium的锅）
|
||||
- session模式下现在能通过xpath定位上级元素
|
||||
- 优化driver模式兄弟元素、父级元素的获取效率
|
||||
- 优化标签页处理功能
|
||||
- 其它小优化和修复
|
||||
|
||||
# V1.0.5
|
||||
|
||||
- 修复切换模式时url出错的bug
|
||||
|
||||
# V1.0.3
|
||||
|
||||
- DriverOptions支持链式操作
|
||||
- download函数增加参数处理遇到已存在同名文件的情况，可选跳过、覆盖、自动重命名
|
||||
- download函数重命名调整为只需输入文件名，不带后缀名，输入带后缀名也可自动识别
|
||||
|
||||
# V1.0.1
|
||||
|
||||
- 增强拖拽功能和chrome设置功能
|
||||
|
||||
# V0.14.0
|
||||
|
||||
- Drission类增加代理设置和修改
|
||||
|
||||
# V0.12.4
|
||||
|
||||
- click()的by_js可接收False
|
||||
- 修复一些bug
|
||||
|
||||
# V0.12.0
|
||||
|
||||
- 增加tag:tagName@arg=val查找元素方式
|
||||
- MixPage增加简易方式创建对象方式
|
||||
|
||||
# V0.11.0
|
||||
|
||||
- 完善easy_set的函数
|
||||
- 元素增加多级定位函数
|
||||
|
||||
# v0.10.2
|
||||
|
||||
- 完善attr及attrs功能
|
||||
|
||||
# v0.10.1
|
||||
|
||||
- 增加set_headless以及to_iframe兼容全部原生参数
|
||||
|
||||
# v0.9.4
|
||||
|
||||
- 修复bug
|
||||
|
||||
# v0.9.0
|
||||
|
||||
- 增加了元素拖拽和处理提示框功能
|
||||
|
||||
# v0.8.4
|
||||
|
||||
- 基本完成
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
```python
|
||||
url = 'https://www.baidu.com/img/flexible/logo/pc/result.png'
|
||||
save_path = r'C:\download'
|
||||
page.download(url, save_path)
|
||||
```
|
||||
@ -1,39 +0,0 @@
|
||||
以下代码实现一模一样的功能，对比两者的代码量：
|
||||
|
||||
- 获取元素内容
|
||||
|
||||
```python
|
||||
url = 'https://baike.baidu.com/item/python'
|
||||
|
||||
# 使用 requests：
|
||||
from lxml import etree
|
||||
headers = {'User-Agent':'Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36'}
|
||||
response = requests.get(url, headers = headers)
|
||||
html = etree.HTML(response.text)
|
||||
element = html.xpath('//h1')[0]
|
||||
title = element.text
|
||||
|
||||
# 使用 DrissionPage：
|
||||
page = MixPage('s')
|
||||
page.get(url)
|
||||
title = page('tag:h1').text
|
||||
```
|
||||
|
||||
Tips: DrissionPage 自带默认 headers
|
||||
|
||||
- 下载文件
|
||||
|
||||
```python
|
||||
url = 'https://www.baidu.com/img/flexible/logo/pc/result.png'
|
||||
save_path = r'C:\download'
|
||||
|
||||
# 使用 requests：
|
||||
r = requests.get(url)
|
||||
with open(f'{save_path}\\img.png', 'wb') as fd:
|
||||
for chunk in r.iter_content():
|
||||
fd.write(chunk)
|
||||
|
||||
# 使用 DrissionPage：
|
||||
page.download(url, save_path, 'img') # 支持重命名，处理文件名冲突
|
||||
```
|
||||
|
||||
@ -1,96 +0,0 @@
|
||||
以下代码实现一模一样的功能，对比两者的代码量：
|
||||
|
||||
- 用显性等待方式查找第一个文本包含 some text 的元素。
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
element = WebDriverWait(driver).until(ec.presence_of_element_located((By.XPATH, '//*[contains(text(), "some text")]')))
|
||||
|
||||
# 使用 DrissionPage：
|
||||
element = page('some text')
|
||||
```
|
||||
|
||||
- 跳转到第一个标签页
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
driver.switch_to.window(driver.window_handles[0])
|
||||
|
||||
# 使用 DrissionPage：
|
||||
page.to_tab(0)
|
||||
```
|
||||
|
||||
- 按文本选择下拉列表
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
from selenium.webdriver.support.select import Select
|
||||
select_element = Select(element)
|
||||
select_element.select_by_visible_text('text')
|
||||
|
||||
# 使用 DrissionPage：
|
||||
element.select('text')
|
||||
```
|
||||
|
||||
- 拖拽一个元素
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
ActionChains(driver).drag_and_drop(ele1, ele2).perform()
|
||||
|
||||
# 使用 DrissionPage：
|
||||
ele1.drag_to(ele2)
|
||||
```
|
||||
|
||||
- 滚动窗口到底部（保持水平滚动条不变）
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
driver.execute_script("window.scrollTo(document.documentElement.scrollLeft, document.body.scrollHeight);")
|
||||
|
||||
# 使用 DrissionPage：
|
||||
page.scroll_to('bottom')
|
||||
```
|
||||
|
||||
- 设置 headless 模式
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
options = webdriver.ChromeOptions()
|
||||
options.add_argument("--headless")
|
||||
|
||||
# 使用 DrissionPage：
|
||||
set_headless()
|
||||
```
|
||||
|
||||
- 获取伪元素内容
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
text = webdriver.execute_script('return window.getComputedStyle(arguments[0], "::after").getPropertyValue("content");', element)
|
||||
|
||||
# 使用 DrissionPage：
|
||||
text = element.after
|
||||
```
|
||||
|
||||
- 获取 shadow-root
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
shadow_element = webdriver.execute_script('return arguments[0].shadowRoot', element)
|
||||
|
||||
# 使用 DrissionPage：
|
||||
shadow_element = element.shadow_root
|
||||
```
|
||||
|
||||
- 用 xpath 直接获取属性或文本节点（返回文本）
|
||||
|
||||
```python
|
||||
# 使用 selenium：
|
||||
相当复杂
|
||||
|
||||
# 使用 DrissionPage：
|
||||
class_name = element('xpath://div[@id="div_id"]/@class')
|
||||
text = element('xpath://div[@id="div_id"]/text()[2]')
|
||||
```
|
||||
|
||||
@ -1,19 +0,0 @@
|
||||
用 selenium 登录网站，然后切换到 requests 读取网页。两者会共享登录信息。
|
||||
|
||||
```python
|
||||
page = MixPage() # 创建页面对象，默认 driver 模式
|
||||
page.get('https://gitee.com/profile') # 访问个人中心页面（未登录，重定向到登录页面）
|
||||
|
||||
page.ele('@id:user_login').input('your_user_name') # 使用 selenium 输入账号密码登录
|
||||
page.ele('@id:user_password').input('your_password\n')
|
||||
sleep(1)
|
||||
|
||||
page.change_mode() # 切换到 session 模式
|
||||
print('登录后title：', page.title, '\n') # 登录后 session 模式的输出
|
||||
```
|
||||
|
||||
输出：
|
||||
|
||||
```
|
||||
登录后title： 个人资料 - 码云 Gitee.com
|
||||
```
|
||||
@ -1,22 +0,0 @@
|
||||
```python
|
||||
# 接上段代码
|
||||
foot = page.ele('@id:footer-left') # 用 id 查找元素
|
||||
first_col = foot.ele('css:>div') # 使用 css selector 在元素的下级中查找元素（第一个）
|
||||
lnk = first_col.ele('text:命令学') # 使用文本内容查找元素
|
||||
text = lnk.text # 获取元素文本
|
||||
href = lnk.attr('href') # 获取元素属性值
|
||||
|
||||
print(text, href, '\n')
|
||||
|
||||
# 简洁模式串联查找
|
||||
text = page('@id:footer-left')('css:>div')('text:命令学').text
|
||||
print(text)
|
||||
```
|
||||
|
||||
输出：
|
||||
|
||||
```
|
||||
Git 命令学习 https://oschina.gitee.io/learn-git-branching/
|
||||
|
||||
Git 命令学习
|
||||
```
|
||||
63
docs/简介.md
63
docs/简介.md
@ -1,63 +0,0 @@
|
||||
# 简介
|
||||
|
||||
DrissionPage，即 driver 和 session 组合而成的 page。
|
||||
是个基于 python 的 Web 自动化操作集成工具。
|
||||
它用 POM 模式封装了页面和元素常用的方法，
|
||||
自带一套简洁直观优雅的元素定位语法，
|
||||
实现了 selenium 和 requests 之间的无缝切换，
|
||||
可兼顾 selenium 的便利性和 requests 的高效率，
|
||||
更棒的是，它的使用方式非常简洁和人性化，代码量少，对新手友好。
|
||||
|
||||
**项目地址：**
|
||||
|
||||
- https://github.com/g1879/DrissionPage
|
||||
- https://gitee.com/g1879/DrissionPage
|
||||
|
||||
**示例地址：** [使用DrissionPage的网页自动化及爬虫示例](https://gitee.com/g1879/DrissionPage-demos)
|
||||
|
||||
**联系邮箱：** g1879@qq.com **QQ交流群：** 897838127
|
||||
|
||||
# 背景
|
||||
|
||||
requests 爬虫面对要登录的网站时，要分析数据包、JS 源码，构造复杂的请求，往往还要应付验证码、JS 混淆、签名参数等反爬手段，门槛较高。若数据是由 JS 计算生成的，还须重现计算过程，体验不好，开发效率不高。
|
||||
使用 selenium，可以很大程度上绕过这些坑，但 selenium 效率不高。因此，这个库将 selenium 和 requests 合而为一，不同须要时切换相应模式，并提供一种人性化的使用方法，提高开发和运行效率。
|
||||
除了合并两者，本库还以网页为单位封装了常用功能，简化了 selenium 的操作和语句，在用于网页自动化操作时，减少考虑细节，专注功能实现，使用更方便。
|
||||
|
||||
# 特性
|
||||
|
||||
- 代码高度集成，以简洁的代码为第一追求。
|
||||
- 页面对象可在 selenium 和 requests 模式间任意切换，保留登录状态。
|
||||
- 极简单但强大的元素定位语法，支持链式操作，代码极其简洁。
|
||||
- 两种模式提供一致的 API，使用体验一致。
|
||||
- 使用 POM 模式封装，便于扩展。
|
||||
- 兼容 selenium 代码，便于项目迁移。
|
||||
- 人性化设计，集成众多实用功能，大大降低开发工作量。
|
||||
|
||||
# 亮点功能
|
||||
|
||||
作者有多年自动化和爬虫经验，踩过无数坑，总结出的经验全写到这个库里。内置了N多实用功能，对常用功能作了整合和优化。使用时可以更专注业务逻辑，减少重复操作。大概罗列一下：
|
||||
|
||||
- 每次运行程序可以反复使用已经打开的浏览器。如手动设置网页到某个状态，再用程序接管，或手动处理登录，再用程序爬内容。无须每次运行从头启动浏览器，超级方便。
|
||||
- 使用 ini 文件保存常用配置，自动调用，也提供便捷的设置api，远离繁杂的配置项。
|
||||
- 极致简明的定位语法，支持直接按文本定位元素，支持直接获取前后兄弟元素和父元素等。
|
||||
- 强大的下载工具，操作浏览器时也能享受快捷可靠的下载功能。
|
||||
- 下载工具支持多种方式处理文件名冲突、自动创建目标路径、断链重试等。
|
||||
- 访问网址带自动重试功能，可设置间隔和超时时间。
|
||||
- 访问网页能自动识别编码，无须手动设置。
|
||||
- 链接参数默认自动生成 Host 和 Referer 属性。
|
||||
- 可随时直接隐藏或显示浏览器进程窗口，非 headless 或最小化。
|
||||
- 可自动下载合适版本的 chromedriver，免去麻烦的配置。
|
||||
- d 模式查找元素内置等待，可任意设置全局等待时间或单次查找等待时间。
|
||||
- 点击元素集成 js 点击方式，一个参数即可切换点击方式。
|
||||
- 点击支持失败重试，可用于保证点击成功、判读网页遮罩层是否消失等。
|
||||
- 输入文本能自动判断是否成功并重试，避免某些情况下输入或清空失效的情况。
|
||||
- d 模式下支持全功能的 xpath，可直接获取元素的某个属性，selenium 原生无此功能。
|
||||
- 支持直接获取 shadow-root，和普通元素一样操作其下的元素。
|
||||
- 支持直接获取 after 和 before 伪元素的内容。
|
||||
- 可以在元素下直接使用 > 以 css selector 方式获取当前元素直接子元素。原生不支持这种写法。
|
||||
- 可简单地使用 lxml 来解析 d 模式的页面或元素，爬取复杂页面数据时速度大幅提高。
|
||||
- 输出的数据均已转码及处理基本排版，减少重复劳动。
|
||||
- 可方便地与 selenium 或 requests 原生代码对接，便于项目迁移。
|
||||
- 使用 POM 模式封装，可直接用于测试，便于扩展。
|
||||
- d 模式配置可同时兼容 debugger 和其它参数，原生不能兼容。
|
||||
- 还有很多这里不一一列举…………
|
||||
19
docs/项目结构.md
19
docs/项目结构.md
@ -1,19 +0,0 @@
|
||||
## 结构图
|
||||
|
||||
|
||||
|
||||
## Drission 类
|
||||
|
||||
管理负责与网页通讯的 WebDriver 对象和 Session 对象，相当于驱动器的角色。
|
||||
|
||||
## MixPage 类
|
||||
|
||||
MixPage 封装了页面操作的常用功能，它调用 Drission 类中管理的驱动器，对页面进行访问、操作。可在 driver 和 session 模式间切换。切换的时候会自动同步登录状态。
|
||||
|
||||
## DriverElement 类
|
||||
|
||||
driver 模式下的页面元素类，可对元素进行点击、输入文本、修改属性、运行 js 等操作，也可在其下级搜索后代元素。
|
||||
|
||||
## SessionElement 类
|
||||
|
||||
session 模式下的页面元素类，可获取元素属性值，也可在其下级搜索后代元素。
|
||||
@ -1,4 +0,0 @@
|
||||
- 剩爪（感谢建群）
|
||||
- 激石网页设计-小徐（感谢找bug和提建议）
|
||||
- Bumblebee47大怪兽47（感谢测试）
|
||||
- kkjj828（感谢建议）
|
||||
Loading…
x
Reference in New Issue
Block a user