Skip to content

TST: added test to ensure subclasses of ExcelWriter don't add any public attributes #50097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 12, 2022
Merged

TST: added test to ensure subclasses of ExcelWriter don't add any public attributes #50097

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bb08641
added test relating to issue 49602 to ensure ExcelWrtier subclasses d…
catmar22 Dec 6, 2022
c46612a
revised test for ExceWriter subclasses according to feedback from #50097
catmar22 Dec 8, 2022
0eb72a8
Merge branch 'main' into add-ioexcel-test
catmar22 Dec 8, 2022
be3c5c9
same test for ExcelWriter subclass but with pre-commit check (#50097)
catmar22 Dec 8, 2022
2dea7d9
I had to pull and it changed everything
catmar22 Dec 8, 2022
f694943
updating to same version
catmar22 Dec 8, 2022
8e07223
Merge branch 'main' into add-ioexcel-test
catmar22 Dec 11, 2022
9c5948a
Merge branch 'pandas-dev:main' into add-ioexcel-test
catmar22 Dec 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions pandas/tests/io/excel/test_writers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
register_writer,
)

# added for last test
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment isn't needed

from pandas.io.excel._util import _writers


@pytest.fixture
def path(ext):
Expand Down Expand Up @@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you put this in the testing function?



@pytest.mark.parametrize("klass", _writers.values())
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()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
assert attrs_base.symmetric_difference(attrs_klass) == set()
assert not attrs_base.symmetric_difference(attrs_klass)