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
feat: add progress bar for to_arrow method #352
Changes from 3 commits
05f101e
288739f
d94894c
fa1bb49
485bcf5
f9b2ff7
481fa05
c1ee80e
47d393c
e1d017c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Copyright 2019 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
"""Shared helper functions for tqdm progress bar.""" | ||
|
||
import warnings | ||
|
||
try: | ||
import tqdm | ||
except ImportError: # pragma: NO COVER | ||
tqdm = None | ||
|
||
_NO_TQDM_ERROR = ( | ||
"A progress bar was requested, but there was an error loading the tqdm " | ||
"library. Please install tqdm to use the progress bar functionality." | ||
) | ||
|
||
|
||
def _get_progress_bar(progress_bar_type, description, total, unit): | ||
"""Construct a tqdm progress bar object, if tqdm is installed.""" | ||
if tqdm is None: | ||
if progress_bar_type is not None: | ||
warnings.warn(_NO_TQDM_ERROR, UserWarning, stacklevel=3) | ||
return None | ||
|
||
try: | ||
if progress_bar_type == "tqdm": | ||
return tqdm.tqdm(desc=description, total=total, unit=unit) | ||
elif progress_bar_type == "tqdm_notebook": | ||
return tqdm.tqdm_notebook(desc=description, total=total, unit=unit) | ||
elif progress_bar_type == "tqdm_gui": | ||
return tqdm.tqdm_gui(desc=description, total=total, unit=unit) | ||
except (KeyError, TypeError): | ||
# Protect ourselves from any tqdm errors. In case of | ||
# unexpected tqdm behavior, just fall back to showing | ||
# no progress bar. | ||
warnings.warn(_NO_TQDM_ERROR, UserWarning, stacklevel=3) | ||
return None |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,6 +20,7 @@ | |
import copy | ||
import re | ||
import threading | ||
import time | ||
|
||
import requests | ||
import six | ||
|
@@ -52,6 +53,7 @@ | |
from google.cloud.bigquery.table import TableListItem | ||
from google.cloud.bigquery.table import TableReference | ||
from google.cloud.bigquery.table import TimePartitioning | ||
from google.cloud.bigquery._tqdm_helpers import _get_progress_bar | ||
|
||
_DONE_STATE = "DONE" | ||
_STOPPED_REASON = "stopped" | ||
|
@@ -3337,7 +3339,49 @@ def to_arrow( | |
|
||
..versionadded:: 1.17.0 | ||
""" | ||
return self.result().to_arrow( | ||
if self.query_plan and progress_bar_type: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this logic necessary if we are calling There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry, didn't get this point, are you talking about table.to_arrow() progress bar support? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh, I was getting this confused with |
||
start_time = time.time() | ||
i = 0 | ||
progress_bar = _get_progress_bar( | ||
progress_bar_type, | ||
"Query executing stage {}".format(self.query_plan[i].name), | ||
len(self.query_plan), | ||
"query", | ||
) | ||
while True: | ||
total = len(self.query_plan) | ||
self.reload() # Refreshes the state via a GET request. | ||
|
||
current_stage = self.query_plan[i] | ||
progress_bar.set_description( | ||
"Query executing stage {} and status {} : {:0.2f}s".format( | ||
current_stage.name, | ||
current_stage.status, | ||
time.time() - start_time, | ||
), | ||
) | ||
|
||
try: | ||
query_result = self.result(timeout=0.5) | ||
progress_bar.update(total) | ||
progress_bar.set_description( | ||
"Query complete after {:0.2f}s".format( | ||
time.time() - start_time | ||
), | ||
) | ||
break | ||
except concurrent.futures.TimeoutError: | ||
if current_stage.status == "COMPLETE": | ||
if i < total - 1: | ||
progress_bar.update(i + 1) | ||
i += 1 | ||
continue | ||
|
||
progress_bar.close() | ||
else: | ||
query_result = self.result() | ||
|
||
return query_result.to_arrow( | ||
progress_bar_type=progress_bar_type, | ||
bqstorage_client=bqstorage_client, | ||
create_bqstorage_client=create_bqstorage_client, | ||
|
@@ -3406,7 +3450,46 @@ def to_dataframe( | |
Raises: | ||
ValueError: If the `pandas` library cannot be imported. | ||
""" | ||
return self.result().to_dataframe( | ||
query_plan = self.query_plan | ||
if query_plan and progress_bar_type: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
start_time = time.time() | ||
i = 0 | ||
progress_bar = _get_progress_bar( | ||
progress_bar_type, | ||
"Query executing stage {}".format(query_plan[i].name), | ||
len(query_plan), | ||
"query", | ||
) | ||
while True: | ||
total = len(query_plan) | ||
self.reload() # Refreshes the state via a GET request. | ||
|
||
current_stage = query_plan[i] | ||
progress_bar.set_description( | ||
"Query executing stage {} and status {} : {:0.2f}s".format( | ||
current_stage.name, | ||
current_stage.status, | ||
time.time() - start_time, | ||
) | ||
) | ||
|
||
try: | ||
query_result = self.result(timeout=0.5) | ||
progress_bar.update(total) | ||
progress_bar.set_description( | ||
"Query complete after {:0.2f}s".format(time.time() - start_time) | ||
) | ||
break | ||
except concurrent.futures.TimeoutError: | ||
if current_stage.status == "COMPLETE": | ||
if i < total - 1: | ||
progress_bar.update(i + 1) | ||
i += 1 | ||
continue | ||
progress_bar.close() | ||
else: | ||
query_result = self.result() | ||
return query_result.to_dataframe( | ||
bqstorage_client=bqstorage_client, | ||
dtypes=dtypes, | ||
progress_bar_type=progress_bar_type, | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want to use these helpers from other modules, let's remove the (redundant because of private module) leading
_
.