查看“可调用对象列表/core.utils.http”的源代码

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

若需要请求网络，请使用此处的函数或 <code>aiohttp</code> 库，'''不可使用 <code>requests</code> 库'''。

== ''def'' <code>private_ip_check</code> ==
<syntaxhighlight lang="py3">
private_ip_check(url: str)
</syntaxhighlight>

参数：
* {{Instructor param|url|str}}：URL 地址。
异常：
* <code>ValueError</code>：URL 为私有 IP 地址。

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

== ''async def'' <code>get_url</code> ==
<syntaxhighlight lang="py3">
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)
</syntaxhighlight>

参数：
* {{Instructor param|url|str}}：URL 地址。
* {{Instructor param|status_code|int}}：状态码。
* {{Instructor param|headers|dict}}：请求时的 HTTP 标头。
* {{Instructor param|params|dict}}：请求时使用的参数。
* {{Instructor param|fmt|str}}：请求时使用的参数。
* {{Instructor param|timeout|int}}：超时时间。（默认 <code>20</code>）
* {{Instructor param|attempt|int}}：尝试次数。（默认 <code>3</code>）
* {{Instructor param|request_private_ip|bool}}：是否允许请求私有 IP。（默认 <code>False</code>）
* {{Instructor param|logging_err_resp|bool}}：是否允许日志记录错误响应。（默认 <code>False</code>）
* {{Instructor param|cookies|dict}}：使用的 Cookies。
异常：
* <code>ValueError</code>：状态码与预期不符、无效获取格式、请求超时。

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


== ''async def'' <code>post_url</code> ==
<syntaxhighlight lang="py3">
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)
</syntaxhighlight>

参数：
* {{Instructor param|url|str}}：URL 地址。
* <code>data</code>：需要发送的数据。
* {{Instructor param|status_code|int}}：状态码。
* {{Instructor param|headers|dict}}：请求时的 HTTP 标头。
* {{Instructor param|params|dict}}：请求时使用的参数。
* {{Instructor param|fmt|str}}：请求时使用的参数。
* {{Instructor param|timeout|int}}：超时时间。（默认 <code>20</code>）
* {{Instructor param|attempt|int}}：尝试次数。（默认 <code>3</code>）
* {{Instructor param|request_private_ip|bool}}：是否允许请求私有 IP。（默认 <code>False</code>）
* {{Instructor param|logging_err_resp|bool}}：是否允许日志记录错误响应。（默认 <code>False</code>）
* {{Instructor param|cookies|dict}}：使用的 Cookies。
异常：
* <code>ValueError</code>：状态码与预期不符、无效获取格式、请求超时。

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


== ''async def'' <code>download</code> ==
<syntaxhighlight lang="py3">
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]
</syntaxhighlight>

参数：
* {{Instructor param|url|str}}：URL 地址。
* {{Instructor param|filename|str}}：文件名，默认为随机文件名。
* {{Instructor param|path|str}}：下载目录，默认为缓存目录。
* {{Instructor param|status_code|int}}：状态码。
* {{Instructor param|method|str}}：请求方法（默认 <code>GET</code>）。
* <code>post_data</code>：若请求方法为 POST，需要发送的数据。
* {{Instructor param|headers|dict}}：请求时的 HTTP 标头。
* {{Instructor param|timeout|int}}：超时时间。（默认 <code>20</code>）
* {{Instructor param|attempt|int}}：尝试次数。（默认 <code>3</code>）
* {{Instructor param|request_private_ip|bool}}：是否允许请求私有 IP。（默认 <code>False</code>）
* {{Instructor param|logging_err_resp|bool}}：是否允许日志记录错误响应。（默认 <code>False</code>）
异常：
* <code>ValueError</code>：状态码与预期不符、无效获取格式、请求超时。
返回：文件的相对路径，若获取失败则返回 <code>False</code>。

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