tests: helper: Add type annotations. #1083
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
This commit changes the previous incorrect configuration of `Lists` to the `muted_streams` parameter in `test_classify_unread_counts` which is assigned model's muted_streams, to `Set`s instead, which is the appropriate data structure.
This commit adds parameter and return type annotations or hints to the `test_helper.py` file, that contains tests for its counterpart `helper.py` from the `zulipterminal` module, to make mypy checks consistent and improve code readability.
This commit adds `test_helper.py` to the `type_consistent_testfiles` list to check for type consistency with mypy.
neiljp
force-pushed
the
test_annotation_helper
branch
from
e96694f to
191d6d0
Compare
|
Hello @zulip/server-refactoring members, this pull request was labeled with the "area: refactoring" label, so you may want to check it out! |
|
@prah23 Looks good after the small Composition tidy I mentioned, so merging now 🎉 |
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_helper.py. I've also added a prior bugfix commit changingmuted_streams' data structure from List to Set and a final follow up commit to includetest_helper.pyin the list of files being checked byrun-mypy.Tested?
Commit flow
bugfix: tests: helper: Use Sets as params for muted_streams.
This commits changes the previous incorrect configuration of
Liststo the
muted_streamsparameter intest_classify_unread_countswhich is assigned model's muted_streams, to
Sets instead, which isthe appropriate data structure.
refactor: tests: helper: Add type annotations.
This commit adds parameter and return type annotations or hints
to the
test_helper.pyfile, that contains tests for its counterparthelper.pyfrom thezulipterminalmodule, to make mypy checksconsistent and improve code readability.
tools: Include test_helper.py to be checked by mypy.
This commit adds
test_helper.pyto thetype_consistent_testfileslist to check for type consistency with mypy.