tests: ui: Add type annotations. #1091
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
prah23
commented
Jul 19, 2021
| import pytest | ||
| from pytest_mock import MockerFixture | ||
| from urwid import Widget |
There was a problem hiding this comment.
I'm not very confident in this being the most relevant type for the widget parameter in widget_size, does this fit?
There was a problem hiding this comment.
This seems fine for now - it is the base widget class after all?
There was a problem hiding this comment.
Yeah, verified by the class's docstring.
neiljp
reviewed
Jul 20, 2021
prah23
force-pushed
the
test_annotation_ui
branch
2 times, most recently
from
53d1aba to
192f2a8
Compare
This commit assigns patches `stream_box_view` and `private_box_view` using `mocker.patch.object` to maintain type consistency since their mocked nature's assert methods are being called.
This commit uses `mocker.patch.object()` with the `create` argument set as True for attributes of the `View` fixture instance that don't exist without their corresponding generation methods being called. `View`'s `middle_column` is generated by the `middle_column_view()` method and `users_view` is generated by the `right_column_view()` method. Also removes an unused patch.
This commit adds parameter and return type annotations or hints to the `test_ui.py` file, that contains tests for its counterpart `ui.py` from the `zulipterminal` module, to make mypy checks consistent and improve code readability.
This commit adds `test_ui.py` to the `type_consistent_testfiles` list to check for type consistency with mypy.
neiljp
force-pushed
the
test_annotation_ui
branch
from
192f2a8 to
dc2632e
Compare
|
@prah23 Just amended one commit text to take into account the extra mock removal, and merging now - thanks! 🎉 |
|
Hello @zulip/server-refactoring members, this pull request was labeled with the "area: refactoring" label, so you may want to check it out! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds type annotations to
test_ui.pyand includes it under files to be checked by mypy in the run-mypy tool. Also added a couple of prior commits to use appropriate patches.Tested?
Commit flow
refactor: ui: Patch *_box_views in OPEN_DRAFT tests.
This commit assigns patches
stream_box_viewandprivate_box_viewusing
mocker.patch.objectto maintain type consistency since theirmocked nature's assert methods are being called.
refactor: ui: Use patch for non-existent attributes instead of Mock.
This commit uses
mocker.patchwith thecreateparameter set asTrue for attributes of the
Viewfixture instance that don't existwithout their corresponding generation methods being called.
View'smiddle_columnis generated by themiddle_column_view()methodand
users_viewis generated by theright_column_view()method.refactor: tests: ui: Add type annotations.
This commit adds parameter and return type annotations or hints to the
test_ui.pyfile, that contains tests for its counterpartui.pyfrom the
zulipterminalmodule, to make mypy checks consistent andimprove code readability.
tools: Include test_ui.py to be checked by mypy.
This commit adds
test_ui.pyto thetype_consistent_testfileslist to check for type consistency with mypy.