Adds ExternalCatalogTableOptions and tests

Author: chalmerlowe

google/cloud/bigquery/external_config.py

@@ -1109,7 +1109,7 @@ def __init__(
         self.storage_descriptor = storage_descriptor
 
     @property
-    def connection_id(self):
+    def connection_id(self) -> Optional[str]:
         """Optional. The connection specifying the credentials to be
         used to read external storage, such as Azure Blob, Cloud Storage, or
         S3. The connection is needed to read the open source table from
@@ -1125,7 +1125,7 @@ def connection_id(self, value: Optional[str]):
         self._properties["connectionId"] = value
 
     @property
-    def parameters(self) -> Any:
+    def parameters(self) -> Union[Dict[str, Any], None]:
         """Optional. A map of key value pairs defining the parameters and
         properties of the open source table. Corresponds with hive meta
         store table parameters. Maximum size of 4Mib.
@@ -1150,7 +1150,7 @@ def storage_descriptor(self) -> Any:
         return None
 
     @storage_descriptor.setter
-    def storage_descriptor(self, value):
+    def storage_descriptor(self, value: Union[schema.StorageDescriptor, dict, None]):
         value = _helpers._isinstance_or_raise(
             value, (schema.StorageDescriptor, dict), none_allowed=True
         )

google/cloud/bigquery/magics/magics.py

@@ -56,7 +56,7 @@
     bigquery_magics = None
 
 
-IPYTHON_USER_AGENT = "ipython-{}".format(IPython.__version__)
+IPYTHON_USER_AGENT = "ipython-{}".format(IPython.__version__)  # type: ignore
 
 
 class Context(object):

google/cloud/bigquery/table.py

@@ -1026,7 +1026,9 @@ def table_constraints(self) -> Optional["TableConstraints"]:
         return table_constraints
 
     @property
-    def external_catalog_table_options(self):
+    def external_catalog_table_options(
+        self,
+    ) -> Optional[external_config.ExternalCatalogTableOptions]:
         """Options defining open source compatible datasets living in the
         BigQuery catalog. Contains metadata of open source database, schema
         or namespace represented by the current dataset."""
@@ -1035,17 +1037,26 @@ def external_catalog_table_options(self):
             self._PROPERTY_TO_API_FIELD["external_catalog_table_options"]
         )
         if prop is not None:
-            prop = external_config.ExternalCatalogTableOptions.from_api_repr(prop)
-        return prop
+            return external_config.ExternalCatalogTableOptions.from_api_repr(prop)
+        return None
 
     @external_catalog_table_options.setter
-    def external_catalog_table_options(self, value):
+    def external_catalog_table_options(
+        self, value: Union[external_config.ExternalCatalogTableOptions, dict, None]
+    ):
         value = _helpers._isinstance_or_raise(
-            value, external_config.ExternalCatalogTableOptions, none_allowed=True
+            value,
+            (external_config.ExternalCatalogTableOptions, dict),
+            none_allowed=True,
         )
-        self._properties[
-            self._PROPERTY_TO_API_FIELD["external_catalog_table_options"]
-        ] = value.to_api_repr()
+        if isinstance(value, external_config.ExternalCatalogTableOptions):
+            self._properties[
+                self._PROPERTY_TO_API_FIELD["external_catalog_table_options"]
+            ] = value.to_api_repr()
+        else:
+            self._properties[
+                self._PROPERTY_TO_API_FIELD["external_catalog_table_options"]
+            ] = value
 
     @classmethod
     def from_string(cls, full_table_id: str) -> "Table":

tests/unit/test_table.py

@@ -30,6 +30,7 @@
 
 from google.cloud.bigquery import _versions_helpers
 from google.cloud.bigquery import exceptions
+from google.cloud.bigquery import external_config
 from google.cloud.bigquery.table import TableReference
 from google.cloud.bigquery.dataset import DatasetReference
 
@@ -5879,6 +5880,92 @@ def test_from_api_repr_only_foreign_keys_resource(self):
         self.assertIsNotNone(instance.foreign_keys)
 
 
+class TestExternalCatalogTableOptions:
+    PROJECT = "test-project"
+    DATASET_ID = "test_dataset"
+    TABLE_ID = "coffee_table"
+    DATASET = DatasetReference(PROJECT, DATASET_ID)
+    TABLEREF = DATASET.table(TABLE_ID)
+
+    @staticmethod
+    def _get_target_class(self):
+        from google.cloud.bigquery.table import Table
+
+        return Table
+
+    def _make_one(self, *args, **kw):
+        return self._get_target_class(self)(*args, **kw)
+
+    EXTERNALCATALOGTABLEOPTIONS = {
+        "connection_id": "connection123",
+        "parameters": {"key": "value"},
+        "storage_descriptor": {
+            "input_format": "testpath.to.OrcInputFormat",
+            "location_uri": "gs://test/path/",
+            "output_format": "testpath.to.OrcOutputFormat",
+            "serde_info": {
+                "serialization_library": "testpath.to.LazySimpleSerDe",
+                "name": "serde_lib_name",
+                "parameters": {"key": "value"},
+            },
+        },
+    }
+
+    def test_external_catalog_table_options_default_initialization(self):
+        table = self._make_one(self.TABLEREF)
+
+        assert table.external_catalog_table_options is None
+
+    def test_external_catalog_table_options_valid_inputs(self):
+        table = self._make_one(self.TABLEREF)
+
+        # supplied in api_repr format
+        table.external_catalog_table_options = self.EXTERNALCATALOGTABLEOPTIONS
+        result = table.external_catalog_table_options.to_api_repr()
+        expected = self.EXTERNALCATALOGTABLEOPTIONS
+        assert result == expected
+
+        # supplied in obj format
+        ecto = external_config.ExternalCatalogTableOptions.from_api_repr(
+            self.EXTERNALCATALOGTABLEOPTIONS
+        )
+        assert isinstance(ecto, external_config.ExternalCatalogTableOptions)
+
+        table.external_catalog_table_options = ecto
+        result = table.external_catalog_table_options.to_api_repr()
+        expected = self.EXTERNALCATALOGTABLEOPTIONS
+        assert result == expected
+
+    def test_external_catalog_table_options_invalid_input(self):
+        table = self._make_one(self.TABLEREF)
+
+        # invalid on the whole
+        with pytest.raises(TypeError) as e:
+            table.external_catalog_table_options = 123
+
+        # Looking for the first word from the string "Pass <variable> as..."
+        assert "Pass " in str(e.value)
+
+    def test_external_catalog_table_options_to_api_repr(self):
+        table = self._make_one(self.TABLEREF)
+
+        table.external_catalog_table_options = self.EXTERNALCATALOGTABLEOPTIONS
+        result = table.external_catalog_table_options.to_api_repr()
+        expected = self.EXTERNALCATALOGTABLEOPTIONS
+        assert result == expected
+
+    def test_external_catalog_table_options_from_api_repr(self):
+        table = self._make_one(self.TABLEREF)
+
+        table.external_catalog_table_options = self.EXTERNALCATALOGTABLEOPTIONS
+        ecto = external_config.ExternalCatalogTableOptions.from_api_repr(
+            self.EXTERNALCATALOGTABLEOPTIONS
+        )
+        result = ecto.to_api_repr()
+        expected = self.EXTERNALCATALOGTABLEOPTIONS
+        assert result == expected
+
+
 @pytest.mark.parametrize(
     "table_path",
     (