chore: include bigquery-magics version number in the user agent (#45)

* chore: include bigquery-magics version number in the user agent

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Import version from bigquery_magics.version package to avoid circular
dependency.

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: sycai

packages/bigquery-magics/bigquery_magics/bigquery.py

@@ -104,13 +104,14 @@
 import bigquery_magics._versions_helpers
 import bigquery_magics.config
 import bigquery_magics.line_arg_parser.exceptions
+import bigquery_magics.version
 
 try:
     from google.cloud import bigquery_storage  # type: ignore
 except ImportError:
     bigquery_storage = None
 
-IPYTHON_USER_AGENT = "ipython-{}".format(IPython.__version__)
+USER_AGENT = f"ipython-{IPython.__version__} bigquery-magics/{bigquery_magics.version.__version__}"
 context = bigquery_magics.config.context
 
 
@@ -418,7 +419,7 @@ def _cell_magic(line, query):
         project=project,
         credentials=context.credentials,
         default_query_job_config=context.default_query_job_config,
-        client_info=client_info.ClientInfo(user_agent=IPYTHON_USER_AGENT),
+        client_info=client_info.ClientInfo(user_agent=USER_AGENT),
         client_options=bigquery_client_options,
         location=location,
     )
@@ -633,7 +634,7 @@ def _make_bqstorage_client(client, use_bqstorage_api, client_options):
 
     return client._ensure_bqstorage_client(
         client_options=client_options,
-        client_info=gapic_client_info.ClientInfo(user_agent=IPYTHON_USER_AGENT),
+        client_info=gapic_client_info.ClientInfo(user_agent=USER_AGENT),
     )
 
 

packages/bigquery-magics/tests/unit/test_bigquery.py

@@ -474,7 +474,10 @@ def test_bigquery_magic_default_connection_user_agent():
 
     client_info_arg = conn.call_args[1].get("client_info")
     assert client_info_arg is not None
-    assert client_info_arg.user_agent == "ipython-" + IPython.__version__
+    assert (
+        client_info_arg.user_agent
+        == f"ipython-{IPython.__version__} bigquery-magics/{bigquery_magics.__version__}"
+    )
 
 
 @pytest.mark.usefixtures("ipython_interactive")
@@ -615,7 +618,10 @@ def warning_match(warning):
     assert kwargs.get("credentials") is mock_credentials
     client_info = kwargs.get("client_info")
     assert client_info is not None
-    assert client_info.user_agent == "ipython-" + IPython.__version__
+    assert (
+        client_info.user_agent
+        == f"ipython-{IPython.__version__} bigquery-magics/{bigquery_magics.__version__}"
+    )
 
     query_job_mock.to_dataframe.assert_called_once_with(
         bqstorage_client=bqstorage_instance_mock,