跳至主要内容

Route

每当使用page.route()或browser_context.route()设置网络路由时，Route对象允许处理该路由。

了解更多关于网络的信息。

方法​

中止​

Added before v1.9 route.abort

中止路由的请求。

用法

route.abort()
route.abort(**kwargs)

参数

  • error_code str (可选)#

    可选的错误代码。默认为failed，可能是以下之一：

    • 'aborted' - 操作被中止（由于用户操作）
    • 'accessdenied' - 访问资源(网络除外)的权限被拒绝
    • 'addressunreachable' - IP地址不可达。这通常意味着没有通往指定主机或网络的路由。
    • 'blockedbyclient' - 客户端选择阻止该请求。
    • 'blockedbyresponse' - 请求失败的原因是响应附带的要求未得到满足（例如'X-Frame-Options'和'Content-Security-Policy'的祖先检查）。
    • 'connectionaborted' - 由于未收到发送数据的ACK确认而导致连接超时。
    • 'connectionclosed' - 连接已关闭（对应TCP FIN）。
    • 'connectionfailed' - 连接尝试失败。
    • 'connectionrefused' - 连接尝试被拒绝。
    • 'connectionreset' - 连接被重置（对应TCP RST）。
    • 'internetdisconnected' - 互联网连接已断开。
    • 'namenotresolved' - 主机名无法解析。
    • 'timedout' - 操作超时。
    • 'failed' - 发生了一般性故障。

返回

继续_​

Added before v1.9 route.continue_

将路由的请求发送到网络，可选择性地进行覆盖。

用法

def handle(route, request):
    # override headers
    headers = {
        **request.headers,
        "foo": "foo-value", # set "foo" header
        "bar": None # remove "bar" header
    }
    route.continue_(headers=headers)

page.route("**/*", handle)

参数

  • headers Dict[str, str] (可选)#

    如果设置，将更改请求的HTTP头信息。头值将被转换为字符串。

  • method str (可选)#

    如果设置该参数，将更改请求方法（例如GET或POST）。

  • post_data str | bytes | Dict (可选)#

    如果设置，将更改请求的post数据。

  • url str (可选)#

    如果设置，将更改请求URL。新URL必须与原始URL使用相同的协议。

返回

详情

headers选项适用于路由请求及其引发的任何重定向。然而，url、method和post_data仅适用于原始请求，不会传递到重定向请求中。

route.continue_() 会立即将请求发送到网络，其他匹配的处理程序不会被调用。如果您希望调用链中的下一个匹配处理程序，请使用 route.fallback()。

回退​

Added in: v1.23 route.fallback

使用可选覆盖继续路由的请求。该方法类似于route.continue_()，不同之处在于在发送请求之前会调用其他匹配的处理程序。

用法

当多个路由匹配给定模式时，它们会按照与注册顺序相反的顺序运行。这样最后注册的路由总是可以覆盖之前所有的路由。在下面的示例中，请求将首先由最底部的处理程序处理，然后回退到前一个处理程序，最终会被第一个注册的路由中止。

page.route("**/*", lambda route: route.abort())  # Runs last.
page.route("**/*", lambda route: route.fallback())  # Runs second.
page.route("**/*", lambda route: route.fallback())  # Runs first.

注册多个路由非常有用，当您希望不同的处理程序处理不同类型的请求时，例如下面的示例中，API调用与页面资源或GET请求与POST请求。

# Handle GET requests.
def handle_get(route):
    if route.request.method != "GET":
        route.fallback()
        return
  # Handling GET only.
  # ...

# Handle POST requests.
def handle_post(route):
    if route.request.method != "POST":
        route.fallback()
        return
  # Handling POST only.
  # ...

page.route("**/*", handle_get)
page.route("**/*", handle_post)

也可以在回退到后续处理程序的同时修改请求，这样中间路由处理程序就可以修改请求的URL、方法、头部和postData。

def handle(route, request):
    # override headers
    headers = {
        **request.headers,
        "foo": "foo-value", # set "foo" header
        "bar": None # remove "bar" header
    }
    route.fallback(headers=headers)

page.route("**/*", handle)

使用 route.continue_() 立即将请求发送到网络，在这种情况下不会调用其他匹配的处理程序。

参数

  • headers Dict[str, str] (可选)#

    如果设置，将更改请求的HTTP头信息。头值将被转换为字符串。

  • method str (可选)#

    如果设置，将更改请求方法（例如GET或POST）。

  • post_data str | bytes | Dict (可选)#

    如果设置，将更改请求的post数据。

  • url str (可选)#

    如果设置则会更改请求URL。新URL必须与原始URL使用相同的协议。更改URL不会影响路由匹配，所有路由都是使用原始请求URL进行匹配的。

返回

fetch​

Added in: v1.29 route.fetch

执行请求并获取结果但不完成它，以便可以修改响应后再完成。

用法

def handle(route):
    response = route.fetch()
    json = response.json()
    json["message"]["big_red_dog"] = []
    route.fulfill(response=response, json=json)

page.route("https://dog.ceo/api/breeds/list/all", handle)

参数

  • headers Dict[str, str] (可选)#

    如果设置，将更改请求的HTTP头信息。头值将被转换为字符串。

  • max_redirects int (可选) 添加于: v1.31#

    自动跟随的最大请求重定向次数。如果超过此数字将抛出错误。默认为20。传递0表示不跟随重定向。

  • max_retries int (可选) 添加于: v1.46#

    网络错误应重试的最大次数。当前仅会重试ECONNRESET错误。不会基于HTTP响应码进行重试。如果超过限制将抛出错误。默认为0 - 不重试。

  • method str (可选)#

    如果设置，将更改请求方法（例如GET或POST）。

  • post_data str | bytes | Dict (可选)#

    允许设置请求的post数据。如果data参数是一个对象，它将被序列化为json字符串，并且如果没有明确设置，content-type头将被设置为application/json。否则，如果没有明确设置，content-type头将被设置为application/octet-stream。

  • timeout float (可选) 添加于: v1.33#

    请求超时时间，单位为毫秒。默认为 30000 (30秒)。传入 0 表示禁用超时。

  • url str (可选)#

    如果设置，将更改请求URL。新URL必须与原始URL使用相同的协议。

返回

详情

请注意，headers选项将同时应用于获取的请求及其引发的任何重定向。如果您只想将headers应用于原始请求而不应用于重定向，请改用route.continue_()。

fulfill​

Added before v1.9 route.fulfill

使用给定的响应完成路由的请求。

用法

一个返回404响应来满足所有请求的示例：

page.route("**/*", lambda route: route.fulfill(
    status=404,
    content_type="text/plain",
    body="not found!"))

一个提供静态文件服务的示例：

page.route("**/xhr_endpoint", lambda route: route.fulfill(path="mock_data.json"))

参数

  • body str | bytes (可选)#

    响应体。

  • content_type str (可选)#

    如果设置，等同于设置Content-Type响应头。

  • headers Dict[str, str] (可选)#

    响应头信息。头部值将被转换为字符串。

  • json Dict (可选) 添加于: v1.29#

    JSON响应。如果未设置，此方法会将内容类型设置为application/json。

  • path Union[str, pathlib.Path] (可选参数)#

    用于响应的文件路径。内容类型将从文件扩展名推断。如果path是相对路径，则相对于当前工作目录解析。

  • response APIResponse (可选) 添加于: v1.15#

    用于满足路由请求的APIResponse。可以使用fulfill选项覆盖响应的各个字段（如headers）。

  • status int (可选)#

    响应状态码，默认为 200。

返回

属性​

请求​

Added before v1.9 route.request

一个需要被路由的请求。

用法

route.request

返回