fixit: clean up appengine/standard_python3/warmup (GoogleCloudPlatform#10072)

bourgeoisor · web-flow · commit afd25353d64f · 2023-05-26T10:48:11.000-04:00
* fixit: clean up appengine/standard_python3/warmup

* fixit: remove stray whitespace
diff --git a/appengine/standard_python3/warmup/main.py b/appengine/standard_python3/warmup/main.py
@@ -20,21 +20,32 @@
 app = Flask(__name__)
 
 
-@app.route('/')
+@app.route("/")
 def main():
-    return 'Hello World!'
+    """Serves a predefined placeholder string.
 
+    Returns:
+        A predefined string saying 'Hello World!'
+    """
+    return "Hello World!"
 
-@app.route('/_ah/warmup')
+
+@app.route("/_ah/warmup")
 def warmup():
-    # Handle your warmup logic here, e.g. set up a database connection pool
-    return '', 200, {}
+    """Served stub function returning no content.
+
+    Your warmup logic can be implemented here (e.g. set up a database connection pool)
+
+    Returns:
+        An empty string, an HTTP code 200, and an empty object.
+    """
+    return "", 200, {}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # This is used when running locally only. When deploying to Google App
     # Engine, a webserver process such as Gunicorn will serve the app. This
     # can be configured by adding an `entrypoint` to app.yaml.
-    app.run(host='127.0.0.1', port=8080, debug=True)
+    app.run(host="127.0.0.1", port=8080, debug=True)
 # [END gae_python3_warmup_app]
 # [END gae_python38_warmup_app]
diff --git a/appengine/standard_python3/warmup/main_test.py b/appengine/standard_python3/warmup/main_test.py
@@ -19,14 +19,14 @@ def test_index():
     main.app.testing = True
     client = main.app.test_client()
 
-    r = client.get('/')
+    r = client.get("/")
     assert r.status_code == 200
-    assert 'Hello World' in r.data.decode('utf-8')
+    assert "Hello World" in r.data.decode("utf-8")
 
 
 def test_warmup():
     main.app.testing = True
     client = main.app.test_client()
 
-    r = client.get('/_ah/warmup')
+    r = client.get("/_ah/warmup")
     assert r.status_code == 200
