How to upload a file to Google Cloud Storage on Python 3

Google Cloud Storage is a scalable, fully-managed object storage service provided by Google Cloud Platform (GCP). It allows you to store and retrieve any amount of data securely, making it a reasonable choice for storing various types of files, such as images, videos, backups, and more. With Google Cloud Storage, you can create buckets (containers) to organize and manage your objects (files) and define access control and permissions for different users.

from google.cloud import storage
def upload_to_gcs(bucket_name, source_file_path, destination_blob_name, credentials_file):
    # Initialize the Google Cloud Storage client with the credentials
    storage_client = storage.Client.from_service_account_json(credentials_file)
    # Get the target bucket
    bucket = storage_client.bucket(bucket_name)
    # Upload the file to the bucket
    blob = bucket.blob(destination_blob_name)
    blob.upload_from_filename(source_file_path)
    print(f"File {source_file_path} uploaded to gs://{bucket_name}/{destination_blob_name}")
if __name__ == "__main__":
    # Replace the following variables with your specific values
    BUCKET_NAME = "your-bucket-name"
    SOURCE_FILE_PATH = "path/to/your/local/file.txt"
    DESTINATION_BLOB_NAME = "uploaded-file.txt"
    CREDENTIALS_FILE = "path/to/your/credentials.json"
    upload_to_gcs(BUCKET_NAME, SOURCE_FILE_PATH, DESTINATION_BLOB_NAME, CREDENTIALS_FILE)

Note:
BUCKET_NAME: Replace your-bucket-name with the name of the bucket you created on Google Cloud Storage. The bucket name must be globally unique across all of Google Cloud Storage, so choose a name that reflects the purpose of the bucket and is not likely to be used by others.
SOURCE_FILE_PATH: Replace path/to/your/local/file.txt with the local file path of the file you want to upload to Google Cloud Storage. This should be the absolute or relative path to the file on your local machine that you want to store in the cloud.
DESTINATION_BLOB_NAME: Replace uploaded-file.txt with the desired name of the file that will be shown in the bucket after the upload. When you upload the file, it will be stored in the bucket with this specified name.
CREDENTIALS_FILE: Replace path/to/your/credentials.json with the file path of the JSON credentials file you downloaded when creating the service account. This JSON file contains the necessary authentication information for the service account, allowing your Python script to interact with Google Cloud Storage securely.

Code explanation

Line 1: Here, we import the storage module from the google.cloud package. This module provides the necessary functionality to interact with Google Cloud Storage.
Line 3–12: In this section, we define a function named upload_to_gcs that takes four parameters: bucket_name, source_file_path, destination_blob_name, and credentials_file. This function will be responsible for uploading a file to Google Cloud Storage.
Line 5: In this part, we create a new storage.Client instance called storage_client by using the from_service_account_json method provided by the Client class. We pass the credentials_file parameter to this method to authenticate the client with the provided service account credentials.
Line 8: Using the initialized storage_client, we retrieve the specified bucket by calling the bucket method with the bucket_name parameter. This step allows us to interact with the bucket and its objects.
Line 10–12: In this section, we create a new blob (object) within the target bucket with the specified destination_blob_name. The blob.upload_from_filename method is used to upload the file from the local source_file_path to the blob in the bucket.
Line 14: After the file is successfully uploaded, we print a message to indicate the success and display the URL of the uploaded object in the Google Cloud Storage bucket.
Line 16–23: In this part, we have the main code execution block. We define the specific values for BUCKET_NAME, SOURCE_FILE_PATH, DESTINATION_BLOB_NAME, and CREDENTIALS_FILE, and then call the upload_to_gcs function to upload the file to Google Cloud Storage using the provided credentials and configurations.

How to upload a file to Google Cloud Storage on Python 3

Upload a file to Google Cloud Storage

Code explanation