refactor and testing

Author: shollyman

google/cloud/bigquery/job/__init__.py

@@ -85,4 +85,5 @@
     "SourceFormat",
     "TransactionInfo",
     "WriteDisposition",
+    "IncrementalResultStats",
 ]

google/cloud/bigquery/job/query.py

@@ -197,6 +197,66 @@ def from_api_repr(cls, stats: Dict[str, str]) -> "DmlStats":
         return cls(*args)
 
 
+class IncrementalResultStats:
+    """IncrementalResultStats provides information about incremental query execution."""
+
+    def __init__(self):
+        self._properties = {}
+
+    @classmethod
+    def from_api_repr(cls, resource) -> "IncrementalResultStats":
+        """Factory: construct instance from the JSON repr.
+
+        Args:
+            resource(Dict[str: object]):
+                IncrementalResultStats representation returned from API.
+
+        Returns:
+            google.cloud.bigquery.job.IncrementalResultStats:
+                stats parsed from ``resource``.
+        """
+        entry = cls()
+        entry._properties = resource
+        return entry
+
+    @property
+    def disabled_reason(self):
+        """Optional[string]: Reason why incremental results were not
+        written by the query.
+        """
+        return _helpers._str_or_none(self._properties.get("disabledReason"))
+
+    @property
+    def result_set_last_replace_time(self):
+        """Optional[datetime]: The time at which the result table's contents
+        were completely replaced.  May be absent if no results have been written
+        or the query has completed."""
+        from google.cloud._helpers import _rfc3339_nanos_to_datetime
+
+        value = self._properties.get("resultSetLastReplaceTime")
+        if value:
+            try:
+                return _rfc3339_nanos_to_datetime(value)
+            except ValueError:
+                pass
+        return None
+
+    @property
+    def result_set_last_modify_time(self):
+        """Optional[datetime]: The time at which the result table's contents
+        were completely replaced.  May be absent if no results have been written
+        or the query has completed."""
+        from google.cloud._helpers import _rfc3339_nanos_to_datetime
+
+        value = self._properties.get("resultSetLastModifyTime")
+        if value:
+            try:
+                return _rfc3339_nanos_to_datetime(value)
+            except ValueError:
+                pass
+        return None
+
+
 class IndexUnusedReason(typing.NamedTuple):
     """Reason about why no search index was used in the search query (or sub-query).
 
@@ -1340,15 +1400,11 @@ def bi_engine_stats(self) -> Optional[BiEngineStats]:
             return BiEngineStats.from_api_repr(stats)
 
     @property
-    def incremental_result_stats(self):
-        """Optional[google.cloud.bigquery.job.IncrementalResultStats]: return information about incremental query results.
-
-        This feature is not generally available.
-        """
+    def incremental_result_stats(self) -> Optional[IncrementalResultStats]:
         stats = self._job_statistics().get("incrementalResultStats")
-        if stats is not None:
-            prop = IncrementalResultStats.from_api_repr(stats)
-        return None
+        if stats is None:
+            return None
+        return IncrementalResultStats.from_api_repr(stats)
 
     def _blocking_poll(self, timeout=None, **kwargs):
         self._done_timeout = timeout
@@ -2576,63 +2632,3 @@ def slot_millis(self):
         """Optional[int]: Cumulative slot-milliseconds consumed by
         this query."""
         return _helpers._int_or_none(self._properties.get("totalSlotMs"))
-
-
-class IncrementalResultStats(object):
-    """IncrementalResultStats provides information about incremental query execution."""
-
-    def __init__(self):
-        self._properties = {}
-
-    @classmethod
-    def from_api_repr(cls, resource):
-        """Factory: construct instance from the JSON repr.
-
-        Args:
-            resource(Dict[str: object]):
-                QueryTimelineSample representation returned from API.
-
-        Returns:
-            google.cloud.bigquery.TimelineEntry:
-                Timeline sample parsed from ``resource``.
-        """
-        entry = cls()
-        entry._properties = resource
-        return entry
-
-    @property
-    def disabled_reason(self):
-        """Optional[string]: Reason why incremental reasons were not
-        written by the query.
-        """
-        return _helpers._str_or_none(self._properties.get("disabledReason"))
-
-    @property
-    def result_set_last_replace_time(self):
-        """Optional[datetime]: The time at which the result table's contents
-        were completely replaced.  May be absent if no results have been written
-        or the query has completed."""
-        from google.cloud._helpers import _rfc3339_nanos_to_datetime
-
-        value = self._properties.get("resultSetLastReplaceTime")
-        if value:
-            try:
-                return _rfc3339_nanos_to_datetime(value)
-            except ValueError:
-                pass
-        return None
-
-    @property
-    def result_set_last_modify_time(self):
-        """Optional[datetime]: The time at which the result table's contents
-        were completely replaced.  May be absent if no results have been written
-        or the query has completed."""
-        from google.cloud._helpers import _rfc3339_nanos_to_datetime
-
-        value = self._properties.get("resultSetLastModifyTime")
-        if value:
-            try:
-                return _rfc3339_nanos_to_datetime(value)
-            except ValueError:
-                pass
-        return None

tests/unit/job/test_query.py

@@ -838,6 +838,23 @@ def test_search_stats(self):
         assert isinstance(job.search_stats, SearchStats)
         assert job.search_stats.mode == "INDEX_USAGE_MODE_UNSPECIFIED"
 
+    def test_incremental_result_stats(self):
+        from google.cloud.bigquery.job.query import IncrementalResultStats
+
+        client = _make_client(project=self.PROJECT)
+        job = self._make_one(self.JOB_ID, self.QUERY, client)
+        assert job.incremental_result_stats is None
+
+        statistics = job._properties["statistics"] = {}
+        assert job.incremental_result_stats is None
+
+        query_stats = statistics["query"] = {}
+        assert job.incremental_result_stats is None
+
+        query_stats["incrementalResultStats"] = {"disabledReason": "BAZ"}
+        assert isinstance(job.incremental_result_stats, IncrementalResultStats)
+        assert job.incremental_result_stats.disabled_reason == "BAZ"
+
     def test_reload_query_results_uses_transport_timeout(self):
         conn = make_connection({})
         client = _make_client(self.PROJECT, connection=conn)