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

fix: use REST API in cell magic when requested #892

Merged
merged 4 commits into from
Aug 25, 2021
Merged

fix: use REST API in cell magic when requested #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bdef180
fix: use REST API in cell magic when requested
plamut Aug 23, 2021
a5b5b4c
Always set create_bqstorage_client to False
plamut Aug 24, 2021
4bc9c84
Merge branch 'master' into iss-876
tswast Aug 25, 2021
9309760
Merge branch 'master' into iss-876
tswast Aug 25, 2021
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
12 changes: 9 additions & 3 deletions google/cloud/bigquery/magics/magics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,9 @@ def _cell_magic(line, query):
_handle_error(ex, args.destination_var)
return

result = rows.to_dataframe(bqstorage_client=bqstorage_client)
result = rows.to_dataframe(
bqstorage_client=bqstorage_client, create_bqstorage_client=False,
)
if args.destination_var:
IPython.get_ipython().push({args.destination_var: result})
return
Expand Down Expand Up @@ -728,11 +730,15 @@ def _cell_magic(line, query):

if max_results:
result = query_job.result(max_results=max_results).to_dataframe(
bqstorage_client=bqstorage_client, progress_bar_type=progress_bar
bqstorage_client=None,
create_bqstorage_client=False,
progress_bar_type=progress_bar,
)
else:
result = query_job.to_dataframe(
bqstorage_client=bqstorage_client, progress_bar_type=progress_bar
bqstorage_client=bqstorage_client,
create_bqstorage_client=False,
progress_bar_type=progress_bar,
)

if args.destination_var:
Expand Down
21 changes: 16 additions & 5 deletions tests/unit/test_magics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,9 @@ def warning_match(warning):
assert client_info.user_agent == "ipython-" + IPython.__version__

query_job_mock.to_dataframe.assert_called_once_with(
bqstorage_client=bqstorage_instance_mock, progress_bar_type="tqdm"
bqstorage_client=bqstorage_instance_mock,
create_bqstorage_client=mock.ANY,
progress_bar_type="tqdm",
)

assert isinstance(return_value, pandas.DataFrame)
Expand Down Expand Up @@ -703,7 +705,9 @@ def test_bigquery_magic_with_rest_client_requested(monkeypatch):

bqstorage_mock.assert_not_called()
query_job_mock.to_dataframe.assert_called_once_with(
bqstorage_client=None, progress_bar_type="tqdm"
bqstorage_client=None,
create_bqstorage_client=False,
progress_bar_type="tqdm",
)

assert isinstance(return_value, pandas.DataFrame)
Expand Down Expand Up @@ -757,7 +761,12 @@ def test_bigquery_magic_w_max_results_valid_calls_queryjob_result():
client_query_mock.return_value = query_job_mock
ip.run_cell_magic("bigquery", "--max_results=5", sql)

query_job_mock.result.assert_called_with(max_results=5)
query_job_mock.result.assert_called_with(max_results=5)
query_job_mock.result.return_value.to_dataframe.assert_called_once_with(
bqstorage_client=None,
create_bqstorage_client=False,
progress_bar_type=mock.ANY,
)


@pytest.mark.usefixtures("ipython_interactive")
Expand Down Expand Up @@ -929,7 +938,7 @@ def test_bigquery_magic_w_table_id_and_bqstorage_client():

ip.run_cell_magic("bigquery", "--max_results=5", table_id)
row_iterator_mock.to_dataframe.assert_called_once_with(
bqstorage_client=bqstorage_instance_mock
bqstorage_client=bqstorage_instance_mock, create_bqstorage_client=mock.ANY,
)


Expand Down Expand Up @@ -1246,7 +1255,9 @@ def test_bigquery_magic_w_progress_bar_type_w_context_setter(monkeypatch):

bqstorage_mock.assert_not_called()
query_job_mock.to_dataframe.assert_called_once_with(
bqstorage_client=None, progress_bar_type=magics.context.progress_bar_type
bqstorage_client=None,
create_bqstorage_client=False,
progress_bar_type=magics.context.progress_bar_type,
)

assert isinstance(return_value, pandas.DataFrame)
Expand Down