refactor: add type hints #774
Conversation
| @@ -220,19 +223,19 @@ def highlight_text(text): | |||
| return "".join(ansiSplit) | |||
|
|
|||
|
|
|||
| def gef_print(x="", *args, **kwargs): | |||
| def gef_print(x: str = "", *args: Tuple, **kwargs: Dict) -> Optional[int]: | |||
| """Wrapper around print(), using string buffering feature.""" | |||
| x = highlight_text(x) | |||
| if gef.ui.stream_buffer and not is_debug(): | |||
| return gef.ui.stream_buffer.write(x + kwargs.get("end", "\n")) | |||
| return print(x, *args, **kwargs) | |||
There was a problem hiding this comment.
weird. Why do we return print here? Mind changing to print then return? This whole function can probably just return None, actually.
There was a problem hiding this comment.
I actually encountered quite some similar questionable practices along the way ;)
In regards to changing this code in this PR: If I were to start changing things so it makes more sense this PR will become even huger and very confusing. IMO code changes should be implemented in separate PRs.
There was a problem hiding this comment.
which is fine, but we will forget unless we note this done somewhere. Maybe make another issue and just add notes from this PR for things to fix?
There was a problem hiding this comment.
I opened a project for this at https://github.com/hugsy/gef/projects/11
|
Looks good to me! Since this is targeting @hugsy 's branch let's make sure he's OK merging into it. |
refactor: add type hints
Description/Motivation/Screenshots
This huge PR adds type hints to the gdb8/py36 refactor branch and thereby reveals some logical bugs that can be addressed moving forward.
(Probably this PR does not cover 100% of the places where python 3.6. typing hints could be added but I wanted to push it already because I'm not sure about my schedule these next days)
How Has This Been Tested?
make testmake lintChecklist
gdb_8_py36_code_refactorbranch, notmaster.EDIT:
The PR was tested with python version 3.6 to be sure of compatibility
EDIT:
Just FYI: The tests that fail on my local machine are
test_cmd_elf_infoandtest_cmd_unicorn_emulate. And I also set up a CI with docker and ubuntu 18.04 and 20.04 where onlytest_cmd_set_permissionfails (but not the above mentioned). still haven't figured out why that is,