Refactor: Add annoations to lftools.oauth2_helper 36/72236/1
authorAndrew Grimberg <agrimberg@linuxfoundation.org>
Mon, 9 Oct 2023 15:49:31 +0000 (08:49 -0700)
committerAndrew Grimberg <agrimberg@linuxfoundation.org>
Mon, 9 Oct 2023 15:49:31 +0000 (08:49 -0700)
Issue: RELENG-4933
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
Change-Id: I5d80203fa91196de29e77c55721150668545aeee

lftools/oauth2_helper.py

index 1356149..ef73ecd 100644 (file)
@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: EPL-1.0
 ##############################################################################
-# Copyright (c) 2019 The Linux Foundation and others.
+# Copyright (c) 2019, 2023 The Linux Foundation and others.
 #
 # All rights reserved. This program and the accompanying materials
 # are made available under the terms of the Eclipse Public License v1.0
@@ -8,8 +8,10 @@
 # http://www.eclipse.org/legal/epl-v10.html
 ##############################################################################
 """Helper script to get access_token for lfid api."""
+from __future__ import annotations
 
 import logging
+from typing import Tuple
 
 import httplib2
 from oauth2client import client
@@ -17,16 +19,16 @@ from oauth2client import client
 from lftools import config
 
 
-def oauth_helper():
+def oauth_helper() -> Tuple[str, str]:
     """Helper script to get access_token for lfid api."""
     logging.getLogger("oauth2client").setLevel(logging.ERROR)
-    client_id = config.get_setting("lfid", "clientid")
-    client_secret = config.get_setting("lfid", "client_secret")
-    refresh_token = config.get_setting("lfid", "refresh_token")
-    token_uri = config.get_setting("lfid", "token_uri")
-    url = config.get_setting("lfid", "url")
+    client_id: str = config.get_setting("lfid", "clientid")
+    client_secret: str = config.get_setting("lfid", "client_secret")
+    refresh_token: str = config.get_setting("lfid", "refresh_token")
+    token_uri: str = config.get_setting("lfid", "token_uri")
+    url: str = config.get_setting("lfid", "url")
 
-    credentials = client.OAuth2Credentials(
+    credentials: client.Oauth2Credentials = client.OAuth2Credentials(
         access_token=None,  # set access_token to None since we use a refresh token
         client_id=client_id,
         client_secret=client_secret,
@@ -36,5 +38,5 @@ def oauth_helper():
         user_agent=None,
     )
     credentials.refresh(httplib2.Http())
-    access_token = credentials.access_token
+    access_token: str = credentials.access_token
     return access_token, url