mirror of
https://gitee.com/g1879/DrissionPage.git
synced 2024-12-10 04:00:23 +08:00
228 lines
9.0 KiB
Python
228 lines
9.0 KiB
Python
# -*- coding:utf-8 -*-
|
||
"""
|
||
@Author : g1879
|
||
@Contact : g1879@qq.com
|
||
@Copyright: (c) 2024 by g1879, Inc. All Rights Reserved.
|
||
@License : BSD 3-Clause.
|
||
"""
|
||
from pathlib import Path
|
||
from typing import Union, Tuple, List, Optional
|
||
|
||
from .._base.browser import Chromium
|
||
from .._configs.chromium_options import ChromiumOptions
|
||
from .._pages.chromium_base import ChromiumBase
|
||
from .._pages.tabs import ChromiumTab
|
||
from .._units.rect import TabRect
|
||
from .._units.setter import ChromiumPageSetter
|
||
from .._units.waiter import ChromiumPageWaiter
|
||
|
||
|
||
class ChromiumPage(ChromiumBase):
|
||
_PAGES: dict = ...
|
||
tab: ChromiumPage = ...
|
||
_browser: Chromium = ...
|
||
_rect: Optional[TabRect] = ...
|
||
_is_exist: bool = ...
|
||
|
||
def __new__(cls,
|
||
addr_or_opts: Union[str, int, ChromiumOptions] = None,
|
||
tab_id: str = None,
|
||
timeout: float = None):
|
||
"""
|
||
:param addr_or_opts: 浏览器地址:端口、ChromiumOptions对象或端口数字（int）
|
||
:param tab_id: 要控制的标签页id，不指定默认为激活的
|
||
:param timeout: 超时时间（秒）
|
||
"""
|
||
...
|
||
|
||
def __init__(self,
|
||
addr_or_opts: Union[str, int, ChromiumOptions] = None,
|
||
tab_id: str = None,
|
||
timeout: float = None):
|
||
"""
|
||
:param addr_or_opts: 浏览器地址:端口、ChromiumOptions对象或端口数字（int）
|
||
:param tab_id: 要控制的标签页id，不指定默认为激活的
|
||
:param timeout: 超时时间（秒）
|
||
"""
|
||
...
|
||
|
||
@property
|
||
def set(self) -> ChromiumPageSetter:
|
||
"""返回用于设置的对象"""
|
||
...
|
||
|
||
@property
|
||
def wait(self) -> ChromiumPageWaiter:
|
||
"""返回用于等待的对象"""
|
||
...
|
||
|
||
@property
|
||
def browser(self) -> Chromium:
|
||
"""返回浏览器对象"""
|
||
...
|
||
|
||
@property
|
||
def tabs_count(self) -> int:
|
||
"""返回标签页数量"""
|
||
...
|
||
|
||
@property
|
||
def tab_ids(self) -> List[str]:
|
||
"""返回所有标签页id组成的列表"""
|
||
...
|
||
|
||
@property
|
||
def latest_tab(self) -> Union[ChromiumTab, ChromiumPage, str]:
|
||
"""返回最新的标签页，最新标签页指最后创建或最后被激活的
|
||
当Settings.singleton_tab_obj==True时返回Tab对象，否则返回tab id"""
|
||
...
|
||
|
||
@property
|
||
def process_id(self) -> Optional[int]:
|
||
"""返回浏览器进程id"""
|
||
...
|
||
|
||
@property
|
||
def browser_version(self) -> str:
|
||
"""返回所控制的浏览器版本号"""
|
||
...
|
||
|
||
@property
|
||
def address(self) -> str:
|
||
"""返回浏览器地址ip:port"""
|
||
...
|
||
|
||
def save(self,
|
||
path: Union[str, Path] = None,
|
||
name: str = None,
|
||
as_pdf: bool = False,
|
||
landscape: bool = ...,
|
||
displayHeaderFooter: bool = ...,
|
||
printBackground: bool = ...,
|
||
scale: float = ...,
|
||
paperWidth: float = ...,
|
||
paperHeight: float = ...,
|
||
marginTop: float = ...,
|
||
marginBottom: float = ...,
|
||
marginLeft: float = ...,
|
||
marginRight: float = ...,
|
||
pageRanges: str = ...,
|
||
headerTemplate: str = ...,
|
||
footerTemplate: str = ...,
|
||
preferCSSPageSize: bool = ...,
|
||
generateTaggedPDF: bool = ...,
|
||
generateDocumentOutline: bool = ...) -> Union[bytes, str]:
|
||
"""把当前页面保存为文件，如果path和name参数都为None，只返回文本
|
||
:param path: 保存路径，为None且name不为None时保存在当前路径
|
||
:param name: 文件名，为None且path不为None时用title属性值
|
||
:param as_pdf: 为Ture保存为pdf，否则为mhtml且忽略kwargs参数
|
||
:param landscape: 纸张方向，as_pdf为True时才生效
|
||
:param displayHeaderFooter: 是否显示页头页脚，as_pdf为True时才生效
|
||
:param printBackground: 是否打印背景图片，as_pdf为True时才生效
|
||
:param scale: 缩放比例，as_pdf为True时才生效
|
||
:param paperWidth: 页面宽度（英寸），as_pdf为True时才生效
|
||
:param paperHeight: 页面高度（英寸），as_pdf为True时才生效
|
||
:param marginTop: 上边距（英寸），as_pdf为True时才生效
|
||
:param marginBottom: 下边距（英寸），as_pdf为True时才生效
|
||
:param marginLeft: 左边距（英寸），as_pdf为True时才生效
|
||
:param marginRight: 右边距（英寸），as_pdf为True时才生效
|
||
:param pageRanges: 页面范围，格式'1-5, 8, 11-13'，as_pdf为True时才生效
|
||
:param headerTemplate: 页头HTML模板，as_pdf为True时才生效
|
||
模板可包含以下class：
|
||
- date：日期
|
||
- title：文档标题
|
||
- url：文档url
|
||
- pageNumber：当前页码
|
||
- totalPages：总页数
|
||
示例：<span class=title></span>
|
||
:param footerTemplate: 页脚HTML模板，格式与页头的一样，as_pdf为True时才生效
|
||
:param preferCSSPageSize: 是否使用css定义的页面大小，as_pdf为True时才生效
|
||
:param generateTaggedPDF: 是否生成带标签的(可访问的)PDF。默认为嵌入器选择，as_pdf为True时才生效
|
||
:param generateDocumentOutline: 是否将文档大纲嵌入到PDF中。，as_pdf为True时才生效
|
||
:return: as_pdf为True时返回bytes，否则返回文件文本
|
||
"""
|
||
...
|
||
|
||
def get_tab(self,
|
||
id_or_num: Union[str, ChromiumTab, int] = None,
|
||
title: str = None,
|
||
url: str = None,
|
||
tab_type: Union[str, list, tuple] = 'page',
|
||
as_id: bool = False) -> Union[ChromiumTab, str, None]:
|
||
"""获取一个标签页对象，id_or_num不为None时，后面几个参数无效
|
||
:param id_or_num: 要获取的标签页id或序号，序号从1开始，可传入负数获取倒数第几个，不是视觉排列顺序，而是激活顺序
|
||
:param title: 要匹配title的文本，模糊匹配，为None则匹配所有
|
||
:param url: 要匹配url的文本，模糊匹配，为None则匹配所有
|
||
:param tab_type: tab类型，可用列表输入多个，如 'page', 'iframe' 等，为None则匹配所有
|
||
:param as_id: 是否返回标签页id而不是标签页对象
|
||
:return: ChromiumTab对象
|
||
"""
|
||
...
|
||
|
||
def get_tabs(self,
|
||
title: str = None,
|
||
url: str = None,
|
||
tab_type: Union[str, list, tuple] = 'page',
|
||
as_id: bool = False) -> Union[List[ChromiumTab], List[str]]:
|
||
"""查找符合条件的tab，返回它们组成的列表
|
||
:param title: 要匹配title的文本，模糊匹配，为None则匹配所有
|
||
:param url: 要匹配url的文本，模糊匹配，为None则匹配所有
|
||
:param tab_type: tab类型，可用列表输入多个，如 'page', 'iframe' 等，为None则匹配所有
|
||
:param as_id: 是否返回标签页id而不是标签页对象
|
||
:return: ChromiumTab对象组成的列表
|
||
"""
|
||
...
|
||
|
||
def new_tab(self,
|
||
url: str = None,
|
||
new_window: bool = False,
|
||
background: bool = False,
|
||
new_context: bool = False) -> ChromiumTab:
|
||
"""新建一个标签页
|
||
:param url: 新标签页跳转到的网址
|
||
:param new_window: 是否在新窗口打开标签页
|
||
:param background: 是否不激活新标签页，如new_window为True则无效
|
||
:param new_context: 是否创建新的上下文
|
||
:return: 新标签页对象
|
||
"""
|
||
...
|
||
|
||
def activate_tab(self,
|
||
id_ind_tab: Union[int, str, ChromiumTab]) -> None:
|
||
"""使标签页变为活动状态
|
||
:param id_ind_tab: 标签页id（str）、Tab对象或标签页序号（int），序号从1开始
|
||
:return: None
|
||
"""
|
||
...
|
||
|
||
def close(self) -> None:
|
||
"""关闭Page管理的标签页"""
|
||
...
|
||
|
||
def close_tabs(self,
|
||
tabs_or_ids: Union[str, ChromiumTab, List[Union[str, ChromiumTab]],
|
||
Tuple[Union[str, ChromiumTab]]] = None,
|
||
others: bool = False) -> None:
|
||
"""关闭传入的标签页，默认关闭当前页。可传入多个
|
||
:param tabs_or_ids: 要关闭的标签页对象或id，可传入列表或元组，为None时关闭当前页
|
||
:param others: 是否关闭指定标签页之外的
|
||
:return: None
|
||
"""
|
||
...
|
||
|
||
def quit(self,
|
||
timeout: float = 5,
|
||
force: bool = True,
|
||
del_data: bool = False) -> None:
|
||
"""关闭浏览器
|
||
:param timeout: 等待浏览器关闭超时时间（秒）
|
||
:param force: 关闭超时是否强制终止进程
|
||
:param del_data: 是否删除用户文件夹
|
||
:return: None
|
||
"""
|
||
...
|
||
|
||
def _on_disconnect(self) -> None:
|
||
"""浏览器退出时执行"""
|
||
...
|