boto3-refresh-session 2.0.7__py3-none-any.whl → 2.0.9__py3-none-any.whl

boto3_refresh_session/__init__.py

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

boto3_refresh_session/methods/custom.py

@@ -4,11 +4,17 @@ __all__ = ["CustomRefreshableSession"]
 
 from typing import Any, Callable
 
-from ..exceptions import BRSError
+from ..exceptions import BRSError, BRSWarning
 from ..session import BaseRefreshableSession
-from ..utils import RefreshMethod, TemporaryCredentials
+from ..utils import (
+    CustomCredentialsMethod,
+    CustomCredentialsMethodArgs,
+    TemporaryCredentials,
+    refreshable_session,
+)
 
 
+@refreshable_session
 class CustomRefreshableSession(BaseRefreshableSession, registry_key="custom"):
     """A :class:`boto3.session.Session` object that automatically refreshes
     temporary credentials returned by a custom credential getter provided
@@ -17,11 +23,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
@@ -61,21 +67,29 @@ class CustomRefreshableSession(BaseRefreshableSession, registry_key="custom"):
 
     def __init__(
         self,
-        custom_credentials_method: Callable,
-        custom_credentials_method_args: dict[str, Any] | None = None,
-        defer_refresh: bool | None = None,
+        custom_credentials_method: CustomCredentialsMethod,
+        custom_credentials_method_args: (
+            CustomCredentialsMethodArgs | None
+        ) = None,
         **kwargs,
     ):
-        super().__init__(**kwargs)
-        self.defer_refresh: bool = defer_refresh is not False
-        self.refresh_method: RefreshMethod = "custom"
-        self._custom_get_credentials = custom_credentials_method
-        self._custom_get_credentials_args = (
+        if "refresh_method" in kwargs:
+            BRSWarning(
+                "'refresh_method' cannot be set manually. "
+                "Reverting to 'custom'."
+            )
+            del kwargs["refresh_method"]
+
+        # initializing BRSSession
+        super().__init__(refresh_method="custom", **kwargs)
+        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 {}
         )
-        self.__post_init__()
 
     def _get_credentials(self) -> TemporaryCredentials:
         credentials: TemporaryCredentials = self._custom_get_credentials(

boto3_refresh_session/methods/ecs.py

@@ -6,9 +6,9 @@ import os
 
 import requests
 
-from ..exceptions import BRSError
+from ..exceptions import BRSError, BRSWarning
 from ..session import BaseRefreshableSession
-from ..utils import RefreshMethod, TemporaryCredentials
+from ..utils import TemporaryCredentials, refreshable_session
 
 _ECS_CREDENTIALS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"
 _ECS_CREDENTIALS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI"
@@ -16,6 +16,7 @@ _ECS_AUTHORIZATION_TOKEN = "AWS_CONTAINER_AUTHORIZATION_TOKEN"
 _DEFAULT_ENDPOINT_BASE = "http://169.254.170.2"
 
 
+@refreshable_session
 class ECSRefreshableSession(BaseRefreshableSession, registry_key="ecs"):
     """A boto3 session that automatically refreshes temporary AWS credentials
     from the ECS container credentials metadata endpoint.
@@ -34,14 +35,21 @@ class ECSRefreshableSession(BaseRefreshableSession, registry_key="ecs"):
         Optional keyword arguments passed to :class:`boto3.session.Session`.
     """
 
-    def __init__(self, defer_refresh: bool | None = None, **kwargs):
-        super().__init__(**kwargs)
-        self.defer_refresh: bool = defer_refresh is not False
-        self.refresh_method: RefreshMethod = "ecs-container-metadata"
+    def __init__(self, **kwargs):
+        if "refresh_method" in kwargs:
+            BRSWarning(
+                "'refresh_method' cannot be set manually. "
+                "Reverting to 'ecs-container-metadata'."
+            )
+            del kwargs["refresh_method"]
+
+        # initializing BRSSession
+        super().__init__(refresh_method="ecs-container-metadata", **kwargs)
+
+        # initializing various other attributes
         self._endpoint = self._resolve_endpoint()
         self._headers = self._build_headers()
         self._http = self._init_http_session()
-        self.__post_init__()
 
     def _resolve_endpoint(self) -> str:
         uri = os.environ.get(_ECS_CREDENTIALS_FULL_URI) or os.environ.get(

boto3_refresh_session/methods/iot/certificate.typed

@@ -4,10 +4,11 @@ from pathlib import Path
 from typing import Any
 
 from ...exceptions import BRSError
-from ...utils import PKCS11, TemporaryCredentials
+from ...utils import PKCS11, TemporaryCredentials, refreshable_session
 from .core import BaseIoTRefreshableSession
 
 
+@refreshable_session
 class IoTCertificateRefreshableSession(
     BaseIoTRefreshableSession, registry_key="certificate"
 ):

boto3_refresh_session/methods/iot/cognito.typed

@@ -2,10 +2,11 @@ __all__ = ["IoTCognitoRefreshableSession"]
 
 from typing import Any
 
-from ...utils import TemporaryCredentials
+from ...utils import TemporaryCredentials, refreshable_session
 from .core import BaseIoTRefreshableSession
 
 
+@refreshable_session
 class IoTCognitoRefreshableSession(
     BaseIoTRefreshableSession, registry_key="cognito"
 ):

boto3_refresh_session/methods/sts.py

@@ -8,12 +8,13 @@ from ..exceptions import BRSWarning
 from ..session import BaseRefreshableSession
 from ..utils import (
     AssumeRoleParams,
-    RefreshMethod,
     STSClientParams,
     TemporaryCredentials,
+    refreshable_session,
 )
 
 
+@refreshable_session
 class STSRefreshableSession(BaseRefreshableSession, registry_key="sts"):
     """A :class:`boto3.session.Session` object that automatically refreshes
     temporary AWS credentials using an IAM role that is assumed via STS.
@@ -43,13 +44,20 @@ class STSRefreshableSession(BaseRefreshableSession, registry_key="sts"):
     def __init__(
         self,
         assume_role_kwargs: AssumeRoleParams,
-        defer_refresh: bool | None = None,
         sts_client_kwargs: STSClientParams | None = None,
         **kwargs,
     ):
-        super().__init__(**kwargs)
-        self.defer_refresh: bool = defer_refresh is not False
-        self.refresh_method: RefreshMethod = "sts-assume-role"
+        if "refresh_method" in kwargs:
+            BRSWarning(
+                "'refresh_method' cannot be set manually. "
+                "Reverting to 'sts-assume-role'."
+            )
+            del kwargs["refresh_method"]
+
+        # initializing BRSSession
+        super().__init__(refresh_method="sts-assume-role", **kwargs)
+
+        # initializing various other attributes
         self.assume_role_kwargs = assume_role_kwargs
 
         if sts_client_kwargs is not None:
@@ -66,8 +74,6 @@ class STSRefreshableSession(BaseRefreshableSession, registry_key="sts"):
         else:
             self._sts_client = self.client(service_name="sts")
 
-        self.__post_init__()
-
     def _get_credentials(self) -> TemporaryCredentials:
         temporary_credentials = self._sts_client.assume_role(
             **self.assume_role_kwargs

boto3_refresh_session/utils.py

@@ -1,5 +1,8 @@
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 from datetime import datetime
+from functools import wraps
 from typing import (
     Any,
     Callable,
@@ -7,8 +10,12 @@ from typing import (
     Generic,
     List,
     Literal,
+    Mapping,
+    Protocol,
+    TypeAlias,
     TypedDict,
     TypeVar,
+    cast,
 )
 
 from boto3.session import Session
@@ -45,6 +52,52 @@ RefreshMethod = Literal[
 #: Type alias for all currently registered credential refresh methods.
 RegistryKey = TypeVar("RegistryKey", bound=str)
 
+#: Type alias for a generic refreshable session type.
+BRSSessionType = TypeVar("BRSSessionType", bound="BRSSession")
+
+
+def refreshable_session(
+    cls: type[BRSSessionType],
+) -> type[BRSSessionType]:
+    """Wraps cls.__init__ so self.__post_init__ runs after init (if present).
+
+    Returns
+    -------
+    BRSSessionType
+        The decorated class.
+    """
+
+    init = getattr(cls, "__init__", None)
+
+    # synthesize __init__ if undefined in the class
+    if init in (None, object.__init__):
+
+        def __init__(self, *args, **kwargs):
+            super(cls, self).__init__(*args, **kwargs)
+            post = getattr(self, "__post_init__", None)
+            if callable(post) and not getattr(self, "_post_inited", False):
+                post()
+                setattr(self, "_post_inited", True)
+
+        cls.__init__ = __init__  # type: ignore[assignment]
+        return cls
+
+    # avoids double wrapping
+    if getattr(init, "__post_init_wrapped__", False):
+        return cls
+
+    @wraps(init)
+    def wrapper(self, *args, **kwargs):
+        init(self, *args, **kwargs)
+        post = getattr(self, "__post_init__", None)
+        if callable(post) and not getattr(self, "_post_inited", False):
+            post()
+            setattr(self, "_post_inited", True)
+
+    wrapper.__post_init_wrapped__ = True  # type: ignore[attr-defined]
+    cls.__init__ = cast(Callable[..., None], wrapper)
+    return cls
+
 
 class Registry(Generic[RegistryKey]):
     """Gives any hierarchy a class-level registry."""
@@ -76,6 +129,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.
 
@@ -107,12 +171,28 @@ class CredentialProvider(ABC):
 class BRSSession(Session):
     """Wrapper for boto3.session.Session.
 
+    Parameters
+    ----------
+    refresh_method : RefreshMethod
+        The method to use for refreshing temporary credentials.
+    defer_refresh : bool, default=True
+        If True, the initial credential refresh is deferred until the
+        credentials are first accessed. If False, the initial refresh
+
     Other Parameters
     ----------------
     kwargs : Any
-        Optional keyword arguments for initializing boto3.session.Session."""
+        Optional keyword arguments for initializing boto3.session.Session.
+    """
 
-    def __init__(self, **kwargs):
+    def __init__(
+        self,
+        refresh_method: RefreshMethod,
+        defer_refresh: bool | None = None,
+        **kwargs,
+    ):
+        self.refresh_method: RefreshMethod = refresh_method
+        self.defer_refresh: bool = defer_refresh is not False
         super().__init__(**kwargs)
 
     def __post_init__(self):

{boto3_refresh_session-2.0.7.dist-info → boto3_refresh_session-2.0.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 2.0.7
+Version: 2.0.9
 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.9.dist-info/RECORD

@@ -0,0 +1,17 @@
+boto3_refresh_session/__init__.py,sha256=oUmq6AKEMx1Gvi0U6BPMiktIargvfJVoMwyC4jm60eA,387
+boto3_refresh_session/exceptions.py,sha256=cP5d9S8QnUEwXIU3pzMGr6jMOz447kddNJ_UIRERMrk,964
+boto3_refresh_session/methods/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+boto3_refresh_session/methods/custom.py,sha256=fMqaSgbmv-mfDMe1lXEPF1V4dQcwPsCN8qcRHW2IeqE,4209
+boto3_refresh_session/methods/ecs.py,sha256=aXQXS7beS2RBXIeQkUNQkM4zhtDQv0n1Mkf9wnFbOTE,3931
+boto3_refresh_session/methods/iot/__init__.typed,sha256=Z33nIB6oCsz9TZwikHfNHgY1SKxkSCdB5rwdPSUl3C4,135
+boto3_refresh_session/methods/iot/certificate.typed,sha256=xBucJJfRb0_iKuhbtRxOWeRERzyJxo7iYW6-0VbmdA0,1816
+boto3_refresh_session/methods/iot/cognito.typed,sha256=OgFYOCDIkt2QC_F0KLL_BrxVxT6qMwjn-0yi4ZIwZYo,431
+boto3_refresh_session/methods/iot/core.typed,sha256=tL-ngB2XYq0XtxhS9mbggCJYdX3eEE0u1Gvcq8sEYGE,1422
+boto3_refresh_session/methods/sts.py,sha256=FvblbuXDaczEfsRIs59eKOodrJjHcMKHrnrmxjXfNeU,3401
+boto3_refresh_session/session.py,sha256=_Z3uB5Xq3S-dFqOFmWhMQbcd__NPGThjULLPStHI6E4,2914
+boto3_refresh_session/utils.py,sha256=9Nru9GWWMAboDRJMstKIBFtKA2R8u3DFFcCvsQYSNCI,7976
+boto3_refresh_session-2.0.9.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-2.0.9.dist-info/METADATA,sha256=0M9RJlmPWHbmYrbgz1MjLU7BaSsm8wpr4dAkuJJ86Hs,8795
+boto3_refresh_session-2.0.9.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
+boto3_refresh_session-2.0.9.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+boto3_refresh_session-2.0.9.dist-info/RECORD,,

boto3_refresh_session-2.0.7.dist-info/RECORD

@@ -1,17 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=3VYnpC-52TTWbTfkoYwW5o7ImCNWsLGeKNWk5CmL5k8,387
-boto3_refresh_session/exceptions.py,sha256=cP5d9S8QnUEwXIU3pzMGr6jMOz447kddNJ_UIRERMrk,964
-boto3_refresh_session/methods/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-boto3_refresh_session/methods/custom.py,sha256=JDDfBszAesNV2gSv8lJvGxCpbM9-lUn0L9HDt-rPETM,3846
-boto3_refresh_session/methods/ecs.py,sha256=qejldriuTVpHPSkquHeo4vLGbe0_WAg_iayuJFk6W9Q,3728
-boto3_refresh_session/methods/iot/__init__.typed,sha256=Z33nIB6oCsz9TZwikHfNHgY1SKxkSCdB5rwdPSUl3C4,135
-boto3_refresh_session/methods/iot/certificate.typed,sha256=yvKptwH-GagBREI_1AXs_mCaU6vL3AcUDQ58vn7V8QM,1774
-boto3_refresh_session/methods/iot/cognito.typed,sha256=0VorzOXHpsVemiGWZzHE9fuX-MZcpqzWQ4nK3gNDUMg,389
-boto3_refresh_session/methods/iot/core.typed,sha256=tL-ngB2XYq0XtxhS9mbggCJYdX3eEE0u1Gvcq8sEYGE,1422
-boto3_refresh_session/methods/sts.py,sha256=SjeVNXXB50wLINr5GhjALrnytPleu6UeE0BBAJU28Lc,3226
-boto3_refresh_session/session.py,sha256=_Z3uB5Xq3S-dFqOFmWhMQbcd__NPGThjULLPStHI6E4,2914
-boto3_refresh_session/utils.py,sha256=z-lN5szAETD88-h4pNEwBDcqAPqzeGo5QJ0hNUJdDWA,5560
-boto3_refresh_session-2.0.7.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-2.0.7.dist-info/METADATA,sha256=fhSKcYLuhphxBm8uLmzAKt7kO4YE1dbl3gsPj_Li4DU,8795
-boto3_refresh_session-2.0.7.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
-boto3_refresh_session-2.0.7.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-boto3_refresh_session-2.0.7.dist-info/RECORD,,