commit 6fa9486eb2536d1358d8919511dc4cd55e655bfb
author Kevin Shelton <kmshelton@chromium.org> Fri Apr 08 20:46:23 2022 -0700
committer Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> Tue May 03 03:21:32 2022 +0000
tree f6dfaf51024fd1461ef8df661b32399f54438b6b
parent 359b4a89863961a55793dddd673116ddbd529a6f

payload: convert docstring annotations

Converts Python docstring annotations to type hints.

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

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

api/controller/payload.py

diff --git a/api/controller/payload.py b/api/controller/payload.py
index 015245d..dc11e0c 100644
--- a/api/controller/payload.py
+++ b/api/controller/payload.py
@@ -4,6 +4,8 @@
 
 """Payload API Service."""
 
+from typing import TYPE_CHECKING
+
 from chromite.api import controller
 from chromite.api import faux
 from chromite.api import validate
@@ -13,6 +15,9 @@
 from chromite.service import payload
 
 
+if TYPE_CHECKING:
+  from chromite.api import api_config
+
 _VALID_IMAGE_PAIRS = (('src_signed_image', 'tgt_signed_image'),
                       ('src_unsigned_image', 'tgt_unsigned_image'),
                       ('src_dlc_image', 'tgt_dlc_image'),
@@ -32,13 +37,15 @@
 @faux.empty_success
 @faux.empty_completed_unsuccessfully_error
 @validate.require('bucket')
-def GeneratePayload(input_proto, output_proto, config):
+def GeneratePayload(input_proto: payload_pb2.GenerationRequest,
+                    output_proto: payload_pb2.GenerationResponse,
+                    config: 'api_config.ApiConfig') -> int:
   """Generate a update payload ('do paygen').
 
   Args:
-    input_proto (PayloadGenerationRequest): Input proto.
-    output_proto (PayloadGenerationResult): Output proto.
-    config (api.config.ApiConfig): The API call config.
+    input_proto: Input proto.
+    output_proto: Output proto.
+    config: The API call config.
 
   Returns:
     A controller return code (e.g. controller.RETURN_CODE_SUCCESS).
@@ -108,13 +115,15 @@
     return controller.RETURN_CODE_COMPLETED_UNSUCCESSFULLY
 
 
-def _SetGeneratePayloadOutputProto(output_proto, local_path, remote_uri):
+def _SetGeneratePayloadOutputProto(output_proto: payload_pb2.GenerationResponse,
+                                   local_path: str,
+                                   remote_uri: str):
   """Set the output proto with the results from the service class.
 
   Args:
-    output_proto (PayloadGenerationResult_pb2): The output proto.
-    local_path (str): set output_proto with the local path, or ''.
-    remote_uri (str): set output_proto with the remote uri, or ''.
+    output_proto: The output proto.
+    local_path: set output_proto with the local path, or ''.
+    remote_uri: set output_proto with the remote uri, or ''.
   """
   output_proto.success = True
   output_proto.local_path = local_path or ''