Skip to content

Commit 002fbdb

Browse files
committed
Updates docstrings, adds Here There Be Dragons
1 parent 32cd996 commit 002fbdb

File tree

1 file changed

+17
-1
lines changed
  • google/cloud/bigquery_v2/services/centralized_service

1 file changed

+17
-1
lines changed

google/cloud/bigquery_v2/services/centralized_service/client.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ def __init__(
8989
# --- HELPER METHODS ---
9090
def _parse_dataset_path(self, dataset_path: str) -> Tuple[Optional[str], str]:
9191
"""
92-
Helper to parse project and dataset from a string identifier.
92+
Helper to parse project_id and/or dataset_id from a string identifier.
9393
9494
Args:
9595
dataset_path: A string in the format 'project_id.dataset_id' or
@@ -104,6 +104,15 @@ def _parse_dataset_path(self, dataset_path: str) -> Tuple[Optional[str], str]:
104104
return self.project, dataset_path
105105

106106
def _parse_dataset_id_to_dict(self, dataset_id: DatasetIdentifier) -> dict:
107+
"""
108+
Helper to create a request dictionary from a project_id and dataset_id.
109+
110+
Args:
111+
dataset_id: A string or DatasetReference.
112+
113+
Returns:
114+
A dict of {"project_id": project_id, "dataset_id": dataset_id_str }.
115+
"""
107116
if isinstance(dataset_id, str):
108117
project_id, dataset_id_str = self._parse_dataset_path(dataset_id)
109118
return {"project_id": project_id, "dataset_id": dataset_id_str}
@@ -222,6 +231,13 @@ def list_datasets(
222231
metadata=metadata,
223232
)
224233

234+
# ============================================================================
235+
# TODO: HERE THERE BE DRAGONS. Once the above changes have been approved the
236+
# methods below this comment will be updated to look and function similar
237+
# to the above.
238+
# NOT YET READY FOR REVIEW.
239+
# ============================================================================
240+
225241
def list_jobs(
226242
self,
227243
request: Optional[Union[job.ListJobsRequest, dict]] = None,

0 commit comments

Comments
 (0)