DrissionPage模块(五)

5  _configs目录

_configs目录有四个配置文件和一个配置保存文件。

5.1 options_manage.py

Options.manage.py定义的类和函数：

序号	名称	功能
1	OptionsManager(object)	管理配置文件内容的类

5.1.1 OptionsManager类

OptionsManager(object)

属性和方法	功能	说明
本类定义的方法
get_value(section, item)	获取配置的值 section: 段名 item: 项名 return: 项值
get_option(section)	把section内容以字典方式返回         :param section: 段名         :return: 段内容生成的字典
set_item(section,item,vale)	设置配置值         :param section: 段名         :param item: 项名         :param value: 项值         :return: None
remove_item(section,item)	删除配置值         :param section: 段名         :param item: 项名         :return: None
save(path=None)	保存配置文件 path: ini文件的路径，传入 'default' 保存到默认ini文件 return: 保存路径
save_to_default()	保存当前配置到默认ini文件
show()	打印所有设置信息

5.2 Chromium_options.py

Chromium_options.py定义的类和函数：

序号	名称	功能
1	ChromiumOptions(object)	Chromium对象配置类

5.2.1 ChromiumOptions类

ChromiumOptions(object)

属性和方法	功能	说明
本类定义的方法
__init__(self,read_file=True,ini_path=None)	read_file: 是否从默认ini文件中读取配置信息 ini_path: ini文件路径，为None则读取默认ini文件
@property download_path()	默认下载路径文件路径
@property browser_path()	浏览器启动文件路径
@property user_data_path()	返回用户数据文件夹路径
@property tmp_path()	返回临时文件夹路径
@property user()	返回用户配置文件夹名称
@property load-mode()	返回页面加载策略，'normal', 'eager', 'none'
@property timeouts()	返回timeouts设置
@property proxy()	返回代理设置
@property address()	返回浏览器地址 ip:port
@property arguments()	返回浏览器命令行设置列表
@property extensions()	以list形式返回要加载的插件路径
@property preferences()	返回用户首选项配置
@property flags()	返回实验项配置
@property system_user_path()	返回是否使用系统安装的浏览器所使用的用户数据文件夹
@property is_existing_only()	返回是否只接管现有浏览器方式
@property is_auto_port()	返回是否使用自动端口和用户文件，如指定范围则返回范围tuple
@property retry_times()	返回连接失败时的重试次数
@property retry_interval()	返回连接失败时的重试间隔（秒）
set_retry(times=None, interval=None)	设置连接失败时的重试操作 times: 重试次数 interval: 重试间隔 return: 当前对象
set_argument(arg,value=None)	设置浏览器配置的argument属性 arg: 属性名 value: 属性值,有值的属性传入值,没有的传入None,如传入False,删除该项 return: 当前对象
remove_argument(value)	移除一个argument项 value: 设置项名，有值的设置项传入设置名称即可 return: 当前对象
add_extension(path)	添加插件 path: 插件路径，可指向文件夹 return: 当前对象
remove_extension()	移除所有插件 return: 当前对象
set_pref(arg, value)	设置Preferences文件中的用户设置项 arg: 设置项名称 value: 设置项值 return: 当前对象
remove_pref(arg)	删除用户首选项设置，不能删除已设置到文件中的项 arg: 设置项名称 return: 当前对象
remove_pref_from_file(arg)	删除用户配置文件中已设置的项 arg: 设置项名称 return: 当前对象
set_flag(flag, value=None)	设置实验项 flag: 设置项名称 value: 设置项的值，为False则删除该项 return: 当前对象
clear_flags_in_file()	删除浏览器配置文件中已设置的实验项
clear_flags()	清空本对象已设置的flag参数
clear_arguments()	清空本对象已设置的argument参数
clear_prefs()	清空本对象已设置的pref参数
set_timeouts(base=None, page_load=None, script=None, implicit=None)	设置超时时间，单位为秒 base: 默认超时时间 page_load: 页面加载超时时间 script: 脚本运行超时时间 return: 当前对象
set_user(user=’Default’)	设置使用哪个用户配置文件夹 user: 用户文件夹名称 return: 当前对象
headless(on_off=True)	设置是否隐藏浏览器界面 on_off: 开或关 return: 当前对象
no_imgs(on_off=True)	设置是否加载图片 on_off: 开或关 return: 当前对象
no_js(on_off=True)	设置是否禁用js on_off: 开或关 return: 当前对象
mute(on_off=True)	设置是否静音 on_off: 开或关 return: 当前对象
incognito(on_off=True)	设置是否使用无痕模式启动 on_off: 开或关 return: 当前对象
ignore_certificate_errors(on_off=True)	设置是否忽略证书错误 on_off: 开或关 return: 当前对象
set_user_agent(user_agent)	设置user agent user_agent: user agent文本 return: 当前对象
set_proxy(proxy)	设置代理 proxy: 代理url和端口 return: 当前对象
set_load_mode(value)	设置load_mode，可接收 'normal', 'eager', 'none' normal：默认情况下使用, 等待所有资源下载完成 eager：DOM访问已准备就绪, 但其他资源 (如图像) 可能仍在加载中 none：完全不阻塞 value: 可接收 'normal', 'eager', 'none' return: 当前对象
set_paths(browser_path=None, local_port=None, address=None, download_path=None, user_data_path=None, cache_path=None, debugger_address=None)	快捷的路径设置函数 browser_path: 浏览器可执行文件路径 local_port: 本地端口号 address: 调试浏览器地址，IP:PORT download_path: 下载文件路径 user_data_path: 用户数据路径 cache_path: 缓存路径 return: 当前对象
set_local_port(port)	设置本地启动端口 port: 端口号 return: 当前对象
set_address(address)	设置浏览器地址，格式'ip:port' address: 浏览器地址,格式'ip:port' return: 当前对象
set_browser_path(path)	设置浏览器可执行文件路径 path: 浏览器路径 return: 当前对象
set_download_path(path)	设置下载文件保存路径 path: 下载路径 return: 当前对象
set_tmp_path(path)	设置临时文件文件保存路径 path: 下载路径 return: 当前对象
set_user_data_path(path)	设置用户文件夹路径 path: 用户文件夹路径 return: 当前对象
set_cache_path(path)	设置缓存路径 path: 缓存路径 return: 当前对象
use_system_user_path(on_off=True)	设置是否使用系统安装的浏览器默认用户文件夹 on_off: 开或关 return: 当前对象
auto_port(on_off=True, tmp_path=None, scope=None)	自动获取可用端口 on_off: 是否开启自动获取端口号 tmp_path: 临时文件保存路径，为None时保存到系统临时文件夹，on_off为False时此参数无效 scope: 指定端口范围，不含最后的数字，为None则使用[9600-19600) return: 当前对象
existing_only(on_off=True)	设置只接管已有浏览器，不自动启动新的 on_off: 是否开启自动获取端口号 return: 当前对象
save(path=None)	保存设置到文件 path: ini文件的路径， None 保存到当前读取的配置文件，传入 'default' 保存到默认ini文件 return: 保存文件的绝对路径
save_to_default()	保存当前配置到默认ini文件

5.3 session_options.py

session_options.py文件定义的类和函数：

序号	名称	说明
1	SessionOptions(object)	requests的Session对象配置类
2	session_options_to_dict(options)	把session配置对象转换为字典

5.3.1 SessionOptions类

SessionOptions(object)

属性和方法	功能
本类定义的方法
__init__(self,read_file=True,ini_path=None)	read_file: 是否从默认ini文件中读取配置信息 ini_path: ini文件路径，为None则读取默认ini文件
@property download_path()	默认下载路径文件路径
set_download_path(path)	设置下载文件保存路径 path: 下载路径 return: 当前对象
@property timeout()	返回timeouts设置
set_timeout(second)	置超时信息 second: 秒数 return: 返回当前对象
@property proxy()	返回代理设置
set_proxy(proxy)	设置代理 proxy: 代理url和端口 return: 当前对象
@property retry_times()	返回连接失败时的重试次数
@property retry_interval()	返回连接失败时的重试间隔（秒）
set_retry(times=None, interval=None)	设置连接失败时的重试操作 times: 重试次数 interval: 重试间隔 return: 当前对象
@property headers()	返回headers设置信息
set_headers(headers)	设置headers参数 Headers:参数值,传入None可在ini文件标记删除 return:返回当前对象
set_a_header(name, value)	设置headers中一个项 name: 设置名称 value: 设置值 return: 返回当前对象
remove_a_header(name)	从headers中删除一个设置 name: 要删除的设置 return: 返回当前对象
clear_headers()	清空已设置的header参数
@property cookies()	以list形式返回cookies
set_cookies(cookies)	设置一个或多个cookies信息 cookies: cookies，可为Cookie, CookieJar, list, tuple, str, dict，传入None可在ini文件标记删除 return: 返回当前对象
@property auth()	返回认证设置信息
set_auth(auth)	设置认证元组或对象 auth: 认证元组或对象 return: 返回当前对象
@property hooks()	返回回调方法
set_hooks(hooks)	设置回调方法 hooks: 回调方法 return: 返回当前对象
@property params()	返回连接参数设置信息
set_params(params):	设置查询参数字典 params: 查询参数字典 return: 返回当前对象
@property verify()	返回是否验证SSL证书设置
set_verify(on_off)	设置是否验证SSL证书 on_off: 是否验证 SSL 证书 return: 返回当前对象
@property cert()	返回SSL证书设置信息
set_cert(cert)	SSL客户端证书文件的路径(.pem格式)，或(‘cert’, ‘key’)元组 cert: 证书路径或元组 return: 返回当前对象
@property adapters()	返回适配器设置信息
add_adapter(url, adapter)	添加适配器 url: 适配器对应url adapter: 适配器对象 return: 返回当前对象
@property stream()	返回是否使用流式响应内容设置信息
set_stream(on_off)	设置是否使用流式响应内容 on_off: 是否使用流式响应内容 return: 返回当前对象
@property trust_env()	返回是否信任环境设置信息
set_trust_env(on_off)	设置是否信任环境 on_off: 是否信任环境 return: 返回当前对象
@property max_redirects()	返回最大重定向次数
set_max_redirects(times)	设置最大重定向次数 imes: 最大重定向次数 return: 返回当前对象
save(path=None)	保存设置到文件 path: ini文件的路径，传入 'default' 保存到默认ini文件 return: 保存文件的绝对路径
save_to_default()	保存当前配置到默认ini文件
as_dict()	以字典形式返回本对象
make_session()	根据内在的配置生成Session对象，ua从对象中分离
from_session(session, headers=None)	从Session对象中读取配置 session: Session对象 headers: headers return: 当前对象

5.3.2 函数

函数	功能
session_options_to_dict(options)	把session配置对象转换为字典 options: session配置对象或字典 return: 配置字典