Skip to content

DOC: #22899, Fixed docstring of itertuples in pandas/core/frame.py #22902

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 3 commits into from
Oct 7, 2018
Merged

DOC: #22899, Fixed docstring of itertuples in pandas/core/frame.py #22902

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c68feec
DOC: #22899, Fixed docstring of itertuples in pandas/core/frame.py
Sep 30, 2018
be1bee9
DOC: #22899, updated docstring with more examples and fixed Returns t…
Sep 30, 2018
064cf33
DOC: #22899, fix example whitespacing and update formatting in See Al…
Sep 30, 2018
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
44 changes: 32 additions & 12 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,17 +883,21 @@ def iterrows(self):

def itertuples(self, index=True, name="Pandas"):
"""
Iterate over DataFrame rows as namedtuples, with index value as first
element of the tuple.
Iterate over DataFrame rows as namedtuples.

Parameters
----------
index : boolean, default True
index : bool, default True
If True, return the index as the first element of the tuple.
name : string, default "Pandas"
name : str, default "Pandas"
The name of the returned namedtuples or None to return regular
tuples.

Yields
-------
collections.namedtuple
Yields namedtuples of corresponding index and column values.
Copy link
Member

Choose a reason for hiding this comment

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

I see what you mean here, but I think it may be difficult to understand for a beginner. May be something like Yields a namedtuple for each row in the DataFrame, which its values, and possibly the index..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the description just now! I think it's more intuitive now, please do let me know and if anything needs to be added I'll try again.


Notes
-----
The column names will be renamed to positional names if they are
Expand All @@ -907,19 +911,35 @@ def itertuples(self, index=True, name="Pandas"):

Copy link
Member

Choose a reason for hiding this comment

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

In the See Also, can you make the A in the title capital? And then, the items, if you can prefix iterrows and iteritems with DataFrame.iterrows...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, just prefixed both iterrows and iteritems.

Examples
--------

>>> df = pd.DataFrame({'col1': [1, 2], 'col2': [0.1, 0.2]},
index=['a', 'b'])
>>> df = pd.DataFrame({'num_legs': [4,2], 'num_wings': [0,2]},
Copy link
Member

Choose a reason for hiding this comment

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

Can you add spaces after the commas? You can use flake8 --doctests frame.py. It will generate many messages from other docstrings, but you can check the line numbers of yours, and make sure there is nothing wrong between them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry totally forgot about that second test. Fixed the whitespacing between the commas.

... index=['dog','hawk'])
>>> df
col1 col2
a 1 0.1
b 2 0.2
num_legs num_wings
dog 4 0
hawk 2 2
>>> for row in df.itertuples():
... print(row)
...
Pandas(Index='a', col1=1, col2=0.10000000000000001)
Pandas(Index='b', col1=2, col2=0.20000000000000001)
Pandas(Index='dog', num_legs=4, num_wings=0)
Pandas(Index='hawk', num_legs=2, num_wings=2)

By setting the `index` parameter to False we can remove the index
as the first element of the tuple:

>>> for row in df.itertuples(index=False):
... print(row)
...
Pandas(num_legs=4, num_wings=0)
Pandas(num_legs=2, num_wings=2)

With the `name` parameter set we set a custom name for the yielded
namedtuples:

>>> for row in df.itertuples(name='Animal'):
... print(row)
...
Animal(Index='dog', num_legs=4, num_wings=0)
Animal(Index='hawk', num_legs=2, num_wings=2)
"""
arrays = []
fields = []
Expand Down