boto3-refresh-session 0.0.21__tar.gz → 0.0.23__tar.gz

{boto3_refresh_session-0.0.21 → boto3_refresh_session-0.0.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 0.0.21
+Version: 0.0.23
 Summary: A simple Python package for refreshing boto3 sessions automatically.
 Home-page: https://github.com/michaelthomasletts/boto3-refresh-session
 License: MIT
@@ -74,10 +74,10 @@ credentials. To learn more about how `boto3` searches for credentials on a
 machine, check [this documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html).
 
 ```python
-from boto3_refresh_session import AutoRefreshableSession
+import boto3_refresh_session as brs
 
 
-sess = AutoRefreshableSession(
+sess = brs.AutoRefreshableSession(
     region="<your-region>",
     role_arn="<your-role-arn>",
     session_name="<your-session-name>",

{boto3_refresh_session-0.0.21 → boto3_refresh_session-0.0.23}/README.md

@@ -49,10 +49,10 @@ credentials. To learn more about how `boto3` searches for credentials on a
 machine, check [this documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html).
 
 ```python
-from boto3_refresh_session import AutoRefreshableSession
+import boto3_refresh_session as brs
 
 
-sess = AutoRefreshableSession(
+sess = brs.AutoRefreshableSession(
     region="<your-region>",
     role_arn="<your-role-arn>",
     session_name="<your-session-name>",

{boto3_refresh_session-0.0.21 → boto3_refresh_session-0.0.23}/boto3_refresh_session/session.py

@@ -23,7 +23,10 @@ from typing import Type
 from attrs import define, field
 from attrs.validators import instance_of, le, optional
 from boto3 import Session
-from botocore.credentials import RefreshableCredentials
+from botocore.credentials import (
+    DeferredRefreshableCredentials,
+    RefreshableCredentials,
+)
 from botocore.session import get_session
 
 
@@ -43,6 +46,10 @@ class AutoRefreshableSession:
         AWS role ARN.
     session_name : str
         Name for session.
+    defer_refresh : bool, optional
+        If ``True`` then temporary credentials are not automatically refreshed until
+        they are explicitly needed. If ``False`` then temporary credentials refresh
+        immediately upon expiration. Default is ``True``.
     ttl : int, optional
         Number of seconds until temporary credentials expire, default 900.
     session_kwargs : dict, optional
@@ -61,11 +68,15 @@ class AutoRefreshableSession:
     Check the :ref:`authorization documentation <authorization>` for additional
     information concerning how to authorize access to AWS.
 
+    The default ``defer_refresh`` parameter value results in temporary credentials not
+    being refreshed until they are explicitly requested; that is more efficient than
+    refreshing expired temporary credentials automatically after they expire.
+
     Examples
     --------
     Here's how to initialize this object:
 
-    >>> sess = AutoRefreshableSession(
+    >>> sess = brs.AutoRefreshableSession(
     >>>   region="us-east-1",
     >>>   role_arn="<your-arn>",
     >>>   session_name="test",
@@ -76,6 +87,7 @@ class AutoRefreshableSession:
     region: str = field(validator=instance_of(str))
     role_arn: str = field(validator=instance_of(str))
     session_name: str = field(validator=instance_of(str))
+    defer_refresh: bool = field(default=True, validator=instance_of(bool))
     ttl: int = field(
         default=900, validator=optional([instance_of(int), le(900)])
     )
@@ -88,13 +100,19 @@ class AutoRefreshableSession:
     session: Type[Session] = field(init=False)
 
     def __attrs_post_init__(self):
-        __credentials = RefreshableCredentials.create_from_metadata(
-            metadata=self._get_credentials(),
-            refresh_using=self._get_credentials,
-            method="sts-assume-role",
-        )
         __session = get_session()
-        # https://github.com/boto/botocore/blob/f8a1dd0820b548a5e8dc05420b28b6f1c6e21154/botocore/session.py#L143
+
+        if not self.defer_refresh:
+            __credentials = RefreshableCredentials.create_from_metadata(
+                metadata=self._get_credentials(),
+                refresh_using=self._get_credentials,
+                method="sts-assume-role",
+            )
+        else:
+            __credentials = DeferredRefreshableCredentials(
+                refresh_using=self._get_credentials, method="sts-assume-role"
+            )
+
         __session._credentials = __credentials
         self.session = Session(botocore_session=__session)
 

{boto3_refresh_session-0.0.21 → boto3_refresh_session-0.0.23}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boto3-refresh-session"
-version = "0.0.21"
+version = "0.0.23"
 description = "A simple Python package for refreshing boto3 sessions automatically."
 authors = [
     {name = "Mike Letts",email = "michaelthomasletts@gmail.com"}
@@ -42,4 +42,10 @@ line_length = 79
 ensure_newline_before_comments = true
 use_parentheses = true
 include_trailing_comma = true
-multi_line_output = 3
+multi_line_output = 3
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "INFO"
+log_cli_date_format = "%Y-%m-%d %H:%M:%S"
+log_cli_format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"