Initial commit

This commit is contained in:
Alex committed 2026-11-02 22:54:14 +08:00
commit 57fc3525eb
7311 files changed
+1291398

No files matched your search

@@ -0,0 +1,255 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from pathlib import Path
from time import sleep, perf_counter
from .._functions.keys import modifierBit, make_input_data, input_text_or_keys, Keys
from .._functions.settings import Settings as _S
from .._functions.web import location_in_viewport
class Actions:
def __init__(self, owner):
self.owner = owner
self._dr = owner.driver
self.modifier = 0 # 修饰符,Alt=1, Ctrl=2, Meta/Command=4, Shift=8
self.curr_x = 0 # 视口坐标
self.curr_y = 0
self._holding = 'left'
def move_to(self, ele_or_loc, offset_x=None, offset_y=None, duration=.5):
is_loc = False
mid_point = offset_x == offset_y is None
if offset_x is None:
offset_x = 0
if offset_y is None:
offset_y = 0
if isinstance(ele_or_loc, (tuple, list)):
is_loc = True
lx = ele_or_loc[0] + offset_x
ly = ele_or_loc[1] + offset_y
elif isinstance(ele_or_loc, str) or ele_or_loc._type == 'ChromiumElement':
ele_or_loc = self.owner(ele_or_loc)
self.owner.scroll.to_see(ele_or_loc)
x, y = ele_or_loc.rect.midpoint if mid_point else ele_or_loc.rect.location
lx = x + offset_x
ly = y + offset_y
else:
raise ValueError(_S._lang.join(_S._lang.INCORRECT_TYPE_, 'ele_or_loc',
ALLOW_TYPE=_S._lang.ELE_LOC_FORMAT, CURR_VAL=ele_or_loc))
if not location_in_viewport(self.owner, lx, ly):
# 把坐标滚动到页面中间
clientWidth = self.owner._run_js('return document.body.clientWidth;')
clientHeight = self.owner._run_js('return document.body.clientHeight;')
self.owner.scroll.to_location(lx - clientWidth // 2, ly - clientHeight // 2)
# 这样设计为了应付那些不随滚动条滚动的元素
if is_loc:
cx, cy = location_to_client(self.owner, lx, ly)
else:
x, y = ele_or_loc.rect.viewport_midpoint if mid_point else ele_or_loc.rect.viewport_location
cx = x + offset_x
cy = y + offset_y
ox = cx - self.curr_x
oy = cy - self.curr_y
self.move(ox, oy, duration)
return self
def move(self, offset_x=0, offset_y=0, duration=.5):
duration = .02 if duration < .02 else duration
num = int(duration * 50)
points = [(self.curr_x + i * (offset_x / num),
self.curr_y + i * (offset_y / num)) for i in range(1, num)]
points.append((self.curr_x + offset_x, self.curr_y + offset_y))
for x, y in points:
t = perf_counter()
self.curr_x = x
self.curr_y = y
self._dr.run('Input.dispatchMouseEvent', type='mouseMoved', button=self._holding,
x=self.curr_x, y=self.curr_y, modifiers=self.modifier)
ss = .02 - perf_counter() + t
if ss > 0:
sleep(ss)
return self
def click(self, on_ele=None, times=1):
self._hold(on_ele, 'left', times).wait(.05)._release('left')
return self
def r_click(self, on_ele=None, times=1):
self._hold(on_ele, 'right', times).wait(.05)._release('right')
return self
def m_click(self, on_ele=None, times=1):
self._hold(on_ele, 'middle', times).wait(.05)._release('middle')
return self
def hold(self, on_ele=None):
self._hold(on_ele, 'left')
return self
def release(self, on_ele=None):
if on_ele:
self.move_to(on_ele, duration=.2)
self._release('left')
return self
def r_hold(self, on_ele=None):
self._hold(on_ele, 'right')
return self
def r_release(self, on_ele=None):
if on_ele:
self.move_to(on_ele, duration=.2)
self._release('right')
return self
def m_hold(self, on_ele=None):
self._hold(on_ele, 'middle')
return self
def m_release(self, on_ele=None):
if on_ele:
self.move_to(on_ele, duration=.2)
self._release('middle')
return self
def _hold(self, on_ele=None, button='left', count=1):
if on_ele:
self.move_to(on_ele, duration=.2)
self._dr.run('Input.dispatchMouseEvent', type='mousePressed', button=button, clickCount=count,
x=self.curr_x, y=self.curr_y, modifiers=self.modifier)
self._holding = button
return self
def _release(self, button):
self._dr.run('Input.dispatchMouseEvent', type='mouseReleased', button=button, clickCount=1,
x=self.curr_x, y=self.curr_y, modifiers=self.modifier)
self._holding = 'left'
return self
def scroll(self, delta_y=0, delta_x=0, on_ele=None):
if on_ele:
self.move_to(on_ele, duration=.2)
self._dr.run('Input.dispatchMouseEvent', type='mouseWheel', x=self.curr_x, y=self.curr_y,
deltaX=delta_x, deltaY=delta_y, modifiers=self.modifier)
return self
def up(self, pixel):
return self.move(0, -pixel)
def down(self, pixel):
return self.move(0, pixel)
def left(self, pixel):
return self.move(-pixel, 0)
def right(self, pixel):
return self.move(pixel, 0)
def key_down(self, key):
key = getattr(Keys, key.upper(), key)
if key in ('\ue009', '\ue008', '\ue00a', '\ue03d'): # 如果上修饰符,添加到变量
self.modifier |= modifierBit.get(key, 0)
return self
data = make_input_data(self.modifier, key, False)
if not data:
raise ValueError(_S._lang.join(_S._lang.NO_SUCH_KEY_, key))
self.owner._run_cdp('Input.dispatchKeyEvent', **data)
return self
def key_up(self, key):
key = getattr(Keys, key.upper(), key)
if key in ('\ue009', '\ue008', '\ue00a', '\ue03d'): # 如果上修饰符,添加到变量
self.modifier ^= modifierBit.get(key, 0)
return self
data = make_input_data(self.modifier, key, True)
if not data:
raise ValueError(_S._lang.join(_S._lang.NO_SUCH_KEY_, key))
self.owner._run_cdp('Input.dispatchKeyEvent', **data)
return self
def type(self, keys, interval=0):
modifiers = []
if not isinstance(keys, (str, tuple, list)):
keys = str(keys)
for i in keys:
for character in i:
if character in ('\ue009', '\ue008', '\ue00a', '\ue03d'):
self.modifier |= modifierBit.get(character, 0)
modifiers.append(character)
data = make_input_data(self.modifier, character, False)
if data:
self.owner._run_cdp('Input.dispatchKeyEvent', **data)
if character not in ('\ue009', '\ue008', '\ue00a', '\ue03d'):
data['type'] = 'keyUp'
self.owner._run_cdp('Input.dispatchKeyEvent', **data)
else:
self.owner._run_cdp('Input.dispatchKeyEvent', type='char', text=character)
sleep(interval)
for m in modifiers:
self.key_up(m)
return self
def input(self, text):
input_text_or_keys(self.owner, text)
return self
def drag_in(self, ele_or_loc, files=None, text=None, title=None, baseURL=None):
ele_or_loc = self.owner(ele_or_loc)
x, y = ele_or_loc.rect.viewport_midpoint
if files:
items = []
paths = []
if isinstance(files, str):
files = [files]
for file in files:
path = str(Path(file).absolute())
item = {'mimeType': 'text/plain', 'data': path}
items.append(item)
paths.append(path)
data = {'items': items, 'files': paths, 'dragOperationsMask': 16}
elif text:
item = {'data': text}
if title is not None:
item['title'] = title
item['mimeType'] = 'text/uri-list'
elif baseURL is not None:
item['baseURL'] = baseURL
item['mimeType'] = 'text/uri-list'
else:
item['mimeType'] = 'text/plain'
data = {'items': [item], 'dragOperationsMask': 1}
else:
raise ValueError(_S._lang.NEED_FILES_OR_TEXT_ARG)
self._dr.run('Input.dispatchDragEvent', type='dragEnter', x=x, y=y, data=data, modifiers=self.modifier)
self._dr.run('Input.dispatchDragEvent', type='drop', x=x, y=y, data=data, modifiers=self.modifier)
return self
def wait(self, second, scope=None):
self.owner.wait(second=second, scope=scope)
return self
def location_to_client(page, lx, ly):
scroll_x = page._run_js('return document.documentElement.scrollLeft;')
scroll_y = page._run_js('return document.documentElement.scrollTop;')
return lx - scroll_x, ly - scroll_y
@@ -0,0 +1,264 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from typing import Union, Tuple, Any, Literal
from .._base.driver import Driver
from .._elements.chromium_element import ChromiumElement
from .._pages.chromium_base import ChromiumBase
KEYS = Literal['NULL', 'CANCEL', 'HELP', 'BACKSPACE', 'meta',
'TAB', 'CLEAR', 'RETURN', 'ENTER', 'SHIFT', 'CONTROL', 'command ',
'CTRL', 'ALT', 'PAUSE', 'ESCAPE', 'SPACE',
'PAGE_UP', 'PAGE_DOWN', 'END', 'HOME', 'LEFT', 'UP',
'RIGHT', 'DOWN', 'INSERT',
'DELETE', 'DEL', 'SEMICOLON', 'EQUALS', 'NUMPAD0', 'NUMPAD1', 'NUMPAD2',
'NUMPAD3', 'NUMPAD4', 'NUMPAD5', 'NUMPAD6', 'NUMPAD7', 'NUMPAD8', 'NUMPAD9',
'MULTIPLY', 'ADD', 'SUBTRACT', 'DECIMAL', 'DIVIDE', 'F1', 'F2',
'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'F10', 'F11', 'F12', 'META', 'COMMAND ',
'null', 'cancel', 'help', 'backspace', 'tab', 'clear', 'return', 'enter',
'shift', 'control', 'ctrl', 'alt', 'pause',
'escape', 'space', 'page_up', 'page_down', 'end', 'home', 'left', 'up',
'right', 'down', 'insert', 'delete', 'del',
'semicolon', 'equals', 'numpad0', 'numpad1', 'numpad2', 'numpad3', 'numpad4', 'numpad5',
'numpad6', 'numpad7', 'numpad8', 'numpad9', 'multiply', 'add', 'subtract', 'decimal',
'divide', 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10', 'f11', 'f12',
'\ue000', '\ue002', '\ue003', '\ue004', '\ue005', '\ue006', '\ue007', '\ue008', '\ue009',
'\ue009', '\ue00a', '\ue00b', '\ue00c', '\ue00d', '\ue00e', '\ue00f', '\ue010', '\ue011',
'\ue012', '\ue013', '\ue014', '\ue015', '\ue016', '\ue017', '\ue017', '\ue018', '\ue019',
'\ue01a', '\ue01b', '\ue01c', '\ue01d', '\ue01e', '\ue01f', '\ue020', '\ue021', '\ue022',
'\ue023', '\ue024', '\ue025', '\ue027', '\ue028', '\ue029', '\ue031', '\ue032', '\ue033', '\ue034',
'\ue035', '\ue036', '\ue037', '\ue038', '\ue039', '\ue03a', '\ue03b', '\ue03c', '\ue03d', '\ue03d',
'`', '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', '-', '=', 'q', 'w',
'e', 'r', 't', 'y', 'u', 'i', 'o', 'p', '[', ']', '\\', 'a', 's', 'd', 'f',
'g', 'h', 'j', 'k', 'l', ';', '\'', 'z', 'x', 'c', 'v', 'b', 'n', 'm', ',',
'.', '/', '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+',
'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 'O', 'P', '{', '}', 'A', 'S', 'D',
'F', 'G', 'H', 'J', 'K', 'L', ':', '"', 'Z', 'X', 'C', 'V', 'B', 'N', 'M', '<', '>', '?'
]
class Actions:
"""用于实现动作链的类"""
owner: ChromiumBase = ...
_dr: Driver = ...
modifier: int = ...
curr_x: float = ...
curr_y: float = ...
_holding: str = ...
def __init__(self, owner: ChromiumBase):
"""
:param owner: ChromiumBase对象
"""
...
def move_to(self, ele_or_loc: Union[ChromiumElement, Tuple[float, float], str],
offset_x: float = 0, offset_y: float = 0, duration: float = .5) -> Actions:
"""鼠标移动到元素中点,或页面上的某个绝对坐标。可设置偏移量
当带偏移量时,偏移量相对于元素左上角坐标
:param ele_or_loc: 元素对象、绝对坐标或文本定位符,坐标为tuple(int, int)形式
:param offset_x: 偏移量x
:param offset_y: 偏移量y
:param duration: 拖动用时,传入0即瞬间到达
:return: 动作链对象本身
"""
...
def move(self, offset_x: float = 0, offset_y: float = 0, duration: float = .5) -> Actions:
"""鼠标相对当前位置移动若干位置
:param offset_x: 偏移量x
:param offset_y: 偏移量y
:param duration: 拖动用时,传入0即瞬间到达
:return: 动作链对象本身
"""
...
def click(self, on_ele: Union[ChromiumElement, str] = None, times: int = 1) -> Actions:
"""点击鼠标左键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:param times: 点击次数
:return: 动作链对象本身
"""
...
def r_click(self, on_ele: Union[ChromiumElement, str] = None, times: int = 1) -> Actions:
"""点击鼠标右键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:param times: 点击次数
:return: 动作链对象本身
"""
...
def m_click(self, on_ele: Union[ChromiumElement, str] = None, times: int = 1) -> Actions:
"""点击鼠标中键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:param times: 点击次数
:return: 动作链对象本身
"""
...
def hold(self, on_ele: Union[ChromiumElement, str] = None) -> Actions:
"""按住鼠标左键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:return: 动作链对象本身
"""
...
def release(self, on_ele: Union[ChromiumElement, str] = None) -> Actions:
"""释放鼠标左键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:return: 动作链对象本身
"""
...
def r_hold(self, on_ele: Union[ChromiumElement, str] = None) -> Actions:
"""按住鼠标右键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:return: 动作链对象本身
"""
...
def r_release(self, on_ele: Union[ChromiumElement, str] = None) -> Actions:
"""释放鼠标右键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:return: 动作链对象本身
"""
...
def m_hold(self, on_ele: Union[ChromiumElement, str] = None) -> Actions:
"""按住鼠标中键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:return: 动作链对象本身
"""
...
def m_release(self, on_ele: Union[ChromiumElement, str] = None) -> Actions:
"""释放鼠标中键,可先移动到元素上
:param on_ele: ChromiumElement元素或文本定位符
:return: 动作链对象本身
"""
...
def _hold(self,
on_ele: Union[ChromiumElement, str] = None,
button: str = 'left',
count: int = 1) -> Actions:
"""按下鼠标按键
:param on_ele: ChromiumElement元素或文本定位符
:param button: 要按下的按键
:param count: 点击次数
:return: 动作链对象本身
"""
...
def _release(self, button: str) -> Actions:
"""释放鼠标按键
:param button: 要释放的按键
:return: 动作链对象本身
"""
...
def scroll(self, delta_y: int = 0, delta_x: int = 0,
on_ele: Union[ChromiumElement, str] = None) -> Actions:
"""滚动鼠标滚轮,可先移动到元素上
:param delta_y: 滚轮变化值y
:param delta_x: 滚轮变化值x
:param on_ele: ChromiumElement元素
:return: 动作链对象本身
"""
...
def up(self, pixel: int) -> Actions:
"""鼠标向上移动若干像素
:param pixel: 鼠标移动的像素值
:return: 动作链对象本身
"""
...
def down(self, pixel: int) -> Actions:
"""鼠标向下移动若干像素
:param pixel: 鼠标移动的像素值
:return: 动作链对象本身
"""
...
def left(self, pixel: int) -> Actions:
"""鼠标向左移动若干像素
:param pixel: 鼠标移动的像素值
:return: 动作链对象本身
"""
...
def right(self, pixel: int) -> Actions:
"""鼠标向右移动若干像素
:param pixel: 鼠标移动的像素值
:return: 动作链对象本身
"""
...
def key_down(self, key: Union[KEYS, str]) -> Actions:
"""按下键盘上的按键,
:param key: 使用Keys获取的按键,或 'DEL' 形式按键名称
:return: 动作链对象本身
"""
...
def key_up(self, key: Union[KEYS, str]) -> Actions:
"""提起键盘上的按键
:param key: 按键,特殊字符见Keys
:return: 动作链对象本身
"""
...
def type(self,
keys: Union[KEYS, str, list, tuple],
interval: float = 0) -> Actions:
"""用模拟键盘按键方式输入文本,可输入字符串,也可输入组合键
:param keys: 要按下的按键,特殊字符和多个文本可用list或tuple传入
:param interval: 每个字符之间间隔时间
:return: 动作链对象本身
"""
...
def input(self, text: Any) -> Actions:
"""输入文本,也可输入组合键,组合键用tuple形式输入
:param text: 文本值或按键组合
:return: 动作链对象本身
"""
...
def drag_in(self, ele_or_loc: Union[str, ChromiumElement], files: Union[str, list, tuple] = None,
text: str = None, title: str = None, baseURL: str = None) -> Actions:
"""触发从浏览器外拖入文件、文本等事件
:param ele_or_loc: 接收拖动动作的元素
:param files: 要拖入文件路径,可多个,不为None时下面参数无效
:param text: 要拖入的文本,files参数为None时才生效
:param title: 如果text是超链接,可在此设置title,与baseURL互斥
:param baseURL: 如果text是html,可在此设置baseUrl,与title互斥
:return:
"""
...
def wait(self, second: float, scope: float = None) -> Actions:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: None
"""
...
def location_to_client(page: ChromiumBase, lx: int, ly: int) -> tuple:
"""绝对坐标转换为视口坐标
:param page: 页面对象
:param lx: 绝对坐标x
:param ly: 绝对坐标y
:return: 视口坐标元组
"""
...
@@ -0,0 +1,209 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from pathlib import Path
from time import perf_counter, sleep
from .waiter import wait_mission
from .._functions.settings import Settings as _S
from .._functions.web import offset_scroll
from .._units.downloader import TabDownloadSettings
from ..errors import CanNotClickError, CDPError, NoRectError, AlertExistsError
class Clicker(object):
def __init__(self, ele):
self._ele = ele
def __call__(self, by_js=False, timeout=1.5, wait_stop=True):
return self.left(by_js, timeout, wait_stop)
def left(self, by_js=False, timeout=1.5, wait_stop=True):
if self._ele.tag == 'option':
if not self._ele.states.is_selected:
self._ele.parent('t:select').select.by_option(self._ele)
else:
select = self._ele.parent('t:select')
if select.select.is_multi:
self._ele.parent('t:select').select.cancel_by_option(self._ele)
return self._ele
if not by_js: # 模拟点击
can_click = False
if timeout is None:
timeout = self._ele.timeout
rect = None
if timeout == 0:
try:
self._ele.scroll.to_see()
if self._ele.states.is_enabled and self._ele.states.is_displayed:
rect = self._ele.rect.viewport_corners
can_click = True
except NoRectError:
if by_js is False:
raise
else:
rect = self._ele.states.has_rect
end_time = perf_counter() + timeout
while not rect and perf_counter() < end_time:
rect = self._ele.states.has_rect
sleep(.001)
if wait_stop and rect:
self._ele.wait.stop_moving(timeout=end_time - perf_counter())
if rect:
self._ele.scroll.to_see()
rect = self._ele.rect.corners
while perf_counter() < end_time:
if self._ele.states.is_enabled and self._ele.states.is_displayed:
can_click = True
break
sleep(.001)
elif by_js is False:
raise NoRectError
if can_click and not self._ele.states.is_in_viewport:
by_js = True
elif can_click and (by_js is False or not self._ele.states.is_covered):
x = rect[1][0] - (rect[1][0] - rect[0][0]) / 2
y = rect[0][0] + 3
try:
r = self._ele.owner._run_cdp('DOM.getNodeForLocation', x=int(x), y=int(y),
includeUserAgentShadowDOM=True, ignorePointerEventsNone=True)
if r['backendNodeId'] != self._ele._backend_id:
vx, vy = self._ele.rect.viewport_midpoint
else:
vx, vy = self._ele.rect.viewport_click_point
except CDPError:
vx, vy = self._ele.rect.viewport_midpoint
self._click(vx, vy)
return self._ele
if by_js is not False:
self._ele._run_js('this.click();')
return self._ele
if _S.raise_when_click_failed:
raise CanNotClickError
return False
def right(self):
self._ele.owner.scroll.to_see(self._ele)
return self._click(*self._ele.rect.viewport_click_point, button='right')
def middle(self, get_tab=True):
self._ele.owner.scroll.to_see(self._ele)
curr_tid = self._ele.tab.browser._newest_tab_id
self._click(*self._ele.rect.viewport_click_point, button='middle')
if get_tab:
tid = self._ele.tab.browser.wait.new_tab(curr_tab=curr_tid)
if not tid:
raise RuntimeError(_S._lang.join(_S._lang.NO_NEW_TAB))
return self._ele.tab.browser._get_tab(tid, mix=self._ele.tab._type == 'MixTab')
def at(self, offset_x=None, offset_y=None, button='left', count=1):
self._ele.owner.scroll.to_see(self._ele)
if offset_x is None and offset_y is None:
w, h = self._ele.rect.size
offset_x = w // 2
offset_y = h // 2
return self._click(*offset_scroll(self._ele, offset_x, offset_y), button=button, count=count)
def multi(self, times=2):
return self.at(count=times)
def to_download(self, save_path=None, rename=None, suffix=None, new_tab=None, by_js=False, timeout=None):
if not self._ele.tab._browser._dl_mgr._running:
self._ele.tab._browser.set.download_path('.')
when_file_exists = None
tmp_path = None
if self._ele.tab._type.endswith('Page'):
obj = browser = self._ele.owner._browser
tid = 'browser'
elif new_tab:
obj = browser = self._ele.owner._browser
tid = 'browser'
t_settings = TabDownloadSettings(self._ele.owner.tab_id)
b_settings = TabDownloadSettings('browser')
when_file_exists = b_settings.when_file_exists
b_settings.when_file_exists = t_settings.when_file_exists
b_settings.rename = t_settings.rename
b_settings.suffix = t_settings.suffix
t_settings.rename = None
t_settings.suffix = None
if not save_path and b_settings.path != t_settings.path:
tmp_path = b_settings.path
b_settings.path = t_settings.path
else:
obj = self._ele.owner._tab
browser = obj.browser
browser._dl_mgr._waiting_tab.add(self._ele.owner.tab_id)
tid = obj.tab_id
if save_path:
tmp_path = obj.download_path
TabDownloadSettings(tid).path = str(Path(save_path).absolute())
if rename or suffix:
obj.set.download_file_name(rename, suffix)
if timeout is None:
timeout = obj.timeout
browser._dl_mgr.set_flag(tid, True)
self.left(by_js=by_js)
m = wait_mission(browser, tid, timeout)
if tmp_path:
TabDownloadSettings(tid).path = tmp_path
if when_file_exists:
browser.set.when_download_file_exists(when_file_exists)
if m and new_tab:
self._ele.owner.browser._dl_mgr._tab_missions.setdefault(self._ele.owner.tab_id, set()).add(m)
m.from_tab = self._ele.owner.tab_id
browser._dl_mgr._waiting_tab.discard(self._ele.owner.tab_id)
return m
def to_upload(self, file_paths, by_js=False):
self._ele.owner.set.upload_files(file_paths)
self.left(by_js=by_js)
self._ele.owner.wait.upload_paths_inputted()
def for_new_tab(self, by_js=False, timeout=3):
curr_tid = self._ele.tab.browser._newest_tab_id
self.left(by_js=by_js)
tid = self._ele.tab.browser.wait.new_tab(timeout=timeout, curr_tab=curr_tid)
if not tid:
raise RuntimeError(_S._lang.join(_S._lang.NO_NEW_TAB))
return self._ele.tab.browser._get_tab(tid, mix=self._ele.tab._type == 'MixTab')
def for_url_change(self, text=None, exclude=False, by_js=False, timeout=None):
if text is None:
exclude = True
text = self._ele.tab.url
self.left(by_js=by_js)
return True if self._ele.tab.wait.url_change(text=text, exclude=exclude, timeout=timeout) else False
def for_title_change(self, text=None, exclude=False, by_js=False, timeout=None):
if text is None:
exclude = True
text = self._ele.tab.title
self.left(by_js=by_js)
return True if self._ele.tab.wait.title_change(text=text, exclude=exclude, timeout=timeout) else False
def _click(self, view_x, view_y, button='left', count=1):
self._ele.owner._run_cdp('Input.dispatchMouseEvent', type='mousePressed', x=view_x,
y=view_y, button=button, clickCount=count, _ignore=AlertExistsError)
self._ele.owner._run_cdp('Input.dispatchMouseEvent', type='mouseReleased', x=view_x,
y=view_y, button=button, _ignore=AlertExistsError)
return self._ele
@@ -0,0 +1,147 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from pathlib import Path
from typing import Union
from .downloader import DownloadMission
from .._elements.chromium_element import ChromiumElement
from .._pages.chromium_tab import ChromiumTab
from .._pages.mix_tab import MixTab
class Clicker(object):
_ele: ChromiumElement = ...
def __init__(self, ele: ChromiumElement):
"""
:param ele: ChromiumElement
"""
...
def __call__(self, by_js: Union[bool, str, None] = False,
timeout: float = 1.5, wait_stop: bool = True) -> Union[ChromiumElement, False]:
"""点击元素
如果遇到遮挡,可选择是否用js点击
:param by_js: 是否用js点击,为None时先用模拟点击,遇到遮挡改用js,为True时直接用js点击,为False时只用模拟点击
:param timeout: 模拟点击的超时时间(秒),等待元素可见、可用、进入视口
:param wait_stop: 是否等待元素运动结束再执行点击
:return: 是否点击成功
"""
...
def left(self, by_js: Union[bool, str, None] = False,
timeout: float = 1.5, wait_stop: bool = True) -> Union[ChromiumElement, False]:
"""点击元素,可选择是否用js点击
:param by_js: 是否用js点击,为None时先用模拟点击,遇到遮挡改用js,为True时直接用js点击,为False时只用模拟点击
:param timeout: 模拟点击的超时时间(秒),等待元素可见、可用、进入视口
:param wait_stop: 是否等待元素运动结束再执行点击
:return: 是否点击成功
"""
...
def right(self) -> ChromiumElement:
"""右键单击"""
...
def middle(self, get_tab: bool = True) -> Union[ChromiumTab, MixTab, None]:
"""中键单击,默认返回新出现的tab对象
:param get_tab: 是否返回新tab对象,为False则返回None
:return: Tab对象或None
"""
...
def at(self,
offset_x: float = None,
offset_y: float = None,
button: str = 'left',
count: int = 1) -> ChromiumElement:
"""带偏移量点击本元素,相对于左上角坐标。不传入x或y值时点击元素中间点
:param offset_x: 相对元素左上角坐标的x轴偏移量
:param offset_y: 相对元素左上角坐标的y轴偏移量
:param button: 点击哪个键,可选 left, middle, right, back, forward
:param count: 点击次数
:return: None
"""
...
def multi(self, times: int = 2) -> ChromiumElement:
"""多次点击
:param times: 默认双击
:return: None
"""
...
def to_download(self,
save_path: Union[str, Path] = None,
rename: str = None,
suffix: str = None,
new_tab: bool = None,
by_js: bool = False,
timeout: float = None) -> DownloadMission:
"""点击触发下载
:param save_path: 保存路径,为None保存在原来设置的,如未设置保存到当前路径
:param rename: 重命名文件名
:param suffix: 指定文件后缀
:param new_tab: 下载任务是否从新标签页触发,为None会自动获取,如获取不到,设为True
:param by_js: 是否用js方式点击,逻辑与click()一致
:param timeout: 等待下载触发的超时时间,为None则使用页面对象设置
:return: DownloadMission对象
"""
...
def to_upload(self, file_paths: Union[str, Path, list, tuple], by_js: bool = False) -> None:
"""触发上传文件选择框并自动填入指定路径
:param file_paths: 文件路径,如果上传框支持多文件,可传入列表或字符串,字符串时多个文件用回车分隔
:param by_js: 是否用js方式点击,逻辑与click()一致
:return: None
"""
...
def for_new_tab(self, by_js: bool = False, timeout: float = 3) -> Union[ChromiumTab, MixTab]:
"""点击后等待新tab出现并返回其对象
:param by_js: 是否使用js点击,逻辑与click()一致
:param timeout: 等待超时时间
:return: 新标签页对象,如果没有等到新标签页出现则抛出异常
"""
...
def for_url_change(self, text: str = None, exclude: bool = False,
by_js: bool = False, timeout: float = None) -> bool:
"""点击并等待tab的url变成包含或不包含指定文本
:param text: 用于识别的文本,为None等待当前url变化
:param exclude: 是否排除,为True时当url不包含text指定文本时返回True,text为None时自动设为True
:param by_js: 是否用js点击
:param timeout: 超时时间(秒),为None使用页面设置
:return: 是否等待成功
"""
...
def for_title_change(self, text: str = None, exclude: bool = False,
by_js: bool = False, timeout: float = None) -> bool:
"""点击并等待tab的title变成包含或不包含指定文本
:param text: 用于识别的文本,为None等待当前title变化
:param exclude: 是否排除,为True时当title不包含text指定文本时返回True,text为None时自动设为True
:param by_js: 是否用js点击
:param timeout: 超时时间(秒),为None使用页面设置
:return: 是否等待成功
"""
...
def _click(self,
view_x: float,
view_y: float,
button: str = 'left',
count: int = 1) -> ChromiumElement:
"""实施点击
:param view_x: 视口x坐标
:param view_y: 视口y坐标
:param button: 'left' 'right' 'middle' 'back' 'forward'
:param count: 点击次数
:return: None
"""
...
@@ -0,0 +1,101 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from queue import Queue
from time import perf_counter, sleep
from .._functions.settings import Settings as _S
class Console(object):
def __init__(self, owner):
self._owner = owner
self._caught = None
self._not_enabled = True
self.listening = False
@property
def messages(self):
if self._caught is None:
return []
lst = []
while not self._caught.empty():
lst.append(self._caught.get_nowait())
return lst
def start(self):
self._caught = Queue(maxsize=0)
self._owner._driver.set_callback("Console.messageAdded", self._console)
if self._not_enabled:
self._owner._run_cdp("Console.enable")
self._not_enabled = False
self.listening = True
def stop(self):
if self.listening:
self._owner._driver.set_callback('Console.messageAdded', None)
self.listening = False
def clear(self):
self._caught = Queue(maxsize=0)
def wait(self, timeout=None):
if not self.listening:
raise RuntimeError(_S._lang.join(_S._lang.NOT_LISTENING))
if timeout is None:
while self._owner._driver.is_running and self.listening and not self._caught.qsize():
sleep(.03)
return self._caught.get_nowait() if self._caught.qsize() else None
else:
end = perf_counter() + timeout
while self._owner._driver.is_running and self.listening and perf_counter() < end:
if self._caught.qsize():
return self._caught.get_nowait()
sleep(0.05)
return False
def steps(self, timeout=None):
if timeout is None:
while self._owner._driver.is_running and self.listening:
if self._caught.qsize():
yield self._caught.get_nowait()
sleep(0.05)
else:
end = perf_counter() + timeout
while self._owner._driver.is_running and self.listening and perf_counter() < end:
if self._caught.qsize():
yield self._caught.get_nowait()
end = perf_counter() + timeout
sleep(0.05)
return False
def _console(self, **kwargs):
self._caught.put(ConsoleData(kwargs['message']))
class ConsoleData(object):
__slots__ = ('_data', 'source', 'level', 'text', 'url', 'line', 'column')
def __init__(self, data):
self._data = data
def __getattr__(self, item):
return self._data.get(item, None)
def __repr__(self):
return (f'<ConsoleData source={self.source} level={self.level} text={self.text} url={self.url} '
f'line={self.line} column={self.column} >')
@property
def body(self):
from json import loads
try:
return loads(self.text)
except:
return self._raw_body
@@ -0,0 +1,68 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from queue import Queue
from typing import Optional, Iterable, List, Union, Any
from .._pages.chromium_base import ChromiumBase
class Console(object):
listening: bool = ...
_owner: ChromiumBase = ...
_caught: Optional[Queue] = ...
_not_enabled: bool = ...
def __init__(self, owner: ChromiumBase) -> None:
"""
:param owner: 页面对象
"""
...
@property
def messages(self) -> List[ConsoleData]:
"""以list方式返回获取到的信息,返回后会清空列表"""
...
def start(self) -> None:
"""开启console监听"""
...
def stop(self) -> None:
"""停止监听,清空已监听到的列表"""
...
def clear(self) -> None:
"""清空已获取但未返回的信息"""
...
def wait(self, timeout: float = None) -> Union[ConsoleData, False]:
"""等待一条信息
:param timeout: 超时时间(秒)
:return: ConsoleData对象
"""
...
def steps(self, timeout: Optional[float] = None) -> Iterable[ConsoleData]:
"""每监听到一个信息就返回,用于for循环
:param timeout: 等待一个信息的超时时间,为None无限等待
:return: None
"""
...
def _console(self, **kwargs) -> None: ...
class ConsoleData(object):
__slots__ = ('_data', 'source', 'level', 'text', 'url', 'line', 'column')
def __init__(self, data: dict) -> None: ...
def __getattr__(self, item: str) -> str: ...
@property
def body(self) -> Any: ...
@@ -0,0 +1,100 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from .._functions.cookies import set_tab_cookies, set_session_cookies, set_browser_cookies
from .._functions.settings import Settings as _S
class BrowserCookiesSetter(object):
def __init__(self, owner):
self._owner = owner
def __call__(self, cookies):
set_browser_cookies(self._owner, cookies)
def clear(self):
self._owner._run_cdp('Storage.clearCookies')
class CookiesSetter(BrowserCookiesSetter):
def __call__(self, cookies):
set_tab_cookies(self._owner, cookies)
def remove(self, name, url=None, domain=None, path=None):
d = {'name': name}
if url is not None:
d['url'] = url
if domain is not None:
d['domain'] = domain
if not url and not domain:
d['url'] = self._owner.url
if not d['url'].startswith('http'):
raise ValueError(_S._lang.join(_S._lang.NEED_DOMAIN))
if path is not None:
d['path'] = path
self._owner._run_cdp('Network.deleteCookies', **d)
def clear(self):
self._owner._run_cdp('Network.clearBrowserCookies')
class SessionCookiesSetter(object):
def __init__(self, owner):
self._owner = owner
def __call__(self, cookies):
set_session_cookies(self._owner.session, cookies)
def remove(self, name):
self._owner.session.cookies.set(name, None)
def clear(self):
self._owner.session.cookies.clear()
class WebPageCookiesSetter(CookiesSetter):
def __call__(self, cookies):
if self._owner.mode == 'd' and self._owner._has_driver:
super().__call__(cookies)
elif self._owner.mode == 's' and self._owner._has_session:
set_session_cookies(self._owner.session, cookies)
def remove(self, name, url=None, domain=None, path=None):
if self._owner.mode == 'd' and self._owner._has_driver:
super().remove(name, url, domain, path)
elif self._owner.mode == 's' and self._owner._has_session:
if url or domain or path:
raise ValueError(_S._lang.join(_S._lang.D_MODE_ONLY))
self._owner.session.cookies.set(name, None)
def clear(self):
if self._owner.mode == 'd' and self._owner._has_driver:
super().clear()
elif self._owner.mode == 's' and self._owner._has_session:
self._owner.session.cookies.clear()
class MixTabCookiesSetter(CookiesSetter):
def __call__(self, cookies):
if self._owner._d_mode and self._owner._driver.is_running:
super().__call__(cookies)
elif not self._owner._d_mode and self._owner._session:
set_session_cookies(self._owner.session, cookies)
def remove(self, name, url=None, domain=None, path=None):
if self._owner._d_mode and self._owner._driver.is_running:
super().remove(name, url, domain, path)
elif not self._owner._d_mode and self._owner._session:
if url or domain or path:
raise ValueError(_S._lang.join(_S._lang.D_MODE_ONLY))
self._owner.session.cookies.set(name, None)
def clear(self):
if self._owner._d_mode and self._owner._driver.is_running:
super().clear()
elif not self._owner._d_mode and self._owner._session:
self._owner.session.cookies.clear()
@@ -0,0 +1,169 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from http.cookiejar import Cookie, CookieJar
from typing import Union
from .._base.chromium import Chromium
from .._pages.chromium_base import ChromiumBase
from .._pages.mix_tab import MixTab
from .._pages.session_page import SessionPage
from .._pages.web_page import WebPage
class BrowserCookiesSetter(object):
_owner: Chromium = ...
def __init__(self, owner: Chromium):
"""
:param owner: Chromium对象
"""
...
def __call__(self, cookies: Union[CookieJar, Cookie, list, tuple, str, dict]) -> None:
"""设置一个或多个cookie
:param cookies: cookies信息
:return: None
"""
...
def clear(self) -> None:
"""清除cookies"""
...
class CookiesSetter(BrowserCookiesSetter):
_owner: ChromiumBase = ...
def __init__(self, owner: ChromiumBase):
"""
:param owner: 页面对象
"""
...
def __call__(self, cookies: Union[CookieJar, Cookie, list, tuple, str, dict]) -> None:
"""设置一个或多个cookie
:param cookies: cookies信息
:return: None
"""
...
def remove(self,
name: str,
url: str = None,
domain: str = None,
path: str = None) -> None:
"""删除一个cookie
:param name: cookie的name字段
:param url: cookie的url字段,可选
:param domain: cookie的domain字段,可选
:param path: cookie的path字段,可选
:return: None
"""
...
def clear(self) -> None:
"""清除cookies"""
...
class SessionCookiesSetter(object):
_owner: SessionPage = ...
def __init__(self, owner: SessionPage):
"""
:param owner: SessionPage对象
"""
...
def __call__(self, cookies: Union[CookieJar, Cookie, list, tuple, str, dict]) -> None:
"""设置一个或多个cookie
:param cookies: cookies信息
:return: None
"""
...
def remove(self, name: str) -> None:
"""删除一个cookie
:param name: cookie的name字段
:return: None
"""
...
def clear(self) -> None:
"""清除cookies"""
...
class WebPageCookiesSetter(CookiesSetter, SessionCookiesSetter):
_owner: WebPage = ...
def __init__(self, owner: WebPage):
"""
:param owner: WebPage对象
"""
...
def __call__(self, cookies: Union[CookieJar, Cookie, list, tuple, str, dict]) -> None:
"""设置一个或多个cookie
:param cookies: cookies信息
:return: None
"""
...
def remove(self,
name: str,
url: str = None,
domain: str = None,
path: str = None) -> None:
"""删除一个cookie
:param name: cookie的name字段
:param url: cookie的url字段,可选,d模式时才有效
:param domain: cookie的domain字段,可选,d模式时才有效
:param path: cookie的path字段,可选,d模式时才有效
:return: None
"""
...
def clear(self) -> None:
"""清除cookies"""
...
class MixTabCookiesSetter(CookiesSetter, SessionCookiesSetter):
_owner: MixTab = ...
def __init__(self, owner: MixTab):
"""
:param owner: MixTab对象
"""
...
def __call__(self, cookies: Union[CookieJar, Cookie, list, tuple, str, dict]) -> None:
"""设置一个或多个cookie
:param cookies: cookies信息
:return: None
"""
...
def remove(self,
name: str,
url: str = None,
domain: str = None,
path: str = None) -> None:
"""删除一个cookie
:param name: cookie的name字段
:param url: cookie的url字段,可选,d模式时才有效
:param domain: cookie的domain字段,可选,d模式时才有效
:param path: cookie的path字段,可选,d模式时才有效
:return: None
"""
...
def clear(self) -> None:
"""清除cookies"""
...
@@ -0,0 +1,302 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from os.path import sep
from pathlib import Path
from shutil import move
from time import sleep, perf_counter
from DrissionRecord.tools import get_usable_path
from .._functions.settings import Settings as _S
class DownloadManager(object):
def __init__(self, browser):
self._browser = browser
t = TabDownloadSettings('browser')
t.path = self._browser.download_path
t.rename = None
t.suffix = None
t.when_file_exists = 'rename'
self._missions = {} # {guid: DownloadMission}
self._tab_missions = {} # {tab_id: [DownloadMission, ...]}
self._flags = {} # {tab_id: [bool, DownloadMission]}
self._waiting_tab = set() # click.to_download()专用
self._tmp_path = '.'
self._page_id = None
self._running = False
@property
def missions(self):
return self._missions
def set_path(self, tab, path):
tid = tab if isinstance(tab, str) else tab.tab_id
TabDownloadSettings(tid).path = path
if not self._running or tid == 'browser':
self._browser._driver.set_callback('Browser.downloadProgress', self._onDownloadProgress)
self._browser._driver.set_callback('Browser.downloadWillBegin', self._onDownloadWillBegin)
r = self._browser._run_cdp('Browser.setDownloadBehavior', downloadPath=self._browser._download_path,
behavior='allowAndName', eventsEnabled=True)
self._tmp_path = self._browser._download_path
if 'error' in r:
print(_S._lang.NOT_SUPPORT_DOWNLOAD)
self._running = True
@staticmethod
def set_rename(tab_id, rename=None, suffix=None):
ts = TabDownloadSettings(tab_id)
ts.rename = rename
ts.suffix = suffix
@staticmethod
def set_file_exists(tab_id, mode):
TabDownloadSettings(tab_id).when_file_exists = mode
def set_flag(self, tab_id, flag):
self._flags[tab_id] = flag
def get_flag(self, tab_id):
return self._flags.get(tab_id, None)
def get_tab_missions(self, tab_id):
return self._tab_missions.get(tab_id, set())
def set_done(self, mission, state, final_path=None):
if mission.state not in ('canceled', 'skipped'):
mission.state = state
mission.final_path = final_path
if mission.tab_id in self._tab_missions and mission in self._tab_missions[mission.tab_id]:
self._tab_missions[mission.tab_id].discard(mission)
if (mission.from_tab and mission.from_tab in self._tab_missions
and mission in self._tab_missions[mission.from_tab]):
self._tab_missions[mission.from_tab].discard(mission)
self._missions.pop(mission.id, None)
mission._is_done = True
def cancel(self, mission):
mission.state = 'canceled'
try:
self._browser._run_cdp('Browser.cancelDownload', guid=mission.id)
except:
pass
if mission.final_path:
Path(mission.final_path).unlink(True)
def skip(self, mission):
mission.state = 'skipped'
try:
self._browser._run_cdp('Browser.cancelDownload', guid=mission.id)
except:
pass
def clear_tab_info(self, tab_id):
self._tab_missions.pop(tab_id, None)
self._flags.pop(tab_id, None)
TabDownloadSettings.TABS.pop(tab_id, None)
self._waiting_tab.discard(tab_id)
def _onDownloadWillBegin(self, **kwargs):
guid = kwargs['guid']
tab_id = self._browser._frames.get(kwargs['frameId'], 'browser')
tab = 'browser' if tab_id in ('browser', self._page_id) or self.get_flag('browser') is not None else tab_id
opener = self._browser._relation.get(tab_id, None)
from_tab = None
if opener and opener in self._waiting_tab:
tab = from_tab = opener
settings = TabDownloadSettings(tab)
if settings.rename:
if settings.suffix is not None:
name = f'{settings.rename}.{settings.suffix}' if settings.suffix else settings.rename
else:
tmp = kwargs['suggestedFilename'].rsplit('.', 1)
ext_name = tmp[-1] if len(tmp) > 1 else ''
tmp = settings.rename.rsplit('.', 1)
ext_rename = tmp[-1] if len(tmp) > 1 else ''
name = settings.rename if ext_rename == ext_name else f'{settings.rename}.{ext_name}'
settings.rename = None
settings.suffix = None
elif settings.suffix is not None:
name = kwargs["suggestedFilename"].rsplit(".", 1)[0]
if settings.suffix:
name = f'{name}.{settings.suffix}'
settings.suffix = None
else:
name = kwargs['suggestedFilename']
skip = False
overwrite = None # 存在且重命名
goal_path = Path(settings.path) / name
if goal_path.exists():
if settings.when_file_exists == 'skip':
skip = True
elif settings.when_file_exists == 'overwrite':
overwrite = True # 存在且覆盖
else: # 不存在
overwrite = False
m = DownloadMission(self, tab_id, guid, settings.path, name, kwargs['url'], self._tmp_path, overwrite)
if from_tab:
m.from_tab = from_tab
self._tab_missions.setdefault(from_tab, set()).add(m)
self._missions[guid] = m
if self.get_flag('browser') is False or self.get_flag(tab) is False: # 取消该任务
self.cancel(m)
elif skip:
self.skip(m)
else:
self._tab_missions.setdefault(tab_id, set()).add(m)
if self.get_flag('browser') is not None:
self._flags['browser'] = m
elif self.get_flag(tab) is not None:
self._flags[tab] = m
def _onDownloadProgress(self, **kwargs):
if kwargs['guid'] in self._missions:
mission = self._missions[kwargs['guid']]
if kwargs['state'] == 'inProgress':
mission.received_bytes = kwargs['receivedBytes']
mission.total_bytes = kwargs['totalBytes']
elif kwargs['state'] == 'completed':
if mission.state == 'skipped':
Path(f'{mission.tmp_path}{sep}{mission.id}').unlink(True)
self.set_done(mission, 'skipped')
return
mission.received_bytes = kwargs['receivedBytes']
mission.total_bytes = kwargs['totalBytes']
form_path = f'{mission.tmp_path}{sep}{mission.id}'
if mission._overwrite is None:
to_path = str(get_usable_path(f'{mission.folder}{sep}{mission.name}'))
else:
to_path = f'{mission.folder}{sep}{mission.name}'
Path(mission.folder).mkdir(parents=True, exist_ok=True)
not_moved = True
for _ in range(10):
try:
move(form_path, to_path)
not_moved = False
break
except PermissionError:
sleep(.5)
if not_moved:
from shutil import copy
copy(form_path, to_path)
self.set_done(mission, 'completed', final_path=to_path)
else: # 'canceled'
self.set_done(mission, 'canceled')
class TabDownloadSettings(object):
TABS = {}
def __new__(cls, tab_id):
"""
:param tab_id: tab id
"""
if tab_id in cls.TABS:
return cls.TABS[tab_id]
return object.__new__(cls)
def __init__(self, tab_id):
if hasattr(self, '_created'):
return
self._created = True
self.tab_id = tab_id
self.rename = None
self.suffix = None
self.path = '' if tab_id == 'browser' else self.TABS['browser'].path
self.when_file_exists = 'rename' if tab_id == 'browser' else self.TABS['browser'].when_file_exists
TabDownloadSettings.TABS[tab_id] = self
class DownloadMission(object):
def __init__(self, mgr, tab_id, _id, folder, name, url, tmp_path, overwrite):
self._mgr = mgr
self.url = url
self.tab_id = tab_id
self.from_tab = None
self.id = _id
self.folder = folder
self.name = name
self.state = 'running'
self.total_bytes = None
self.received_bytes = 0
self.final_path = None
self.tmp_path = tmp_path
self._overwrite = overwrite
self._is_done = False
def __repr__(self):
return f'<DownloadMission {id(self)} {self.rate}>'
@property
def rate(self):
return round((self.received_bytes / self.total_bytes) * 100, 2) if self.total_bytes else None
@property
def is_done(self):
return self._is_done
def cancel(self):
self._mgr.cancel(self)
def wait(self, show=True, timeout=None, cancel_if_timeout=True):
if show:
print(f'url: {self.url}')
end_time = perf_counter()
while self.name is None and perf_counter() < end_time:
sleep(0.01)
print(f'{_S._lang.FILE_NAME}: {self.name or _S._lang.UNKNOWN}')
print(f'{_S._lang.FOLDER_PATH}: {self.folder}')
if timeout is None:
while not self.is_done:
if show:
print(f'\r{self.rate}% ', end='')
sleep(.2)
else:
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if show:
print(f'\r{self.rate}% ', end='')
sleep(.2)
if not self.is_done and cancel_if_timeout:
self.cancel()
if show:
if self.state == 'completed':
print('\r100% ', end='')
if self._overwrite is None:
print(f'{_S._lang.COMPLETED_AND_RENAME} {self.final_path}')
elif self._overwrite is False:
print(f'{_S._lang.DOWNLOAD_COMPLETED} {self.final_path}')
else:
print(f'{_S._lang.OVERWROTE} {self.final_path}')
elif self.state == 'canceled':
print(_S._lang.DOWNLOAD_CANCELED)
elif self.state == 'skipped':
print(f'{_S._lang.SKIPPED} {self.folder}{sep}{self.name}')
print()
return self.final_path if self.final_path else False
@@ -0,0 +1,207 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from typing import Dict, Optional, Union, Literal, Set
from .._base.chromium import Chromium
from .._pages.chromium_base import ChromiumBase
FILE_EXISTS = Literal['skip', 'rename', 'overwrite', 's', 'r', 'o']
class DownloadManager(object):
_browser: Chromium = ...
_missions: Dict[str, DownloadMission] = ...
_tab_missions: Dict[str, Set[DownloadMission]] = ...
_flags: dict = ...
_waiting_tab: set = ...
_running: bool = ...
_tmp_path: str = ...
_page_id: Optional[str] = ...
def __init__(self, browser: Chromium):
"""
:param browser: Browser对象
"""
...
@property
def missions(self) -> Dict[str, DownloadMission]:
"""返回所有未完成的下载任务"""
...
def set_path(self, tab: Union[str, ChromiumBase], path: str) -> None:
"""设置某个tab的下载路径
:param tab: 页面对象
:param path: 下载路径(绝对路径str)
:return: None
"""
...
@staticmethod
def set_rename(tab_id: str,
rename: str = None,
suffix: str = None) -> None:
"""设置某个tab的重命名文件名
:param tab_id: tab id
:param rename: 文件名,可不含后缀,会自动使用远程文件后缀
:param suffix: 后缀名,显式设置后缀名,不使用远程文件后缀
:return: None
"""
...
@staticmethod
def set_file_exists(tab_id: str, mode: FILE_EXISTS) -> None:
"""设置某个tab下载文件重名时执行的策略
:param tab_id: tab id
:param mode: 下载路径
:return: None
"""
...
def set_flag(self, tab_id: str, flag: Union[bool, DownloadMission, None]) -> None:
"""设置某个tab的重命名文件名
:param tab_id: tab id
:param flag: 等待标志
:return: None
"""
...
def get_flag(self, tab_id: str) -> Union[bool, DownloadMission, None]:
"""获取tab下载等待标记
:param tab_id: tab id
:return: 任务对象或False
"""
...
def get_tab_missions(self, tab_id: str) -> list:
"""获取某个tab正在下载的任务
:param tab_id:
:return: 下载任务组成的列表
"""
...
def set_done(self,
mission: DownloadMission,
state: str,
final_path: str = None) -> None:
"""设置任务结束
:param mission: 任务对象
:param state: 任务状态
:param final_path: 最终路径
:return: None
"""
...
def cancel(self, mission: DownloadMission) -> None:
"""取消任务
:param mission: 任务对象
:return: None
"""
...
def skip(self, mission: DownloadMission) -> None:
"""跳过任务
:param mission: 任务对象
:return: None
"""
...
def clear_tab_info(self, tab_id: str) -> None:
"""当tab关闭时清除有关信息
:param tab_id: 标签页id
:return: None
"""
...
def _onDownloadWillBegin(self, **kwargs) -> None:
"""用于获取弹出新标签页触发的下载任务"""
...
def _onDownloadProgress(self, **kwargs) -> None:
"""下载状态变化时执行"""
...
class TabDownloadSettings(object):
TABS: dict = ...
tab_id: str = ...
waiting_flag: Union[bool, dict, None] = ...
rename: Optional[str] = ...
suffix: Optional[str] = ...
path: Optional[str] = ...
when_file_exists: FILE_EXISTS = ...
def __init__(self, tab_id: str):
"""
:param tab_id: tab id
"""
...
class DownloadMission(object):
tab_id: str = ...
from_tab: Optional[str] = ...
_mgr: DownloadManager = ...
url: str = ...
id: str = ...
folder: str = ...
name: str = ...
state: str = ...
total_bytes: Optional[int] = ...
received_bytes: int = ...
final_path: Optional[str] = ...
tmp_path: str = ...
_overwrite: bool = ...
_is_done: bool = ...
def __init__(self,
mgr: DownloadManager,
tab_id: str,
_id: str,
folder: str,
name: str,
url: str,
tmp_path: str,
overwrite: bool):
"""
:param mgr: BrowserDownloadManager对象
:param tab_id: 标签页id
:param _id: 任务id
:param folder: 最终保存文件夹路径
:param name: 文件名
:param url: url
:param tmp_path: 下载临时路径
:param overwrite: 是否已存在同名文件,None表示重命名
"""
...
@property
def rate(self) -> float:
"""以百分比形式返回下载进度"""
...
@property
def is_done(self) -> bool:
"""返回任务是否在运行中"""
...
def cancel(self) -> None:
"""取消该任务,如任务已完成,删除已下载的文件"""
...
def wait(self,
show: bool = True,
timeout=None,
cancel_if_timeout=True) -> Union[bool, str]:
"""等待任务结束
:param show: 是否显示下载信息
:param timeout: 超时时间(秒),为None则无限等待
:param cancel_if_timeout: 超时时是否取消任务
:return: 等待成功返回完整路径,否则返回False
"""
...
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,565 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from base64 import b64decode
from json import JSONDecodeError, loads
from queue import Queue
from re import search
from time import perf_counter, sleep
from requests.structures import CaseInsensitiveDict
from .._base.driver import Driver
from .._functions.settings import Settings as _S
from ..errors import WaitTimeoutError
class Listener(object):
"""监听器基类"""
def __init__(self, owner):
self._owner = owner
self._address = owner.browser._ws_address
self._target_id = owner._target_id
self._driver = None
self._running_requests = 0
self._running_targets = 0
self._caught = None
self._request_ids = None
self._extra_info_ids = None
self.listening = False
self.tab_id = None
self._targets = True
self._is_regex = False
self._method = {'GET', 'POST'}
self._res_type = True
@property
def targets(self):
"""返回监听目标"""
return self._targets
def set_targets(self, targets=True, is_regex=False, method=('GET', 'POST'), res_type=True):
if targets is not None:
if not isinstance(targets, (str, list, tuple, set)) and targets is not True:
raise ValueError(_S._lang.join(_S._lang.INCORRECT_TYPE_, 'targets',
ALLOW_TYPE='str, list, tuple, set, True', CURR_TYPE=type(targets)))
if targets is True:
self._targets = True
else:
self._targets = {targets} if isinstance(targets, str) else set(targets)
if is_regex is not None:
self._is_regex = is_regex
if method is not None:
if isinstance(method, str):
self._method = {method.upper()}
elif isinstance(method, (list, tuple, set)):
self._method = set(i.upper() for i in method)
elif method is True:
self._method = True
else:
raise ValueError(_S._lang.join(_S._lang.INCORRECT_TYPE_, 'method',
ALLOW_TYPE='str, list, tuple, set, True', CURR_TYPE=type(method)))
if res_type is not None:
if isinstance(res_type, str):
self._res_type = {res_type.upper()}
elif isinstance(res_type, (list, tuple, set)):
self._res_type = set(i.upper() for i in res_type)
elif res_type is True:
self._res_type = True
else:
raise ValueError(_S._lang.join(_S._lang.INCORRECT_TYPE_, 'res_type',
ALLOW_TYPE='str, list, tuple, set, True', CURR_TYPE=type(res_type)))
def start(self, targets=None, is_regex=None, method=None, res_type=None):
if targets is not None:
if is_regex is None:
is_regex = False
if targets or is_regex is not None or method or res_type:
self.set_targets(targets, is_regex, method, res_type)
self.clear()
if self.listening:
return
self._driver = Driver(self._target_id, self._address)
self._driver.session_id = self._driver.run('Target.attachToTarget', targetId=self._target_id, flatten=True)['sessionId']
self._driver.run('Network.enable')
self._set_callback()
self.listening = True
def wait(self, count=1, timeout=None, fit_count=True, raise_err=None):
if not self.listening:
raise RuntimeError(_S._lang.join(_S._lang.NOT_LISTENING))
if not timeout:
while self._driver.is_running and self.listening and self._caught.qsize() < count:
sleep(.03)
fail = False
else:
end = perf_counter() + timeout
while self._driver.is_running and self.listening:
if perf_counter() > end:
fail = True
break
if self._caught.qsize() >= count:
fail = False
break
sleep(.03)
if fail:
if fit_count or not self._caught.qsize():
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.join(_S._lang.WAITING_FAILED_, _S._lang.DATA_PACKET, timeout))
else:
return False
else:
return [self._caught.get_nowait() for _ in range(self._caught.qsize())]
if count == 1:
return self._caught.get_nowait()
return [self._caught.get_nowait() for _ in range(count)]
def steps(self, count=None, timeout=None, gap=1):
if not self.listening:
raise RuntimeError(_S._lang.join(_S._lang.NOT_LISTENING))
caught = 0
if timeout is None:
while self._driver.is_running and self.listening:
if self._caught.qsize() >= gap:
yield self._caught.get_nowait() if gap == 1 else [self._caught.get_nowait() for _ in range(gap)]
if count:
caught += gap
if caught >= count:
return
sleep(.03)
else:
end = perf_counter() + timeout
while self._driver.is_running and self.listening and perf_counter() < end:
if self._caught.qsize() >= gap:
yield self._caught.get_nowait() if gap == 1 else [self._caught.get_nowait() for _ in range(gap)]
end = perf_counter() + timeout
if count:
caught += gap
if caught >= count:
return
sleep(.03)
return False
def stop(self):
if self.listening:
self.pause()
self.clear()
self._driver.stop()
self._driver = None
def pause(self, clear=True):
if self.listening:
self._driver.set_callback('Network.requestWillBeSent', None)
self._driver.set_callback('Network.responseReceived', None)
self._driver.set_callback('Network.loadingFinished', None)
self._driver.set_callback('Network.loadingFailed', None)
self.listening = False
if clear:
self.clear()
def resume(self):
if self.listening:
return
self._set_callback()
self.listening = True
def clear(self):
self._request_ids = {}
self._extra_info_ids = {}
self._caught = Queue(maxsize=0)
self._running_requests = 0
self._running_targets = 0
def wait_silent(self, timeout=None, targets_only=False, limit=0):
if not self.listening:
raise RuntimeError(_S._lang.join(_S._lang.NOT_LISTENING))
if timeout is None:
while ((not targets_only and self._running_requests > limit)
or (targets_only and self._running_targets > limit)):
sleep(.01)
return True
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if ((not targets_only and self._running_requests <= limit)
or (targets_only and self._running_targets <= limit)):
return True
sleep(.01)
else:
return False
def _to_target(self, target_id, address, owner):
self._target_id = target_id
self._address = address
self._owner = owner
if self._driver:
self._driver.stop()
if self.listening:
self._driver = Driver(self._target_id, self._address)
self._driver.session_id = self._driver.run('Target.attachToTarget',
targetId=target_id, flatten=True)['sessionId']
self._driver.run('Network.enable')
self._set_callback()
def _set_callback(self):
self._driver.set_callback('Network.requestWillBeSent', self._requestWillBeSent)
self._driver.set_callback('Network.requestWillBeSentExtraInfo', self._requestWillBeSentExtraInfo)
self._driver.set_callback('Network.responseReceived', self._response_received)
self._driver.set_callback('Network.responseReceivedExtraInfo', self._responseReceivedExtraInfo)
self._driver.set_callback('Network.loadingFinished', self._loading_finished)
self._driver.set_callback('Network.loadingFailed', self._loading_failed)
def _requestWillBeSent(self, **kwargs):
self._running_requests += 1
p = None
if self._targets is True:
if ((self._method is True or kwargs['request']['method'] in self._method)
and (self._res_type is True or kwargs.get('type', '').upper() in self._res_type)):
self._running_targets += 1
rid = kwargs['requestId']
p = self._request_ids.setdefault(rid, DataPacket(self._owner.tab_id, True))
p._raw_request = kwargs
if kwargs['request'].get('hasPostData', None) and not kwargs['request'].get('postData', None):
p._raw_post_data = self._driver.run('Network.getRequestPostData',
requestId=rid).get('postData', None)
else:
rid = kwargs['requestId']
for target in self._targets:
if (((self._is_regex and search(target, kwargs['request']['url']))
or (not self._is_regex and target in kwargs['request']['url']))
and (self._method is True or kwargs['request']['method'] in self._method)
and (self._res_type is True or kwargs.get('type', '').upper() in self._res_type)):
self._running_targets += 1
p = self._request_ids.setdefault(rid, DataPacket(self._owner.tab_id, target))
p._raw_request = kwargs
break
self._extra_info_ids.setdefault(kwargs['requestId'], {})['obj'] = p if p else False
def _requestWillBeSentExtraInfo(self, **kwargs):
self._running_requests += 1
self._extra_info_ids.setdefault(kwargs['requestId'], {})['request'] = kwargs
def _response_received(self, **kwargs):
request = self._request_ids.get(kwargs['requestId'], None)
if request:
request._raw_response = kwargs['response']
request._resource_type = kwargs['type']
def _responseReceivedExtraInfo(self, **kwargs):
self._running_requests -= 1
r = self._extra_info_ids.get(kwargs['requestId'], None)
if r:
obj = r.get('obj', None)
if obj is False:
self._extra_info_ids.pop(kwargs['requestId'], None)
elif isinstance(obj, DataPacket):
obj._requestExtraInfo = r.get('request', None)
obj._responseExtraInfo = kwargs
self._extra_info_ids.pop(kwargs['requestId'], None)
else:
r['response'] = kwargs
def _loading_finished(self, **kwargs):
self._running_requests -= 1
rid = kwargs['requestId']
packet = self._request_ids.get(rid)
if packet:
r = self._driver.run('Network.getResponseBody', requestId=rid)
if 'body' in r:
packet._raw_body = r['body']
packet._base64_body = r['base64Encoded']
else:
packet._raw_body = ''
packet._base64_body = False
if (packet._raw_request['request'].get('hasPostData', None)
and not packet._raw_request['request'].get('postData', None)):
r = self._driver.run('Network.getRequestPostData', requestId=rid, _timeout=1)
packet._raw_post_data = r.get('postData', None)
r = self._extra_info_ids.get(kwargs['requestId'], None)
if r:
obj = r.get('obj', None)
if obj is False or (isinstance(obj, DataPacket) and not self._extra_info_ids.get('request')):
self._extra_info_ids.pop(kwargs['requestId'], None)
elif isinstance(obj, DataPacket) and self._extra_info_ids.get('response'):
response = r.get('response')
obj._requestExtraInfo = r['request']
obj._responseExtraInfo = response
self._extra_info_ids.pop(kwargs['requestId'], None)
self._request_ids.pop(rid, None)
if packet:
self._caught.put(packet)
self._running_targets -= 1
def _loading_failed(self, **kwargs):
self._running_requests -= 1
r_id = kwargs['requestId']
data_packet = self._request_ids.get(r_id, None)
if data_packet:
data_packet._raw_fail_info = kwargs
data_packet._resource_type = kwargs['type']
data_packet.is_failed = True
r = self._extra_info_ids.get(kwargs['requestId'], None)
if r:
obj = r.get('obj', None)
if obj is False and r.get('response'):
self._extra_info_ids.pop(kwargs['requestId'], None)
elif isinstance(obj, DataPacket):
response = r.get('response')
if response:
obj._requestExtraInfo = r['request']
obj._responseExtraInfo = response
self._extra_info_ids.pop(kwargs['requestId'], None)
self._request_ids.pop(r_id, None)
if data_packet:
self._caught.put(data_packet)
self._running_targets -= 1
class FrameListener(Listener):
def _requestWillBeSent(self, **kwargs):
if not self._owner._is_diff_domain and kwargs.get('frameId', None) != self._owner._frame_id:
return
super()._requestWillBeSent(**kwargs)
def _response_received(self, **kwargs):
if not self._owner._is_diff_domain and kwargs.get('frameId', None) != self._owner._frame_id:
return
super()._response_received(**kwargs)
class DataPacket(object):
def __init__(self, tab_id, target):
self.tab_id = tab_id
self.target = target
self.is_failed = False
self._raw_request = None
self._raw_post_data = None
self._raw_response = None
self._raw_body = None
self._raw_fail_info = None
self._request = None
self._response = None
self._fail_info = None
self._base64_body = False
self._requestExtraInfo = None
self._responseExtraInfo = None
self._resource_type = None
def __repr__(self):
t = f'"{self.target}"' if self.target is not True else True
return f'<DataPacket target={t} url="{self.url}">'
@property
def _request_extra_info(self):
return self._requestExtraInfo
@property
def _response_extra_info(self):
return self._responseExtraInfo
@property
def url(self):
return self.request.url
@property
def method(self):
return self.request.method
@property
def frameId(self):
return self._raw_request.get('frameId')
@property
def resourceType(self):
return self._resource_type
@property
def request(self):
if self._request is None:
self._request = Request(self, self._raw_request['request'], self._raw_post_data)
return self._request
@property
def response(self):
if self._response is None:
self._response = Response(self, self._raw_response, self._raw_body, self._base64_body)
return self._response
@property
def fail_info(self):
if self._fail_info is None:
self._fail_info = FailInfo(self, self._raw_fail_info)
return self._fail_info
def wait_extra_info(self, timeout=None):
if timeout is None:
while self._responseExtraInfo is None:
sleep(.01)
return True
else:
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if self._responseExtraInfo is not None:
return True
sleep(.01)
else:
return False
class Request(object):
def __init__(self, data_packet, raw_request, post_data):
self._data_packet = data_packet
self._request = raw_request
self._raw_post_data = post_data
self._postData = None
self._headers = None
def __getattr__(self, item):
return self._request.get(item, None)
@property
def headers(self):
if self._headers is None:
self._headers = CaseInsensitiveDict(self._request['headers'])
if self.extra_info.headers:
h = CaseInsensitiveDict(self.extra_info.headers)
for k, v in h.items():
if k not in self._headers:
self._headers[k] = v
return self._headers
@property
def params(self):
from urllib.parse import parse_qsl, urlparse
return dict(parse_qsl(urlparse(self.url).query, keep_blank_values=True))
@property
def postData(self):
if self._postData is None:
if self._raw_post_data:
postData = self._raw_post_data
elif self._request.get('postData', None):
postData = self._request['postData']
else:
postData = False
try:
self._postData = loads(postData)
except (JSONDecodeError, TypeError):
self._postData = postData
return self._postData
@property
def cookies(self):
return [c['cookie'] for c in self.extra_info.associatedCookies if not c['blockedReasons']]
@property
def extra_info(self):
return RequestExtraInfo(self._data_packet._request_extra_info or {})
class Response(object):
def __init__(self, data_packet, raw_response, raw_body, base64_body):
self._data_packet = data_packet
self._response = raw_response
self._raw_body = raw_body
self._is_base64_body = base64_body
self._body = None
self._headers = None
def __getattr__(self, item):
return self._response.get(item, None) if self._response else None
@property
def headers(self):
if self._headers is None:
self._headers = CaseInsensitiveDict(self._response['headers'])
if self.extra_info.headers:
h = CaseInsensitiveDict(self.extra_info.headers)
for k, v in h.items():
if k not in self._headers:
self._headers[k] = v
return self._headers
@property
def raw_body(self):
return self._raw_body
@property
def body(self):
if self._body is None:
if self._is_base64_body:
self._body = b64decode(self._raw_body)
else:
try:
self._body = loads(self._raw_body)
except (JSONDecodeError, TypeError):
self._body = self._raw_body
return self._body
@property
def extra_info(self):
return ResponseExtraInfo(self._data_packet._response_extra_info or {})
class ExtraInfo(object):
def __init__(self, extra_info):
self._extra_info = extra_info
@property
def all_info(self):
return self._extra_info
def __getattr__(self, item):
return self._extra_info.get(item, None)
class RequestExtraInfo(ExtraInfo):
pass
class ResponseExtraInfo(ExtraInfo):
pass
class FailInfo(object):
def __init__(self, data_packet, fail_info):
self._data_packet = data_packet
self._fail_info = fail_info
def __getattr__(self, item):
return self._fail_info.get(item, None) if self._fail_info else None
@@ -0,0 +1,420 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from queue import Queue
from typing import Union, List, Iterable, Optional, Literal, Any
from requests.structures import CaseInsensitiveDict
from .._base.driver import Driver
from .._pages.chromium_base import ChromiumBase
from .._pages.chromium_frame import ChromiumFrame
__RES_TYPE__ = Literal['Document', 'Stylesheet', 'Image', 'Media', 'Font', 'Script', 'TextTrack', 'XHR', 'Fetch',
'Prefetch', 'EventSource', 'WebSocket', 'Manifest', 'SignedExchange', 'Ping', 'CSPViolationReport', 'Preflight', 'Other']
class Listener(object):
_owner: ChromiumBase = ...
_address: str = ...
_target_id: str = ...
_targets: Union[str, dict, True, None] = ...
_method: Union[set, True] = ...
_res_type: Union[set, True] = ...
_caught: Optional[Queue] = ...
_is_regex: bool = ...
_driver: Optional[Driver] = ...
_request_ids: Optional[dict] = ...
_extra_info_ids: Optional[dict] = ...
_running_requests: int = ...
_running_targets: int = ...
listening: bool = ...
def __init__(self, owner: ChromiumBase):
"""
:param owner: 页面对象
"""
...
@property
def targets(self) -> Optional[set]: ...
def set_targets(self,
targets: Union[str, list, tuple, set, bool, None] = True,
is_regex: Optional[bool] = False,
method: Union[str, list, tuple, set, bool, None] = ('GET', 'POST'),
res_type: Union[__RES_TYPE__, list, tuple, set, bool, None] = True) -> None:
"""指定要等待的数据包
:param targets: 要匹配的数据包url特征,可用list等传入多个,为True时获取所有
:param is_regex: 设置的target是否正则表达式
:param method: 设置监听的请求类型,可指定多个,为True时监听全部
:param res_type: 设置监听的资源类型,可指定多个,为True时监听全部,可指定的值有:
Document, Stylesheet, Image, Media, Font, Script, TextTrack, XHR, Fetch, Prefetch, EventSource, WebSocket,
Manifest, SignedExchange, Ping, CSPViolationReport, Preflight, Other
:return: None
"""
...
def start(self,
targets: Union[str, list, tuple, set, bool, None] = None,
is_regex: Optional[bool] = None,
method: Union[str, list, tuple, set, bool, None] = None,
res_type: Union[__RES_TYPE__, list, tuple, set, bool, None] = None) -> None:
"""拦截目标请求,每次拦截前清空结果
:param targets: 要匹配的数据包url特征,可用list等传入多个,为True时获取所有
:param is_regex: 设置的target是否正则表达式,为None时保持原来设置
:param method: 设置监听的请求类型,可指定多个,默认('GET', 'POST'),为True时监听全部,为None时保持原来设置
:param res_type: 设置监听的资源类型,可指定多个,默认为True时监听全部,为None时保持原来设置,可指定的值有:
Document, Stylesheet, Image, Media, Font, Script, TextTrack, XHR, Fetch, Prefetch, EventSource, WebSocket,
Manifest, SignedExchange, Ping, CSPViolationReport, Preflight, Other
:return: None
"""
...
def wait(self,
count: int = 1,
timeout: float = None,
fit_count: bool = True,
raise_err: bool = None) -> Union[List[DataPacket], DataPacket, None]:
"""等待符合要求的数据包到达指定数量
:param count: 需要捕捉的数据包数量
:param timeout: 超时时间(秒),为None无限等待
:param fit_count: 是否必须满足总数要求,发生超时,为True返回False,为False返回已捕捉到的数据包
:param raise_err: 超时时是否抛出错误,为None时根据Settings设置
:return: count为1时返回数据包对象,大于1时返回列表,超时且fit_count为True时返回False
"""
...
def steps(self,
count: int = None,
timeout: float = None,
gap=1) -> Iterable[Union[DataPacket, List[DataPacket]]]:
"""用于单步操作,可实现每收到若干个数据包执行一步操作(如翻页)
:param count: 需捕获的数据包总数,为None表示无限
:param timeout: 每个数据包等待时间(秒),为None表示无限
:param gap: 每接收到多少个数据包返回一次数据
:return: 用于在接收到监听目标时触发动作的可迭代对象
"""
...
def stop(self) -> None:
"""停止监听,清空已监听到的列表"""
...
def pause(self, clear: bool = True) -> None:
"""暂停监听
:param clear: 是否清空已获取队列
:return: None
"""
...
def resume(self) -> None:
"""继续暂停的监听"""
...
def clear(self) -> None:
"""清空监听到但还没返回的结果"""
...
def wait_silent(self,
timeout: float = None,
targets_only: bool = False,
limit: int = 0) -> bool:
"""等待所有请求结束
:param timeout: 超时时间(秒),为None时无限等待
:param targets_only: 是否只等待targets指定的请求结束
:param limit: 剩下多少个连接时视为结束
:return: 返回是否等待成功
"""
...
def _to_target(self, target_id: str, address: str, owner: ChromiumBase) -> None:
"""切换监听的页面对象
:param target_id: 新页面对象_target_id
:param address: 新页面对象address
:param owner: 新页面对象
:return: None
"""
...
def _set_callback(self) -> None: ...
def _requestWillBeSent(self, **kwargs) -> None: ...
def _requestWillBeSentExtraInfo(self, **kwargs) -> None: ...
def _response_received(self, **kwargs) -> None: ...
def _responseReceivedExtraInfo(self, **kwargs) -> None: ...
def _loading_finished(self, **kwargs) -> None: ...
def _loading_failed(self, **kwargs) -> None: ...
class FrameListener(Listener):
_owner: ChromiumFrame = ...
_is_diff: bool = ...
def __init__(self, owner: ChromiumFrame):
"""
:param owner: ChromiumFrame对象
"""
...
class DataPacket(object):
"""数据包类"""
tab_id: str = ...
target: str = ...
is_failed: bool = ...
_raw_request: Optional[dict] = ...
_raw_response: Optional[dict] = ...
_raw_post_data: Optional[str] = ...
_raw_body: Optional[str] = ...
_raw_fail_info: Optional[dict] = ...
_base64_body: bool = ...
_request: Optional[Request] = ...
_response: Optional[Response] = ...
_fail_info: Optional[FailInfo] = ...
_resource_type: Optional[str] = ...
_requestExtraInfo: Optional[dict] = ...
_responseExtraInfo: Optional[dict] = ...
def __init__(self, tab_id: str, target: [str, bool]):
"""
:param tab_id: 产生这个数据包的tab的id
:param target: 监听目标
"""
...
@property
def url(self) -> str:
"""请求网址"""
...
@property
def method(self) -> str:
"""请求类型"""
...
@property
def frameId(self) -> str:
"""发出请求的frame id"""
...
@property
def resourceType(self) -> str:
"""资源类型"""
...
@property
def request(self) -> Request:
"""数据"""
...
@property
def response(self) -> Response:
"""Response数据"""
...
@property
def fail_info(self) -> Optional[FailInfo]:
"""请求失败数据"""
...
def wait_extra_info(self, timeout: float = None) -> bool:
"""等待额外的信息加载完成
:param timeout: 超时时间(秒),None为无限等待
:return: 是否等待成功
"""
...
@property
def _request_extra_info(self) -> Optional[dict]: ...
@property
def _response_extra_info(self) -> Optional[dict]: ...
class Request(object):
_data_packet: DataPacket = ...
_request: dict = ...
_raw_post_data: str = ...
_postData: Optional[str] = ...
url: str = ...
_headers: Union[CaseInsensitiveDict, None] = ...
method: str = ...
urlFragment: str = ...
hasPostData: bool = ...
postDataEntries: List[dict] = ...
mixedContentType: Literal['blockable', 'optionally-blockable', 'none'] = ...
initialPriority: Literal['VeryLow', 'Low', 'Medium', 'High', 'VeryHigh'] = ...
referrerPolicy: Literal['unsafe-url', 'no-referrer-when-downgrade', 'no-referrer', 'origin',
'origin-when-cross-origin', 'same-origin', 'strict-origin', 'strict-origin-when-cross-origin'] = ...
isLinkPreload: bool = ...
trustTokenParams: dict = ...
isSameSite: bool = ...
def __init__(self,
data_packet: DataPacket,
raw_request: dict,
post_data: str):
"""
:param data_packet: DataPacket对象
:param raw_request: 未处理的请求数据
:param post_data: post发送的数据
"""
...
@property
def headers(self) -> dict:
"""以大小写不敏感字典返回headers数据"""
...
@property
def params(self) -> dict:
"""dict格式返回请求url中的参数"""
...
@property
def postData(self) -> Any:
"""返回postData数据"""
...
@property
def cookies(self) -> List[dict]:
"""以list形式返回发送的cookies"""
...
@property
def extra_info(self) -> Optional[RequestExtraInfo]:
"""返回额外数据"""
...
class Response(object):
_data_packet: DataPacket = ...
_response: dict = ...
_raw_body: str = ...
_is_base64_body: bool = ...
_body: Union[str, dict, bytes, None] = ...
_headers: Union[dict, CaseInsensitiveDict, None] = ...
url: str = ...
status: int = ...
statusText: str = ...
headersText: str = ...
mimeType: str = ...
requestHeaders: dict = ...
requestHeadersText: str = ...
connectionReused: bool = ...
connectionId = ...
remoteIPAddress: str = ...
remotePort: int = ...
fromDiskCache: bool = ...
fromServiceWorker: bool = ...
fromPrefetchCache: bool = ...
fromEarlyHints: bool = ...
serviceWorkerRouterInfo: dict = ...
encodedDataLength: int = ...
timing: dict = ...
serviceWorkerResponseSource: Literal['cache-storage', 'http-cache', 'fallback-code', 'network'] = ...
responseTime: float = ...
cacheStorageCacheName: str = ...
protocol: str = ...
alternateProtocolUsage: Literal['alternativeJobWonWithoutRace', 'alternativeJobWonRace', 'mainJobWonRace',
'mappingMissing', 'broken', 'dnsAlpnH3JobWonWithoutRace', 'dnsAlpnH3JobWonRace', 'unspecifiedReason'] = ...
securityState: Literal['unknown', 'neutral', 'insecure', 'secure', 'info', 'insecure-broken'] = ...
securityDetails: dict = ...
def __init__(self,
data_packet: DataPacket,
raw_response: dict,
raw_body: str,
base64_body: bool):
"""
:param data_packet: DataPacket对象
:param raw_response: 未处理的response信息
:param raw_body: 未处理的body
:param base64_body: body是否base64格式
"""
...
@property
def headers(self) -> CaseInsensitiveDict:
"""以大小写不敏感字典返回headers数据"""
...
@property
def raw_body(self) -> str:
"""返回未被处理的body文本"""
...
@property
def body(self) -> Any:
"""返回body内容,如果是json格式,自动进行转换,如果时图片格式,进行base64转换,其它格式直接返回文本"""
...
@property
def extra_info(self) -> Optional[ResponseExtraInfo]:
"""额外信息"""
...
class ExtraInfo(object):
_extra_info: dict = ...
def __init__(self, extra_info: dict):
"""
:param extra_info: dict格式信息
"""
...
@property
def all_info(self) -> dict:
"""以dict形式返回所有额外信息"""
...
class RequestExtraInfo(ExtraInfo):
requestId: str = ...
associatedCookies: List[dict] = ...
headers: dict = ...
connectTiming: dict = ...
clientSecurityState: dict = ...
siteHasCookieInOtherPartition: bool = ...
class ResponseExtraInfo(ExtraInfo):
requestId: str = ...
blockedCookies: List[dict] = ...
headers: dict = ...
resourceIPAddressSpace: str = ...
statusCode: int = ...
headersText: str = ...
cookiePartitionKey: str = ...
cookiePartitionKeyOpaque: bool = ...
class FailInfo(object):
_data_packet: DataPacket
_fail_info: dict
errorText: str
canceled: bool
blockedReason: Optional[str]
corsErrorStatus: Optional[str]
def __init__(self, data_packet: DataPacket, fail_info: dict):
"""
:param data_packet: DataPacket对象
:param fail_info: 返回的失败数据
"""
...
@@ -0,0 +1,216 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
class ElementRect(object):
def __init__(self, ele):
self._ele = ele
@property
def corners(self):
vr = self._get_viewport_rect('border')
r = self._ele.owner._run_cdp_loaded('Page.getLayoutMetrics')['visualViewport']
sx = r['pageX']
sy = r['pageY']
return [(vr[0] + sx, vr[1] + sy), (vr[2] + sx, vr[3] + sy), (vr[4] + sx, vr[5] + sy), (vr[6] + sx, vr[7] + sy)]
@property
def viewport_corners(self):
r = self._get_viewport_rect('border')
return (r[0], r[1]), (r[2], r[3]), (r[4], r[5]), (r[6], r[7])
@property
def size(self):
border = self._ele.owner._run_cdp('DOM.getBoxModel', backendNodeId=self._ele._backend_id,
nodeId=self._ele._node_id, objectId=self._ele._obj_id)['model']['border']
return border[2] - border[0], border[5] - border[1]
@property
def location(self):
return self._get_page_coord(*self.viewport_location)
@property
def midpoint(self):
return self._get_page_coord(*self.viewport_midpoint)
@property
def click_point(self):
return self._get_page_coord(*self.viewport_click_point)
@property
def viewport_location(self):
m = self._get_viewport_rect('border')
return m[0], m[1]
@property
def viewport_midpoint(self):
m = self._get_viewport_rect('border')
return m[0] + (m[2] - m[0]) // 2, m[3] + (m[5] - m[3]) // 2
@property
def viewport_click_point(self):
m = self._get_viewport_rect('padding')
return self.viewport_midpoint[0], m[1] + 3
@property
def screen_location(self):
vx, vy = self._ele.owner.rect.viewport_location
ex, ey = self.viewport_location
pr = self._ele.owner._run_js('return window.devicePixelRatio;')
if getattr(self._ele.owner, '_is_diff_domain', None):
x, y = self._ele.owner.rect.screen_location
return ex * pr + x, ey * pr + y
else:
return (vx + ex) * pr, (ey + vy) * pr
@property
def screen_midpoint(self):
vx, vy = self._ele.owner.rect.viewport_location
ex, ey = self.viewport_midpoint
pr = self._ele.owner._run_js('return window.devicePixelRatio;')
if getattr(self._ele.owner, '_is_diff_domain', None):
x, y = self._ele.owner.rect.screen_location
return ex * pr + x, ey * pr + y
else:
return (vx + ex) * pr, (ey + vy) * pr
@property
def screen_click_point(self):
vx, vy = self._ele.owner.rect.viewport_location
ex, ey = self.viewport_click_point
pr = self._ele.owner._run_js('return window.devicePixelRatio;')
if getattr(self._ele.owner, '_is_diff_domain', None):
x, y = self._ele.owner.rect.screen_location
return ex * pr + x, ey * pr + y
else:
return (vx + ex) * pr, (ey + vy) * pr
@property
def scroll_position(self):
r = self._ele._run_js('return this.scrollLeft.toString() + " " + this.scrollTop.toString();')
w, h = r.split(' ')
return int(w), int(h)
def _get_viewport_rect(self, quad):
return self._ele.owner._run_cdp('DOM.getBoxModel', backendNodeId=self._ele._backend_id)['model'][quad]
def _get_page_coord(self, x, y):
r = self._ele.owner._run_cdp_loaded('Page.getLayoutMetrics')['visualViewport']
sx = r['pageX']
sy = r['pageY']
return x + sx, y + sy
class TabRect(object):
def __init__(self, owner):
self._owner = owner
@property
def window_state(self):
return self._get_window_rect()['windowState']
@property
def window_location(self):
r = self._get_window_rect()
if r['windowState'] in ('maximized', 'fullscreen'):
return 0, 0
return r['left'] + 7, r['top']
@property
def window_size(self):
r = self._get_window_rect()
if r['windowState'] == 'fullscreen':
return r['width'], r['height']
elif r['windowState'] == 'maximized':
return r['width'] - 16, r['height'] - 16
else:
return r['width'] - 16, r['height'] - 7
@property
def page_location(self):
w, h = self.viewport_location
r = self._get_page_rect()['layoutViewport']
return w - r['pageX'], h - r['pageY']
@property
def viewport_location(self):
w_bl, h_bl = self.window_location
w_bs, h_bs = self.window_size
w_vs, h_vs = self.viewport_size_with_scrollbar
return w_bl + w_bs - w_vs, h_bl + h_bs - h_vs
@property
def size(self):
r = self._get_page_rect()['contentSize']
return r['width'], r['height']
@property
def viewport_size(self):
r = self._get_page_rect()['visualViewport']
return r['clientWidth'], r['clientHeight']
@property
def viewport_size_with_scrollbar(self):
r = self._owner._run_js('return window.innerWidth.toString() + " " + window.innerHeight.toString();')
w, h = r.split(' ')
return int(w), int(h)
@property
def scroll_position(self):
r = self._get_page_rect()['visualViewport']
return r['pageX'], r['pageY']
def _get_page_rect(self):
return self._owner._run_cdp_loaded('Page.getLayoutMetrics')
def _get_window_rect(self):
return self._owner.browser._driver.run('Browser.getWindowForTarget', targetId=self._owner.tab_id)['bounds']
class FrameRect(object):
"""异域iframe使用"""
def __init__(self, frame):
self._frame = frame
@property
def location(self):
return self._frame.frame_ele.rect.location
@property
def viewport_location(self):
return self._frame.frame_ele.rect.viewport_location
@property
def screen_location(self):
return self._frame.frame_ele.rect.screen_location
@property
def size(self):
w = self._frame.doc_ele._run_js('return this.body.scrollWidth')
h = self._frame.doc_ele._run_js('return this.body.scrollHeight')
return w, h
@property
def viewport_size(self):
return self._frame.frame_ele.rect.size
@property
def corners(self):
return self._frame.frame_ele.rect.corners
@property
def viewport_corners(self):
return self._frame.frame_ele.rect.viewport_corners
@property
def scroll_position(self):
r = self._frame.doc_ele._run_js('return this.documentElement.scrollLeft.toString() + " " '
'+ this.documentElement.scrollTop.toString();')
w, h = r.split(' ')
return int(w), int(h)
@@ -0,0 +1,216 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from typing import Tuple, Union
from .._elements.chromium_element import ChromiumElement
from .._pages.chromium_base import ChromiumBase
from .._pages.chromium_frame import ChromiumFrame
from .._pages.chromium_page import ChromiumPage
from .._pages.chromium_tab import ChromiumTab
from .._pages.mix_tab import MixTab
from .._pages.web_page import WebPage
class ElementRect(object):
_ele: ChromiumElement = ...
def __init__(self, ele: ChromiumElement):
"""
:param ele: ChromiumElement对象
"""
...
@property
def corners(self) -> Tuple[Tuple[float, float], ...]:
"""返回元素四个角坐标,顺序:左上、右上、右下、左下,没有大小的元素抛出NoRectError"""
...
@property
def viewport_corners(self) -> Tuple[Tuple[float, float], ...]:
"""返回元素四个角视口坐标,顺序:左上、右上、右下、左下,没有大小的元素抛出NoRectError"""
...
@property
def size(self) -> Tuple[float, float]:
"""返回元素大小,格式(宽, 高)"""
...
@property
def location(self) -> Tuple[float, float]:
"""返回元素左上角的绝对坐标"""
...
@property
def midpoint(self) -> Tuple[float, float]:
"""返回元素中间点的绝对坐标"""
...
@property
def click_point(self) -> Tuple[float, float]:
"""返回元素接受点击的点的绝对坐标"""
...
@property
def viewport_location(self) -> Tuple[float, float]:
"""返回元素左上角在视口中的坐标"""
...
@property
def viewport_midpoint(self) -> Tuple[float, float]:
"""返回元素中间点在视口中的坐标"""
...
@property
def viewport_click_point(self) -> Tuple[float, float]:
"""返回元素接受点击的点视口坐标"""
...
@property
def screen_location(self) -> Tuple[float, float]:
"""返回元素左上角在屏幕上坐标,左上角为(0, 0)"""
...
@property
def screen_midpoint(self) -> Tuple[float, float]:
"""返回元素中点在屏幕上坐标,左上角为(0, 0)"""
...
@property
def screen_click_point(self) -> Tuple[float, float]:
"""返回元素中点在屏幕上坐标,左上角为(0, 0)"""
...
@property
def scroll_position(self) -> Tuple[float, float]:
"""返回滚动条位置,格式:(x, y)"""
...
def _get_viewport_rect(self, quad: str) -> Union[list, None]:
"""按照类型返回在可视窗口中的范围
:param quad: 方框类型,margin border padding
:return: 四个角坐标
"""
...
def _get_page_coord(self, x: float, y: float) -> Tuple[float, float]:
"""根据视口坐标获取绝对坐标
:param x: 视口x坐标
:param y: 视口y坐标
:return: 坐标元组
"""
...
class TabRect(object):
def __init__(self, owner: ChromiumBase):
"""
:param owner: Page对象和Tab对象
"""
self._owner: Union[ChromiumPage, ChromiumTab, WebPage, MixTab] = ...
@property
def window_state(self) -> str:
"""返回窗口状态:normal、fullscreen、maximized、minimized"""
...
@property
def window_location(self) -> Tuple[int, int]:
"""返回窗口在屏幕上的坐标,左上角为(0, 0)"""
...
@property
def window_size(self) -> Tuple[int, int]:
"""返回窗口大小"""
...
@property
def page_location(self) -> Tuple[int, int]:
"""返回页面左上角在屏幕中坐标,左上角为(0, 0)"""
...
@property
def viewport_location(self) -> Tuple[int, int]:
"""返回视口在屏幕中坐标,左上角为(0, 0)"""
...
@property
def size(self) -> Tuple[int, int]:
"""返回页面总宽高,格式:(宽, 高)"""
...
@property
def viewport_size(self) -> Tuple[int, int]:
"""返回视口宽高,不包括滚动条,格式:(宽, 高)"""
...
@property
def viewport_size_with_scrollbar(self) -> Tuple[int, int]:
"""返回视口宽高,包括滚动条,格式:(宽, 高)"""
...
@property
def scroll_position(self) -> Tuple[int, int]:
"""返回滚动条位置,格式:(x, y)"""
...
def _get_page_rect(self) -> dict:
"""获取页面范围信息"""
...
def _get_window_rect(self) -> dict:
"""获取窗口范围信息"""
...
class FrameRect(object):
_frame: ChromiumFrame = ...
def __init__(self, frame: ChromiumFrame):
"""
:param frame: ChromiumFrame对象
"""
...
@property
def location(self) -> Tuple[float, float]:
"""返回iframe元素左上角的绝对坐标"""
...
@property
def viewport_location(self) -> Tuple[float, float]:
"""返回元素在视口中坐标,左上角为(0, 0)"""
...
@property
def screen_location(self) -> Tuple[float, float]:
"""返回元素左上角在屏幕上坐标,左上角为(0, 0)"""
...
@property
def size(self) -> Tuple[float, float]:
"""返回frame内页面尺寸,格式:(宽, 高)"""
...
@property
def viewport_size(self) -> Tuple[float, float]:
"""返回视口宽高,格式:(宽, 高)"""
...
@property
def corners(self) -> Tuple[Tuple[float, float], ...]:
"""返回元素四个角坐标,顺序:左上、右上、右下、左下"""
...
@property
def viewport_corners(self) -> Tuple[Tuple[float, float], ...]:
"""返回元素四个角视口坐标,顺序:左上、右上、右下、左下"""
...
@property
def scroll_position(self) -> Tuple[float, float]:
"""返回滚动条位置,格式:(x, y)"""
...
@@ -0,0 +1,179 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from base64 import b64decode
from os.path import sep
from pathlib import Path
from random import randint
from shutil import rmtree
from tempfile import gettempdir
from threading import Thread
from time import sleep, time
from .._functions.settings import Settings as _S
class Screencast(object):
def __init__(self, owner):
self._owner = owner
self._path = None
self._tmp_path = None
self._running = False
self._enable = False
self._mode = 'video'
@property
def set_mode(self):
return ScreencastMode(self)
def start(self, save_path=None):
self.set_save_path(save_path)
if self._path is None:
raise RuntimeError(_S._lang.join(_S._lang.NEED_ARG_, 'save_path'))
if self._mode in ('frugal_video', 'video'):
if self._owner.browser._chromium_options.tmp_path:
self._tmp_path = Path(
self._owner.browser._chromium_options.tmp_path) / f'screencast_tmp_{time()}_{randint(0, 100)}'
else:
self._tmp_path = Path(gettempdir()) / 'DrissionPage' / f'screencast_tmp_{time()}_{randint(0, 100)}'
self._tmp_path.mkdir(parents=True, exist_ok=True)
if self._mode.startswith('frugal'):
self._owner.driver.set_callback('Page.screencastFrame', self._onScreencastFrame)
self._owner._run_cdp('Page.startScreencast', everyNthFrame=1, quality=100)
elif not self._mode.startswith('js'):
self._running = True
self._enable = True
Thread(target=self._run).start()
else: # js模式
js = '''
async function () {
stream = await navigator.mediaDevices.getDisplayMedia({video: true, audio: true})
mime = MediaRecorder.isTypeSupported("video/webm; codecs=vp9")
? "video/webm; codecs=vp9"
: "video/webm"
mediaRecorder = new MediaRecorder(stream, {mimeType: mime})
DrissionPage_Screencast_chunks = [];
mediaRecorder.addEventListener('dataavailable', function(e) {
DrissionPage_Screencast_blob_ok = false;
DrissionPage_Screencast_chunks.push(e.data);
DrissionPage_Screencast_blob_ok = true;
})
mediaRecorder.start()
mediaRecorder.addEventListener('stop', function(){
while(DrissionPage_Screencast_blob_ok==false){}
DrissionPage_Screencast_blob = new Blob(DrissionPage_Screencast_chunks,
{type: DrissionPage_Screencast_chunks[0].type});
})
}
'''
print(_S._lang.CHOOSE_RECORD_TARGET)
self._owner._run_js('var DrissionPage_Screencast_blob;var DrissionPage_Screencast_blob_ok=false;')
self._owner._run_js(js)
print(_S._lang.START_RECORD)
def stop(self, video_name=None, suffix='mp4', coding='mp4v'):
video_name = f'{time()}.{suffix}' if not video_name else video_name
if not video_name.endswith(f'.{suffix}'):
video_name = f'{video_name}.{suffix}'
path = f'{self._path}{sep}{video_name}'
if self._mode.startswith('js'):
self._owner._run_js('mediaRecorder.stop();', as_expr=True)
while not self._owner._run_js('return DrissionPage_Screencast_blob_ok;'):
sleep(.05)
with open(path, 'wb') as f:
f.write(b64decode(self._owner._run_js('return DrissionPage_Screencast_blob;')))
self._owner._run_js('DrissionPage_Screencast_blob_ok = false;'
'DrissionPage_Screencast_chunks = [];'
'DrissionPage_Screencast_blob = null', as_expr=True)
print(_S._lang.STOP_RECORDING)
return path
if self._mode.startswith('frugal'):
self._owner.driver.set_callback('Page.screencastFrame', None)
self._owner._run_cdp('Page.stopScreencast')
else:
self._enable = False
while self._running:
sleep(.01)
if self._mode.endswith('imgs'):
print(_S._lang.STOP_RECORDING)
return str(Path(self._path).absolute())
if not str(self._path).isascii():
raise ValueError(_S._lang.join(_S._lang.ONLY_ENGLISH, CURR_VAL=self._path))
try:
from cv2 import VideoWriter, imread, VideoWriter_fourcc
from numpy import fromfile, uint8
except (ImportError, ModuleNotFoundError):
raise EnvironmentError(_S._lang.join(_S._lang.NEED_LIB_, 'cv2, numpy',
TIP='pip install opencv-python\npip install numpy'))
pic_list = Path(self._tmp_path or self._path).glob('*.jpg')
img = imread(str(next(pic_list)))
imgInfo = img.shape
size = (imgInfo[1], imgInfo[0])
videoWrite = VideoWriter(path, VideoWriter_fourcc(*coding.upper()), 5, size)
for i in pic_list:
img = imread(str(i))
videoWrite.write(img)
rmtree(self._tmp_path)
self._tmp_path = None
print(_S._lang.STOP_RECORDING)
return f'{self._path}{sep}{video_name}'
def set_save_path(self, save_path=None):
if save_path:
save_path = Path(save_path)
if save_path.exists() and save_path.is_file():
raise ValueError(_S._lang.join(_S._lang.SAVE_PATH_MUST_BE_FOLDER))
save_path.mkdir(parents=True, exist_ok=True)
self._path = save_path
def _run(self):
self._running = True
path = self._tmp_path or self._path
while self._enable:
self._owner.get_screenshot(path=path, name=f'{time()}.jpg')
sleep(.04)
self._running = False
def _onScreencastFrame(self, **kwargs):
path = self._tmp_path or self._path
with open(f'{path}{sep}{kwargs["metadata"]["timestamp"]}.jpg', 'wb') as f:
f.write(b64decode(kwargs['data']))
self._owner._run_cdp('Page.screencastFrameAck', sessionId=kwargs['sessionId'])
class ScreencastMode(object):
def __init__(self, screencast):
self._screencast = screencast
def video_mode(self):
self._screencast._mode = 'video'
def frugal_video_mode(self):
self._screencast._mode = 'frugal_video'
def js_video_mode(self):
self._screencast._mode = 'js_video'
def frugal_imgs_mode(self):
self._screencast._mode = 'frugal_imgs'
def imgs_mode(self):
self._screencast._mode = 'imgs'
@@ -0,0 +1,91 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from pathlib import Path
from typing import Union, Optional
from .._pages.chromium_base import ChromiumBase
class Screencast(object):
_owner: ChromiumBase = ...
_path: Optional[Path] = ...
_tmp_path: Optional[Path] = ...
_running: bool = ...
_enable: bool = ...
_mode: str = ...
def __init__(self, owner: ChromiumBase):
"""
:param owner: 页面对象
"""
@property
def set_mode(self) -> ScreencastMode:
"""返回用于设置录屏幕式的对象"""
...
def start(self, save_path: Union[str, Path] = None) -> None:
"""开始录屏
:param save_path: 录屏保存位置
:return: None
"""
...
def stop(self, video_name: str = None, suffix: str='mp4', coding:str='mp4v') -> str:
"""停止录屏
:param video_name: 视频文件名,为None时以当前时间名命
:param suffix: 文件后缀名
:param coding: 视频编码格式,仅video_mode模式有效,根据cv2.VideoWriter_fourcc()定义
:return: 文件路径
"""
...
def set_save_path(self, save_path: Union[str, Path] = None) -> None:
"""设置保存路径
:param save_path: 保存路径
:return: None
"""
...
def _run(self) -> None:
"""非节俭模式运行方法"""
...
def _onScreencastFrame(self, **kwargs) -> None:
"""节俭模式运行方法"""
...
class ScreencastMode(object):
_screencast: Screencast = ...
def __init__(self, screencast: Screencast):
"""
:param screencast: Screencast对象
"""
...
def video_mode(self) -> None:
"""持续视频模式,生成的视频没有声音"""
...
def frugal_video_mode(self) -> None:
"""设置节俭视频模式,页面有变化时才录制,生成的视频没有声音"""
...
def js_video_mode(self) -> None:
"""设置使用js录制视频模式,可生成有声音的视频,但需要手动启动"""
...
def frugal_imgs_mode(self) -> None:
"""设置节俭视频模式,页面有变化时才截图"""
...
def imgs_mode(self) -> None:
"""设置图片模式,持续对页面进行截图"""
...
@@ -0,0 +1,141 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from time import sleep, perf_counter
class Scroller(object):
"""用于滚动的对象"""
def __init__(self, owner):
self._owner = owner
self._t1 = self._t2 = 'this'
self._wait_complete = False
def __call__(self, pixel=300):
return self.down(pixel)
def _run_js(self, js):
js = js.format(self._t1, self._t2, self._t2)
self._owner._run_js(js)
self._wait_scrolled()
def to_top(self):
self._run_js('{}.scrollTo({}.scrollLeft, 0);')
return self._owner
def to_bottom(self):
self._run_js('{}.scrollTo({}.scrollLeft, {}.scrollHeight);')
return self._owner
def to_half(self):
self._run_js('{}.scrollTo({}.scrollLeft, {}.scrollHeight/2);')
return self._owner
def to_rightmost(self):
self._run_js('{}.scrollTo({}.scrollWidth, {}.scrollTop);')
return self._owner
def to_leftmost(self):
self._run_js('{}.scrollTo(0, {}.scrollTop);')
return self._owner
def to_location(self, x, y):
self._run_js(f'{{}}.scrollTo({x}, {y});')
return self._owner
def up(self, pixel=300):
pixel = -pixel
self._run_js(f'{{}}.scrollBy(0, {pixel});')
return self._owner
def down(self, pixel=300):
self._run_js(f'{{}}.scrollBy(0, {pixel});')
return self._owner
def left(self, pixel=300):
pixel = -pixel
self._run_js(f'{{}}.scrollBy({pixel}, 0);')
return self._owner
def right(self, pixel=300):
self._run_js(f'{{}}.scrollBy({pixel}, 0);')
return self._owner
def _wait_scrolled(self):
if not self._wait_complete:
return
owner = self._owner.owner if self._owner._type == 'ChromiumElement' else self._owner
r = owner._run_cdp('Page.getLayoutMetrics')
x = r['layoutViewport']['pageX']
y = r['layoutViewport']['pageY']
end_time = perf_counter() + owner.timeout
while perf_counter() < end_time:
sleep(.02)
r = owner._run_cdp('Page.getLayoutMetrics')
x1 = r['layoutViewport']['pageX']
y1 = r['layoutViewport']['pageY']
if x == x1 and y == y1:
break
x = x1
y = y1
class ElementScroller(Scroller):
def to_see(self, center=None):
self._owner.owner.scroll.to_see(self._owner, center=center)
return self._owner
def to_center(self):
self._owner.owner.scroll.to_see(self._owner, center=True)
return self._owner
class PageScroller(Scroller):
def __init__(self, owner):
super().__init__(owner)
self._t1 = 'window'
self._t2 = 'document.documentElement'
def to_see(self, loc_or_ele, center=None):
ele = self._owner._ele(loc_or_ele)
self._to_see(ele, center)
return self._owner
def _to_see(self, ele, center):
txt = 'true' if center else 'false'
ele._run_js(f'this.scrollIntoViewIfNeeded({txt});')
if center or (center is not False and ele.states.is_covered):
ele._run_js('''function getWindowScrollTop() {let scroll_top = 0;
if (document.documentElement && document.documentElement.scrollTop) {
scroll_top = document.documentElement.scrollTop;
} else if (document.body) {scroll_top = document.body.scrollTop;}
return scroll_top;}
const { top, height } = this.getBoundingClientRect();
const elCenter = top + height / 2;
const center = window.innerHeight / 2;
window.scrollTo({top: getWindowScrollTop() - (center - elCenter),
behavior: 'instant'});''')
self._wait_scrolled()
class FrameScroller(PageScroller):
def __init__(self, owner):
"""
:param owner: ChromiumFrame对象
"""
super().__init__(owner.doc_ele)
self._t1 = self._t2 = 'this.documentElement'
def to_see(self, loc_or_ele, center=None):
ele = self._owner._ele(loc_or_ele)
self._to_see(ele, center)
return self._owner
@@ -0,0 +1,331 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from typing import Union
from .._elements.chromium_element import ChromiumElement
from .._pages.chromium_base import ChromiumBase
from .._pages.chromium_frame import ChromiumFrame
from .._pages.chromium_page import ChromiumPage
from .._pages.chromium_tab import ChromiumTab
from .._pages.mix_tab import MixTab
from .._pages.web_page import WebPage
class Scroller(object):
_owner: Union[ChromiumBase, ChromiumElement] = ...
_t1: str = ...
_t2: str = ...
_wait_complete: bool = ...
def __init__(self, owner: Union[ChromiumBase, ChromiumElement]):
"""
:param owner: 元素对象或页面对象
"""
...
def __call__(self, pixel: int = 300) -> None:
"""向下滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def to_top(self) -> None:
"""滚动到顶端,水平位置不变"""
...
def to_bottom(self) -> None:
"""滚动到底端,水平位置不变"""
...
def to_half(self) -> None:
"""滚动到垂直中间位置,水平位置不变"""
...
def to_rightmost(self) -> None:
"""滚动到最右边,垂直位置不变"""
...
def to_leftmost(self) -> None:
"""滚动到最左边,垂直位置不变"""
...
def to_location(self, x: int, y: int) -> None:
"""滚动到指定位置
:param x: 水平距离
:param y: 垂直距离
:return: None
"""
...
def up(self, pixel: int = 300) -> None:
"""向上滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def down(self, pixel: int = 300) -> None:
"""向下滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def left(self, pixel: int = 300) -> None:
"""向左滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def right(self, pixel: int = 300) -> None:
"""向右滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def _run_js(self, js: str): ...
def _wait_scrolled(self) -> None:
"""等待滚动结束"""
...
class ElementScroller(Scroller):
_owner: ChromiumElement = ...
def __init__(self, owner: ChromiumElement):
"""
:param owner: 元素对象
"""
...
def to_see(self, center: Union[bool, None] = None) -> ChromiumElement:
"""滚动页面直到元素可见
:param center: 是否尽量滚动到页面正中,为None时如果被遮挡,则滚动到页面正中
:return: None
"""
...
def to_center(self) -> ChromiumElement:
"""元素尽量滚动到视口中间"""
...
def to_top(self) -> ChromiumElement:
"""滚动到顶端,水平位置不变"""
...
def to_bottom(self) -> ChromiumElement:
"""滚动到底端,水平位置不变"""
...
def to_half(self) -> ChromiumElement:
"""滚动到垂直中间位置,水平位置不变"""
...
def to_rightmost(self) -> ChromiumElement:
"""滚动到最右边,垂直位置不变"""
...
def to_leftmost(self) -> ChromiumElement:
"""滚动到最左边,垂直位置不变"""
...
def to_location(self, x: int, y: int) -> ChromiumElement:
"""滚动到指定位置
:param x: 水平距离
:param y: 垂直距离
:return: None
"""
...
def up(self, pixel: int = 300) -> ChromiumElement:
"""向上滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def down(self, pixel: int = 300) -> ChromiumElement:
"""向下滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def left(self, pixel: int = 300) -> ChromiumElement:
"""向左滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def right(self, pixel: int = 300) -> ChromiumElement:
"""向右滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
class PageScroller(Scroller):
_owner: Union[ChromiumBase, ChromiumElement] = ...
def __init__(self, owner: Union[ChromiumBase, ChromiumElement]):
"""
:param owner: 页面对象
"""
...
def to_see(self,
loc_or_ele: Union[str, tuple, ChromiumElement],
center: Union[bool, None] = None) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""滚动页面直到元素可见
:param loc_or_ele: 元素的定位信息,可以是loc元组,或查询字符串
:param center: 是否尽量滚动到页面正中,为None时如果被遮挡,则滚动到页面正中
:return: None
"""
...
def to_top(self) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""滚动到顶端,水平位置不变"""
...
def to_bottom(self) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""滚动到底端,水平位置不变"""
...
def to_half(self) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""滚动到垂直中间位置,水平位置不变"""
...
def to_rightmost(self) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""滚动到最右边,垂直位置不变"""
...
def to_leftmost(self) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""滚动到最左边,垂直位置不变"""
...
def to_location(self, x: int, y: int) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""滚动到指定位置
:param x: 水平距离
:param y: 垂直距离
:return: None
"""
...
def up(self, pixel: int = 300) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""向上滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def down(self, pixel: int = 300) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""向下滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def left(self, pixel: int = 300) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""向左滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def right(self, pixel: int = 300) -> Union[ChromiumTab, MixTab, ChromiumPage, WebPage]:
"""向右滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def _to_see(self, ele: ChromiumElement, center: Union[bool, None]) -> None:
"""执行滚动页面直到元素可见
:param ele: 元素对象
:param center: 是否尽量滚动到页面正中,为None时如果被遮挡,则滚动到页面正中
:return: None
"""
...
class FrameScroller(PageScroller):
_owner: ChromiumElement = ...
def __init__(self, owner: ChromiumFrame): ...
def to_see(self,
loc_or_ele: Union[str, tuple, ChromiumElement],
center: Union[bool, None] = None) -> ChromiumFrame:
"""滚动页面直到元素可见
:param loc_or_ele: 元素的定位信息,可以是loc元组,或查询字符串
:param center: 是否尽量滚动到页面正中,为None时如果被遮挡,则滚动到页面正中
:return: None
"""
...
def to_top(self) -> ChromiumFrame:
"""滚动到顶端,水平位置不变"""
...
def to_bottom(self) -> ChromiumFrame:
"""滚动到底端,水平位置不变"""
...
def to_half(self) -> ChromiumFrame:
"""滚动到垂直中间位置,水平位置不变"""
...
def to_rightmost(self) -> ChromiumFrame:
"""滚动到最右边,垂直位置不变"""
...
def to_leftmost(self) -> ChromiumFrame:
"""滚动到最左边,垂直位置不变"""
...
def to_location(self, x: int, y: int) -> ChromiumFrame:
"""滚动到指定位置
:param x: 水平距离
:param y: 垂直距离
:return: None
"""
...
def up(self, pixel: int = 300) -> ChromiumFrame:
"""向上滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def down(self, pixel: int = 300) -> ChromiumFrame:
"""向下滚动若干像素,水平位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def left(self, pixel: int = 300) -> ChromiumFrame:
"""向左滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
def right(self, pixel: int = 300) -> ChromiumFrame:
"""向右滚动若干像素,垂直位置不变
:param pixel: 滚动的像素
:return: None
"""
...
@@ -0,0 +1,160 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from time import perf_counter, sleep
from .._functions.settings import Settings as _S
class SelectElement(object):
"""用于处理 select 标签"""
def __init__(self, ele):
if ele.tag != 'select':
raise TypeError(_S._lang.join(_S._lang.SELECT_ONLY))
self._ele = ele
def __call__(self, text_or_index, timeout=None):
para_type = 'index' if isinstance(text_or_index, int) else 'text'
if timeout is None:
timeout = self._ele.timeout
return self._select(text_or_index, para_type, timeout=timeout)
@property
def is_multi(self):
return self._ele.attr('multiple') is not None
@property
def options(self):
return [i for i in self._ele.eles('xpath://option') if not isinstance(i, int)]
@property
def selected_option(self):
return self._ele._run_js('return this.options[this.selectedIndex];')
@property
def selected_options(self):
return [x for x in self.options if x.states.is_selected]
def all(self):
if not self.is_multi:
raise TypeError(_S._lang.join(_S._lang.MULTI_SELECT_ONLY))
return self._by_loc('tag:option', 1, False)
def invert(self):
if not self.is_multi:
raise TypeError(_S._lang.join(_S._lang.MULTI_SELECT_ONLY))
change = False
for i in self.options:
change = True
mode = 'false' if i.states.is_selected else 'true'
i._run_js(f'this.selected={mode};')
if change:
self._dispatch_change()
return self._ele
def clear(self):
if not self.is_multi:
raise TypeError(_S._lang.join(_S._lang.MULTI_SELECT_ONLY))
return self._by_loc('tag:option', 1, True)
def by_text(self, text, timeout=None):
return self._select(text, 'text', False, timeout)
def by_value(self, value, timeout=None):
return self._select(value, 'value', False, timeout)
def by_index(self, index, timeout=None):
return self._select(index, 'index', False, timeout)
def by_locator(self, locator, timeout=None):
return self._by_loc(locator, timeout)
def by_option(self, option):
return self._select_options(option, 'true')
def cancel_by_text(self, text, timeout=None):
return self._select(text, 'text', True, timeout)
def cancel_by_value(self, value, timeout=None):
return self._select(value, 'value', True, timeout)
def cancel_by_index(self, index, timeout=None):
return self._select(index, 'index', True, timeout)
def cancel_by_locator(self, locator, timeout=None):
return self._by_loc(locator, timeout, True)
def cancel_by_option(self, option):
return self._select_options(option, 'false')
def _by_loc(self, loc, timeout=None, cancel=False):
eles = self._ele.eles(loc, timeout)
if not eles:
raise RuntimeError(_S._lang.join(_S._lang.OPTION_NOT_FOUND))
mode = 'false' if cancel else 'true'
if not self.is_multi:
eles = eles[0]
return self._select_options(eles, mode)
def _select(self, condition, para_type='text', cancel=False, timeout=None):
if not self.is_multi and isinstance(condition, (list, tuple)):
raise TypeError(_S._lang.join(_S._lang.STR_FOR_SINGLE_SELECT))
mode = 'false' if cancel else 'true'
if timeout is None:
timeout = self._ele.timeout
condition = set(condition) if isinstance(condition, (list, tuple)) else {condition}
if para_type in ('text', 'value'):
return self._text_value([str(i) for i in condition], para_type, mode, timeout)
elif para_type == 'index':
return self._index(condition, mode, timeout)
def _text_value(self, condition, para_type, mode, timeout):
text_len = len(condition)
eles = []
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if para_type == 'text':
eles = [i for i in self.options if i.text in condition]
elif para_type == 'value':
eles = [i for i in self.options if i.attr('value') in condition]
if len(eles) >= text_len:
return self._select_options(eles, mode)
sleep(.01)
raise RuntimeError(_S._lang.join(_S._lang.OPTION_NOT_FOUND))
def _index(self, condition, mode, timeout):
condition = [int(i) for i in condition]
text_len = abs(max(condition, key=abs))
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if len(self.options) >= text_len:
eles = self.options
eles = [eles[i - 1] if i > 0 else eles[i] for i in condition]
return self._select_options(eles, mode)
sleep(.01)
raise RuntimeError(_S._lang.join(_S._lang.OPTION_NOT_FOUND))
def _select_options(self, option, mode):
if isinstance(option, (list, tuple, set)):
if not self.is_multi and len(option) > 1:
option = option[:1]
for o in option:
o._run_js(f'this.selected={mode};')
self._dispatch_change()
else:
option._run_js(f'this.selected={mode};')
self._dispatch_change()
return self._ele
def _dispatch_change(self):
self._ele._run_js('this.dispatchEvent(new CustomEvent("change", {bubbles: true}));')
@@ -0,0 +1,220 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from typing import Union, Tuple, List, Optional
from .._elements.chromium_element import ChromiumElement
class SelectElement(object):
_ele: ChromiumElement = ...
def __init__(self, ele: ChromiumElement):
"""
:param ele: <select>元素对象
"""
...
def __call__(self,
text_or_index: Union[str, int, list, tuple],
timeout: float = None) -> ChromiumElement:
"""选定下拉列表中子元素
:param text_or_index: 根据文本、值选或序号择选项,若允许多选,传入list或tuple可多选
:param timeout: 超时时间(秒),不输入默认实用页面超时时间
:return: <select>元素对象
"""
...
@property
def is_multi(self) -> bool:
"""返回是否多选表单"""
...
@property
def options(self) -> List[ChromiumElement]:
"""返回所有选项元素组成的列表"""
...
@property
def selected_option(self) -> Optional[ChromiumElement]:
"""返回第一个被选中的<option>元素"""
...
@property
def selected_options(self) -> List[ChromiumElement]:
"""返回所有被选中的<option>元素列表"""
...
def all(self) -> ChromiumElement:
"""全选"""
...
def invert(self) -> ChromiumElement:
"""反选"""
...
def clear(self) -> ChromiumElement:
"""清除所有已选项"""
...
def by_text(self,
text: Union[str, list, tuple],
timeout: float = None) -> ChromiumElement:
"""此方法用于根据text值选择项。当元素是多选列表时,可以接收list或tuple
:param text: text属性值,传入list或tuple可选择多项
:param timeout: 超时时间(秒),为None默认使用页面超时时间
:return: <select>元素对象
"""
...
def by_value(self,
value: Union[str, list, tuple],
timeout: float = None) -> ChromiumElement:
"""此方法用于根据value值选择项。当元素是多选列表时,可以接收list或tuple
:param value: value属性值,传入list或tuple可选择多项
:param timeout: 超时时间,为None默认使用页面超时时间
:return: <select>元素对象
"""
...
def by_index(self,
index: Union[int, list, tuple],
timeout: float = None) -> ChromiumElement:
"""此方法用于根据index值选择项。当元素是多选列表时,可以接收list或tuple
:param index: 序号,从1开始,可传入负数获取倒数第几个,传入list或tuple可选择多项
:param timeout: 超时时间,为None默认使用页面超时时间
:return: <select>元素对象
"""
...
def by_locator(self,
locator: Union[Tuple[str, str], str],
timeout: float = None) -> ChromiumElement:
"""用定位符选择指定的项
:param locator: 定位符
:param timeout: 超时时间
:return: <select>元素对象
"""
...
def by_option(self,
option: Union[ChromiumElement, List[ChromiumElement], Tuple[ChromiumElement]]) -> ChromiumElement:
"""选中单个或多个<option>元素
:param option: <option>元素或它们组成的列表
:return: <select>元素对象
"""
...
def cancel_by_text(self,
text: Union[str, list, tuple],
timeout: float = None) -> ChromiumElement:
"""此方法用于根据text值取消选择项。当元素是多选列表时,可以接收list或tuple
:param text: 文本,传入list或tuple可取消多项
:param timeout: 超时时间,不输入默认实用页面超时时间
:return: <select>元素对象
"""
...
def cancel_by_value(self,
value: Union[str, list, tuple],
timeout: float = None) -> ChromiumElement:
"""此方法用于根据value值取消选择项。当元素是多选列表时,可以接收list或tuple
:param value: value属性值,传入list或tuple可取消多项
:param timeout: 超时时间,不输入默认实用页面超时时间
:return: <select>元素对象
"""
...
def cancel_by_index(self,
index: Union[int, list, tuple],
timeout: float = None) -> ChromiumElement:
"""此方法用于根据index值取消选择项。当元素是多选列表时,可以接收list或tuple
:param index: 序号,从1开始,可传入负数获取倒数第几个,传入list或tuple可取消多项
:param timeout: 超时时间,不输入默认实用页面超时时间
:return: <select>元素对象
"""
...
def cancel_by_locator(self,
locator: Union[Tuple[str, str], str],
timeout: float = None) -> ChromiumElement:
"""用定位符取消选择指定的项
:param locator: 定位符
:param timeout: 超时时间
:return: <select>元素对象
"""
...
def cancel_by_option(self,
option: Union[ChromiumElement, List[ChromiumElement],
Tuple[ChromiumElement]]) -> ChromiumElement:
"""取消选中单个或多个<option>元素
:param option: <option>元素或它们组成的列表
:return: <select>元素对象
"""
...
def _by_loc(self,
loc: Union[str, Tuple[str, str]],
timeout: float = None,
cancel: bool = False) -> ChromiumElement:
"""用定位符取消选择指定的项
:param loc: 定位符
:param timeout: 超时时间
:param cancel: 是否取消选择
:return: <select>元素对象
"""
...
def _select(self,
condition: Union[str, int, list, tuple] = None,
para_type: str = 'text',
cancel: bool = False,
timeout: float = None) -> ChromiumElement:
"""选定或取消选定下拉列表中子元素
:param condition: 根据文本、值选或序号择选项,若允许多选,传入list或tuple可多选
:param para_type: 参数类型,可选 'text'、'value'、'index'
:param cancel: 是否取消选择
:return: <select>元素对象
"""
...
def _text_value(self,
condition: Union[list, set],
para_type: str,
mode: str,
timeout: float) -> ChromiumElement:
"""执行text和value搜索
:param condition: 条件set
:param para_type: 参数类型,可选 'text'、'value'
:param mode: 'true' 或 'false'
:param timeout: 超时时间
:return: <select>元素对象
"""
...
def _index(self, condition: set, mode: str, timeout: float) -> ChromiumElement:
"""执行index搜索
:param condition: 条件set
:param mode: 'true' 或 'false'
:param timeout: 超时时间
:return: <select>元素对象
"""
...
def _select_options(self,
option: Union[ChromiumElement, List[ChromiumElement], Tuple[ChromiumElement]],
mode: str) -> ChromiumElement:
"""选中或取消某个选项
:param option: options元素对象
:param mode: 选中还是取消
:return: <select>元素对象
"""
...
def _dispatch_change(self) -> None:
"""触发修改动作"""
...
@@ -0,0 +1,486 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from pathlib import Path
from time import sleep
from requests.structures import CaseInsensitiveDict
from .cookies_setter import (SessionCookiesSetter, CookiesSetter, WebPageCookiesSetter, BrowserCookiesSetter,
MixTabCookiesSetter)
from .._functions.settings import Settings as _S
from .._functions.tools import show_or_hide_browser
from .._functions.web import format_headers
from ..errors import ElementLostError, JavaScriptError
class BaseSetter(object):
def __init__(self, owner):
self._owner = owner
def NoneElement_value(self, value=None, on_off=True):
self._owner._none_ele_return_value = on_off
self._owner._none_ele_value = value
def retry_times(self, times):
self._owner.retry_times = times
def retry_interval(self, interval):
self._owner.retry_interval = interval
def download_path(self, path):
if path is None:
path = '.'
self._owner._download_path = str(Path(path).absolute())
class SessionPageSetter(BaseSetter):
def __init__(self, owner):
super().__init__(owner)
self._cookies_setter = None
@property
def cookies(self):
if self._cookies_setter is None:
self._cookies_setter = SessionCookiesSetter(self._owner)
return self._cookies_setter
def download_path(self, path):
super().download_path(path)
if self._owner._DrissionGet:
self._owner._DrissionGet.set.save_path(self._owner._download_path)
def timeout(self, second):
self._owner._timeout = second
def encoding(self, encoding, set_all=True):
if set_all:
self._owner._encoding = encoding if encoding else None
if self._owner.response:
self._owner.response.encoding = encoding
def headers(self, headers):
self._owner._headers = CaseInsensitiveDict(format_headers(headers))
def header(self, name, value):
self._owner._headers[name] = value
def user_agent(self, ua):
self._owner._headers['user-agent'] = ua
def proxies(self, http=None, https=None):
self._owner.session.proxies = {'http': http, 'https': https}
def auth(self, auth):
self._owner.session.auth = auth
def hooks(self, hooks):
self._owner.session.hooks = hooks
def params(self, params):
self._owner.session.params = params
def verify(self, on_off):
self._owner.session.verify = on_off
def cert(self, cert):
self._owner.session.cert = cert
def stream(self, on_off):
self._owner.session.stream = on_off
def trust_env(self, on_off):
self._owner.session.trust_env = on_off
def max_redirects(self, times):
self._owner.session.max_redirects = times
def add_adapter(self, url, adapter):
self._owner.session.mount(url, adapter)
class BrowserBaseSetter(BaseSetter):
def __init__(self, owner):
super().__init__(owner)
self._cookies_setter = None
@property
def load_mode(self):
return LoadMode(self._owner)
def timeouts(self, base=None, page_load=None, script=None):
if base is not None:
self._owner.timeouts.base = base
if page_load is not None:
self._owner.timeouts.page_load = page_load
if script is not None:
self._owner.timeouts.script = script
class BrowserSetter(BrowserBaseSetter):
@property
def cookies(self):
if self._cookies_setter is None:
self._cookies_setter = BrowserCookiesSetter(self._owner)
return self._cookies_setter
def auto_handle_alert(self, on_off=True, accept=True):
self._owner._auto_handle_alert = None if on_off is None else accept if on_off else 'close'
def download_path(self, path):
super().download_path(path)
self._owner._dl_mgr.set_path('browser', self._owner._download_path)
def download_file_name(self, name=None, suffix=None):
self._owner._dl_mgr.set_rename('browser', name, suffix)
def when_download_file_exists(self, mode):
types = {'rename': 'rename', 'overwrite': 'overwrite', 'skip': 'skip', 'r': 'rename', 'o': 'overwrite',
's': 'skip'}
mode = types.get(mode, mode)
if mode not in types:
raise ValueError(_S._lang.join(_S._lang.INCORRECT_VAL_, 'mode',
ALLOW_VAL="', '".join(types.keys()), CURR_VAL=mode))
self._owner._dl_mgr.set_file_exists('browser', mode)
class ChromiumBaseSetter(BrowserBaseSetter):
@property
def scroll(self):
return PageScrollSetter(self._owner.scroll)
@property
def cookies(self):
if self._cookies_setter is None:
self._cookies_setter = CookiesSetter(self._owner)
return self._cookies_setter
def headers(self, headers):
self._owner._run_cdp('Network.enable')
self._owner._run_cdp('Network.setExtraHTTPHeaders', headers=format_headers(headers))
def user_agent(self, ua, platform=None):
keys = {'userAgent': ua}
if platform:
keys['platform'] = platform
self._owner._run_cdp('Emulation.setUserAgentOverride', **keys)
def session_storage(self, item, value):
self._owner._run_cdp_loaded('DOMStorage.enable')
i = self._owner._run_cdp('Storage.getStorageKeyForFrame', frameId=self._owner._frame_id)['storageKey']
if value is False:
self._owner._run_cdp('DOMStorage.removeDOMStorageItem',
storageId={'storageKey': i, 'isLocalStorage': False}, key=item)
else:
self._owner._run_cdp('DOMStorage.setDOMStorageItem', storageId={'storageKey': i, 'isLocalStorage': False},
key=item, value=value)
self._owner._run_cdp_loaded('DOMStorage.disable')
def local_storage(self, item, value):
self._owner._run_cdp_loaded('DOMStorage.enable')
i = self._owner._run_cdp('Storage.getStorageKeyForFrame', frameId=self._owner._frame_id)['storageKey']
if value is False:
self._owner._run_cdp('DOMStorage.removeDOMStorageItem',
storageId={'storageKey': i, 'isLocalStorage': True}, key=item)
else:
self._owner._run_cdp('DOMStorage.setDOMStorageItem', storageId={'storageKey': i, 'isLocalStorage': True},
key=item, value=value)
self._owner._run_cdp_loaded('DOMStorage.disable')
def upload_files(self, files):
if not self._owner._upload_list:
self._owner.driver.set_callback('Page.fileChooserOpened', self._owner._onFileChooserOpened)
self._owner._run_cdp('Page.setInterceptFileChooserDialog', enabled=True)
if isinstance(files, str):
files = files.split('\n')
elif isinstance(files, Path):
files = (files,)
self._owner._upload_list = [str(Path(i).absolute()) for i in files]
def auto_handle_alert(self, on_off=True, accept=True):
self._owner._alert.auto = None if on_off is None else accept if on_off else 'close'
def blocked_urls(self, urls):
if not urls:
urls = []
elif isinstance(urls, str):
urls = (urls,)
if not isinstance(urls, (list, tuple)):
raise ValueError(_S._lang.join(_S._lang.INCORRECT_TYPE_, 'urls',
ALLOW_TYPE='str, list, tuple', CURR_VAL=urls))
self._owner._run_cdp('Network.enable')
self._owner._run_cdp('Network.setBlockedURLs', urls=urls)
class TabSetter(ChromiumBaseSetter):
def __init__(self, owner):
super().__init__(owner)
@property
def window(self):
return WindowSetter(self._owner)
def download_path(self, path):
super().download_path(path)
self._owner.browser._dl_mgr.set_path(self._owner, self._owner._download_path)
if self._owner._DrissionGet:
self._owner._DrissionGet.set.save_path(self._owner._download_path)
def download_file_name(self, name=None, suffix=None):
self._owner.browser._dl_mgr.set_rename(self._owner.tab_id, name, suffix)
def when_download_file_exists(self, mode):
types = {'rename': 'rename', 'overwrite': 'overwrite', 'skip': 'skip',
'r': 'rename', 'o': 'overwrite', 's': 'skip'}
mode = types.get(mode, mode)
if mode not in types:
raise ValueError(_S._lang.join(_S._lang.INCORRECT_VAL_, 'mode',
ALLOW_VAL="', '".join(types.keys()), CURR_VAL=mode))
self._owner.browser._dl_mgr.set_file_exists(self._owner.tab_id, mode)
def activate(self):
self._owner.browser.activate_tab(self._owner.tab_id)
class ChromiumPageSetter(TabSetter):
def NoneElement_value(self, value=None, on_off=True):
super().NoneElement_value(value, on_off)
self._owner.browser._none_ele_return_value = on_off
self._owner.browser._none_ele_value = value
def retry_times(self, times):
super().retry_times(times)
self._owner.browser.retry_times = times
def retry_interval(self, interval):
super().retry_interval(interval)
self._owner.browser.retry_interval = interval
def download_path(self, path):
if path is None:
path = '.'
self._owner._download_path = str(Path(path).absolute())
self._owner.browser.set.download_path(path)
if self._owner._DrissionGet:
self._owner._DrissionGet.set.save_path(path)
def download_file_name(self, name=None, suffix=None):
self._owner.browser.set.download_file_name(name, suffix)
def when_download_file_exists(self, mode):
self._owner.browser.set.when_download_file_exists(mode)
class WebPageSetter(ChromiumPageSetter):
def __init__(self, owner):
super().__init__(owner)
self._session_setter = SessionPageSetter(self._owner)
self._chromium_setter = ChromiumPageSetter(self._owner)
@property
def cookies(self):
if self._cookies_setter is None:
self._cookies_setter = WebPageCookiesSetter(self._owner)
return self._cookies_setter
def headers(self, headers):
if self._owner.mode == 's':
self._session_setter.headers(headers)
else:
self._chromium_setter.headers(headers)
def user_agent(self, ua, platform=None):
if self._owner.mode == 's':
self._session_setter.user_agent(ua)
else:
self._chromium_setter.user_agent(ua, platform)
class MixTabSetter(TabSetter):
def __init__(self, owner):
super().__init__(owner)
self._session_setter = SessionPageSetter(self._owner)
self._chromium_setter = ChromiumBaseSetter(self._owner)
@property
def cookies(self):
if self._cookies_setter is None:
self._cookies_setter = MixTabCookiesSetter(self._owner)
return self._cookies_setter
def headers(self, headers):
if self._owner._session:
self._session_setter.headers(headers)
if self._owner._driver and self._owner._driver.is_running:
self._chromium_setter.headers(headers)
def user_agent(self, ua, platform=None):
if self._owner._session:
self._session_setter.user_agent(ua)
if self._owner._driver and self._owner._driver.is_running:
self._chromium_setter.user_agent(ua, platform)
def timeouts(self, base=None, page_load=None, script=None):
super().timeouts(base=base, page_load=page_load, script=script)
if base is not None:
self._owner._timeout = base
class ChromiumElementSetter(object):
def __init__(self, ele):
self._ele = ele
def attr(self, name, value=''):
try:
self._ele.owner._run_cdp('DOM.setAttributeValue',
nodeId=self._ele._node_id, name=name, value=str(value))
except ElementLostError:
self._ele._refresh_id()
self._ele.owner._run_cdp('DOM.setAttributeValue',
nodeId=self._ele._node_id, name=name, value=str(value))
def property(self, name, value):
value = value.replace('"', r'\"')
self._ele._run_js(f'this.{name}="{value}";')
def style(self, name, value):
try:
self._ele._run_js(f'this.style.{name}="{value}";')
except JavaScriptError:
raise RuntimeError(_S._lang.join(_S._lang.SET_FAILED_, name, VALUE=value))
def innerHTML(self, html):
self.property('innerHTML', html)
def value(self, value):
self.property('value', value)
class ChromiumFrameSetter(ChromiumBaseSetter):
def attr(self, name, value):
self._owner.frame_ele.set.attr(name, value)
def property(self, name, value):
self._owner.frame_ele.set.property(name=name, value=value)
def style(self, name, value):
self._owner.frame_ele.set.style(name=name, value=value)
class LoadMode(object):
def __init__(self, owner):
self._owner = owner
def __call__(self, value):
if value.lower() not in ('normal', 'eager', 'none'):
raise ValueError(_S._lang.join(_S._lang.INCORRECT_VAL_, 'value',
ALLOW_VAL="'normal', 'eager', 'none'", CURR_VAL=value))
self._owner._load_mode = value
if self._owner._type in ('ChromiumPage', 'WebPage'):
self._owner.browser._load_mode = value
def normal(self):
self.__call__('normal')
def eager(self):
self.__call__('eager')
def none(self):
self.__call__('none')
class PageScrollSetter(object):
def __init__(self, scroll):
self._scroll = scroll
def wait_complete(self, on_off=True):
if not isinstance(on_off, bool):
raise ValueError(_S._lang.join(_S._lang.INCORRECT_TYPE_, 'on_off',
ALLOW_TYPE='bool', CURR_TYPE=type(on_off)))
self._scroll._wait_complete = on_off
def smooth(self, on_off=True):
if not isinstance(on_off, bool):
raise ValueError(_S._lang.join(_S._lang.INCORRECT_TYPE_, 'on_off',
ALLOW_TYPE='bool', CURR_TYPE=type(on_off)))
b = 'smooth' if on_off else 'auto'
self._scroll._owner._run_js(f'document.documentElement.style.setProperty("scroll-behavior","{b}");')
self._scroll._wait_complete = on_off
class WindowSetter(object):
def __init__(self, owner):
self._owner = owner
self._window_id = self._get_info()['windowId']
def max(self):
s = self._get_info()['bounds']['windowState']
if s in ('fullscreen', 'minimized'):
self._perform({'windowState': 'normal'})
self._perform({'windowState': 'maximized'})
def mini(self):
s = self._get_info()['bounds']['windowState']
if s == 'fullscreen':
self._perform({'windowState': 'normal'})
self._perform({'windowState': 'minimized'})
def full(self):
s = self._get_info()['bounds']['windowState']
if s == 'minimized':
self._perform({'windowState': 'normal'})
self._perform({'windowState': 'fullscreen'})
def normal(self):
s = self._get_info()['bounds']['windowState']
if s == 'fullscreen':
self._perform({'windowState': 'normal'})
self._perform({'windowState': 'normal'})
def size(self, width=None, height=None):
if width or height:
s = self._get_info()['bounds']['windowState']
if s != 'normal':
self._perform({'windowState': 'normal'})
info = self._get_info()['bounds']
width = width - 16 if width else info['width']
height = height + 7 if height else info['height']
self._perform({'width': width, 'height': height})
def location(self, x=None, y=None):
if x is not None or y is not None:
self.normal()
info = self._get_info()['bounds']
x = x if x is not None else info['left']
y = y if y is not None else info['top']
self._perform({'left': x - 8, 'top': y})
def hide(self):
show_or_hide_browser(self._owner, hide=True)
def show(self):
show_or_hide_browser(self._owner, hide=False)
def _get_info(self):
for _ in range(50):
try:
return self._owner._run_cdp('Browser.getWindowForTarget')
except:
sleep(.02)
raise RuntimeError(_S._lang.join(_S._lang.GET_WINDOW_SIZE_FAILED))
def _perform(self, bounds):
try:
self._owner._run_cdp('Browser.setWindowBounds', windowId=self._window_id, bounds=bounds)
except:
raise RuntimeError(_S._lang.join(TIP=_S._lang.SET_WINDOW_NORMAL))
@@ -0,0 +1,645 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from pathlib import Path
from typing import Union, Tuple, Literal, Any, Optional
from requests.adapters import HTTPAdapter
from requests.auth import HTTPBasicAuth
from .cookies_setter import SessionCookiesSetter, CookiesSetter, WebPageCookiesSetter, BrowserCookiesSetter
from .scroller import PageScroller
from .._base.base import BasePage
from .._base.chromium import Chromium
from .._elements.chromium_element import ChromiumElement
from .._pages.chromium_base import ChromiumBase
from .._pages.chromium_frame import ChromiumFrame
from .._pages.chromium_page import ChromiumPage
from .._pages.chromium_tab import ChromiumTab
from .._pages.mix_tab import MixTab
from .._pages.session_page import SessionPage
from .._pages.web_page import WebPage
FILE_EXISTS = Literal['skip', 'rename', 'overwrite', 's', 'r', 'o']
class BaseSetter(object):
_owner: Union[Chromium, BasePage] = ...
def __init__(self, owner: Union[Chromium, BasePage]):
"""
:param owner: BasePage对象
"""
...
def NoneElement_value(self,
value: Any = None,
on_off: bool = True) -> None:
"""设置空元素是否返回设定值
:param value: 返回的设定值
:param on_off: 是否启用
:return: None
"""
...
def retry_times(self, times: int) -> None:
"""设置连接失败重连次数
:param times: 重试次数
:return: None
"""
...
def retry_interval(self, interval: float) -> None:
"""设置连接失败重连间隔(秒)
:param interval: 重试间隔
:return: None
"""
...
def download_path(self, path: Union[str, Path, None]) -> None:
"""设置下载路径
:param path: 下载路径
:return: None
"""
...
class SessionPageSetter(BaseSetter):
_owner: SessionPage = ...
_cookies_setter: Optional[SessionCookiesSetter] = ...
def __init__(self, owner: SessionPage):
"""
:param owner: SessionPage对象
"""
...
@property
def cookies(self) -> SessionCookiesSetter:
"""返回用于设置cookies的对象"""
...
def download_path(self, path: Union[str, Path, None]) -> None:
"""设置下载路径
:param path: 下载路径
:return: None
"""
...
def timeout(self, second: float) -> None:
"""设置连接超时时间
:param second: 秒数
:return: None
"""
...
def encoding(self, encoding: Union[str, None], set_all: bool = True) -> None:
"""设置编码
:param encoding: 编码名称,如果要取消之前的设置,传入None
:param set_all: 是否设置对象参数,为False则只设置当前Response
:return: None
"""
...
def headers(self, headers: Union[str, dict]) -> None:
"""设置通用的headers
:param headers: dict形式的headers
:return: None
"""
...
def header(self, name: str, value: str) -> None:
"""设置headers中一个项
:param name: 设置名称
:param value: 设置值
:return: None
"""
...
def user_agent(self, ua: str) -> None:
"""设置user agent
:param ua: user agent
:return: None
"""
...
def proxies(self, http: str = None, https: str = None) -> None:
"""设置proxies参数
:param http: http代理地址
:param https: https代理地址
:return: None
"""
...
def auth(self, auth: Union[Tuple[str, str], HTTPBasicAuth, None]) -> None:
"""设置认证元组或对象
:param auth: 认证元组或对象
:return: None
"""
...
def hooks(self, hooks: Union[dict, None]) -> None:
"""设置回调方法
:param hooks: 回调方法
:return: None
"""
...
def params(self, params: Union[dict, None]) -> None:
"""设置查询参数字典
:param params: 查询参数字典
:return: None
"""
...
def verify(self, on_off: Union[bool, None]) -> None:
"""设置是否验证SSL证书
:param on_off: 是否验证 SSL 证书
:return: None
"""
...
def cert(self, cert: Union[str, Tuple[str, str], None]) -> None:
"""SSL客户端证书文件的路径(.pem格式),或('cert', 'key')元组
:param cert: 证书路径或元组
:return: None
"""
...
def stream(self, on_off: Union[bool, None]) -> None:
"""设置是否使用流式响应内容
:param on_off: 是否使用流式响应内容
:return: None
"""
...
def trust_env(self, on_off: Union[bool, None]) -> None:
"""设置是否信任环境
:param on_off: 是否信任环境
:return: None
"""
...
def max_redirects(self, times: Union[int, None]) -> None:
"""设置最大重定向次数
:param times: 最大重定向次数
:return: None
"""
...
def add_adapter(self, url: str, adapter: HTTPAdapter) -> None:
"""添加适配器
:param url: 适配器对应url
:param adapter: 适配器对象
:return: None
"""
...
class BrowserBaseSetter(BaseSetter):
"""Browser和ChromiumBase设置"""
_cookies_setter: Optional[CookiesSetter] = ...
def __init__(self, owner: ChromiumBase):
"""
:param owner: ChromiumBase对象
"""
...
@property
def load_mode(self) -> LoadMode:
"""返回用于设置页面加载模式的对象"""
...
def timeouts(self,
base=None,
page_load=None,
script=None) -> None:
"""设置超时时间,单位为秒
:param base: 基本等待时间,除页面加载和脚本超时,其它等待默认使用
:param page_load: 页面加载超时时间
:param script: 脚本运行超时时间
:return: None
"""
...
class BrowserSetter(BrowserBaseSetter):
_owner: Chromium = ...
_cookies_setter: BrowserCookiesSetter = ...
def __init__(self, owner: Chromium):
"""
:param owner: Chromium对象
"""
...
@property
def cookies(self) -> BrowserCookiesSetter:
"""返回用于设置cookies的对象"""
...
@property
def window(self)->WindowSetter:...
def auto_handle_alert(self,
on_off: bool = True,
accept: bool = True) -> None:
"""设置本浏览器是否启用自动处理弹窗
:param on_off: bool表示开或关,传入None表示使用Settings设置
:param accept: bool表示确定还是取消
:return: None
"""
...
def download_path(self, path: Union[Path, str, None]) -> None:
"""设置下载路径
:param path: 下载路径
:return: None
"""
...
def download_file_name(self,
name: str = None,
suffix: str = None) -> None:
"""设置下一个被下载文件的名称
:param name: 文件名,可不含后缀,会自动使用远程文件后缀
:param suffix: 后缀名,显式设置后缀名,不使用远程文件后缀
:return: None
"""
...
def when_download_file_exists(self, mode: FILE_EXISTS) -> None:
"""设置当存在同名文件时的处理方式
:param mode: 可在 'rename', 'overwrite', 'skip', 'r', 'o', 's'中选择
:return: None
"""
...
class ChromiumBaseSetter(BrowserBaseSetter):
_owner: ChromiumBase = ...
_cookies_setter: CookiesSetter = ...
def __init__(self, owner): ...
@property
def scroll(self) -> PageScrollSetter:
"""返回用于设置页面滚动设置的对象"""
...
@property
def cookies(self) -> CookiesSetter:
"""返回用于设置cookies的对象"""
...
def headers(self, headers: Union[dict, str]) -> None:
"""设置固定发送的headers
:param headers: dict格式的headers数据,或从浏览器复制的headers文本(\n分行)
:return: None
"""
...
def user_agent(self, ua: str, platform: str = None) -> None:
"""为当前tab设置user agent,只在当前tab有效
:param ua: user agent字符串
:param platform: platform字符串
:return: None
"""
...
def session_storage(self, item: str, value: Union[str, bool]) -> None:
"""设置或删除某项sessionStorage信息
:param item: 要设置的项
:param value: 项的值,设置为False时,删除该项
:return: None
"""
...
def local_storage(self, item: str, value: Union[str, bool]) -> None:
"""设置或删除某项localStorage信息
:param item: 要设置的项
:param value: 项的值,设置为False时,删除该项
:return: None
"""
...
def upload_files(self, files: Union[str, Path, list, tuple]) -> None:
"""等待上传的文件路径
:param files: 文件路径列表或字符串,字符串时多个文件用回车分隔
:return: None
"""
...
def auto_handle_alert(self,
on_off: bool = True,
accept: bool = True) -> None:
"""设置是否启用自动处理弹窗
:param on_off: bool表示开或关
:param accept: bool表示确定还是取消
:return: None
"""
...
def blocked_urls(self, urls: Union[list, tuple, str, None]) -> None:
"""设置要忽略的url
:param urls: 要忽略的url,可用*通配符,可输入多个,传入None时清空已设置的内容
:return: None
"""
...
class TabSetter(ChromiumBaseSetter):
_owner: ChromiumTab = ...
def __init__(self, owner: ChromiumTab):
"""
:param owner: 标签页对象
"""
...
@property
def window(self) -> WindowSetter:
"""返回用于设置浏览器窗口的对象"""
...
def download_path(self, path: Union[str, Path, None]) -> None:
"""设置下载路径
:param path: 下载路径
:return: None
"""
...
def download_file_name(self,
name: str = None,
suffix: str = None) -> None:
"""设置下一个被下载文件的名称
:param name: 文件名,可不含后缀,会自动使用远程文件后缀
:param suffix: 后缀名,显式设置后缀名,不使用远程文件后缀
:return: None
"""
...
def when_download_file_exists(self, mode: FILE_EXISTS) -> None:
"""设置当存在同名文件时的处理方式
:param mode: 可在 'rename', 'overwrite', 'skip', 'r', 'o', 's'中选择
:return: None
"""
...
def activate(self) -> None:
"""使标签页处于最前面"""
...
class ChromiumPageSetter(TabSetter):
_owner: ChromiumPage = ...
def __init__(self, owner: ChromiumPage):
"""
:param owner: ChromiumPage对象
"""
...
class WebPageSetter(ChromiumPageSetter):
_owner: WebPage = ...
_session_setter: SessionPageSetter = ...
_chromium_setter: ChromiumPageSetter = ...
def __init__(self, owner: WebPage):
"""
:param owner: WebPage对象
"""
...
@property
def cookies(self) -> WebPageCookiesSetter:
"""返回用于设置cookies的对象"""
...
class MixTabSetter(TabSetter):
_owner: MixTab = ...
_session_setter: SessionPageSetter = ...
_chromium_setter: ChromiumBaseSetter = ...
def __init__(self, owner: MixTab):
"""
:param owner: MixTab对象
"""
...
@property
def cookies(self) -> WebPageCookiesSetter:
"""返回用于设置cookies的对象"""
...
def timeouts(self,
base: float = None,
page_load: float = None,
script: float = None) -> None:
"""设置超时时间,单位为秒
:param base: 基本等待时间,除页面加载和脚本超时,其它等待默认使用
:param page_load: 页面加载超时时间
:param script: 脚本运行超时时间
:return: None
"""
...
class ChromiumElementSetter(object):
_ele: ChromiumElement = ...
def __init__(self, ele: ChromiumElement):
"""
:param ele: ChromiumElement
"""
...
def attr(self, name: str, value: str = '') -> None:
"""设置元素attribute属性
:param name: 属性名
:param value: 属性值
:return: None
"""
...
def property(self, name: str, value: str) -> None:
"""设置元素property属性
:param name: 属性名
:param value: 属性值
:return: None
"""
...
def style(self, name: str, value: str) -> None:
"""设置元素style样式
:param name: 样式名称
:param value: 样式值
:return: None
"""
...
def innerHTML(self, html: str) -> None:
"""设置元素innerHTML
:param html: html文本
:return: None
"""
...
def value(self, value: str) -> None:
"""设置元素value值
:param value: value值
:return: None
"""
...
class ChromiumFrameSetter(ChromiumBaseSetter):
_owner: ChromiumFrame = ...
def attr(self, name: str, value: str) -> None:
"""设置frame元素attribute属性
:param name: 属性名
:param value: 属性值
:return: None
"""
...
def property(self, name, value) -> None:
"""设置元素property属性
:param name: 属性名
:param value: 属性值
:return: None
"""
...
def style(self, name, value) -> None:
"""设置元素style样式
:param name: 样式名称
:param value: 样式值
:return: None
"""
...
class LoadMode(object):
"""用于设置页面加载策略的类"""
_owner: Union[Chromium, ChromiumBase] = ...
def __init__(self, owner: Union[Chromium, ChromiumBase]):
"""
:param owner: ChromiumBase对象
"""
...
def __call__(self, value: Literal['normal', 'eager', 'none']) -> None:
"""设置加载策略
:param value: 可选 'normal', 'eager', 'none'
:return: None
"""
...
def normal(self) -> None:
"""设置页面加载策略为normal"""
...
def eager(self) -> None:
"""设置页面加载策略为eager"""
...
def none(self) -> None:
"""设置页面加载策略为none"""
...
class PageScrollSetter(object):
_scroll: PageScroller = ...
def __init__(self, scroll: PageScroller):
"""
:param scroll: PageScroller对象
"""
...
def wait_complete(self, on_off: bool = True):
"""设置滚动命令后是否等待完成
:param on_off: 开或关
:return: None
"""
...
def smooth(self, on_off: bool = True):
"""设置页面滚动是否平滑滚动
:param on_off: 开或关
:return: None
"""
...
class WindowSetter(object):
"""用于设置窗口大小的类"""
_owner: ChromiumBase = ...
_window_id: str = ...
def __init__(self, owner: Union[ChromiumTab, ChromiumPage]):
"""
:param owner: Tab或Page对象
"""
...
def max(self) -> None:
"""窗口最大化"""
...
def mini(self) -> None:
"""窗口最小化"""
...
def full(self) -> None:
"""设置窗口为全屏"""
...
def normal(self) -> None:
"""设置窗口为常规模式"""
...
def size(self, width: int = None, height: int = None) -> None:
"""设置窗口大小
:param width: 窗口宽度
:param height: 窗口高度
:return: None
"""
...
def location(self, x: int = None, y: int = None) -> None:
"""设置窗口在屏幕中的位置,相对左上角坐标
:param x: 距离顶部距离
:param y: 距离左边距离
:return: None
"""
...
def hide(self) -> None:
"""隐藏浏览器窗口,只在Windows系统可用"""
...
def show(self) -> None:
"""显示浏览器窗口,只在Windows系统可用"""
...
def _get_info(self) -> dict:
"""获取窗口位置及大小信息"""
...
def _perform(self, bounds: dict) -> None:
"""执行改变窗口大小操作
:param bounds: 控制数据
:return: None
"""
...
@@ -0,0 +1,184 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from .._functions.web import location_in_viewport
from ..errors import CDPError, NoRectError, PageDisconnectedError, ElementLostError
class ElementStates(object):
def __init__(self, ele):
self._ele = ele
@property
def is_selected(self):
return self._ele._run_js('return this.selected;')
@property
def is_checked(self):
return self._ele._run_js('return this.checked;')
@property
def is_displayed(self):
return not (self._ele.style('visibility') == 'hidden'
or self._ele.style('display') == 'none'
or self._ele.property('hidden'))
@property
def is_enabled(self):
return not self._ele._run_js('return this.disabled;')
@property
def is_alive(self):
try:
return self._ele.owner._run_cdp('DOM.describeNode',
backendNodeId=self._ele._backend_id)['node']['nodeId'] != 0
except ElementLostError:
return False
@property
def is_in_viewport(self):
x, y = self._ele.rect.click_point
return location_in_viewport(self._ele.owner, x, y) if x else False
@property
def is_whole_in_viewport(self):
x1, y1 = self._ele.rect.location
w, h = self._ele.rect.size
x2, y2 = x1 + w, y1 + h
return location_in_viewport(self._ele.owner, x1, y1) and location_in_viewport(self._ele.owner, x2, y2)
@property
def is_covered(self):
lx, ly = self._ele.rect.click_point
try:
bid = self._ele.owner._run_cdp('DOM.getNodeForLocation', x=int(lx), y=int(ly)).get('backendNodeId')
return bid if bid != self._ele._backend_id else False
except CDPError:
return False
@property
def is_clickable(self):
return self.has_rect and self.is_enabled and self.is_displayed and self._ele.style('pointer-events') != 'none'
@property
def has_rect(self):
try:
return self._ele.rect.corners
except NoRectError:
return False
class ShadowRootStates(object):
def __init__(self, ele):
self._ele = ele
@property
def is_enabled(self):
return not self._ele._run_js('return this.disabled;')
@property
def is_alive(self):
try:
return self._ele.owner._run_cdp('DOM.describeNode',
backendNodeId=self._ele._backend_id)['node']['nodeId'] != 0
except ElementLostError:
return False
class BrowserStates(object):
def __init__(self, browser):
self._browser = browser
self._incognito = None
@property
def is_alive(self):
return self._browser._driver.is_running
@property
def is_headless(self):
return self._browser._is_headless
@property
def is_existed(self):
return self._browser._is_exists
@property
def is_incognito(self):
if self._incognito is None:
self._incognito = "'Browser.WindowCount.Incognito'" in str(self._browser._run_cdp('Browser.getHistograms'))
return self._incognito
class PageStates(object):
"""Page对象、Tab对象使用"""
def __init__(self, owner):
self._owner = owner
@property
def is_loading(self):
return self._owner._is_loading
@property
def is_alive(self):
try:
self._owner._run_cdp('Page.getLayoutMetrics')
return True
except PageDisconnectedError:
return False
@property
def ready_state(self):
return self._owner._ready_state
@property
def has_alert(self):
return self._owner._has_alert
@property
def is_headless(self):
return self._owner.browser.states.is_headless
@property
def is_existed(self):
return self._owner.browser.states.is_existed
@property
def is_incognito(self):
return self._owner.browser.states.is_incognito
class FrameStates(object):
def __init__(self, frame):
self._frame = frame
@property
def is_loading(self):
return self._frame._is_loading
@property
def is_alive(self):
try:
node = self._frame._target_page._run_cdp('DOM.describeNode',
backendNodeId=self._frame._frame_ele._backend_id)['node']
except (ElementLostError, PageDisconnectedError):
return False
return 'frameId' in node
@property
def ready_state(self):
return self._frame._ready_state
@property
def is_displayed(self):
return not (self._frame.frame_ele.style('visibility') == 'hidden'
or self._frame.frame_ele._run_js('return this.offsetParent === null;')
or self._frame.frame_ele.style('display') == 'none')
@property
def has_alert(self):
return self._frame._has_alert
@@ -0,0 +1,204 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from typing import Union, Tuple, List, Optional, Literal
from .._base.chromium import Chromium
from .._elements.chromium_element import ShadowRoot, ChromiumElement
from .._pages.chromium_base import ChromiumBase
from .._pages.chromium_frame import ChromiumFrame
class ElementStates(object):
_ele: ChromiumElement = ...
def __init__(self, ele: ChromiumElement):
"""
:param ele: ChromiumElement
"""
...
@property
def is_selected(self) -> bool:
"""返回列表元素是否被选择"""
...
@property
def is_checked(self) -> bool:
"""返回元素是否被选择"""
...
@property
def is_displayed(self) -> bool:
"""返回元素是否显示"""
...
@property
def is_enabled(self) -> bool:
"""返回元素是否可用"""
...
@property
def is_alive(self) -> bool:
"""返回元素是否仍在DOM中"""
...
@property
def is_in_viewport(self) -> bool:
"""返回元素是否出现在视口中,以元素click_point为判断"""
...
@property
def is_whole_in_viewport(self) -> bool:
"""返回元素是否整个都在视口内"""
...
@property
def is_covered(self) -> Union[Literal[False], int]:
"""返回元素是否被覆盖,与是否在视口中无关,如被覆盖返回覆盖元素的backend id,否则返回False"""
...
@property
def is_clickable(self) -> bool:
"""返回元素是否可被模拟点击,从是否有大小、是否可用、是否显示、是否响应点击判断,不判断是否被遮挡"""
...
@property
def has_rect(self) -> Union[Literal[False], List[Tuple[float, float]]]:
"""返回元素是否拥有位置和大小,没有返回False,有返回四个角在页面中坐标组成的列表"""
...
class ShadowRootStates(object):
_ele: ShadowRoot = ...
def __init__(self, ele: ShadowRoot):
"""
:param ele: ChromiumElement
"""
...
@property
def is_enabled(self) -> bool:
"""返回元素是否可用"""
...
@property
def is_alive(self) -> bool:
"""返回元素是否仍在DOM中"""
...
class BrowserStates(object):
_browser: Chromium = ...
_incognito: Optional[bool] = ...
def __init__(self, browser: Chromium):
"""
:param browser: Chromium对象
"""
...
@property
def is_alive(self) -> bool:
"""返回浏览器是否仍可用"""
...
@property
def is_headless(self) -> bool:
"""返回浏览器是否无头模式"""
...
@property
def is_existed(self) -> bool:
"""返回浏览器是否接管的"""
...
@property
def is_incognito(self) -> bool:
"""返回浏览器是否无痕模式"""
...
class PageStates(object):
_owner: ChromiumBase = ...
def __init__(self, owner: ChromiumBase):
"""
:param owner: ChromiumBase对象
"""
...
@property
def is_loading(self) -> bool:
"""返回页面是否在加载状态"""
...
@property
def is_alive(self) -> bool:
"""返回页面对象是否仍然可用"""
...
@property
def ready_state(self) -> Optional[str]:
"""返回当前页面加载状态,'connecting' 'loading' 'interactive' 'complete'"""
...
@property
def has_alert(self) -> bool:
"""返回当前页面是否存在弹窗"""
...
@property
def is_headless(self) -> bool:
"""返回浏览器是否无头模式"""
...
@property
def is_existed(self) -> bool:
"""返回浏览器是否接管的"""
...
@property
def is_incognito(self) -> bool:
"""返回浏览器是否无痕模式"""
...
class FrameStates(object):
_frame: ChromiumFrame = ...
def __init__(self, frame: ChromiumFrame):
"""
:param frame: ChromiumFrame对象
"""
...
@property
def is_loading(self) -> bool:
"""返回页面是否在加载状态"""
...
@property
def is_alive(self) -> bool:
"""返回frame元素是否可用,且里面仍挂载有frame"""
...
@property
def ready_state(self) -> str:
"""返回加载状态"""
...
@property
def is_displayed(self) -> bool:
"""返回iframe是否显示"""
...
@property
def has_alert(self) -> bool:
"""返回当前页面是否存在弹窗"""
...
@@ -0,0 +1,422 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from time import sleep, perf_counter
from .._functions.locator import get_loc
from .._functions.settings import Settings as _S
from ..errors import WaitTimeoutError, NoRectError
class OriginWaiter(object):
def __init__(self, owner):
self._owner = owner
def __call__(self, second, scope=None):
if scope is None:
sleep(second)
else:
from random import uniform
sleep(uniform(second, scope))
return self._owner
class BrowserWaiter(OriginWaiter):
def new_tab(self, timeout=None, curr_tab=None, raise_err=None):
if not curr_tab:
curr_tab = self._owner._newest_tab_id
elif hasattr(curr_tab, '_type'):
curr_tab = curr_tab.tab_id
if timeout is None:
timeout = self._owner.timeout
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if curr_tab != self._owner._newest_tab_id:
return self._owner._newest_tab_id
sleep(.01)
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.NEW_TAB, timeout)
else:
return False
def download_begin(self, timeout=None, cancel_it=False):
if not self._owner._dl_mgr._running:
raise RuntimeError(_S._lang.join(_S._lang.NEED_DOWNLOAD_PATH, TIP=_S._lang.SET_DOWNLOAD_PATH))
self._owner._dl_mgr.set_flag('browser', False if cancel_it else True)
if timeout is None:
timeout = self._owner.timeout
return wait_mission(self._owner, 'browser', timeout)
def downloads_done(self, timeout=None, cancel_if_timeout=True):
if not self._owner._dl_mgr._running:
raise RuntimeError(_S._lang.join(_S._lang.NEED_DOWNLOAD_PATH, TIP=_S._lang.SET_DOWNLOAD_PATH))
if not timeout:
while self._owner._dl_mgr._missions:
sleep(.5)
return True
else:
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if not self._owner._dl_mgr._missions:
return True
sleep(.5)
if self._owner._dl_mgr._missions:
if cancel_if_timeout:
for m in list(self._owner._dl_mgr._missions.values()):
m.cancel()
return False
else:
return True
class BaseWaiter(OriginWaiter):
def ele_deleted(self, loc_or_ele, timeout=None, raise_err=None):
ele = self._owner._ele(loc_or_ele, raise_err=False, timeout=0)
return ele.wait.deleted(timeout, raise_err=raise_err) if ele else True
def ele_displayed(self, loc_or_ele, timeout=None, raise_err=None):
if timeout is None:
timeout = self._owner.timeout
end_time = perf_counter() + timeout
ele = self._owner._ele(loc_or_ele, raise_err=False, timeout=timeout)
if not ele:
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.ELE_DISPLAYED, timeout)
else:
return False
return ele.wait.displayed(end_time - perf_counter(), raise_err=raise_err)
def ele_hidden(self, loc_or_ele, timeout=None, raise_err=None):
if timeout is None:
timeout = self._owner.timeout
end_time = perf_counter() + timeout
ele = self._owner._ele(loc_or_ele, raise_err=False, timeout=timeout)
timeout = end_time - perf_counter()
if timeout <= 0:
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.ELE_DISPLAYED, timeout)
else:
return False
return ele.wait.hidden(timeout, raise_err=raise_err)
def eles_loaded(self, locators, timeout=None, any_one=False, raise_err=None):
def _find(loc, driver):
r = driver.run('DOM.performSearch', query=loc, includeUserAgentShadowDOM=True)
if not r or 'error' in r:
return False
elif r['resultCount'] == 0:
driver.run('DOM.discardSearchResults', searchId=r['searchId'])
return False
searchId = r['searchId']
ids = driver.run('DOM.getSearchResults', searchId=searchId, fromIndex=0,
toIndex=r['resultCount'])
if 'error' in ids:
return False
ids = ids['nodeIds']
res = False
for i in ids:
r = driver.run('DOM.describeNode', nodeId=i)
if 'error' in r or r['node']['nodeName'] in ('#text', '#comment'):
continue
else:
res = True
break
driver.run('DOM.discardSearchResults', searchId=searchId)
return res
by = ('id', 'xpath', 'link text', 'partial link text', 'name', 'tag name', 'class name', 'css selector')
locators = ((get_loc(locators)[1],) if (isinstance(locators, str) or isinstance(locators, tuple)
and locators[0] in by and len(locators) == 2)
else [get_loc(x)[1] for x in locators])
method = any if any_one else all
if timeout is None:
timeout = self._owner.timeout
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if method([_find(l, self._owner.driver) for l in locators]):
return True
sleep(.01)
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.ELE_LOADED, timeout, LOCATOR=locators)
else:
return False
def load_start(self, timeout=None, raise_err=None):
return self._loading(timeout=timeout, gap=.002, raise_err=raise_err)
def doc_loaded(self, timeout=None, raise_err=None):
return self._loading(timeout=timeout, start=False, raise_err=raise_err)
def upload_paths_inputted(self):
end_time = perf_counter() + self._owner.timeout
while perf_counter() < end_time:
if not self._owner._upload_list:
return True
sleep(.01)
return False
def download_begin(self, timeout=None, cancel_it=False):
if not self._owner.browser._dl_mgr._running:
raise RuntimeError(_S._lang.join(_S._lang.NEED_DOWNLOAD_PATH, TIP=_S._lang.SET_DOWNLOAD_PATH))
self._owner.browser._dl_mgr.set_flag(self._owner.tab_id, False if cancel_it else True)
if timeout is None:
timeout = self._owner.timeout
return wait_mission(self._owner.browser, self._owner.tab_id, timeout)
def url_change(self, text, exclude=False, timeout=None, raise_err=None):
return self._owner if self._change('url', text, exclude, timeout, raise_err) else False
def title_change(self, text, exclude=False, timeout=None, raise_err=None):
return self._owner if self._change('title', text, exclude, timeout, raise_err) else False
def _change(self, arg, text, exclude=False, timeout=None, raise_err=None):
def do():
if arg == 'url':
v = self._owner._run_cdp('Target.getTargetInfo', targetId=self._owner._target_id)['targetInfo']['url']
elif arg == 'title':
v = self._owner._run_cdp('Target.getTargetInfo', targetId=self._owner._target_id)['targetInfo']['title']
else:
raise ValueError
if (not exclude and text in v) or (exclude and text not in v):
return True
if do():
return True
if timeout is None:
timeout = self._owner.timeout
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if do():
return True
sleep(.05)
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.ARG, timeout, ARG=arg)
else:
return False
def _loading(self, timeout=None, start=True, gap=.01, raise_err=None):
if timeout is None:
timeout = self._owner.timeout
timeout = .1 if timeout <= 0 else timeout
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if self._owner._is_loading == start:
return True
sleep(gap)
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.PAGE_LOADED, timeout)
else:
return False
class TabWaiter(BaseWaiter):
def downloads_done(self, timeout=None, cancel_if_timeout=True):
if not self._owner.browser._dl_mgr._running:
raise RuntimeError(_S._lang.join(_S._lang.NEED_DOWNLOAD_PATH, TIP=_S._lang.SET_DOWNLOAD_PATH))
if not timeout:
while self._owner.browser._dl_mgr.get_tab_missions(self._owner.tab_id):
sleep(.5)
return self._owner
else:
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if not self._owner.browser._dl_mgr.get_tab_missions(self._owner.tab_id):
return self._owner
sleep(.5)
if self._owner.browser._dl_mgr.get_tab_missions(self._owner.tab_id):
if cancel_if_timeout:
for m in self._owner.browser._dl_mgr.get_tab_missions(self._owner.tab_id):
m.cancel()
return False
else:
return self._owner
def alert_closed(self, timeout=None):
if timeout is None:
while not self._owner.states.has_alert:
sleep(.2)
while self._owner.states.has_alert:
sleep(.2)
else:
end_time = perf_counter() + timeout
while not self._owner.states.has_alert and perf_counter() < end_time:
sleep(.2)
while self._owner.states.has_alert and perf_counter() < end_time:
sleep(.2)
return False if self._owner.states.has_alert else self._owner
class ChromiumPageWaiter(TabWaiter):
def new_tab(self, timeout=None, raise_err=None):
return self._owner.browser.wait.new_tab(timeout=timeout, raise_err=raise_err)
def download_begin(self, timeout=None, cancel_it=False):
return self._owner.browser.wait.download_begin(timeout=timeout, cancel_it=cancel_it)
def all_downloads_done(self, timeout=None, cancel_if_timeout=True):
return self._owner.browser.wait.downloads_done(timeout=timeout, cancel_if_timeout=cancel_if_timeout)
class ElementWaiter(OriginWaiter):
def __init__(self, owner):
super().__init__(owner)
self._ele = owner
@property
def _timeout(self):
return self._ele.timeout
def deleted(self, timeout=None, raise_err=None):
return self._wait_state('is_alive', False, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_DEL, timeout))
def displayed(self, timeout=None, raise_err=None):
return self._wait_state('is_displayed', True, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_DISPLAYED, timeout))
def hidden(self, timeout=None, raise_err=None):
return self._wait_state('is_displayed', False, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_HIDDEN, timeout))
def covered(self, timeout=None, raise_err=None):
return self._ele if self._wait_state('is_covered', True, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_COVERED,
timeout)) else False
def not_covered(self, timeout=None, raise_err=None):
return self._wait_state('is_covered', False, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_NOT_COVERED, timeout))
def enabled(self, timeout=None, raise_err=None):
return self._wait_state('is_enabled', True, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_AVAILABLE, timeout))
def disabled(self, timeout=None, raise_err=None):
return self._wait_state('is_enabled', False, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_NOT_AVAILABLE, timeout))
def disabled_or_deleted(self, timeout=None, raise_err=None):
if not self._ele.states.is_enabled or not self._ele.states.is_alive:
return self._ele
if timeout is None:
timeout = self._timeout
end_time = perf_counter() + timeout
while perf_counter() < end_time:
if not self._ele.states.is_enabled or not self._ele.states.is_alive:
return self._ele
sleep(.05)
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.ELE_HIDDEN_DEL, timeout)
else:
return False
def clickable(self, wait_moved=True, timeout=None, raise_err=None):
if timeout is None:
timeout = self._timeout
t1 = perf_counter()
r = self._wait_state('is_clickable', True, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_CLICKABLE, timeout))
r = self.stop_moving(timeout=timeout - perf_counter() + t1) if wait_moved and r else r
if raise_err and not r:
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.ELE_CLICKABLE, timeout)
return r
def has_rect(self, timeout=None, raise_err=None):
return self._ele if self._wait_state('has_rect', True, timeout, raise_err,
err_text=_S._lang.WAITING_FAILED_.format(_S._lang.ELE_HAS_RECT,
timeout)) else False
def stop_moving(self, timeout=None, gap=.1, raise_err=None):
if timeout is None:
timeout = self._timeout
if timeout <= 0:
timeout = .1
end_time = perf_counter() + timeout
while perf_counter() < end_time:
try:
size = self._ele.states.has_rect
location = self._ele.rect.location
break
except NoRectError:
pass
sleep(.005)
else:
raise NoRectError
while perf_counter() < end_time:
sleep(gap)
if self._ele.rect.size == size and self._ele.rect.location == location:
return self._ele
size = self._ele.rect.size
location = self._ele.rect.location
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(_S._lang.WAITING_FAILED_, _S._lang.ELE_STOP_MOVING, timeout)
else:
return False
def _wait_state(self, attr, mode=False, timeout=None, raise_err=None, err_text=None):
a = self._ele.states.__getattribute__(attr)
if (a and mode) or (not a and not mode):
return self._ele if isinstance(a, bool) else a
if timeout is None:
timeout = self._timeout
end_time = perf_counter() + timeout
while perf_counter() < end_time:
a = self._ele.states.__getattribute__(attr)
if (a and mode) or (not a and not mode):
return self._ele if isinstance(a, bool) else a
sleep(.05)
err_text = err_text or _S._lang.ELE_STATE_CHANGED_.format(timeout)
if raise_err is True or (_S.raise_when_wait_failed is True and raise_err is None):
raise WaitTimeoutError(err_text)
else:
return False
class FrameWaiter(BaseWaiter, ElementWaiter):
def __init__(self, owner):
super().__init__(owner)
self._ele = owner.frame_ele
@property
def _timeout(self):
return self._owner.timeout
def wait_mission(browser, tid, timeout=None):
r = False
end_time = perf_counter() + timeout
while perf_counter() < end_time:
v = browser._dl_mgr.get_flag(tid)
if not isinstance(v, bool):
r = v
break
sleep(.005)
browser._dl_mgr.set_flag(tid, None)
return r
@@ -0,0 +1,780 @@
# -*- coding:utf-8 -*-
"""
@Author : g1879
@Contact : g1879@qq.com
@Website : https://DrissionPage.cn
@Copyright: (c) 2020 by g1879, Inc. All Rights Reserved.
"""
from typing import Union, Tuple, Any
from .downloader import DownloadMission
from .._base.chromium import Chromium
from .._elements.chromium_element import ChromiumElement
from .._pages.chromium_base import ChromiumBase
from .._pages.chromium_frame import ChromiumFrame
from .._pages.chromium_page import ChromiumPage
from .._pages.chromium_tab import ChromiumTab
from .._pages.mix_tab import MixTab
from .._pages.web_page import WebPage
class OriginWaiter(object):
_owner: Any = ...
def __init__(self, owner: Any): ...
def __call__(self, second: float, scope: float = None):
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: 调用等待的对象
"""
...
class BrowserWaiter(OriginWaiter):
_owner: Chromium = ...
def __init__(self, owner: Chromium):
"""
:param owner: Chromium对象
"""
...
def __call__(self, second: float, scope: float = None) -> Chromium:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: Chromium对象
"""
...
def new_tab(self,
timeout: float = None,
curr_tab: Union[str, ChromiumTab, MixTab] = None,
raise_err: bool = None) -> Union[str, bool]:
"""等待新标签页出现
:param timeout: 超时时间(秒),为None则使用对象timeout属性
:param curr_tab: 指定当前最新的tab对象或tab id,用于判断新tab出现,为None自动获取
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等到新标签页返回其id,否则返回False
"""
...
def download_begin(self, timeout: float = None, cancel_it: bool = False) -> Union[DownloadMission, False]:
"""等待浏览器下载开始,可将其拦截
:param timeout: 超时时间(秒),None使用页面对象超时时间
:param cancel_it: 是否取消该任务
:return: 成功返回任务对象,失败返回False
"""
...
def downloads_done(self, timeout: float = None, cancel_if_timeout: bool = True) -> bool:
"""等待所有浏览器下载任务结束
:param timeout: 超时时间(秒),为None时无限等待
:param cancel_if_timeout: 超时时是否取消剩余任务
:return: 是否等待成功
"""
...
class BaseWaiter(OriginWaiter):
_owner: ChromiumBase = ...
def ele_deleted(self,
loc_or_ele: Union[str, tuple, ChromiumElement],
timeout: float = None,
raise_err: bool = None) -> bool:
"""等待元素从DOM中删除
:param loc_or_ele: 要等待的元素,可以是已有元素、定位符
:param timeout: 超时时间(秒),默认读取页面超时时间
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 是否等待成功
"""
...
def ele_displayed(self,
loc_or_ele: Union[str, tuple, ChromiumElement],
timeout: float = None,
raise_err: bool = None) -> bool:
"""等待元素变成显示状态
:param loc_or_ele: 要等待的元素,可以是已有元素、定位符
:param timeout: 超时时间(秒),默认读取页面超时时间
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 是否等待成功
"""
...
def ele_hidden(self,
loc_or_ele: Union[str, tuple, ChromiumElement],
timeout: float = None,
raise_err: bool = None) -> bool:
"""等待元素变成隐藏状态
:param loc_or_ele: 要等待的元素,可以是已有元素、定位符
:param timeout: 超时时间(秒),默认读取页面超时时间
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 是否等待成功
"""
...
def eles_loaded(self,
locators: Union[Tuple[str, str], str, list, tuple],
timeout: float = None,
any_one: bool = False,
raise_err: bool = None) -> bool:
"""等待元素加载到DOM,可等待全部或任意一个
:param locators: 要等待的元素,输入定位符,用list输入多个
:param timeout: 超时时间(秒),默认读取页面超时时间
:param any_one: 是否等待到一个就返回
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回True,失败返回False
"""
...
def load_start(self, timeout: float = None, raise_err: bool = None) -> bool:
"""等待页面开始加载
:param timeout: 超时时间(秒),为None时使用页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 是否等待成功
"""
...
def doc_loaded(self, timeout: float = None, raise_err: bool = None) -> bool:
"""等待页面加载完成
:param timeout: 超时时间(秒),为None时使用页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 是否等待成功
"""
...
def upload_paths_inputted(self) -> bool:
"""等待自动填写上传文件路径"""
...
def download_begin(self, timeout: float = None, cancel_it: bool = False) -> Union[DownloadMission, bool, dict]:
"""等待浏览器下载开始,可将其拦截
:param timeout: 超时时间(秒),None使用页面对象超时时间
:param cancel_it: 是否取消该任务
:return: 成功返回任务对象(cancel_it为True时返回dict格式的下载信息),失败返回False
"""
...
def url_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> ChromiumBase:
"""等待url变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当url不包含text指定文本时返回True
:param timeout: 超时时间(秒)
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def title_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> ChromiumBase:
"""等待title变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当title不包含text指定文本时返回True
:param timeout: 超时时间(秒),为None使用页面设置
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def _change(self,
arg: str,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> bool:
"""等待指定属性变成包含或不包含指定文本
:param arg: 要被匹配的属性
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当属性不包含text指定文本时返回True
:param timeout: 超时时间(秒)
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 是否等待成功
"""
...
def _loading(self,
timeout: float = None,
start: bool = True,
gap: float = .01,
raise_err: bool = None) -> bool:
"""等待页面开始加载或加载完成
:param timeout: 超时时间(秒),为None时使用页面timeout属性
:param start: 等待开始还是结束
:param gap: 间隔秒数
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 是否等待成功
"""
...
class TabWaiter(BaseWaiter):
_owner: ChromiumTab = ...
def __init__(self, owner: ChromiumTab):
"""
:param owner: Tab对象
"""
...
def __call__(self,
second: float,
scope: float = None) -> ChromiumTab:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: ChromiumTab对象
"""
...
def downloads_done(self,
timeout: float = None,
cancel_if_timeout: bool = True) -> Union[False, ChromiumTab]:
"""等待所有浏览器下载任务结束
:param timeout: 超时时间(秒),为None时无限等待
:param cancel_if_timeout: 超时时是否取消剩余任务
:return: 是否等待成功
"""
...
def alert_closed(self, timeout: float = None) -> ChromiumTab:
"""等待弹出框关闭
:param timeout: 超时时间,为None无限等待
:return: 标签页对象自己
"""
...
def url_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, ChromiumTab]:
"""等待url变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当url不包含text指定文本时返回True
:param timeout: 超时时间(秒)
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def title_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, ChromiumTab]:
"""等待title变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当title不包含text指定文本时返回True
:param timeout: 超时时间(秒),为None使用页面设置
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
class MixTabWaiter(BaseWaiter):
_owner: MixTab = ...
def __init__(self, owner: MixTab):
"""
:param owner: Tab对象
"""
...
def __call__(self,
second: float,
scope: float = None) -> MixTab:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: MixTab对象
"""
...
def downloads_done(self,
timeout: float = None,
cancel_if_timeout: bool = True) -> Union[False, MixTab]:
"""等待所有浏览器下载任务结束
:param timeout: 超时时间(秒),为None时无限等待
:param cancel_if_timeout: 超时时是否取消剩余任务
:return: 是否等待成功
"""
...
def alert_closed(self, timeout: float = None) -> MixTab:
"""等待弹出框关闭
:param timeout: 超时时间,为None无限等待
:return: 标签页对象自己
"""
...
def url_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, MixTab]:
"""等待url变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当url不包含text指定文本时返回True
:param timeout: 超时时间(秒)
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def title_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, MixTab]:
"""等待title变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当title不包含text指定文本时返回True
:param timeout: 超时时间(秒),为None使用页面设置
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
class ChromiumPageWaiter(TabWaiter):
_owner: Union[ChromiumPage, WebPage] = ...
def __init__(self, owner: ChromiumPage):
"""
:param owner: Page对象
"""
...
def __call__(self,
second: float,
scope: float = None) -> ChromiumPage:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: ChromiumPage对象
"""
...
def new_tab(self,
timeout: float = None,
raise_err: bool = None) -> Union[str, bool]:
"""等待新标签页出现
:param timeout: 超时时间(秒),为None则使用页面对象timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等到新标签页返回其id,否则返回False
"""
...
def all_downloads_done(self,
timeout: float = None,
cancel_if_timeout: bool = True) -> bool:
"""等待所有浏览器下载任务结束
:param timeout: 超时时间(秒),为None时无限等待
:param cancel_if_timeout: 超时时是否取消剩余任务
:return: 是否等待成功
"""
...
def url_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, ChromiumPage]:
"""等待url变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当url不包含text指定文本时返回True
:param timeout: 超时时间(秒)
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def title_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, ChromiumPage]:
"""等待title变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当title不包含text指定文本时返回True
:param timeout: 超时时间(秒),为None使用页面设置
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
class WebPageWaiter(TabWaiter):
_owner: Union[ChromiumPage, WebPage] = ...
def __init__(self, owner: WebPage):
"""
:param owner: Page对象
"""
...
def __call__(self,
second: float,
scope: float = None) -> WebPage:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: WebPage对象
"""
...
def new_tab(self,
timeout: float = None,
raise_err: bool = None) -> Union[str, bool]:
"""等待新标签页出现
:param timeout: 超时时间(秒),为None则使用页面对象timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等到新标签页返回其id,否则返回False
"""
...
def all_downloads_done(self,
timeout: float = None,
cancel_if_timeout: bool = True) -> bool:
"""等待所有浏览器下载任务结束
:param timeout: 超时时间(秒),为None时无限等待
:param cancel_if_timeout: 超时时是否取消剩余任务
:return: 是否等待成功
"""
...
def url_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, WebPage]:
"""等待url变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当url不包含text指定文本时返回True
:param timeout: 超时时间(秒)
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def title_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, WebPage]:
"""等待title变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当title不包含text指定文本时返回True
:param timeout: 超时时间(秒),为None使用页面设置
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
class ElementWaiter(OriginWaiter):
_owner: ChromiumElement = ...
_ele: ChromiumElement = ...
def __init__(self, owner: ChromiumElement):
"""
:param owner: ChromiumElement对象
"""
...
def __call__(self,
second: float,
scope: float = None) -> ChromiumElement:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: ChromiumElement对象
"""
...
@property
def _timeout(self) -> float:
"""返回超时设置"""
...
def deleted(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待元素从dom删除
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def displayed(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待元素从dom显示
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def hidden(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待元素从dom隐藏
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def covered(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素被遮盖
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回覆盖元素id,返回False
"""
...
def not_covered(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待当前元素不被遮盖
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def enabled(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待当前元素变成可用
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def disabled(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待当前元素变成不可用
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def disabled_or_deleted(self, timeout: float = None, raise_err: bool = None) -> bool:
"""等待当前元素变成不可用或从DOM移除
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def clickable(self,
wait_moved: bool = True,
timeout: float = None,
raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待当前元素可被点击
:param wait_moved: 是否等待元素运动结束
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def has_rect(self,
timeout: float = None,
raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待当前元素有大小及位置属性
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def stop_moving(self,
timeout: float = None,
gap: float = .1,
raise_err: bool = None) -> Union[ChromiumElement, False]:
"""等待当前元素停止运动
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param gap: 检测间隔时间
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def _wait_state(self,
attr: str,
mode: bool = False,
timeout: float = None,
raise_err: bool = None,
err_text: str = None) -> Union[ChromiumElement, False]:
"""等待元素某个元素状态到达指定状态
:param attr: 状态名称
:param mode: 等待True还是False
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:param err_text: 抛出错误时显示的信息
:return: 成功返回元素对象,失败返回False
"""
...
class FrameWaiter(BaseWaiter, ElementWaiter):
_owner: ChromiumFrame = ...
def __init__(self, owner: ChromiumFrame):
"""
:param owner: ChromiumFrame对象
"""
...
def __call__(self,
second: float,
scope: float = None) -> ChromiumFrame:
"""等待若干秒,如传入两个参数,等待时间为这两个数间的一个随机数
:param second: 秒数
:param scope: 随机数范围
:return: ChromiumFrame对象
"""
...
def url_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, ChromiumFrame]:
"""等待url变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当url不包含text指定文本时返回True
:param timeout: 超时时间(秒)
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def title_change(self,
text: str,
exclude: bool = False,
timeout: float = None,
raise_err: bool = None) -> Union[False, ChromiumFrame]:
"""等待title变成包含或不包含指定文本
:param text: 用于识别的文本
:param exclude: 是否排除,为True时当title不包含text指定文本时返回True
:param timeout: 超时时间(秒),为None使用页面设置
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 等待成功返回页面对象,否则返回False
"""
...
def deleted(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待元素从dom删除
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def displayed(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待元素从dom显示
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def hidden(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待元素从dom隐藏
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def has_rect(self,
timeout: float = None,
raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素有大小及位置属性
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def covered(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素被遮盖
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回覆盖元素id,返回False
"""
...
def not_covered(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素不被遮盖
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def enabled(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素变成可用
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def disabled(self, timeout: float = None, raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素变成不可用
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def disabled_or_deleted(self, timeout: float = None, raise_err: bool = None) -> bool:
"""等待当前元素变成不可用或从DOM移除
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def clickable(self,
wait_moved: bool = True,
timeout: float = None,
raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素可被点击
:param wait_moved: 是否等待元素运动结束
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def stop_moving(self,
timeout: float = None,
gap: float = .1,
raise_err: bool = None) -> Union[ChromiumFrame, False]:
"""等待当前元素停止运动
:param timeout: 超时时间(秒),为None使用元素所在页面timeout属性
:param gap: 检测间隔时间
:param raise_err: 等待失败时是否报错,为None时根据Settings设置
:return: 成功返回元素对象,失败返回False
"""
...
def wait_mission(browser: Chromium, tid: str, timeout: float = None) -> Union[DownloadMission, False]:
"""等待下载任务
:param browser: Chromium对象
:param tid: 标签页id
:param timeout: 超时时间
:return:
"""
...