Gallopsled / pwntools / 25496194267

74%

Build Type

push

github

Committed by web-flow

Commit Message

Add type hints to timeout, term.text, hashes, and more (#2723)

* Add typehints to timeout module

Co-authored-by: Copilot <copilot@github.com>

* Add typehints to device class

* Add typehints to PwnlibException

* Add general typehints for term.text module

Since the available module attributes are handled dynamically like `text.green()` or `text.green_on_white()` or `text.underline_red()`, it's not feasible to type out all possible combinations.

Just tell the type checker that all module attibutes have the same type and thus avoid the `error: Module has no attribute "bold_blue"  [attr-defined]` errors.

* Add typehints for config module

* Add typehints for hashes module

The guaranteed algorithms in hashlib are pretty stable and we can generate the list out proper type checking and auto complete.

Still add a check in CI that notifies us if there are changes in the future.

* Add atexception and atexit types

atexception.unregister was not documented correctly since the function expects an identifier returned by `atexception.register` instead of the handler function.

* Fix toplevel type hints in shellcraft.internal

* Fix toplevel type hints in term.key

---------

Co-authored-by: Copilot <copilot@github.com>

Coverage Stats

3938 of 6600 branches covered (59.67%)

91 of 96 new or added lines in 10 files covered. (94.79%)

7 existing lines in 2 files now uncovered.

13570 of 18352 relevant lines covered (73.94%)

0.74 hits per line