Bigtable client snippets (googleapis#7020)

sangramql · sduskis · commit af3df9cc2c52 · 2019-01-04T15:15:45.000-05:00
* add conditional row snippets

* add snippets

* Add client snippets
diff --git a/bigtable/docs/snippets.py b/bigtable/docs/snippets.py
@@ -425,5 +425,50 @@ def test_bigtable_set_iam_policy_then_get_iam_policy():
     assert len(policy.bigtable_admins) > 0
 
 
+def test_bigtable_project_path():
+    import re
+    # [START bigtable_project_path]
+    from google.cloud.bigtable import Client
+
+    client = Client(admin=True)
+    project_path = client.project_path
+    # [END bigtable_project_path]
+
+    _project_path_re = re.compile(r'^projects/'
+                                  r'(?P<project_id>'
+                                  r'[_a-zA-Z0-9][-_.a-zA-Z0-9]*)$')
+    assert _project_path_re.match(project_path)
+
+
+def test_bigtable_table_data_client():
+    # [START bigtable_table_data_client]
+    from google.cloud.bigtable import Client
+
+    client = Client(admin=True)
+    table_data_client = client.table_data_client
+    # [END bigtable_table_data_client]
+    assert "BigtableClient" in str(table_data_client)
+
+
+def test_bigtable_table_admin_client():
+    # [START bigtable_table_admin_client]
+    from google.cloud.bigtable import Client
+
+    client = Client(admin=True)
+    table_admin_client = client.table_admin_client
+    # [END bigtable_table_admin_client]
+    assert "BigtableTableAdmin" in str(table_admin_client)
+
+
+def test_bigtable_instance_admin_client():
+    # [START bigtable_instance_admin_client]
+    from google.cloud.bigtable import Client
+
+    client = Client(admin=True)
+    instance_admin_client = client.instance_admin_client
+    # [END bigtable_instance_admin_client]
+    assert "BigtableInstanceAdmin" in str(instance_admin_client)
+
+
 if __name__ == "__main__":
     pytest.main()
diff --git a/bigtable/google/cloud/bigtable/client.py b/bigtable/google/cloud/bigtable/client.py
@@ -168,6 +168,12 @@ def project_path(self):
             This property will not change if ``project`` does not, but the
             return value is not cached.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_project_path]
+            :end-before: [END bigtable_project_path]
+
         The project name is of the form
 
             ``"projects/{project}"``
@@ -181,6 +187,12 @@ def project_path(self):
     def table_data_client(self):
         """Getter for the gRPC stub used for the Table Admin API.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_table_data_client]
+            :end-before: [END bigtable_table_data_client]
+
         :rtype: :class:`.bigtable_v2.BigtableClient`
         :returns: A BigtableClient object.
         """
@@ -194,6 +206,12 @@ def table_data_client(self):
     def table_admin_client(self):
         """Getter for the gRPC stub used for the Table Admin API.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_table_admin_client]
+            :end-before: [END bigtable_table_admin_client]
+
         :rtype: :class:`.bigtable_admin_pb2.BigtableTableAdmin`
         :returns: A BigtableTableAdmin instance.
         :raises: :class:`ValueError <exceptions.ValueError>` if the current
@@ -212,6 +230,12 @@ def table_admin_client(self):
     def instance_admin_client(self):
         """Getter for the gRPC stub used for the Table Admin API.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_instance_admin_client]
+            :end-before: [END bigtable_instance_admin_client]
+
         :rtype: :class:`.bigtable_admin_pb2.BigtableInstanceAdmin`
         :returns: A BigtableInstanceAdmin instance.
         :raises: :class:`ValueError <exceptions.ValueError>` if the current
