Skip to content

fix 'Alias for field number X' problem with NamedTuples #527

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 4 commits into from
Feb 20, 2024
Merged

fix 'Alias for field number X' problem with NamedTuples #527

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8893976
fix 'Alias for field number X' problem with NamedTuples
fohrloop Feb 14, 2024
67f6b4c
TST: Add test for duplicated attrs w/ namedtuples.
rossbar Feb 15, 2024
1fad9fb
TST: Add test of explicitly documented namedtuple params.
rossbar Feb 16, 2024
6d67dc6
TST: Make test for namedtuple params more specific.
rossbar Feb 20, 2024
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
14 changes: 14 additions & 0 deletions numpydoc/docscrape.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,6 +706,7 @@ def properties(self):
for name, func in inspect.getmembers(self._cls)
if (
not name.startswith("_")
and not self._should_skip_member(name, self._cls)
and (
func is None
or isinstance(func, (property, cached_property))
Expand All @@ -715,6 +716,19 @@ def properties(self):
)
]

@staticmethod
def _should_skip_member(name, klass):
if (
# Namedtuples should skip everything in their ._fields as the
# docstrings for each of the members is: "Alias for field number X"
Copy link
Member

Choose a reason for hiding this comment

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

Does it work properly with #257 (comment) ?

Copy link
Contributor Author

@fohrloop fohrloop Feb 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Tested with code from this comment, using

.. autoclass:: mypkg.Foo
    :members:

that outputs:

image

does that answer to the question?

Edit: Added also the methods to the screenshot.

Copy link
Member

Choose a reason for hiding this comment

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

It does, thank you!

issubclass(klass, tuple)
and hasattr(klass, "_asdict")
and hasattr(klass, "_fields")
and name in klass._fields
):
return True
return False

def _is_show_member(self, name):
if self.show_inherited_members:
return True # show all class members
Expand Down