DOC: added type annotations and tests to check for multiple warning match #47833
Conversation
This file contains hidden or 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
Contributor
shourya5
commented
Jul 23, 2022
shourya5
commented
- closes DOC: clarify that assert_produces_warning can take multiple warnings #47829
- Added type annotations to new arguments/methods/functions.
…es_warning function
|
@github-actions pre-commit |
mroeschke
added
Testing
MarcoGorelli
suggested changes
Jul 29, 2022
this was removed not long ago (the stable docs will only update after the 1.5 release, but the dev docs already don't show it) - can you run it locally? Just where you put any files you've modified after |
|
I am failing one test besides the pre-commit test |
|
You need to update the type annotation in _assert_caught_no_extra_warnings too |
|
Does this look correct? |
MarcoGorelli
suggested changes
Aug 2, 2022
There was a problem hiding this comment.
Nice
Couple of things:
- the docstring of assert produces warning needs updating, can you add a line there about how to catch multiple warnings you can pass them as a tuple? Line 40, in the description of "expected warning"
- can you run pre-commit on the files you've modified?
|
the pre-commit action is changing 'Tuple' to tuple. Should I change it or leave it as is? |
|
Yeah that's fine, just git add, git commit, git push |
|
I think it should pass all tests now |
MarcoGorelli
approved these changes
Aug 2, 2022
noatamir
pushed a commit
to noatamir/pandas
that referenced
this pull request
Nov 9, 2022
…atch (pandas-dev#47833) * Testing * TST: added a test for multiple warnings * TYP: added type annotation Tuple[Type[Warning], ...] in assert_produces_warning function * TST: added a test for multiple warnings * TYP: Fixed Annotations * TST: Test for catching multiple warnings * TST: Test for catching multiple warnings * TST: Test for catching multiple warnings * TYP : fixed type annotations in _assert_caught_no_extra_warnings * TYP : updated type annotations * DOC : added issue as inline comment * DOC : added some documentation regarding type annotations * DOC : fixed pre-commit errors * fix missing whitespace Co-authored-by: Marco Edward Gorelli <[email protected]>
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.