Bigtable: create snippets.py for python docs.

bigtable/google/cloud/bigtable/client.py

@@ -203,6 +203,12 @@ def instance(self, instance_id, display_name=None,
                  instance_type=None, labels=None):
         """Factory to create a instance associated with this client.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_create_prod_instance]
+            :end-before: [END bigtable_create_prod_instance]
+
         :type instance_id: str
         :param instance_id: The ID of the instance.
 
@@ -241,6 +247,12 @@ def instance(self, instance_id, display_name=None,
     def list_instances(self):
         """List instances owned by the project.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_instances]
+            :end-before: [END bigtable_list_instances]
+
         :rtype: tuple
         :returns:
             (instances, failed_locations), where 'instances' is list of
@@ -256,6 +268,12 @@ def list_instances(self):
     def list_clusters(self):
         """List the clusters in the project.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_clusters]
+            :end-before: [END bigtable_list_clusters]
+
         :rtype: tuple
         :returns:
             (clusters, failed_locations), where 'clusters' is list of

bigtable/google/cloud/bigtable/cluster.py

@@ -172,7 +172,14 @@ def __ne__(self, other):
         return not self == other
 
     def reload(self):
-        """Reload the metadata for this cluster."""
+        """Reload the metadata for this cluster.
+
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_reload_cluster]
+            :end-before: [END bigtable_reload_cluster]
+        """
         cluster_pb = self._instance._client.instance_admin_client.get_cluster(
             self.name)
 
@@ -183,6 +190,12 @@ def reload(self):
     def exists(self):
         """Check whether the cluster already exists.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_check_cluster_exists]
+            :end-before: [END bigtable_check_cluster_exists]
+
         :rtype: bool
         :returns: True if the table exists, else False.
         """
@@ -197,6 +210,12 @@ def exists(self):
     def create(self):
         """Create this cluster.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_create_cluster]
+            :end-before: [END bigtable_create_cluster]
+
         .. note::
 
             Uses the ``project``, ``instance`` and ``cluster_id`` on the
@@ -223,6 +242,12 @@ def create(self):
     def update(self):
         """Update this cluster.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_update_cluster]
+            :end-before: [END bigtable_update_cluster]
+
         .. note::
 
             Updates the ``serve_nodes``. If you'd like to
@@ -260,6 +285,12 @@ def update(self):
     def delete(self):
         """Delete this cluster.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_delete_cluster]
+            :end-before: [END bigtable_delete_cluster]
+
         Marks a cluster and all of its tables for permanent deletion in 7 days.
 
         Immediately upon completion of the request:

bigtable/google/cloud/bigtable/instance.py

@@ -198,6 +198,12 @@ def reload(self):
     def exists(self):
         """Check whether the instance already exists.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_check_instance_exists]
+            :end-before: [END bigtable_check_instance_exists]
+
         :rtype: bool
         :returns: True if the table exists, else False.
         """
@@ -213,6 +219,12 @@ def create(self, location_id=None,
                default_storage_type=None, clusters=None):
         """Create this instance.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_create_prod_instance]
+            :end-before: [END bigtable_create_prod_instance]
+
         .. note::
 
             Uses the ``project`` and ``instance_id`` on the current
@@ -324,6 +336,12 @@ def update(self):
     def delete(self):
         """Delete this instance.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_delete_instance]
+            :end-before: [END bigtable_delete_instance]
+
         Marks an instance and all of its tables for permanent deletion
         in 7 days.
 
@@ -349,6 +367,12 @@ def cluster(self, cluster_id, location_id=None,
                 serve_nodes=None, default_storage_type=None):
         """Factory to create a cluster associated with this instance.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_create_cluster]
+            :end-before: [END bigtable_create_cluster]
+
         :type cluster_id: str
         :param cluster_id: The ID of the cluster.
 
@@ -385,6 +409,12 @@ def cluster(self, cluster_id, location_id=None,
     def list_clusters(self):
         """List the clusters in this instance.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_clusters]
+            :end-before: [END bigtable_list_clusters]
+
         :rtype: tuple
         :returns:
             (clusters, failed_locations), where 'clusters' is list of
@@ -400,6 +430,12 @@ def list_clusters(self):
     def table(self, table_id, app_profile_id=None):
         """Factory to create a table associated with this instance.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_create_table]
+            :end-before: [END bigtable_create_table]
+
         :type table_id: str
         :param table_id: The ID of the table.
 
@@ -414,6 +450,12 @@ def table(self, table_id, app_profile_id=None):
     def list_tables(self):
         """List the tables in this instance.
 
+        For example:
+
+        .. literalinclude:: snippets.py
+            :start-after: [START bigtable_list_tables]
+            :end-before: [END bigtable_list_tables]
+
         :rtype: list of :class:`Table <google.cloud.bigtable.table.Table>`
         :returns: The list of tables owned by the instance.
         :raises: :class:`ValueError <exceptions.ValueError>` if one of the

bigtable/nox.py

@@ -97,6 +97,35 @@ def system(session, py):
     # Run py.test against the system tests.
     session.run('py.test', '--quiet', 'tests/system.py', *session.posargs)
 
+#@nox.parametrize('py', ['2.7', '3.6'])
+
+@nox.session
+@nox.parametrize('py', ['2.7'])
+def snippets(session, py):
+    """Run the system test suite."""
+
+    # Sanity check: Only run system tests if the environment variable is set.
+    if not os.environ.get('GOOGLE_APPLICATION_CREDENTIALS', ''):
+        session.skip('Credentials must be set via environment variable.')
+
+    # Run the system tests against latest Python 2 and Python 3 only.
+    session.interpreter = 'python{}'.format(py)
+
+    # Set the virtualenv dirname.
+    session.virtualenv_dirname = 'snip-' + py
+
+    # Install all test dependencies, then install local packages in place.
+    session.install('mock', 'pytest')
+    for local_dep in LOCAL_DEPS:
+        session.install('-e', local_dep)
+    session.install('-e', os.path.join('..', 'bigtable'))
+    session.install('-e', '.')
+
+    # Run py.test against the system tests.
+    session.run('py.test', os.path.join('../docs/bigtable', \
+                                        'snippets.py'), *session.posargs)
+
+
 
 @nox.session
 def lint(session):