🚄 启动配置
本节介绍SessionPage
的启动配置。
我们用SessionOptions
对象管理SessionPage
对象初始配置。
SessionOptions
仅用于管理启动配置,程序启动后再修 改无效。
✅️️ 创建对象
📌 导入
from DrissionPage import SessionOptions
📌 初始化参数
SessionOptions
对象用于管理Session
对象的初始化配置。可从配置文件中读取配置来进行初始化。
初始化参数 | 类型 | 默认值 | 说明 |
---|---|---|---|
read_file | bool | True | 是否从 ini 文件中读取配置信息,为False 则用默认配置创建 |
ini_path | Path str | None | 指定 ini 文件路径,为None 则读取内置 ini 文件 |
创建配置对象:
from DrissionPage import SessionOptions
so = SessionOptions()
默认情况下,SessionOptions
对象会从 ini 文件中读取配置信息,当指定read_file
参数为False
时,则以默认配置创建。
对象创建时已带有默认 headers,如要清除,可调用clear_headers()
方法。
✅️️ 使用方法
创建配置对象后,可调整配置内容,然后在页面对象创建时以参数形式把配置对象传递进去。
from DrissionPage import SessionPage, SessionOptions
# 创建配置对象(默认从 ini 文件中读取配置)
so = SessionOptions()
# 设置代理
so.set_proxies('http://localhost:1080')
# 设置 cookies
cookies = ['key1=val1; domain=****', 'key2=val2; domain=****']
so.set_cookies(cookies)
# 以该配置创建页面对象
page = SessionPage(session_or_options=so)
✅️️ 用于设置的方法
📌 set_headers()
该方法用于设置整个 headers 参数,传入值会覆盖原来的 headers。
headers 可以是dict
格式的,也可以是文本格式。
文本格式不同字段用\n
分隔,字段 key 和 value 用': '
分隔,即从浏览器直接复制的格式。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
headers | dict str | 必填 | headers 信息 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
示例:
so.set_headers = {'user-agent': 'Mozilla/5.0 (Macint...', 'connection': 'keep-alive' ...}
📌 set_a_header()
该方法用于设置headers
中的一个项。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
name | str | 必填 | 设置名称 |
value | str | 必填 | 设置值 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
示例:
so.set_a_header('accept', 'text/html')
so.set_a_header('Accept-Charset', 'GB2312')
输出:
{'accept': 'text/html', 'accept-charset': 'GB2312'}
📌 remove_a_header()
此方法用于从headers
中移除一个设置项。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
name | str | 必填 | 要删除的设置 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
示例:
so.remove_a_header('accept')
📌 clear_headers()
此方法用于清空已设置的headers
参数。
参数: 无
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象自身 |
📌 set_cookies()
此方法用于设置一个或多个 cookie,每次设置会覆盖之前所有 cookies 信息。
详细用法见实用教程相关章节。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
cookies | Cookie CookieJar list tuple str dict | 必填 | cookies |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
示例:
cookies = ['key1=val1; domain=****', 'key2=val2; domain=****']
so.set_cookies(cookies)
📌 set_timeout()
此方法用于设置连接超时属性。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
second | float | 必填 | 连接等待秒数 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_retry()
此方法用于设置页面连接超时时的重试次数和间隔。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
times | int | None | 连接失败重试次数 |
interval | float | None | 连接失败重试间隔(秒) |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 retry_times
该属性返回连接失败时的重试次数。
类型:int
📌 retry_interval
该属性返回连接失败时的重试间隔(秒)。
类型:float
📌 set_proxies()
此方法用于设置代理信息。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
http | str | 必填 | http 代理地址 |
https | str | None | https 代理地址,为None 时使用http 参数的值 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
示例:
so.set_proxies('http://127.0.0.1:1080')
📌 set_download_path()
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
path | str Path | 必填 | 默认下载保存路径 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_auth()
此方法用于设置认证元组信息。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
auth | tuple HTTPBasicAuth | 必填 | 认证元组或对象 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_hooks()
此方法用于设置回调方法。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
hooks | dict | 必填 | 回调方法 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_params()
此方法用于设置查询参数。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
params | dict | 必填 | 查询参数字典 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_cert()
此方法用于设置 SSL 客户端证书文件的路径(.pem格式),或 ('cert', 'key') 元组。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
cert | str tuple | 必填 | 证书路径或元组 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_verify()
此方法用于设置是否验证SSL证书。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
on_off | bool | 必填 | bool 表示开或关 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 add_adapter()
此方法用于添加适配器。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
url | str | 必填 | 适配器对应 url |
adapter | HTTPAdapter | 必填 | 适配器对象 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_stream()
此方法用于设置是否使用流式响应内容。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
on_off | bool | 必填 | bool 表示开或关 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_trust_env()
此方法用于设置是否信任环境。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
on_off | bool | 必填 | bool 表示开或关 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
📌 set_max_redirects()
此方法用于设置最大重定向次数。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
times | int | 必填 | 最大重定向次数 |
返回类型 | 说明 |
---|---|
SessionOptions | 配置对象本身 |
✅️️ 保存设置到文件
您可以把不同的配置保存到各自 的 ini 文件,以便适应不同的场景。
hooks
和adapters
配置是不会保存到文件中的。
📌 save()
此方法用于保存配置项到一个 ini 文件。
参数名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
path | str Path | None | ini 文件的路径, 传入None 保存到当前读取的配置文件 |
返回类型 | 说明 |
---|---|
str | 保存的 ini 文件绝对路径 |
示例:
# 保存当前读取的ini文件
so.save()
# 把当前配置保存到指定的路径
so.save(path=r'D:\tmp\settings.ini')
📌 save_to_default()
此方法用于保存配置项到固定的默认 ini 文件。默认 ini 文件是指随 DrissionPage 内置的那个。
参数: 无
返回类型 | 说明 |
---|---|
str | 保存的 ini 文件绝对路径 |
示例:
so.save_to_default()
✅️️ SessionOptions
属性
📌 headers
该属性返回 headers 设置信息。
类型:dict
📌 cookies
此属性以list
方式返回 cookies 设置信息。
类型:list
📌 proxies
此属性返回代理信息。
类型:dict
格式:{'http': 'http://**.**.**.**:****', 'https': 'http://**.**.**.**:****'}
📌 auth
此属性返回认证设置。
类型:tuple
、HTTPBasicAuth
📌 hooks
此属性返回回调方法设置。
类型:dict
📌 params
此属性返回查询参数设置。
类型:dict
📌 verify
此属性返回是否验证 SSL 证书设置。
类型:bool
📌 cert
此属性返回 SSL 证书设置。
类型:str
、tuple
📌 adapters
此属性返回适配器设置。
类型:List[HTTPAdapter]
📌 stream
此属性返回是否使用流式响应设置。
类型:bool
📌 trust_env
此属性返回是否信任环境设置。
类型:bool
📌 max_redirects
此属性返回max_redirects
设置。
类型:int
📌 timeout
此属性返回连接超时设置。
类型:int
、float
📌 download_path
此属性返回默认下载路径设置。
类型:str