boto3-refresh-session 2.0.8__tar.gz → 2.0.10__tar.gz

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 2.0.8
+Version: 2.0.10
 Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
 License: MIT
 Keywords: boto3,botocore,aws,sts,ecs,credentials,token,refresh

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/boto3_refresh_session/__init__.py

@@ -4,7 +4,7 @@ from .methods.sts import STSRefreshableSession
 from .session import RefreshableSession
 
 __all__ = ["RefreshableSession"]
-__version__ = "2.0.8"
+__version__ = "2.0.10"
 __title__ = "boto3-refresh-session"
 __author__ = "Mike Letts"
 __maintainer__ = "Mike Letts"

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/boto3_refresh_session/methods/custom.py

@@ -6,7 +6,13 @@ from typing import Any, Callable
 
 from ..exceptions import BRSError, BRSWarning
 from ..session import BaseRefreshableSession
-from ..utils import TemporaryCredentials, refreshable_session
+from ..utils import (
+    CustomCredentialsMethod,
+    CustomCredentialsMethodArgs,
+    Identity,
+    TemporaryCredentials,
+    refreshable_session,
+)
 
 
 @refreshable_session
@@ -18,11 +24,11 @@ class CustomRefreshableSession(BaseRefreshableSession, registry_key="custom"):
 
     Parameters
     ----------
-    custom_credentials_method: Callable
+    custom_credentials_method: CustomCredentialsMethod
         Required. Accepts a callable object that returns temporary AWS
         security credentials. That object must return a dictionary containing
         'access_key', 'secret_key', 'token', and 'expiry_time' when called.
-    custom_credentials_method_args : dict[str, Any], optional
+    custom_credentials_method_args : CustomCredentialsMethodArgs, optional
         Optional keyword arguments for the function passed to the
         ``custom_credentials_method`` parameter.
     defer_refresh : bool, optional
@@ -62,8 +68,10 @@ class CustomRefreshableSession(BaseRefreshableSession, registry_key="custom"):
 
     def __init__(
         self,
-        custom_credentials_method: Callable,
-        custom_credentials_method_args: dict[str, Any] | None = None,
+        custom_credentials_method: CustomCredentialsMethod,
+        custom_credentials_method_args: (
+            CustomCredentialsMethodArgs | None
+        ) = None,
         **kwargs,
     ):
         if "refresh_method" in kwargs:
@@ -75,8 +83,10 @@ class CustomRefreshableSession(BaseRefreshableSession, registry_key="custom"):
 
         # initializing BRSSession
         super().__init__(refresh_method="custom", **kwargs)
-        self._custom_get_credentials = custom_credentials_method
-        self._custom_get_credentials_args = (
+        self._custom_get_credentials: CustomCredentialsMethod = (
+            custom_credentials_method
+        )
+        self._custom_get_credentials_args: CustomCredentialsMethodArgs = (
             custom_credentials_method_args
             if custom_credentials_method_args is not None
             else {}
@@ -97,12 +107,12 @@ class CustomRefreshableSession(BaseRefreshableSession, registry_key="custom"):
 
         return credentials
 
-    def get_identity(self) -> dict[str, str]:
+    def get_identity(self) -> Identity:
         """Returns metadata about the custom credential getter.
 
         Returns
         -------
-        dict[str, str]
+        Identity
             Dict containing information about the custom credential getter.
         """
 

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/boto3_refresh_session/methods/ecs.py

@@ -8,7 +8,7 @@ import requests
 
 from ..exceptions import BRSError, BRSWarning
 from ..session import BaseRefreshableSession
-from ..utils import TemporaryCredentials, refreshable_session
+from ..utils import Identity, TemporaryCredentials, refreshable_session
 
 _ECS_CREDENTIALS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"
 _ECS_CREDENTIALS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI"
@@ -101,12 +101,12 @@ class ECSRefreshableSession(BaseRefreshableSession, registry_key="ecs"):
             "expiry_time": credentials.get("Expiration"),  # already ISO8601
         }
 
-    def get_identity(self) -> dict[str, str]:
+    def get_identity(self) -> Identity:
         """Returns metadata about ECS.
 
         Returns
         -------
-        dict[str, str]
+        Identity
             Dict containing metadata about ECS.
         """
 

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/boto3_refresh_session/methods/iot/certificate.typed

@@ -4,7 +4,7 @@ from pathlib import Path
 from typing import Any
 
 from ...exceptions import BRSError
-from ...utils import PKCS11, TemporaryCredentials, refreshable_session
+from ...utils import Identity, PKCS11, TemporaryCredentials, refreshable_session
 from .core import BaseIoTRefreshableSession
 
 
@@ -52,4 +52,4 @@ class IoTCertificateRefreshableSession(
 
     def _get_credentials(self) -> TemporaryCredentials: ...
 
-    def get_identity(self) -> dict[str, Any]: ...
+    def get_identity(self) -> Identity: ...

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/boto3_refresh_session/methods/iot/cognito.typed

@@ -2,7 +2,7 @@ __all__ = ["IoTCognitoRefreshableSession"]
 
 from typing import Any
 
-from ...utils import TemporaryCredentials, refreshable_session
+from ...utils import Identity, TemporaryCredentials, refreshable_session
 from .core import BaseIoTRefreshableSession
 
 
@@ -14,4 +14,4 @@ class IoTCognitoRefreshableSession(
 
     def _get_credentials(self) -> TemporaryCredentials: ...
 
-    def get_identity(self) -> dict[str, Any]: ...
+    def get_identity(self) -> Identity: ...

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/boto3_refresh_session/methods/sts.py

@@ -8,6 +8,7 @@ from ..exceptions import BRSWarning
 from ..session import BaseRefreshableSession
 from ..utils import (
     AssumeRoleParams,
+    Identity,
     STSClientParams,
     TemporaryCredentials,
     refreshable_session,
@@ -85,12 +86,12 @@ class STSRefreshableSession(BaseRefreshableSession, registry_key="sts"):
             "expiry_time": temporary_credentials.get("Expiration").isoformat(),
         }
 
-    def get_identity(self) -> dict[str, Any]:
+    def get_identity(self) -> Identity:
         """Returns metadata about the identity assumed.
 
         Returns
         -------
-        dict[str, Any]
+        Identity
             Dict containing caller identity according to AWS STS.
         """
 

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/boto3_refresh_session/utils.py

@@ -10,6 +10,9 @@ from typing import (
     Generic,
     List,
     Literal,
+    Mapping,
+    Protocol,
+    TypeAlias,
     TypedDict,
     TypeVar,
     cast,
@@ -52,6 +55,9 @@ RegistryKey = TypeVar("RegistryKey", bound=str)
 #: Type alias for a generic refreshable session type.
 BRSSessionType = TypeVar("BRSSessionType", bound="BRSSession")
 
+#: Type alias for values returned by get_identity
+Identity: TypeAlias = dict[str, Any]
+
 
 def refreshable_session(
     cls: type[BRSSessionType],
@@ -126,6 +132,17 @@ class TemporaryCredentials(TypedDict):
     expiry_time: datetime | str
 
 
+class _CustomCredentialsMethod(Protocol):
+    def __call__(self, **kwargs: Any) -> TemporaryCredentials: ...
+
+
+#: Type alias for custom credential retrieval methods.
+CustomCredentialsMethod: TypeAlias = _CustomCredentialsMethod
+
+#: Type alias for custom credential method arguments.
+CustomCredentialsMethodArgs: TypeAlias = Mapping[str, Any]
+
+
 class RefreshableTemporaryCredentials(TypedDict):
     """Refreshable IAM credentials.
 

{boto3_refresh_session-2.0.8 → boto3_refresh_session-2.0.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boto3-refresh-session"
-version = "2.0.8"
+version = "2.0.10"
 description = "A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically."
 authors = [
     {name = "Mike Letts",email = "lettsmt@gmail.com"}