chore(gae): fix region tags from standard: mailjet mail and flask folders (#13106)

eapl-gemugami · web-flow · commit 47d5b15b3877 · 2025-01-30T12:49:20.000-06:00
* chore(gae): rename and delete region tags in standard/mailjet/main.py

* chore(gae): add requirements.txt and requirements-test.txt

* chore(gae): rename region tags in standard/mail/handle_incoming_email.py

* chore(gae): rename region tags in appengine/standard/mail/handle_bounced_email.py

* chore(gae): rename region tags in appengine/standard/mail/header.py

* chore(gae): rename region tags in appengine/standard/mail/send_mail.py

* chore(gae): rename region tags in appengine/standard/mail/send_message.py

* chore(gae): rename region tags in appengine/standard/mail/user_signup.py

* chore(gae): add requirements.txt and requirements-test.txt

* chore(gae): rename region tag 'app' from standard/flask/hello_world/main.py
diff --git a/appengine/standard/flask/hello_world/main.py b/appengine/standard/flask/hello_world/main.py
@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# [START app]
 import logging
 
 from flask import Flask
@@ -31,6 +30,3 @@ def server_error(e):
     # Log the error and stacktrace.
     logging.exception("An error occurred during a request.")
     return "An internal error occurred.", 500
-
-
-# [END app]
diff --git a/appengine/standard/flask/hello_world/requirements-test.txt b/appengine/standard/flask/hello_world/requirements-test.txt
@@ -0,0 +1,6 @@
+# pin pytest to 4.6.11 for Python2.
+pytest==4.6.11; python_version < '3.0'
+
+# pytest==8.3.4 and six==1.17.0 for Python3.
+pytest==8.3.4; python_version >= '3.0'
+six==1.17.0
diff --git a/appengine/standard/flask/hello_world/requirements.txt b/appengine/standard/flask/hello_world/requirements.txt
@@ -0,0 +1 @@
+
diff --git a/appengine/standard/mail/handle_bounced_email.py b/appengine/standard/mail/handle_bounced_email.py
@@ -18,15 +18,13 @@
 import webapp2
 
 
-# [START bounce_handler]
+# [START gae_mail_bounce_handler]
 class LogBounceHandler(BounceNotificationHandler):
     def receive(self, bounce_message):
         logging.info("Received bounce post ... [%s]", self.request)
         logging.info("Bounce original: %s", bounce_message.original)
         logging.info("Bounce notification: %s", bounce_message.notification)
-
-
-# [END bounce_handler]
+# [END gae_mail_bounce_handler]
 
 
 app = webapp2.WSGIApplication([LogBounceHandler.mapping()], debug=True)
diff --git a/appengine/standard/mail/handle_incoming_email.py b/appengine/standard/mail/handle_incoming_email.py
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# [START log_sender_handler]
+# [START gae_mail_log_sender_handler]
 import logging
 
 from google.appengine.ext.webapp.mail_handlers import InboundMailHandler
@@ -22,21 +22,21 @@
 class LogSenderHandler(InboundMailHandler):
     def receive(self, mail_message):
         logging.info("Received a message from: " + mail_message.sender)
-        # [END log_sender_handler]
-        # [START bodies]
+        # [END gae_mail_log_sender_handler]
+        # [START gae_mail_log_sender_handler_bodies]
         plaintext_bodies = mail_message.bodies("text/plain")
         html_bodies = mail_message.bodies("text/html")
 
         for content_type, body in html_bodies:
             decoded_html = body.decode()
-            # ...
-            # [END bodies]
             logging.info("Html body of length %d.", len(decoded_html))
         for content_type, body in plaintext_bodies:
             plaintext = body.decode()
             logging.info("Plain text body of length %d.", len(plaintext))
+            # ...
+            # [END gae_mail_log_sender_handler_bodies]
 
 
-# [START app]
+# [START gae_mail_log_sender_handler_app]
 app = webapp2.WSGIApplication([LogSenderHandler.mapping()], debug=True)
-# [END app]
+# [END gae_mail_log_sender_handler_app]
diff --git a/appengine/standard/mail/header.py b/appengine/standard/mail/header.py
@@ -20,7 +20,7 @@
 
 
 def send_example_mail(sender_address, email_thread_id):
-    # [START send_mail]
+    # [START gae_mail_header_send_mail]
     mail.send_mail(
         sender=sender_address,
         to="Albert Johnson <Albert.Johnson@example.com>",
@@ -32,7 +32,7 @@ def send_example_mail(sender_address, email_thread_id):
 """,
         headers={"References": email_thread_id},
     )
-    # [END send_mail]
+    # [END gae_mail_header_send_mail]
 
 
 class SendMailHandler(webapp2.RequestHandler):
diff --git a/appengine/standard/mail/requirements-test.txt b/appengine/standard/mail/requirements-test.txt
@@ -0,0 +1,6 @@
+# pin pytest to 4.6.11 for Python2.
+pytest==4.6.11; python_version < '3.0'
+
+# pytest==8.3.4 and six==1.17.0 for Python3.
+pytest==8.3.4; python_version >= '3.0'
+six==1.17.0
diff --git a/appengine/standard/mail/requirements.txt b/appengine/standard/mail/requirements.txt
@@ -0,0 +1 @@
+
diff --git a/appengine/standard/mail/send_mail.py b/appengine/standard/mail/send_mail.py
@@ -18,7 +18,7 @@
 
 
 def send_approved_mail(sender_address):
-    # [START send_mail]
+    # [START gae_mail_send_approved_mail]
     mail.send_mail(
         sender=sender_address,
         to="Albert Johnson <Albert.Johnson@example.com>",
@@ -34,7 +34,7 @@ def send_approved_mail(sender_address):
 The example.com Team
 """,
     )
-    # [END send_mail]
+    # [END gae_mail_send_approved_mail]
 
 
 class SendMailHandler(webapp2.RequestHandler):
diff --git a/appengine/standard/mail/send_message.py b/appengine/standard/mail/send_message.py
@@ -18,7 +18,7 @@
 
 
 def send_approved_mail(sender_address):
-    # [START send_message]
+    # [START gae_mail_send_approved_message]
     message = mail.EmailMessage(
         sender=sender_address, subject="Your account has been approved"
     )
@@ -35,7 +35,7 @@ def send_approved_mail(sender_address):
 The example.com Team
 """
     message.send()
-    # [END send_message]
+    # [END gae_mail_send_approved_message]
 
 
 class SendMessageHandler(webapp2.RequestHandler):
diff --git a/appengine/standard/mail/user_signup.py b/appengine/standard/mail/user_signup.py
@@ -23,7 +23,7 @@
 import webapp2
 
 
-# [START send-confirm-email]
+# [START gae_mail_send_confirm_email]
 class UserSignupHandler(webapp2.RequestHandler):
     """Serves the email address sign up form."""
 
@@ -46,7 +46,7 @@ def post(self):
                 confirmation_url
             )
             mail.send_mail(sender_address, user_address, subject, body)
-            # [END send-confirm-email]
+            # [END gae_mail_send_confirm_email]
             self.response.content_type = "text/plain"
             self.response.write("An email has been sent to {}.".format(user_address))
 
diff --git a/appengine/standard/mailjet/main.py b/appengine/standard/mailjet/main.py
@@ -12,13 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# [START app]
+# [START gae_mailjet_app]
 import logging
 import os
 
 from flask import Flask, render_template, request
 
-# [START config]
 import mailjet_rest
 import requests_toolbelt.adapters.appengine
 
@@ -29,12 +28,11 @@
 MAILJET_API_KEY = os.environ["MAILJET_API_KEY"]
 MAILJET_API_SECRET = os.environ["MAILJET_API_SECRET"]
 MAILJET_SENDER = os.environ["MAILJET_SENDER"]
-# [END config]
 
 app = Flask(__name__)
 
 
-# [START send_message]
+# [START gae_mailjet_send_message]
 def send_message(to):
     client = mailjet_rest.Client(
         auth=(MAILJET_API_KEY, MAILJET_API_SECRET), version="v3.1"
@@ -58,9 +56,7 @@ def send_message(to):
     result = client.send.create(data=data)
 
     return result.json()
-
-
-# [END send_message]
+# [END gae_mailjet_send_message]
 
 
 @app.route("/")
@@ -89,6 +85,4 @@ def server_error(e):
         ),
         500,
     )
-
-
-# [END app]
+# [END gae_mailjet_app]
