TST: added test to ensure subclasses of ExcelWriter don't add any public attributes #50097
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
catmar22
commented
Dec 6, 2022
•
catmar22
commented
- closes TST: Subclasses of ExcelWriter should not be allowed to add new public attributes #49602
- not fully tested with style and pre-commit checks yet
…on't have public attributes
mroeschke
reviewed
Dec 8, 2022
| @@ -30,6 +30,9 @@ | |||
| register_writer, | |||
| ) | |||
|
|
|||
| # added for last test | |||
mroeschke
reviewed
Dec 8, 2022
| @@ -1353,3 +1356,12 @@ def test_excelwriter_fspath(self): | |||
| with tm.ensure_clean("foo.xlsx") as path: | |||
| with ExcelWriter(path) as writer: | |||
| assert os.fspath(writer) == str(path) | |||
|
|
|||
| # testing that subclasses of ExcelWriter don't have public attributes (issue 49602) | |||
There was a problem hiding this comment.
Could you put this in the testing function?
mroeschke
reviewed
Dec 8, 2022
| def test_subclass_attr(klass): | ||
| attrs_base = {name for name in dir(ExcelWriter) if not name.startswith("_")} | ||
| attrs_klass = {name for name in dir(klass) if not name.startswith("_")} | ||
| assert attrs_base.symmetric_difference(attrs_klass) == set() |
There was a problem hiding this comment.
Suggested change
| assert attrs_base.symmetric_difference(attrs_klass) == set() | |
| assert not attrs_base.symmetric_difference(attrs_klass) |
mroeschke
added
Testing
|
I am failing the pre-commit check and from what I saw in the results of the tests this time, I think it has to do with the import statement? Do you have any input on what the issue might be, ie did I put it in a bad spot based on certain code style/maintenance criteria? Or where I could look for further documentation on this? |
mroeschke
approved these changes
Dec 12, 2022
|
Thanks @catmar22 |
|
Thanks @catmar22! |
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.