Adds ForeignTypeInfo test_from_api_repr

Author: chalmerlowe

google/cloud/bigquery/schema.py

@@ -501,6 +501,7 @@ def _to_schema_fields(schema):
         sequence is not a :class:`~google.cloud.bigquery.schema.SchemaField`
         instance or a compatible mapping representation of the field.
     """
+
     for field in schema:
         if not isinstance(field, (SchemaField, collections.abc.Mapping)):
             raise ValueError(
@@ -598,59 +599,59 @@ def to_api_repr(self) -> dict:
         return answer
 
 
-class TableSchema:
-    """Schema of a table
+# class TableSchema:
+#     """Schema of a table
 
-    Args:
-        fields (Optional[list]): Describes the fields in a table.
-        foreignTypeInfo (Optional[str]): Specifies metadata of the foreign data type
-            definition in field schema.
-    """
+#     Args:
+#         fields (Optional[list]): Describes the fields in a table.
+#         foreignTypeInfo (Optional[str]): Specifies metadata of the foreign data type
+#             definition in field schema.
+#     """
 
-    def __init__(
-        self, fields: Optional[list] = None, foreign_type_info: Optional[str] = None
-    ):
-        self._properties = {}
-        self.fields = fields
-        self.foreign_type_info = foreign_type_info
+#     def __init__(
+#         self, fields: Optional[list] = None, foreign_type_info: Optional[str] = None
+#     ):
+#         self._properties = {}
+#         self.fields = fields
+#         self.foreign_type_info = foreign_type_info
 
-    @property
-    def fields(self) -> Any:
-        """Describes the fields in a table."""
+#     @property
+#     def fields(self) -> Any:
+#         """Describes the fields in a table."""
 
-        return self._properties.get("fields")
+#         return self._properties.get("fields")
 
-    @fields.setter
-    def fields(self, value: list, dtype: str) -> str:
-        value = _isinstance_or_raise(value, list, none_allowed=True)
-        self._properties["fields"] = value
+#     @fields.setter
+#     def fields(self, value: list, dtype: str) -> str:
+#         value = _isinstance_or_raise(value, list, none_allowed=True)
+#         self._properties["fields"] = value
 
-    @property
-    def foreign_type_info(self) -> Any:
-        """Optional. Specifies metadata of the foreign data type definition in
-        field schema (TableFieldSchema.foreign_type_definition)."""
+#     @property
+#     def foreign_type_info(self) -> Any:
+#         """Optional. Specifies metadata of the foreign data type definition in
+#         field schema (TableFieldSchema.foreign_type_definition)."""
 
-        return self._properties.get("foreignTypeInfo")
+#         return self._properties.get("foreignTypeInfo")
 
-    @foreign_type_info.setter
-    def foreign_type_info(self, value: str, dtype: str) -> str:
-        if not isinstance(value, str):
-            raise ValueError(
-                f"Pass {value} as a '{repr(dtype)}'." f"Got {type(value)}."
-            )
-        self._properties["foreignTypeInfo"] = value
+#     @foreign_type_info.setter
+#     def foreign_type_info(self, value: str, dtype: str) -> str:
+#         if not isinstance(value, str):
+#             raise ValueError(
+#                 f"Pass {value} as a '{repr(dtype)}'." f"Got {type(value)}."
+#             )
+#         self._properties["foreignTypeInfo"] = value
 
-    def to_api_repr(self) -> dict:
-        """Build an API representation of this object.
+#     def to_api_repr(self) -> dict:
+#         """Build an API representation of this object.
 
-        Returns:
-            Dict[str, Any]:
-                A dictionary in the format used by the BigQuery API.
-        """
-        return copy.deepcopy(self._properties)
+#         Returns:
+#             Dict[str, Any]:
+#                 A dictionary in the format used by the BigQuery API.
+#         """
+#         return copy.deepcopy(self._properties)
 
-    def from_api_repr(self, resource):
-        return _from_api_repr(self, resource)
+#     def from_api_repr(self, resource):
+#         return _from_api_repr(self, resource)
 
 
 class ForeignTypeInfo:
@@ -686,9 +687,22 @@ def to_api_repr(self) -> dict:
                 A dictionary in the format used by the BigQuery API.
         """
         return copy.deepcopy(self._properties)
+    
+    @classmethod
+    def from_api_repr(cls, resource):
+        """Factory: constructs an instance of the class (cls)
+        given its API representation.
 
-    def from_api_repr(self, resource):
-        return _from_api_repr(self, resource)
+        Args:
+            resource (Dict[str, Any]):
+                API representation of the object to be instantiated.
+
+        Returns:
+            An instance of the class initialized with data from 'resource'.
+        """
+        config = cls()
+        config._properties = copy.deepcopy(resource)
+        return config
 
 
 class StorageDescriptor:

tests/unit/test_schema.py

@@ -19,7 +19,7 @@
     ForeignTypeInfo,
     StorageDescriptor,
     SerDeInfo,
-    TableSchema,
+    # TODO: delete this line...TableSchema,
 )
 
 import unittest
@@ -1159,6 +1159,26 @@ def test_to_api_repr(self, type_system, expected):
         result = self._make_one(type_system=type_system)
         assert result.to_api_repr() == expected
 
+    def test_from_api_repr(self):
+        """GIVEN an api representation of a ForeignTypeInfo object (i.e. resource)
+        WHEN converted into a ForeignTypeInfo object using from_api_repr() and
+        displayed as a dict
+        THEN it will have the same representation a ForeignTypeInfo object created
+        directly (via _make_one()) and displayed as a dict.
+        """
+        resource = {
+            "typeSystem": "TYPE_SYSTEM_UNSPECIFIED"
+        }
+
+        expected = self._make_one(
+            type_system="TYPE_SYSTEM_UNSPECIFIED"
+        )
+
+        klass = self._get_target_class()
+        result = klass.from_api_repr(resource)
+
+        assert result.to_api_repr() == expected.to_api_repr()
+
 
 class TestStorageDescriptor:
     """Tests for the StorageDescriptor class."""
@@ -1316,39 +1336,39 @@ def test_to_api_repr(self):
 
     # TODO: needs a from_api_repr() test.
 
-@pytest.fixture
-def _make_foreign_type_info():
-    return ForeignTypeInfo(
-        type_system="TODO_fake_type_system",
-    )
-
-
-class TestTableSchema:
-    @staticmethod
-    def _get_target_class():
-        return TableSchema
-
-    def _make_one(self, *args, **kwargs):
-        return self._get_target_class()(*args, **kwargs)
-
-    def test_ctor_valid_input(self, _make_foreign_type_info):
-        table_schema = self._make_one(
-            fields="TODO needs a fields object",
-            foreign_type_info=_make_foreign_type_info.to_api_repr(),
-        )
-        # Test default constructors
-        # Create expected TableSchema object
-        # * use target_class
-        # * use make_one
-        # Create result TableSchema object
-        # compare the two
-        assert False
-
-    def test_ctor_invalid_input(self):
-        assert False
-
-    def test_to_api_repr(self):
-        assert False
+# @pytest.fixture
+# def _make_foreign_type_info():
+#     return ForeignTypeInfo(
+#         type_system="TODO_fake_type_system",
+#     )
+
+
+# class TestTableSchema:
+#     @staticmethod
+#     def _get_target_class():
+#         return TableSchema
+
+#     def _make_one(self, *args, **kwargs):
+#         return self._get_target_class()(*args, **kwargs)
+
+#     def test_ctor_valid_input(self, _make_foreign_type_info):
+#         table_schema = self._make_one(
+#             fields="TODO needs a fields object",
+#             foreign_type_info=_make_foreign_type_info.to_api_repr(),
+#         )
+#         # Test default constructors
+#         # Create expected TableSchema object
+#         # * use target_class
+#         # * use make_one
+#         # Create result TableSchema object
+#         # compare the two
+#         assert False
+
+#     def test_ctor_invalid_input(self):
+#         assert False
+
+#     def test_to_api_repr(self):
+#         assert False
 
-    def test_from_api_repr(self):
-        assert False
+#     def test_from_api_repr(self):
+#         assert False

tests/unit/test_table.py

@@ -570,6 +570,26 @@ def test_ctor_w_schema(self):
 
         self.assertEqual(table.schema, [full_name, age])
 
+    def test_ctor_w_schema_klass(self):
+        from google.cloud.bigquery.schema import SchemaField
+        from google.cloud.bigquery.schema import Schema
+
+
+        dataset = DatasetReference(self.PROJECT, self.DS_ID)
+        table_ref = dataset.table(self.TABLE_NAME)
+        full_name = SchemaField("full_name", "STRING", mode="REQUIRED")
+        age = SchemaField("age", "INTEGER", mode="REQUIRED")
+        # ONLY CHANGE IN THE BODY OF THE TEST
+        schema = Schema(foreign_type_info="EXAMPLE FTF", fields=[full_name, age])
+
+        table = self._make_one(table_ref, schema=schema)
+        print(f"DINOSAUR: {schema}\n{dir(schema)}\n{type(schema)}\n{type(table.schema)}")
+        self.assertEqual(table.schema, [full_name, age])
+        # ADDITIONAL CHECK TEST
+        self.assertEqual(table.schema.foreign_type_info, "EXAMPLE FTF")
+
+
+
     def test_ctor_string(self):
         table = self._make_one("some-project.some_dset.some_tbl")
         self.assertEqual(table.project, "some-project")