[Feature] rename TimeoutError or make it extend the builtin TimeoutError

[DetachHead]

TimeoutError shadows a builtin exception with the same name, which leads to confusion

try:
    page.click("foo")
except TimeoutError: # builtins.TimeoutError
    # this doesn't run because it raises a playwright.sync_api.TimeoutError
    print("failed to click element")

[KotlinIsland]

This can be super sus if the import (from playwright.sync_api import TimeoutError) gets removed, your code will silently change behavior with no warning.

[rwoll]

You can rename it within your own project like: from playwright.sync_api import sync_playwright, TimeoutError as PlaywrightTimeoutError.

While this doesn't address the shadowing and omission concern, Playwright cannot break its API by renaming this completely.

Perhaps doing:

from playwright.sync_api import sync_playwright, TimeoutError
class PlaywrightTimeoutError(TimeoutError):
   pass

would be a backwards compatible compromise. (The examples and your code could then be changed to look for PlaywrightTimeoutError.) Would this work for you? If so, we could discuss it further?

[DetachHead]

perhaps simply making playwright.sync_api.TimeoutError extend both Error and the builtin TimeoutError would solve the problem?

_BuiltinTimeoutError = TimeoutError


class TimeoutError(Error, _BuiltinTimeoutError):
    ...

that way there's no backward incompatible change and code that catches builtins.TimeoutError will still work

[KotlinIsland]

Probably want something like this:

class TimeoutError(Error, __builtins__.TimeoutError):
    pass

[danphenderson]

@mxschmitt why was this reopened and the commit reverted?

[danphenderson]

@mxschmitt, as a contributor who volunteered his time, may I please have an explanation? Without an explanation, I am highly unmotivated to continue contributing. Overall, I am just asking for more transparency.

[mxschmitt]

See #2312 (comment) for the reason. Since there is a good workaround we think its ok to hold off for now.