commit a805636843ff0b65736713b621792e6da673f913
author Kevin Shelton <kmshelton@chromium.org> Mon Apr 04 16:19:23 2022 -0700
committer Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> Fri Apr 08 00:49:28 2022 +0000
tree 7a51724f09176d1c881f179baf179bafbc77d0cb
parent 1e84db1e81b473080a1c4fc471cc7c4a3471ead0

controller_util: convert docstring annotations

Converts Python docstring annotations to type hints.

BUG=b:196895668
TEST=./run_tests api/controller/controller_util_unittest.py

Change-Id: Ic9c7c99ae909edc31032b21a3564031f8ae6d2f6
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/chromite/+/3570356
Reviewed-by: Chris McDonald <cjmcdonald@chromium.org>
Tested-by: Kevin Shelton <kmshelton@chromium.org>
Commit-Queue: Kevin Shelton <kmshelton@chromium.org>

api/controller/controller_util.py

diff --git a/api/controller/controller_util.py b/api/controller/controller_util.py
index 3a3b9ea..ee50969 100644
--- a/api/controller/controller_util.py
+++ b/api/controller/controller_util.py
@@ -7,7 +7,7 @@
 import glob
 import logging
 import os
-from typing import TYPE_CHECKING, Union
+from typing import Optional, TYPE_CHECKING, Union
 
 from chromite.api.gen.chromite.api import sysroot_pb2, test_pb2
 from chromite.api.gen.chromiumos import common_pb2
@@ -30,11 +30,11 @@
   """Invalid message."""
 
 
-def ParseChroot(chroot_message):
+def ParseChroot(chroot_message: common_pb2.Chroot) -> chroot_lib.Chroot:
   """Create a chroot object from the chroot message.
 
   Args:
-    chroot_message (common_pb2.Chroot): The chroot message.
+    chroot_message: The chroot message.
 
   Returns:
     Chroot: The parsed chroot object.
@@ -68,11 +68,11 @@
   return chroot
 
 
-def ParseSysroot(sysroot_message):
+def ParseSysroot(sysroot_message: sysroot_pb2.Sysroot) -> sysroot_lib.Sysroot:
   """Create a sysroot object from the sysroot message.
 
   Args:
-    sysroot_message (commmon_pb2.Sysroot): The sysroot message.
+    sysroot_message: The sysroot message.
 
   Returns:
     Sysroot: The parsed sysroot object.
@@ -129,12 +129,15 @@
                         counterz_filename=counterz_filename)
 
 
-def ParseBuildTarget(build_target_message, profile_message=None):
+def ParseBuildTarget(
+    build_target_message: common_pb2.BuildTarget,
+    profile_message: Optional[sysroot_pb2.Profile] = None
+) -> build_target_lib.BuildTarget:
   """Create a BuildTarget object from a build_target message.
 
   Args:
-    build_target_message (common_pb2.BuildTarget): The BuildTarget message.
-    profile_message (sysroot_pb2.Profile|None): The profile message.
+    build_target_message: The BuildTarget message.
+    profile_message: The profile message.
 
   Returns:
     BuildTarget: The parsed instance.
@@ -248,14 +251,11 @@
   return '%s%s%s' % (c, p, v)
 
 
-def CPVToString(cpv):
+def CPVToString(cpv: package_info.CPV) -> str:
   """Get the most useful string representation from a CPV.
 
   Args:
-    cpv (package_info.CPV): The CPV object.
-
-  Returns:
-    str
+    cpv: The CPV object.
 
   Raises:
     ValueError - when the CPV has no useful fields set.