tests: boxes: Add type annotations. #1102
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
added
PR needs review
|
Hello @zulip/server-refactoring members, this pull request was labeled with the "area: refactoring" label, so you may want to check it out! |
prah23
force-pushed
the
test_annotation_boxes
branch
from
e9e3a7b to
cce1d98
Compare
prah23
force-pushed
the
test_annotation_boxes
branch
3 times, most recently
from
74150b5 to
b00f4e6
Compare
neiljp
force-pushed
the
test_annotation_boxes
branch
from
b00f4e6 to
ce4d74b
Compare
3 tasks
|
As I mentioned in #1096, I think that is best done before this, to finalize the type annotations here. |
|
@prah23 I was just going to look at this again, but there may have been boxes merges since, as well as the other tests merge - could you do a quick rebase? |
|
@neiljp sure, I'll just review the types again once, since you wanted the |
prah23
force-pushed
the
test_annotation_boxes
branch
from
ce4d74b to
66821ec
Compare
|
PR updated. |
prah23
force-pushed
the
test_annotation_boxes
branch
from
66821ec to
f4da11e
Compare
This commit patches the `write_box` fixture's `_set_stream_box_write_style` using `mocker.patch` instead of assigning a `mocker.Mock` to it to maintain type consistency.
This commit removes the `mocker` fixture as a parameter from tests where it isn't used.
This commit adds assert statements within multiple tests to assert that the value of WriteBox's `to_write_box` is None after a `private_box_view` function call, since it initiates `to_write_box` with a ReadlineEdit instance. This is also necessary for supporting mypy, since the attribute type depends on whether it is a private box or not.
This commit adds parameter and return type annotations or hints to the `test_boxes.py` file, that contains tests for it's counterpart `boxes.py` from the `zulipterminal` module, to make mypy checks consistent and improve code readability.
This commit adds `test_boxes.py` to the `type_consistent_testfiles` list to check for type consistency with mypy.
neiljp
force-pushed
the
test_annotation_boxes
branch
from
f4da11e to
cb73646
Compare
|
@prah23 Thanks for keeping up with this 🎉 |
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_boxes.pyand adds the file to the list inrun-mypy. Also has a prior refactor commit to remove unnecessarymockerparameters.Tested?
Commit flow
refactor: tests: boxes: Remove mocker as parameter where unnecessary.
This commit removes the
mockerfixture as a parameter from testswhere it isn't used.
refactor: tests: boxes: Add type annotations.
This commit adds parameter and return type annotations or hints to the
test_boxes.pyfile, that contains tests for it's counterpartboxes.pyfrom thezulipterminalmodule, to make mypy checksconsistent and improve code readability.
tools: Include test_boxes.py to be checked by mypy.
This commit adds
test_boxes.pyto thetype_consistent_testfileslist to check for type consistency with mypy.