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

BigQuery: Add tqdm progress bar for downloads #7552

Merged
merged 12 commits into from
Mar 28, 2019
+219 −20
Merged

BigQuery: Add tqdm progress bar for downloads #7552

Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d309212
Add tqdm progressbar for bigquery downloads
JohnPaton Mar 23, 2019
c6efe1b
Catch any tqdm errors during progress bar construction
JohnPaton Mar 23, 2019
b23d581
Update total rows in progress bar during download
JohnPaton Mar 25, 2019
3c1f008
tqdm import to pandas pattern
JohnPaton Mar 27, 2019
c0e3a39
unit tests for download progress bar
JohnPaton Mar 27, 2019
0693789
Add tqdm to setup.py extras
JohnPaton Mar 27, 2019
9506caa
Merge branch 'master' into progressbar-download
JohnPaton Mar 27, 2019
a7d9d59
Make progress bar tests more specific
JohnPaton Mar 27, 2019
25f4e13
Style adjustments to improve clarity
JohnPaton Mar 27, 2019
4aafefe
Add progress_bar_type argument to to_dataframe
tswast Mar 28, 2019
62e3d58
Fix lint, coverage, and docs errors.
tswast Mar 28, 2019
bed0694
Add shared variable for common tqdm description.
tswast Mar 28, 2019
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
13 changes: 13 additions & 0 deletions bigquery/google/cloud/bigquery/table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1334,8 +1334,21 @@ def _to_dataframe_tabledata_list(self, dtypes):
"""Use (slower, but free) tabledata.list to construct a DataFrame."""
column_names = [field.name for field in self.schema]
frames = []

# report progress if tqdm installed
try:
from tqdm import tqdm
Copy link
Contributor

Choose a reason for hiding this comment

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

We aim for 100% unit test coverage, so could you follow the pattern that we do with the optional pandas dependency where we import it at the top of the module and catch import errors there?

That way we can install tqdm for our unit tests but then mock it out in another test to check that it doesn't fail when the tqdm module can't be loaded.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

pbar = tqdm(desc="Downloading", total=self.total_rows, unit="rows")
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this do something sensible when total_rows is not populated? As discussed in #7217 total_rows is None until iteration starts.

Copy link
Contributor Author

@JohnPaton JohnPaton Mar 25, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Good catch, I'll update pbar.total in the loop if it's unset. tqdm handles this just fine.

except (ImportError, KeyError, TypeError):
pbar = None

for page in iter(self.pages):
frames.append(self._to_dataframe_dtypes(page, column_names, dtypes))

if pbar is not None:
# update progress bar with number of rows in last frame
Copy link
Contributor

Choose a reason for hiding this comment

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

This comment is unnecessary, since it just states what is happening in the next line. Comments in this codebase should state why or explain something that looks "wrong".

This comment indicates to me that we need to rename pbar to progress_bar. Also, we could add some intermediate variables above to make this line more self-explanatory.

frames.append(self._to_dataframe_dtypes(page, column_names, dtypes))

     |
turns into
     |
     V

current_frame = self._to_dataframe_dtypes(page, column_names, dtypes)
frames.append(current_frame)
...
    progress_bar.update(len(current_frame))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Awesome feedback, thank you :)

pbar.update(len(frames[-1]))

return pandas.concat(frames)

def _to_dataframe_bqstorage(self, bqstorage_client, dtypes):
Expand Down