Switch from black to yapf + postprocessing (#1110)

* Format with black

* Switch from black to yapf + postprocessing

* Reformat samples

* Reformat FCM sample

Author: kevinthecheung

.github/workflows/test_python.yml

@@ -45,4 +45,4 @@ jobs:
         run: pip install -r requirements.txt
       - name: Lint
         working-directory: ./Python
-        run: black . --exclude=venv --check --diff
+        run: python pyfmt.py --check_only --exclude "**/venv/**/*.py" **/*.py

Python/alerts-to-discord/functions/main.py

@@ -16,22 +16,16 @@
 
 # [START v2import]
 from firebase_functions import params
-from firebase_functions.alerts import (
-    app_distribution_fn,
-    crashlytics_fn,
-    performance_fn,
-)
-
+from firebase_functions.alerts import app_distribution_fn, crashlytics_fn, performance_fn
 # [END v2import]
 
 import requests
 
 DISCORD_WEBHOOK_URL = params.SecretParam("DISCORD_WEBHOOK_URL")
 
 
-def post_message_to_discord(
-    bot_name: str, message_body: str, webhook_url: str
-) -> requests.Response:
+def post_message_to_discord(bot_name: str, message_body: str,
+                            webhook_url: str) -> requests.Response:
     """Posts a message to Discord with Discord's Webhook API.
 
     Params:
@@ -42,28 +36,24 @@ def post_message_to_discord(
         raise EnvironmentError(
             "No webhook URL found. Set the Discord Webhook URL before deploying. "
             "Learn more about Discord webhooks here: "
-            "https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks"
-        )
+            "https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks")
 
     return requests.post(
         url=webhook_url,
         json={
             # Here's what the Discord API supports in the payload:
             # https://discord.com/developers/docs/resources/webhook#execute-webhook-jsonform-params
             "username": bot_name,
-            "content": message_body,
-        },
-    )
+            "content": message_body
+        })
 
 
 # [START v2Alerts]
 # [START v2CrashlyticsAlertTrigger]
 @crashlytics_fn.on_new_fatal_issue_published(secrets=["DISCORD_WEBHOOK_URL"])
-def post_fatal_issue_to_discord(
-    event: crashlytics_fn.CrashlyticsNewFatalIssueEvent,
-) -> None:
+def post_fatal_issue_to_discord(event: crashlytics_fn.CrashlyticsNewFatalIssueEvent) -> None:
     """Publishes a message to Discord whenever a new Crashlytics fatal issue occurs."""
-    # [END v2CrashlyticsAlertTrigger]
+# [END v2CrashlyticsAlertTrigger]
     # [START v2CrashlyticsEventPayload]
     # Construct a helpful message to send to Discord.
     app_id = event.app_id
@@ -81,33 +71,22 @@ def post_fatal_issue_to_discord(
 
     try:
         # [START v2SendToDiscord]
-        response = post_message_to_discord(
-            "Crashlytics Bot", message, DISCORD_WEBHOOK_URL.value
-        )
+        response = post_message_to_discord("Crashlytics Bot", message, DISCORD_WEBHOOK_URL.value)
         if response.ok:
-            print(
-                f"Posted fatal Crashlytics alert {issue.id} for {app_id} to Discord."
-            )
+            print(f"Posted fatal Crashlytics alert {issue.id} for {app_id} to Discord.")
             pprint.pp(event.data.payload)
         else:
             response.raise_for_status()
         # [END v2SendToDiscord]
     except (EnvironmentError, requests.HTTPError) as error:
-        print(
-            f"Unable to post fatal Crashlytics alert {issue.id} for {app_id} to Discord.",
-            error,
-        )
+        print(f"Unable to post fatal Crashlytics alert {issue.id} for {app_id} to Discord.", error)
 
 
 # [START v2AppDistributionAlertTrigger]
-@app_distribution_fn.on_new_tester_ios_device_published(
-    secrets=["DISCORD_WEBHOOK_URL"]
-)
-def post_new_udid_to_discord(
-    event: app_distribution_fn.NewTesterDeviceEvent,
-) -> None:
+@app_distribution_fn.on_new_tester_ios_device_published(secrets=["DISCORD_WEBHOOK_URL"])
+def post_new_udid_to_discord(event: app_distribution_fn.NewTesterDeviceEvent) -> None:
     """Publishes a message to Discord whenever someone registers a new iOS test device."""
-    # [END v2AppDistributionAlertTrigger]
+# [END v2AppDistributionAlertTrigger]
     # [START v2AppDistributionEventPayload]
     # Construct a helpful message to send to Discord.
     app_id = event.app_id
@@ -121,31 +100,24 @@ def post_new_udid_to_discord(
 
     try:
         # [START v2SendNewTesterIosDeviceToDiscord]
-        response = post_message_to_discord(
-            "App Distro Bot", message, DISCORD_WEBHOOK_URL.value
-        )
+        response = post_message_to_discord("App Distro Bot", message, DISCORD_WEBHOOK_URL.value)
         if response.ok:
-            print(
-                f"Posted iOS device registration alert for {app_dist.tester_email} to Discord."
-            )
+            print(f"Posted iOS device registration alert for {app_dist.tester_email} to Discord.")
             pprint.pp(event.data.payload)
         else:
             response.raise_for_status()
         # [END v2SendNewTesterIosDeviceToDiscord]
     except (EnvironmentError, requests.HTTPError) as error:
         print(
             f"Unable to post iOS device registration alert for {app_dist.tester_email} to Discord.",
-            error,
-        )
+            error)
 
 
 # [START v2PerformanceAlertTrigger]
 @performance_fn.on_threshold_alert_published(secrets=["DISCORD_WEBHOOK_URL"])
-def post_performance_alert_to_discord(
-    event: performance_fn.PerformanceThresholdAlertEvent,
-) -> None:
+def post_performance_alert_to_discord(event: performance_fn.PerformanceThresholdAlertEvent) -> None:
     """Publishes a message to Discord whenever a performance threshold alert is fired."""
-    # [END v2PerformanceAlertTrigger]
+# [END v2PerformanceAlertTrigger]
     # [START v2PerformanceEventPayload]
     # Construct a helpful message to send to Discord.
     app_id = event.app_id
@@ -167,22 +139,14 @@ def post_performance_alert_to_discord(
 
     try:
         # [START v2SendPerformanceAlertToDiscord]
-        response = post_message_to_discord(
-            "App Performance Bot", message, DISCORD_WEBHOOK_URL.value
-        )
+        response = post_message_to_discord("App Performance Bot", message,
+                                           DISCORD_WEBHOOK_URL.value)
         if response.ok:
-            print(
-                f"Posted Firebase Performance alert {perf.event_name} to Discord."
-            )
+            print(f"Posted Firebase Performance alert {perf.event_name} to Discord.")
             pprint.pp(event.data.payload)
         else:
             response.raise_for_status()
         # [END v2SendPerformanceAlertToDiscord]
     except (EnvironmentError, requests.HTTPError) as error:
-        print(
-            f"Unable to post Firebase Performance alert {perf.event_name} to Discord.",
-            error,
-        )
-
-
+        print(f"Unable to post Firebase Performance alert {perf.event_name} to Discord.", error)
 # [END v2Alerts]

Python/delete-unused-accounts-cron/functions/main.py

@@ -36,14 +36,10 @@ def accountcleanup(event: scheduler_fn.ScheduledEvent) -> None:
     user_page: auth.ListUsersPage | None = auth.list_users()
     while user_page is not None:
         inactive_uids = [
-            user.uid
-            for user in user_page.users
-            if is_inactive(user, timedelta(days=30))
+            user.uid for user in user_page.users if is_inactive(user, timedelta(days=30))
         ]
         auth.delete_users(inactive_uids)
         user_page = user_page.get_next_page()
-
-
 # [END accountcleanup]
 
 
@@ -59,6 +55,4 @@ def is_inactive(user: auth.UserRecord, inactive_limit: timedelta) -> bool:
     last_seen = datetime.fromtimestamp(last_seen_timestamp)
     inactive_time = datetime.now() - last_seen
     return inactive_time >= inactive_limit
-
-
 # [END all]

Python/fcm-notifications/functions/main.py

@@ -25,15 +25,10 @@ def send_follower_notification(event: db_fn.Event[db_fn.Change]) -> None:
     print(f"User {follower_uid} is now following user {followed_uid}")
     tokens_ref = db.reference(f"users/{followed_uid}/notificationTokens")
     notification_tokens = tokens_ref.get()
-    if (
-        not isinstance(notification_tokens, dict)
-        or len(notification_tokens) < 1
-    ):
+    if (not isinstance(notification_tokens, dict) or len(notification_tokens) < 1):
         print("There are no tokens to send notifications to.")
         return
-    print(
-        f"There are {len(notification_tokens)} tokens to send notifications to."
-    )
+    print(f"There are {len(notification_tokens)} tokens to send notifications to.")
 
     follower: auth.UserRecord = auth.get_user(follower_uid)
     notification = messaging.Notification(
@@ -44,8 +39,7 @@ def send_follower_notification(event: db_fn.Event[db_fn.Change]) -> None:
 
     # Send notifications to all tokens.
     msgs = [
-        messaging.Message(token=token, notification=notification)
-        for token in notification_tokens
+        messaging.Message(token=token, notification=notification) for token in notification_tokens
     ]
     batch_response: messaging.BatchResponse = messaging.send_each(msgs)
     if batch_response.failure_count < 1:
@@ -54,7 +48,7 @@ def send_follower_notification(event: db_fn.Event[db_fn.Change]) -> None:
     # Clean up the tokens that are not registered any more.
     for response in batch_response.responses:
         if response.exception.code in (
-            "messaging/invalid-registration-token",
-            "messaging/registration-token-not-registered",
+                "messaging/invalid-registration-token",
+                "messaging/registration-token-not-registered",
         ):
             tokens_ref.child(response.message_id).delete()

Python/http-flask/functions/main.py

@@ -46,6 +46,4 @@ def add_widget():
 def httpsflaskexample(req: https_fn.Request) -> https_fn.Response:
     with app.request_context(req.environ):
         return app.full_dispatch_request()
-
-
 # [END httpflaskexample]