Polling库技术文档-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01231/article/details/143037110

Polling库技术文档

polling Powerful polling utility in Python 项目地址: https://gitcode.com/gh_mirrors/pol/polling

Polling 是一个强大的Python实用工具，用于等待函数返回期望的特定条件。它广泛适用于各种场景，如等待API响应成功、文件存在性检查、线程锁释放以及在自动化测试中的元素等待等。以下是全面使用和了解此库的指南。

安装指南

您可以通过pip轻松地将Polling库添加到您的Python环境中：

pip install polling

项目使用说明

Polling库的运用非常灵活，以下是一些典型的应用实例。

等待URL响应码为200

import requests
polling.poll(
    lambda: requests.get('http://google.com').status_code == 200,
    step=60,  # 每60秒检查一次
    poll_forever=True)  # 直至条件满足

耐心等待文件出现

# 将阻塞直到'/tmp/myfile.txt'文件存在
file_handle = polling.poll(
    lambda: open('/tmp/myfile.txt'),  # 尝试打开文件
    ignore_exceptions=(IOError,),  # 忽略找不到文件的错误
    timeout=3,  # 最多等待3秒
    step=0.1)  # 每0.1秒检查一次
file_handle.close()  # 文件找到后进行处理

集成Selenium进行Web自动化测试

如果您在进行网页自动化测试，Polling也能派上用场：

from selenium import webdriver
driver = webdriver.Firefox()
driver.get('http://google.com')

# 等待搜索框出现
search_box = polling.poll(
    lambda: driver.find_element_by_id('search'),  # 寻找ID为'search'的元素
    step=0.5,  # 半秒检查一次
    timeout=7)  # 最多等待7秒
search_box.send_keys('python polling')  # 找到后输入文本

处理超时情况

当需要严格控制等待时间时，可以利用TimeoutException来处理超时事件：

try:
    polling.poll(lambda: ..., step=0.5, timeout=1)
except polling.TimeoutException as te:
    for val in te.values:  # 访问未达条件的所有值
        print(val)

项目API使用文档

Polling的核心在于其灵活的等待逻辑，主要通过调用poll方法实现，支持自定义条件检查、异常忽略和步进间隔等参数。

polling.poll(function, step, *args, **kwargs)
- function: 一个返回布尔值的函数，用来检查条件是否满足。
- step: 两次检查之间的间隔时间（秒）。
- *args, **kwargs: 传递给function的额外参数。
- 可选参数：
  - timeout: 设定最长等待时间（秒），超时抛出TimeoutException。
  - poll_forever: 是否无限循环直到条件满足，默认为False。
  - ignore_exceptions: 允许忽略的异常类型列表，循环会跳过这些异常并继续执行。
  - check_success: 自定义的成功检查函数，替代默认的真值检查。
  - max_tries: 在达到最大尝试次数后停止尝试，默认是无限次。