Skip to content
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

Don't fail when docstrings have been stripped by -OO mode #2473

Merged
merged 3 commits into from
Feb 5, 2021
Merged

Don't fail when docstrings have been stripped by -OO mode #2473

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
283a485
Don't fail when docstrings have been stripped by -OO mode
mwaskom Feb 5, 2021
9c39d87
Fix comment
mwaskom Feb 5, 2021
250a643
Clarify language
mwaskom Feb 5, 2021
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
15 changes: 13 additions & 2 deletions seaborn/_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,22 @@ def __init__(self, comp_dict, strip_whitespace=True):
self.entries = entries

def __getattr__(self, attr):
"""Provided dot access to entries."""
"""Provide dot access to entries for clean raw docstrings."""
if attr in self.entries:
return self.entries[attr]
else:
return self.__getattribute__(attr)
try:
return self.__getattribute__(attr)
except AttributeError as err:
# If Python is run with -OO, it will strip docstrings and our lookup
# from self.entries will fail. We check for __debug__, which is actually
# set to False by -O (it is True for normal execution).
# But we only want to see an error when building the docs;
# not something users should see, so this slight inconsistency is fine.
if __debug__:
raise err
else:
pass

@classmethod
def from_nested_components(cls, **kwargs):
Expand Down