Migrate python formatting tool from yapf to ruff and use uv in CI. (#1265)

Changes included:
* Replace yapf with ruff in Python/requirements.txt and Python/pyproject.toml.
* Rewrite python formatter Python/pyfmt.py to use `ruff format -`.
* Format all Python code under Python/.
* Update CI at .github/workflows/test_python.yml to install uv and use `uv pip install --system` for speed.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

Author: jhuleatt

.github/workflows/test_python.yml

@@ -44,7 +44,9 @@ jobs:
             python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         working-directory: ./Python
-        run: pip install -r requirements.txt
+        run: |
+          pip install uv
+          uv pip install --system -r requirements.txt
       - name: Lint
         working-directory: ./Python
         run: python pyfmt.py --check_only --exclude "**/venv/**/*.py" **/*.py

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

@@ -24,8 +24,9 @@
 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:
@@ -36,16 +37,18 @@ def post_message_to_discord(bot_name: str, message_body: str,
         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]
@@ -110,7 +113,8 @@ def post_new_udid_to_discord(event: app_distribution_fn.NewTesterDeviceEvent) ->
     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]
@@ -139,8 +143,9 @@ def post_performance_alert_to_discord(event: performance_fn.PerformanceThreshold
 
     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.")
             pprint.pp(event.data.payload)

Python/fcm-notifications/functions/main.py

@@ -25,7 +25,7 @@ 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.")
@@ -52,6 +52,8 @@ def send_follower_notification(event: db_fn.Event[db_fn.Change]) -> None:
         if not isinstance(exception, exceptions.FirebaseError):
             continue
         message = exception.http_response.json()["error"]["message"]
-        if (isinstance(exception, messaging.UnregisteredError) or
-                message == "The registration token is not a valid FCM registration token"):
+        if (
+            isinstance(exception, messaging.UnregisteredError)
+            or message == "The registration token is not a valid FCM registration token"
+        ):
             tokens_ref.child(msgs[i].token).delete()

Python/post-signup-event/functions/main.py

@@ -31,7 +31,8 @@
 # [START savegoogletoken]
 @identity_fn.before_user_created()
 def savegoogletoken(
-        event: identity_fn.AuthBlockingEvent) -> identity_fn.BeforeCreateResponse | None:
+    event: identity_fn.AuthBlockingEvent,
+) -> identity_fn.BeforeCreateResponse | None:
     """During sign-up, save the Google OAuth2 access token and queue up a task
     to schedule an onboarding session on the user's Google Calendar.
 
@@ -48,24 +49,19 @@ def savegoogletoken(
         doc_ref.set({"calendar_access_token": event.credential.access_token}, merge=True)
 
         tasks_client = google.cloud.tasks_v2.CloudTasksClient()
-        task_queue = tasks_client.queue_path(params.PROJECT_ID.value,
-                                             options.SupportedRegion.US_CENTRAL1,
-                                             "scheduleonboarding")
+        task_queue = tasks_client.queue_path(
+            params.PROJECT_ID.value, options.SupportedRegion.US_CENTRAL1, "scheduleonboarding"
+        )
         target_uri = get_function_url("scheduleonboarding")
-        calendar_task = google.cloud.tasks_v2.Task(http_request={
-            "http_method": google.cloud.tasks_v2.HttpMethod.POST,
-            "url": target_uri,
-            "headers": {
-                "Content-type": "application/json"
+        calendar_task = google.cloud.tasks_v2.Task(
+            http_request={
+                "http_method": google.cloud.tasks_v2.HttpMethod.POST,
+                "url": target_uri,
+                "headers": {"Content-type": "application/json"},
+                "body": json.dumps({"data": {"uid": event.data.uid}}).encode(),
             },
-            "body": json.dumps({
-                "data": {
-                    "uid": event.data.uid
-                }
-            }).encode()
-        },
-                                                   schedule_time=datetime.now() +
-                                                   timedelta(minutes=1))
+            schedule_time=datetime.now() + timedelta(minutes=1),
+        )
         tasks_client.create_task(parent=task_queue, task=calendar_task)
 # [END savegoogletoken]
 
@@ -79,46 +75,48 @@ def scheduleonboarding(request: tasks_fn.CallableRequest) -> https_fn.Response:
     """
 
     if "uid" not in request.data:
-        return https_fn.Response(status=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
-                                 response="No user specified.")
+        return https_fn.Response(
+            status=https_fn.FunctionsErrorCode.INVALID_ARGUMENT, response="No user specified."
+        )
     uid = request.data["uid"]
 
     user_record: auth.UserRecord = auth.get_user(uid)
     if user_record.email is None:
-        return https_fn.Response(status=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
-                                 response="No email address on record.")
+        return https_fn.Response(
+            status=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
+            response="No email address on record.",
+        )
 
     firestore_client: google.cloud.firestore.Client = firestore.client()
     user_info = firestore_client.collection("user_info").document(uid).get().to_dict()
     if not isinstance(user_info, dict) or "calendar_access_token" not in user_info:
-        return https_fn.Response(status=https_fn.FunctionsErrorCode.PERMISSION_DENIED,
-                                 response="No Google OAuth token found.")
+        return https_fn.Response(
+            status=https_fn.FunctionsErrorCode.PERMISSION_DENIED,
+            response="No Google OAuth token found.",
+        )
     calendar_access_token = user_info["calendar_access_token"]
     firestore_client.collection("user_info").document(uid).update(
-        {"calendar_access_token": google.cloud.firestore.DELETE_FIELD})
+        {"calendar_access_token": google.cloud.firestore.DELETE_FIELD}
+    )
 
     google_credentials = google.oauth2.credentials.Credentials(token=calendar_access_token)
 
-    calendar_client = googleapiclient.discovery.build("calendar",
-                                                      "v3",
-                                                      credentials=google_credentials)
+    calendar_client = googleapiclient.discovery.build(
+        "calendar", "v3", credentials=google_credentials
+    )
     calendar_event = {
         "summary": "Onboarding with ExampleCo",
         "location": "Video call",
         "description": "Walk through onboarding tasks with an ExampleCo engineer.",
         "start": {
             "dateTime": (datetime.now() + timedelta(days=3)).isoformat(),
-            "timeZone": "America/Los_Angeles"
+            "timeZone": "America/Los_Angeles",
         },
         "end": {
             "dateTime": (datetime.now() + timedelta(days=3, hours=1)).isoformat(),
-            "timeZone": "America/Los_Angeles"
+            "timeZone": "America/Los_Angeles",
         },
-        "attendees": [{
-            "email": user_record.email
-        }, {
-            "email": "onboarding@example.com"
-        }]
+        "attendees": [{"email": user_record.email}, {"email": "onboarding@example.com"}],
     }
     calendar_client.events().insert(calendarId="primary", body=calendar_event).execute()
 
@@ -137,10 +135,13 @@ def get_function_url(name: str, location: str = options.SupportedRegion.US_CENTR
         The URL of the function
     """
     credentials, project_id = google.auth.default(
-        scopes=["https://www.googleapis.com/auth/cloud-platform"])
+        scopes=["https://www.googleapis.com/auth/cloud-platform"]
+    )
     authed_session = google.auth.transport.requests.AuthorizedSession(credentials)
-    url = ("https://cloudfunctions.googleapis.com/v2beta/" +
-           f"projects/{project_id}/locations/{location}/functions/{name}")
+    url = (
+        "https://cloudfunctions.googleapis.com/v2beta/"
+        + f"projects/{project_id}/locations/{location}/functions/{name}"
+    )
     response = authed_session.get(url)
     data = response.json()
     function_url = data["serviceConfig"]["uri"]

Python/pyfmt.py

@@ -17,8 +17,7 @@
 import difflib
 import pathlib
 import re
-
-from yapf.yapflib import yapf_api
+import subprocess
 
 start_tag_re = re.compile(r"^([ \t]*)#\s*\[START\s+(\w+).*\]\s*\n", flags=re.MULTILINE)
 end_tag_re = re.compile(r"^\s*#\s*\[END\s+(\w+).*\][ \t]*$", flags=re.MULTILINE)
@@ -41,19 +40,25 @@ def check_and_diff(files: list[str]) -> int:
             orig = f.read()
         fmt = format(orig)
         diff = list(
-            difflib.unified_diff(orig.splitlines(),
-                                 fmt.splitlines(),
-                                 fromfile=file,
-                                 tofile=f"{file} (reformatted)",
-                                 lineterm=""))
+            difflib.unified_diff(
+                orig.splitlines(),
+                fmt.splitlines(),
+                fromfile=file,
+                tofile=f"{file} (reformatted)",
+                lineterm="",
+            )
+        )
         if len(diff) > 0:
             diff_count += 1
             print("\n".join(diff), end="\n\n")
     return diff_count
 
 
 def format(src: str) -> str:
-    out, _ = yapf_api.FormatCode(src, style_config=pyproject_toml)
+    result = subprocess.run(
+        ["ruff", "format", "-"], input=src.encode("utf-8"), capture_output=True, check=True
+    )
+    out = result.stdout.decode("utf-8")
     out = fix_region_tags(out)
     return out
 
@@ -83,15 +88,19 @@ def fix_end_tag(m: re.Match) -> str:
     import argparse
 
     argparser = argparse.ArgumentParser()
-    argparser.add_argument("--check_only",
-                           "-c",
-                           action="store_true",
-                           help="check files and print diffs, but don't modify files")
-    argparser.add_argument("--exclude",
-                           "-e",
-                           action="append",
-                           default=[],
-                           help="exclude file or glob (can specify multiple times)")
+    argparser.add_argument(
+        "--check_only",
+        "-c",
+        action="store_true",
+        help="check files and print diffs, but don't modify files",
+    )
+    argparser.add_argument(
+        "--exclude",
+        "-e",
+        action="append",
+        default=[],
+        help="exclude file or glob (can specify multiple times)",
+    )
     argparser.add_argument("file_or_glob", nargs="+")
     args = argparser.parse_args()
 

Python/pyproject.toml

@@ -15,8 +15,7 @@
 [project]
 name = "functions_samples"
 version = "1.0.0"
-[tool.yapf]
-based_on_style = "google"
-column_limit = 100
+[tool.ruff]
+line-length = 100
 [tool.mypy]
 python_version = "3.10"