Skip to content

DOC: add warning to append about inefficiency #16956

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 7 additions & 4 deletions doc/make.py
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,13 @@ def _remove_notebooks():
print("Warning: Pandoc is not installed. Skipping notebooks.")
_remove_notebooks()

yield
for nb, content in contents.items():
with open(nb, 'wt') as f:
f.write(content)
try:
Copy link
Member

Choose a reason for hiding this comment

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

Why this try-except here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was to fix an issue if a doc build failed halfway through due to a missing dependency or ^C. I worked on this fix with @TomAugspurger, but am no longer to reproduce it's success. I am removing it from further pull requests.

yield
except BaseException:
for nb, content in contents.items():
with open(nb, 'wt') as f:
f.write(content)
raise


def html():
Expand Down
31 changes: 31 additions & 0 deletions pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -4618,6 +4618,11 @@ def append(self, other, ignore_index=False, verify_integrity=False):
the DataFrame's index, the order of the columns in the resulting
DataFrame will be unchanged.

Iteratively appending rows to a DataFrame can be more computationally
intensive than a single concatenate. A better solution is to append
those rows to a list and then concatenate the list with the original
DataFrame all at once.

See also
--------
pandas.concat : General function to concatenate DataFrame, Series
Expand Down Expand Up @@ -4648,6 +4653,32 @@ def append(self, other, ignore_index=False, verify_integrity=False):
2 5 6
3 7 8

The following, while not a recommended method for generating a
DataFrame, illustrates how to efficiently generate a DataFrame from
Copy link
Member

Choose a reason for hiding this comment

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

You can't call this "efficient" since you just said it wasn't efficient.

multiple data sources.

Less efficient:
>>> df = pd.DataFrame(columns=['A'])
Copy link
Member

Choose a reason for hiding this comment

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

Add a newline between "Less efficient" and ">>> df = ..."

>>> for i in range(5):
... df = df.append({'A'}: i}, ignore_index=True)
>>> df
A
0 0
1 1
2 2
3 3
4 4

More efficient:
>>> pd.concat([pd.DataFrame([i], columns=['A']) for i in range(5)],
... ignore_index=True)
A
0 0
1 1
2 2
3 3
4 4

"""
if isinstance(other, (Series, dict)):
if isinstance(other, dict):
Expand Down
12 changes: 12 additions & 0 deletions pandas/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -1522,6 +1522,18 @@ def append(self, to_append, ignore_index=False, verify_integrity=False):
verify_integrity : boolean, default False
If True, raise Exception on creating index with duplicates

Notes
-----
Iteratively appending to a Series can be more computationally intensive
than a single concatenate. A better solution is to append values to a
list and then concatenate the list with the original series all at
once.

See also
--------
pandas.concat : General function to concatenate DataFrame, Series
or Panel objects

Returns
-------
appended : Series
Expand Down