• 欢迎来到小可 · Wiki,人人可编辑的,多平台聊天机器人“小可”的官方文档资源。
  • 小可很可爱,请给我们打钱
  • 原 MkDocs 已迁入本站。若发现 404 属正常现象,请点击左上角搜索您想要的模块。

可调用对象列表/core.utils.http

来自小可 · Wiki,人人可编辑的,QQ机器人“小可”的官方文档资源
Dorowolf讨论 | 贡献2024年9月22日 (日) 05:38的版本
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)

此部分为机器人的网络请求功能相关。

若需要请求网络,请使用此处的函数或 aiohttp 库,不可使用 requests

def private_ip_check

private_ip_check(url: str)

参数:

  • 字符串 url:URL 地址。

异常:

  • ValueError:URL 为私有 IP 地址。

此函数可以检查 URL 是否为私有 IP 地址。

async def get_url

get_url(url: str, status_code: int = False, headers: dict = None, params: dict = None, fmt: str = None, timeout: int = 20, attempt: int = 3, request_private_ip: bool = False, logging_err_resp: bool = True, cookies: dict = None)

参数:

  • 字符串 url:URL 地址。
  • 整数 status_code:状态码。
  • 字典 headers:请求时的 HTTP 标头。
  • 字典 params:请求时使用的参数。
  • 字符串 fmt:请求时使用的参数。
  • 整数 timeout:超时时间。(默认 20
  • 整数 attempt:尝试次数。(默认 3
  • 布尔值 request_private_ip:是否允许请求私有 IP。(默认 False
  • 布尔值 logging_err_resp:是否允许日志记录错误响应。(默认 False
  • 字典 cookies:使用的 Cookies。

异常:

  • ValueError:状态码与预期不符、无效获取格式、请求超时。

此异步函数可以对 URL 发送 GET 请求,并获取对应内容。

async def post_url

post_url(url: str, data: any = None, status_code: int = False, headers: dict = None, fmt: str = None, timeout: int = 20, attempt: int = 3, request_private_ip: bool = False, logging_err_resp: bool = True, cookies: dict = None)

参数:

  • 字符串 url:URL 地址。
  • data:需要发送的数据。
  • 整数 status_code:状态码。
  • 字典 headers:请求时的 HTTP 标头。
  • 字典 params:请求时使用的参数。
  • 字符串 fmt:请求时使用的参数。
  • 整数 timeout:超时时间。(默认 20
  • 整数 attempt:尝试次数。(默认 3
  • 布尔值 request_private_ip:是否允许请求私有 IP。(默认 False
  • 布尔值 logging_err_resp:是否允许日志记录错误响应。(默认 False
  • 字典 cookies:使用的 Cookies。

异常:

  • ValueError:状态码与预期不符、无效获取格式、请求超时。

此异步函数可以对 URL 发送 POST 请求,并获取对应内容。

async def download

download(url: str, filename: str = None, path: str = None, status_code: int = False, method: str = "GET", post_data: any = None, headers: dict = None, timeout: int = 20, attempt: int = 3, request_private_ip: bool = False, logging_err_resp: bool = True) -> Union[str, bool]

参数:

  • 字符串 url:URL 地址。
  • 字符串 filename:文件名,默认为随机文件名。
  • 字符串 path:下载目录,默认为缓存目录。
  • 整数 status_code:状态码。
  • 字符串 method:请求方法(默认 GET)。
  • post_data:若请求方法为 POST,需要发送的数据。
  • 字典 headers:请求时的 HTTP 标头。
  • 整数 timeout:超时时间。(默认 20
  • 整数 attempt:尝试次数。(默认 3
  • 布尔值 request_private_ip:是否允许请求私有 IP。(默认 False
  • 布尔值 logging_err_resp:是否允许日志记录错误响应。(默认 False

异常:

  • ValueError:状态码与预期不符、无效获取格式、请求超时。

返回:文件的相对路径,若获取失败则返回 False

此异步函数可以下载 URL 内容,并保存到指定目录。

Cookie帮助我们提供我们的服务。通过使用我们的服务,您同意我们使用cookie。