test edits, linting, etc.

Author: chalmerlowe

google/cloud/bigquery/client.py

@@ -866,10 +866,22 @@ def get_dataset(
                 How to retry the RPC.
             timeout (Optional[float]):
                 The number of seconds to wait for the underlying HTTP transport
-                before using ``retry``.
+                before using ``retry`
             dataset_view (Optional[google.cloud.bigquery.enums.DatasetView]):
-                Specifies the level of detail to return. Defaults to None, which
-                returns the default representation of the dataset.
+                # TODO clean up this docstring.
+                Specifies the level of detail to include for the dataset resource.
+                If provided and not None, this parameter controls which parts of the
+                dataset resource are returned.
+                Possible enum values:
+                - :attr:`~google.cloud.bigquery.enums.DatasetView.ACL`:
+                  Includes dataset metadata and the ACL.
+                - :attr:`~google.cloud.bigquery.enums.DatasetView.FULL`:
+                  Includes all dataset metadata, including the ACL and table metadata.
+                  This view is not supported by the `datasets.list` API method.
+                - :attr:`~google.cloud.bigquery.enums.DatasetView.METADATA`:
+                  Includes basic dataset metadata, but not the ACL.
+                - :attr:`~google.cloud.bigquery.enums.DatasetView.DATASET_VIEW_UNSPECIFIED`:
+                  The server will decide which view to use.
 
         Returns:
             google.cloud.bigquery.dataset.Dataset:
@@ -880,9 +892,12 @@ def get_dataset(
                 dataset_ref, default_project=self.project
             )
         path = dataset_ref.path
-        params: Dict[str, Any] = {}
-        if dataset_view is not None:
-            params["view"] = dataset_view.value
+
+        if dataset_view:
+            query_params = {"view": dataset_view.value}
+        else:
+            query_params = {}
+
         span_attributes = {"path": path}
         api_response = self._call_api(
             retry,
@@ -891,7 +906,7 @@ def get_dataset(
             method="GET",
             path=path,
             timeout=timeout,
-            query_params=params if params else None,
+            query_params=query_params,
         )
         return Dataset.from_api_repr(api_response)
 

google/cloud/bigquery/enums.py

@@ -81,6 +81,7 @@ class CreateDisposition(object):
 
 
 class DatasetView(enum.Enum):
+    # TODO add descriptions
     DATASET_VIEW_UNSPECIFIED = "DATASET_VIEW_UNSPECIFIED"
     METADATA = "METADATA"
     ACL = "ACL"

tests/unit/test_client.py

@@ -742,7 +742,7 @@ def test_get_dataset(self):
         final_attributes.assert_called_once_with({"path": "/%s" % path}, client, None)
 
         conn.api_request.assert_called_once_with(
-            method="GET", path="/%s" % path, timeout=7.5
+            method="GET", path="/%s" % path, timeout=7.5, query_params={}
         )
         self.assertEqual(dataset.dataset_id, self.DS_ID)
 
@@ -808,19 +808,7 @@ def test_get_dataset(self):
 
         self.assertEqual(dataset.dataset_id, self.DS_ID)
 
-    @pytest.mark.parametrize(
-        "dataset_view_arg,expected_param_value",
-        [
-            (None, None),
-            (DatasetView.DATASET_VIEW_UNSPECIFIED, "DATASET_VIEW_UNSPECIFIED"),
-            (DatasetView.METADATA, "METADATA"),
-            (DatasetView.ACL, "ACL"),
-            (DatasetView.FULL, "FULL"),
-        ],
-    )
-    def test_get_dataset_with_dataset_view(
-        self, dataset_view_arg, expected_param_value
-    ):
+    def test_get_dataset_with_dataset_view(self):
         path = "projects/%s/datasets/%s" % (self.PROJECT, self.DS_ID)
         creds = _make_credentials()
         http = object()
@@ -829,34 +817,47 @@ def test_get_dataset_with_dataset_view(
             "id": "%s:%s" % (self.PROJECT, self.DS_ID),
             "datasetReference": {"projectId": self.PROJECT, "datasetId": self.DS_ID},
         }
-        conn = client._connection = make_connection(resource)
         dataset_ref = DatasetReference(self.PROJECT, self.DS_ID)
 
-        dataset = client.get_dataset(dataset_ref, dataset_view=dataset_view_arg)
+        test_cases = [
+            (None, None),
+            (DatasetView.DATASET_VIEW_UNSPECIFIED, "DATASET_VIEW_UNSPECIFIED"),
+            (DatasetView.METADATA, "METADATA"),
+            (DatasetView.ACL, "ACL"),
+            (DatasetView.FULL, "FULL"),
+        ]
+
+        for dataset_view_arg, expected_param_value in test_cases:
+            with self.subTest(
+                dataset_view_arg=dataset_view_arg,
+                expected_param_value=expected_param_value,
+            ):
+                # Re-initialize the connection mock for each sub-test to reset side_effect
+                conn = client._connection = make_connection(resource)
 
-        self.assertEqual(dataset.dataset_id, self.DS_ID)
-        expected_query_params = {}
-        if expected_param_value is not None:
-            expected_query_params["view"] = expected_param_value
+                dataset = client.get_dataset(dataset_ref, dataset_view=dataset_view_arg)
 
-        conn.api_request.assert_called_once_with(
-            method="GET",
-            path="/%s" % path,
-            timeout=DEFAULT_TIMEOUT,
-            query_params=expected_query_params if expected_query_params else None,
-        )
+                self.assertEqual(dataset.dataset_id, self.DS_ID)
+
+                if expected_param_value:
+                    expected_query_params = {"view": expected_param_value}
+                else:
+                    expected_query_params = {}
 
-    @pytest.mark.parametrize(
-        "invalid_view_value",
-        [
+                conn.api_request.assert_called_once_with(
+                    method="GET",
+                    path="/%s" % path,
+                    timeout=DEFAULT_TIMEOUT,
+                    query_params=expected_query_params if expected_query_params else {},
+                )
+
+    def test_get_dataset_with_invalid_dataset_view(self):
+        invalid_view_values = [
             "INVALID_STRING",
             123,
             123.45,
             object(),
-        ],
-    )
-    def test_get_dataset_with_invalid_dataset_view(self, invalid_view_value):
-        path = "projects/%s/datasets/%s" % (self.PROJECT, self.DS_ID)
+        ]
         creds = _make_credentials()
         http = object()
         client = self._make_one(project=self.PROJECT, credentials=creds, _http=http)
@@ -867,8 +868,11 @@ def test_get_dataset_with_invalid_dataset_view(self, invalid_view_value):
         conn = client._connection = make_connection(resource)
         dataset_ref = DatasetReference(self.PROJECT, self.DS_ID)
 
-        with pytest.raises(AttributeError):
-            client.get_dataset(dataset_ref, dataset_view=invalid_view_value)
+        for invalid_view_value in invalid_view_values:
+            with self.subTest(invalid_view_value=invalid_view_value):
+                conn.api_request.reset_mock()  # Reset mock for each sub-test
+                with self.assertRaises(AttributeError):
+                    client.get_dataset(dataset_ref, dataset_view=invalid_view_value)
 
     def test_ensure_bqstorage_client_creating_new_instance(self):
         bigquery_storage = pytest.importorskip("google.cloud.bigquery_storage")

tests/unit/test_create_dataset.py

@@ -372,7 +372,12 @@ def test_create_dataset_alreadyexists_w_exists_ok_true(PROJECT, DS_ID, LOCATION)
                 },
                 timeout=DEFAULT_TIMEOUT,
             ),
-            mock.call(method="GET", path=get_path, timeout=DEFAULT_TIMEOUT),
+            mock.call(
+                method="GET",
+                path=get_path,
+                timeout=DEFAULT_TIMEOUT,
+                query_params={},
+            ),
         ]
     )