stubs are completely broken

it looks like whatever is being used to generate the stubs is completely broken. for example the type annotations in SeleniumLibrary/__init__.pyi are mostly invalid:

class SeleniumLibrary:
    def __init__(self, timeout = timedelta(seconds=5.0), implicit_wait = timedelta(seconds=0.0), run_on_failure = 'Capture Page Screenshot', screenshot_root_directory: Optional[Optional] = None, plugins: Optional[Optional] = None, event_firing_webdriver: Optional[Optional] = None, page_load_timeout = timedelta(seconds=300.0), action_chain_delay = timedelta(seconds=0.25)): ...
    def add_cookie(self, name: str, value: str, path: Optional[Optional] = None, domain: Optional[Optional] = None, secure: Optional[Optional] = None, expiry: Optional[Optional] = None): ...
    
    ...
    
    def click_button(self, locator: Union, modifier: Union = False): ...
    def click_element(self, locator: Union, modifier: Union = False, action_chain: bool = False): ...
    def click_element_at_coordinates(self, locator: Union, xoffset: int, yoffset: int): ...
    def click_image(self, locator: Union, modifier: Union = False): ...
    def click_link(self, locator: Union, modifier: Union = False): ...

Optional[Optional] isn't valid. the correct usage would be something like Optional[int] (though Optional is deprecated in favor of the new union syntax eg. int | None)
Union is not valid as a type on its own. it should be something like Union[int, str] (which is deprecated in favor of int | str)
i see that __init__.py contains type annotations, so the generated stubs should not be needed and can probably just be deleted
a py.typed file is also required for type checkers to treat the package as typed

The v6.6.1 stub file was just regenerated as part of the release. I might have messed them up some how. I do recall I was switching between Python 3.12 and an earlier version as to implement and test 3.12 support. Will take a look today. One can regenerate it using the invoke gen-stub task from the root project directory. (See the BUILD / developer docs for more info.)

i don't think the stub file is even needed anymore since the source code now contains type annotations

It is needed, when using SL from Python side, IDE doesn’t know what public API is.

The v6.6.1 stub file was just regenerated as part of the release. I might have messed them up some how. I do recall I was switching between Python 3.12 and an earlier version as to implement and test 3.12 support. Will take a look today. One can regenerate it using the invoke gen-stub task from the root project directory. (See the BUILD / developer docs for more info.)

I think I built some custom parsing, which is not good idea. It might be better to scrap that logic and use MyPy to generate base for the pyi file. It will need some code for finding correct methods and compile it into single file

It is needed, when using SL from Python side, IDE doesn’t know what public API is.

That's probably because a py.typed is missing. With it, the stubs can (and should) be deleted.

Navigation Menu

Repository navigation

stubs are completely broken #1919

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

stubs are completely broken #1919

Description

Activity

emanlove commented on Sep 10, 2024

DetachHead commented on Sep 10, 2024

aaltat commented on Sep 10, 2024

aaltat commented on Sep 10, 2024

jorenham commented on Sep 10, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions