GCSBucket

A storage bucket in Google Cloud Storage.

Like all Resources, this class configures itself across multiple Environments.

For more information see the official documentation.

Example Usage

1
import launchflow as lf
2

3
# Automatically creates / connects to a GCS Bucket in your GCP project
4
gcs = lf.gcp.GCSBucket("my-bucket")
5

6
# Quick utilities for reading and writing file contents
7
gcs.upload_from_string("file contents", "path/in/gcs/file.txt")
8

9
# You can also use the google-cloud-storage library directly
10
bucket = gcs.bucket()
11
bucket.blob("my-file").upload_from_filename("my-file")
content_copy

initialization

Create a new GCS Bucket resource.

Args:

• name (str): The name of the bucket. This must be globally unique.
• location (str): The location of the bucket. Defaults to "US".
• force_destroy (bool): If true, the bucket will be destroyed even if it's not empty. Defaults to False.
• uniform_bucket_level_access (bool): If true, enables uniform bucket-level access for the bucket. Defaults to False.

bucket

1
GCSBucket.bucket()
content_copy

Get the GCS bucket object returned by the google-cloud-storage library.

Returns:

• The GCS bucket object from the GCS client library.

upload_file

1
GCSBucket.upload_file(to_upload: Union[str, IO], bucket_path: str) -> None
content_copy

Uploads a file to the GCS bucket.

Args:

• to_upload (Union[str, IO]): The file to upload. This can be a string representing the path to the file, or a file-like object.
• bucket_path (str): The path to upload the file to in the bucket.

Example usage:

1
import launchflow as lf
2

3
bucket = lf.gcp.GCSBucket("my-bucket")
4
bucket.upload_file("my-file.txt", "my-file.txt")
5
bucket.upload_file(open("my-file.txt", "r"), "my-file.txt")
content_copy

upload_from_string

1
GCSBucket.upload_from_string(to_upload: str, bucket_path: str) -> None
content_copy

Uploads a string to the GCS bucket.

Args:

• to_upload (str): The string to upload.
• bucket_path (str): The path to upload the string to in the bucket.

Example usage:

1
import launchflow as lf
2

3
bucket = lf.gcp.GCSBucket("my-bucket")
4
bucket.upload_from_string("hello", "hello.txt")
content_copy

download_file

1
GCSBucket.download_file(bucket_path: str) -> bytes
content_copy

Downloads a file from the GCS bucket.

Args:

• bucket_path (str): The path to the file in the bucket.

Returns:

• The contents of the file as a bytes object.

Example usage:

1
import launchflow as lf
2

3
bucket = lf.gcp.GCSBucket("my-bucket")
4
with open("my-file.txt", "w") as f:
5
    f.write(bucket.download_file("my-file.txt"))
content_copy

BackendBucket

initialization

Create a new GCS Backend Bucket resource. Args:

• name (str): The name of the bucket. This must be globally unique.
• location (str): The location of the bucket. Defaults to "US".
• force_destroy (bool): If true, the bucket will be destroyed even if it's not empty. Defaults to False.
• custom_domain (Optional[str]): A custom domain to map to the bucket