如何为第三方库（Playwright）猴子补丁覆盖类型提示？

当你给第三方库的类打猴子补丁后，类型检查器无法识别新增的方法，以下是几种解决方式：

方法一：全局扩展类型提示（推荐） #

通过类型检查专属的代码块，扩展原类的类型定义，让所有使用该类的地方都能获得正确提示：

from typing import TYPE_CHECKING
from playwright.sync_api import Locator

# 仅在类型检查阶段生效，不影响运行时
if TYPE_CHECKING:
    class ExtendedLocator(Locator):
        # 根据你的实际逻辑定义方法的参数和返回类型
        def poll(self) -> Locator:
            ...

    # 让类型检查器将原Locator识别为扩展后的类型
    Locator = ExtendedLocator

# 猴子补丁实现
def poll(self):
    # 这里写你的自定义逻辑
    return self

Locator.poll = poll

# 使用示例
from playwright.sync_api import Page, expect

def test_succeeds(page: Page):
    expect(page.locator('dl:has-text("Success")').poll()).to_be_visible()

方法二：使用Protocol局部标注 #

定义一个包含自定义方法的协议，在需要使用的地方标注该类型：

from typing import Protocol
from playwright.sync_api import Locator, Page, expect

# 定义包含poll方法的协议
class LocatorWithPoll(Protocol):
    def poll(self) -> Locator:
        ...

# 猴子补丁实现
def poll(self):
    return self

Locator.poll = poll

# 使用时标注类型
def test_succeeds(page: Page):
    locator: LocatorWithPoll = page.locator('dl:has-text("Success")')
    expect(locator.poll()).to_be_visible()

方法三：临时忽略类型检查（应急用） #

如果只是临时解决问题，可以添加类型忽略注释，但不推荐长期使用：

from playwright.sync_api import Page, expect

def test_succeeds(page: Page):
    # 添加type: ignore跳过类型检查
    expect(page.locator('dl:has-text("Success")').poll()).to_be_visible()  # type: ignore

内容的提问来源于stack exchange，提问作者medihack