commit aab64a9268b16062cf6d7c463873708c176c9022
author Miriam Polzer <mpolzer@google.com> Tue Aug 17 11:26:37 2021 +0200
committer Commit Bot <commit-bot@chromium.org> Thu Aug 19 09:10:11 2021 +0000
tree b1d81df1189eff3df4d1ebce62f5c202352a3f6d
parent 2ccd8b063061a1d4a35a453cdd5e850b5bcae446

api_config: switch to typing module

Converting Python docstring annotations to typing.

BUG=b:196895668
TEST=./run_tests api/api_config_unittest.py

Change-Id: I106642ef8001c2fbe5ba04d0f107f59dcef471cd
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/chromite/+/3097521
Reviewed-by: Chris McDonald <cjmcdonald@chromium.org>
Commit-Queue: Miriam Polzer <mpolzer@google.com>
Tested-by: Miriam Polzer <mpolzer@google.com>

api/api_config.py

diff --git a/api/api_config.py b/api/api_config.py
index 23c0040..e04cbf9 100644
--- a/api/api_config.py
+++ b/api/api_config.py
@@ -88,16 +88,16 @@
     return (not self.validate_only and not self.mock_call and
             not self.mock_error and not self.mock_invalid)
 
-  def get_proto(self, for_inside_execution=True):
+  def get_proto(
+      self,
+      for_inside_execution: bool = True
+  ) -> build_api_config_pb2.BuildApiConfig:
     """Get the config as a proto.
 
     Args:
-      for_inside_execution (bool): Allows avoiding propagating configs that are
+      for_inside_execution: Allows avoiding propagating configs that are
         irrelevant for the build api process executed inside the chroot.
         Enabled by default.
-
-    Returns:
-      build_api_config_pb2.BuildApiConfig
     """
     config = build_api_config_pb2.BuildApiConfig()
     config.call_type = self.ENUM_TYPE_MAP[self._call_type]
@@ -109,22 +109,20 @@
     return config
 
 
-def build_config_from_proto(config_proto):
+def build_config_from_proto(
+    config_proto: build_api_config_pb2.BuildApiConfig) -> ApiConfig:
   """Build an ApiConfig instance from a BuildApiConfig message.
 
   Args:
-    config_proto (build_api_config_pb2.BuildApiConfig): The proto config.
-
-  Returns:
-    ApiConfig
+    config_proto: The proto config.
   """
-  assert isinstance(config_proto, build_api_config_pb2.BuildApiConfig)
 
   if config_proto.call_type not in ApiConfig.TYPE_ENUM_MAP:
     raise UnknownCallTypeEnumValue('The given protobuf call_type value is not '
                                    'configured in api_config.')
-  return ApiConfig(call_type=ApiConfig.TYPE_ENUM_MAP[config_proto.call_type],
-                   log_path=config_proto.log_path)
+  return ApiConfig(
+      call_type=ApiConfig.TYPE_ENUM_MAP[config_proto.call_type],
+      log_path=config_proto.log_path)
 
 
 class ApiConfigMixin(object):