Skip to content

Type the return of itertuples as an iterable of Any #63273

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

Open
frankier wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −1
Open

Type the return of itertuples as an iterable of Any #63273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions doc/source/whatsnew/v3.0.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ Other enhancements
- Added a new :meth:`DataFrame.from_arrow` method to import any Arrow-compatible
tabular data object into a pandas :class:`DataFrame` through the
`Arrow PyCapsule Protocol <https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html>`__ (:issue:`59631`)
- :meth:`DataFrame.itertuples` is now annotated to return an iterable of Any to accommodate dynamic namedtuple types
Copy link
Member

@rhshadrach rhshadrach Dec 5, 2025

Choose a reason for hiding this comment

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

pandas publishes type-hints through pandas-stubs, the ones in the pandas library itself do not impact users. As this is not a user-facing change, the whatsnew note should be removed.


.. ---------------------------------------------------------------------------
.. _whatsnew_300.notable_bug_fixes:
Expand Down
10 changes: 9 additions & 1 deletion pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1598,9 +1598,17 @@ def iterrows(self) -> Iterable[tuple[Hashable, Series]]:
s._mgr.add_references(self._mgr)
yield k, s

@overload
def itertuples(self, index: bool, name: None) -> Iterable[tuple[Any, ...]]:
...

@overload
def itertuples(self, index: bool, name: str) -> Iterable[Any]:
...

def itertuples(
self, index: bool = True, name: str | None = "Pandas"
) -> Iterable[tuple[Any, ...]]:
) -> Iterable[tuple[Any, ...]] | Iterable[Any]:
"""
Iterate over DataFrame rows as namedtuples.

Expand Down
Loading