samples: Add GCS fileio samples (#645)

* Add GCS file-like io samples

* now with pandas!

* change pandas version

* add to readme

* requests from andrew

* lint

* canonical command line args

* Update storage_fileio_pandas.py

* Update storage_fileio_write_read.py

Author: Aaron Gabriel Neyer

samples/README.md

@@ -86,6 +86,8 @@ for instructions on setting up credentials for applications.
 * [Enable Requester Pays](#enable-requester-pays)
 * [Enable Uniform Bucket Level Access](#enable-uniform-bucket-level-access)
 * [Enable Versioning](#enable-versioning)
+* [FileIO Write-Read] (#fileio-write-read)
+* [FileIO Pandas] (#fileio-pandas)
 * [Generate Encryption Key](#generate-encryption-key)
 * [Generate Signed Post Policy V4](#generate-signed-post-policy-v4)
 * [Generate Signed Url V2](#generate-signed-url-v2)
@@ -486,6 +488,22 @@ View the [source code](https://github.com/googleapis/python-storage/blob/main/sa
 
 `python storage_enable_versioning.py`
 
+-----
+### FileIO Write-Read
+[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-storage&page=editor&open_in_editor=samples/snippets/storage_fileio_write_read.py,samples/README.md)
+
+View the [source code](https://github.com/googleapis/python-storage/blob/main/samples/snippets/storage_fileio_write_read.py). To run this sample:
+
+
+`python storage_fileio_write_read.py <BUCKET_NAME> <BLOB_NAME>`
+-----
+### FileIO Pandas
+[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-storage&page=editor&open_in_editor=samples/snippets/storage_fileio_pandas.py,samples/README.md)
+
+View the [source code](https://github.com/googleapis/python-storage/blob/main/samples/snippets/storage_fileio_pandas.py). To run this sample:
+
+
+`python storage_fileio_pandas.py <BUCKET_NAME> <BLOB_NAME>`
 -----
 ### Generate Encryption Key
 [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/python-storage&page=editor&open_in_editor=samples/snippets/storage_generate_encryption_key.py,samples/README.md)

samples/snippets/fileio_test.py

@@ -0,0 +1,35 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import uuid
+
+import storage_fileio_pandas
+import storage_fileio_write_read
+
+
+def test_fileio_write_read(bucket, capsys):
+    blob_name = "test-fileio-{}".format(uuid.uuid4())
+    storage_fileio_write_read.write_read(bucket.name, blob_name)
+    out, _ = capsys.readouterr()
+    assert "Hello world" in out
+
+
+def test_fileio_pandas(bucket, capsys):
+    blob_name = "test-fileio-{}".format(uuid.uuid4())
+    storage_fileio_pandas.pandas_write(bucket.name, blob_name)
+    out, _ = capsys.readouterr()
+    assert f"Wrote csv with pandas with name {blob_name} from bucket {bucket.name}." in out
+    storage_fileio_pandas.pandas_read(bucket.name, blob_name)
+    out, _ = capsys.readouterr()
+    assert f"Read csv with pandas with name {blob_name} from bucket {bucket.name}." in out

samples/snippets/requirements.txt

@@ -1,2 +1,3 @@
 google-cloud-pubsub==2.8.0
 google-cloud-storage==1.42.3
+pandas==1.1.5

samples/snippets/storage_fileio_pandas.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python
+
+# Copyright 2021 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import sys
+
+"""Sample that creates and consumes a GCS blob using pandas with file-like IO
+"""
+
+# [START storage_fileio_pandas_write]
+
+
+def pandas_write(bucket_name, blob_name):
+    """Use pandas to interact with GCS using file-like IO"""
+    # The ID of your GCS bucket
+    # bucket_name = "your-bucket-name"
+
+    # The ID of your new GCS object
+    # blob_name = "storage-object-name"
+
+    from google.cloud import storage
+    import pandas as pd
+
+    storage_client = storage.Client()
+    bucket = storage_client.bucket(bucket_name)
+    blob = bucket.blob(blob_name)
+
+    with blob.open("w") as f:
+        df = pd.DataFrame({'a': [1, 2, 3], 'b': [4, 5, 6]})
+        f.write(df.to_csv(index=False))
+
+    print(f"Wrote csv with pandas with name {blob_name} from bucket {bucket.name}.")
+
+
+# [END storage_fileio_pandas_write]
+
+
+# [START storage_fileio_pandas_read]
+
+
+def pandas_read(bucket_name, blob_name):
+    """Use pandas to interact with GCS using file-like IO"""
+    # The ID of your GCS bucket
+    # bucket_name = "your-bucket-name"
+
+    # The ID of your new GCS object
+    # blob_name = "storage-object-name"
+
+    from google.cloud import storage
+    import pandas as pd
+
+    storage_client = storage.Client()
+    bucket = storage_client.bucket(bucket_name)
+    blob = bucket.blob(blob_name)
+
+    with blob.open("r") as f:
+        pd.read_csv(f)
+
+    print(f"Read csv with pandas with name {blob_name} from bucket {bucket.name}.")
+
+
+# [END storage_fileio_pandas_read]
+
+
+if __name__ == "__main__":
+    pandas_write(
+        bucket_name=sys.argv[1],
+        blob_name=sys.argv[2]
+    )
+
+    pandas_read(
+        bucket_name=sys.argv[1],
+        blob_name=sys.argv[2]
+    )

samples/snippets/storage_fileio_write_read.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+
+# Copyright 2021 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import sys
+
+"""Sample that writes and read a blob in GCS using file-like IO
+"""
+
+# [START storage_fileio_write_read]
+from google.cloud import storage
+
+
+def write_read(bucket_name, blob_name):
+    """Write and read a blob from GCS using file-like IO"""
+    # The ID of your GCS bucket
+    # bucket_name = "your-bucket-name"
+
+    # The ID of your new GCS object
+    # blob_name = "storage-object-name"
+
+    storage_client = storage.Client()
+    bucket = storage_client.bucket(bucket_name)
+    blob = bucket.blob(blob_name)
+
+    # Mode can be specified as wb/rb for bytes mode.
+    # See: https://docs.python.org/3/library/io.html
+    with blob.open("w") as f:
+        f.write("Hello world")
+
+    with blob.open("r") as f:
+        print(f.read())
+
+
+# [END storage_fileio_write_read]
+
+if __name__ == "__main__":
+    write_read(
+        bucket_name=sys.argv[1],
+        blob_name=sys.argv[2]
+    )