show progress bar in %%bigquery magics

[tswast]

Is your feature request related to a problem? Please describe.

When running the %%bigquery magics, there is no indication of progress.

Describe the solution you'd like

Show a progress bar using tqdm or tqdm_notebook.

Describe alternatives you've considered

N/A

Additional context

tqdm_notebook is ideal, as it uses the ability to embed HTML for a nicer-looking progress bar, but this is not always available. tqdm should be the default, but perhaps overridable via the google.cloud.bigquery.magics.context settings.

[tswast]

This may be as simple as setting progress_bar_type="tqdm" here:

python-bigquery/google/cloud/bigquery/magics/magics.py

Line 692 in dc78edd

bqstorage_client=bqstorage_client

and here:

python-bigquery/google/cloud/bigquery/magics/magics.py

Line 695 in dc78edd

result = query_job.to_dataframe(bqstorage_client=bqstorage_client)

but ideally we would want the ability to change to tqdm_notebook when explicitly requested or maybe even if we can detect that we are in a supported environment

[tswast]

Follow-up to #343 which added the progress bar for waiting for the query to finish.

[HemangChothani]

• Can we use get_ipython().__class__ to detect terminal or any other notebooks and set the progress_bar_type accordingly?

• Can we include progress_bar_type parameter in to the magic_arguments and set default to 'tqdm'?

[tswast]

Can we include progress_bar_type parameter in to the magic_arguments and set default to 'tqdm'?

Let's start with this. Plus, let's add progress_bar_type to the global context object so that the default can be changed by the user.

Can we use get_ipython().class to detect terminal or any other notebooks and set the progress_bar_type accordingly?

Let's file a separate issue for that. I don't want to get too magic in our magics. :-)