[![Open in Cloud Shell][shell_img]][shell_link]

[shell_img]: http://gstatic.com/cloudssh/images/open-btn.png

[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=appengine/flexible_ubuntu/storage/README.md

This sample demonstrates how to use [Google Cloud Storage](https://cloud.google.com/storage/) on [Google App Engine Flexible Environment](https://cloud.google.com/appengine).

Before you can run or deploy the sample, you will need to do the following:

1. Enable the Cloud Storage API in the [Google Developers Console](https://console.developers.google.com/project/_/apiui/apiview/storage/overview).

2. Create a Cloud Storage Bucket. You can do this with the [Google Cloud SDK](https://cloud.google.com/sdk) with the following command:

$ gsutil mb gs://[your-bucket-name]

3. Set the default ACL on your bucket to public read in order to serve files directly from Cloud Storage. You can do this with the [Google Cloud SDK](https://cloud.google.com/sdk) with the following command:

$ gsutil defacl set public-read gs://[your-bucket-name]

4. Update the environment variables in ``app.yaml``.

Refer to the [top-level README](../README.md) for instructions on running and deploying.

When running locally, you can use the [Google Cloud SDK](https://cloud.google.com/sdk) to provide authentication to use Google Cloud APIs:

$ gcloud init

Then set environment variables before starting your application:

$ export CLOUD_STORAGE_BUCKET=[your-bucket-name]

$ python main.py

runtime: python

env: flex

entrypoint: gunicorn -b :$PORT main:app

runtime_config:

# We also support 3.8, 3.9 and 3.10.

# See https://cloud.google.com/appengine/docs/flexible/python/runtime#interpreter for more info.

runtime_version: "3.11"

operating_system: "ubuntu22"

env_variables:

CLOUD_STORAGE_BUCKET: [your-bucket-name]

import logging

import os

from typing import Union

from flask import Flask, request

from google.cloud import storage

app = Flask(__name__)

CLOUD_STORAGE_BUCKET = os.environ["CLOUD_STORAGE_BUCKET"]

def index() -> str:

return """

def upload() -> str:

"""Process the uploaded file and upload it to Google Cloud Storage."""

uploaded_file = request.files.get("file")

if not uploaded_file:

return "No file uploaded.", 400

# Create a Cloud Storage client.

gcs = storage.Client()

# Get the bucket that the file will be uploaded to.

bucket = gcs.get_bucket(CLOUD_STORAGE_BUCKET)

# Create a new blob and upload the file's content.

blob = bucket.blob(uploaded_file.filename)

blob.upload_from_string(

uploaded_file.read(), content_type=uploaded_file.content_type

)

# Make the blob public. This is not necessary if the

# entire bucket is public.

# See https://cloud.google.com/storage/docs/access-control/making-data-public.

blob.make_public()

# The public URL can be used to directly access the uploaded file via HTTP.

return blob.public_url

def server_error(e: Union[Exception, int]) -> str:

logging.exception("An error occurred during a request.")

return (

"""

""".format(

e

),

500,

)

if __name__ == "__main__":

# This is used when running locally. Gunicorn is used to run the

# application on Google App Engine. See entrypoint in app.yaml.

app.run(host="127.0.0.1", port=8080, debug=True)

import io

import os

import uuid

import flask

import flask.testing

from google.cloud import storage

import pytest

import requests

import main

def client() -> flask.testing.FlaskClient:

main.app.testing = True

return main.app.test_client()

def test_index(client: flask.testing.FlaskClient) -> None:

r = client.get("/")

assert r.status_code == 200

def blob_name() -> str:

name = f"gae-flex-storage-{uuid.uuid4()}"

yield name

bucket = storage.Client().bucket(os.environ["CLOUD_STORAGE_BUCKET"])

blob = bucket.blob(name)

blob.delete()

def test_upload(client: flask.testing.FlaskClient, blob_name: str) -> None:

# Upload a simple file

file_content = b"This is some test content."

r = client.post("/upload", data={"file": (io.BytesIO(file_content), blob_name)})

assert r.status_code == 200

# The app should return the public cloud storage URL for the uploaded

# file. Download and verify it.

cloud_storage_url = r.data.decode("utf-8")

r = requests.get(cloud_storage_url)

assert r.text.encode("utf-8") == file_content

TEST_CONFIG_OVERRIDE = {

# You can opt out from the test for specific Python versions.

"ignored_versions": ["2.7", "3.6", "3.7", "3.8", "3.9", "3.10"],

# Old samples are opted out of enforcing Python type hints

# All new samples should feature them

"enforce_type_hints": True,

# An envvar key for determining the project id to use. Change it

# to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a

# build specific Cloud project. You can also use your own string

# to use your own Cloud project.

"gcloud_project_env": "GOOGLE_CLOUD_PROJECT",

# 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',

# If you need to use a specific version of pip,

# change pip_version_override to the string representation

# of the version number, for example, "20.2.4"

"pip_version_override": None,

# A dictionary you want to inject into your test. Don't put any

# secrets here. These values will override predefined values.

"envs": {

"CLOUD_STORAGE_BUCKET": "python-docs-samples-tests-public"

},

}

pytest==7.0.1

google-cloud-storage==2.1.0;

Flask==2.1.0;

werkzeug==2.1.2;

google-cloud-storage==2.1.0;

gunicorn==20.1.0;