Skip to content

Commit e010bcd

Browse files
authored
feat: Added type hints to method parameters (#650)
Closes: SDK-1875
1 parent 6a5134f commit e010bcd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+1447
-2780
lines changed

boxsdk/auth/cooperatively_managed_oauth2.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# coding: utf-8
2+
from typing import Callable, Tuple, Any
23

34
from .oauth2 import OAuth2
45

@@ -8,18 +9,16 @@ class CooperativelyManagedOAuth2Mixin(OAuth2):
89
Box SDK OAuth2 mixin.
910
Allows for sharing auth tokens between multiple clients.
1011
"""
11-
def __init__(self, retrieve_tokens=None, *args, **kwargs):
12+
def __init__(self, retrieve_tokens: Callable[[], Tuple[str, str]] = None, *args: Any, **kwargs: Any):
1213
"""
1314
:param retrieve_tokens:
1415
Callback to get the current access/refresh token pair.
15-
:type retrieve_tokens:
16-
`callable` of () => (`unicode`, `unicode`)
1716
"""
1817
# pylint:disable=keyword-arg-before-vararg
1918
self._retrieve_tokens = retrieve_tokens
2019
super().__init__(*args, **kwargs)
2120

22-
def _get_tokens(self):
21+
def _get_tokens(self) -> Tuple[str, str]:
2322
"""
2423
Base class override. Get the tokens from the user-specified callback.
2524
"""

boxsdk/auth/developer_token_auth.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# coding: utf-8
2+
from typing import Callable, Any, Tuple, Optional
23

34
from .oauth2 import OAuth2
45

56

67
class DeveloperTokenAuth(OAuth2):
78
ENTER_TOKEN_PROMPT = 'Enter developer token: '
89

9-
def __init__(self, get_new_token_callback=None, **kwargs):
10+
def __init__(self, get_new_token_callback: Callable[[], str] = None, **kwargs: Any):
1011
self._get_new_token = get_new_token_callback
1112
super().__init__(
1213
client_id=None,
@@ -15,21 +16,21 @@ def __init__(self, get_new_token_callback=None, **kwargs):
1516
**kwargs
1617
)
1718

18-
def _refresh_developer_token(self):
19+
def _refresh_developer_token(self) -> str:
1920
if self._get_new_token is not None:
2021
return self._get_new_token()
2122

2223
return input(self.ENTER_TOKEN_PROMPT)
2324

24-
def _refresh(self, access_token):
25+
def _refresh(self, access_token: str) -> Tuple[str, Optional[str]]:
2526
"""
2627
Base class override.
2728
Ask for a new developer token.
2829
"""
2930
self._access_token = self._refresh_developer_token()
3031
return self._access_token, None
3132

32-
def revoke(self):
33+
def revoke(self) -> None:
3334
"""
3435
Base class override.
3536
Do nothing; developer tokens can't be revoked without client ID and secret.

0 commit comments

Comments
 (0)