awsimple 3.2.0__py3-none-any.whl → 3.4.0__py3-none-any.whl

awsimple/__version__.py

@@ -1,7 +1,7 @@
 __application_name__ = "awsimple"
 __title__ = __application_name__
 __author__ = "abel"
-__version__ = "3.2.0"
+__version__ = "3.4.0"
 __author_email__ = "j@abel.co"
 __url__ = "https://github.com/jamesabel/awsimple"
 __download_url__ = "https://github.com/jamesabel/awsimple"

awsimple/aws.py

@@ -30,12 +30,12 @@ def boto_error_to_string(boto_error) -> Union[str, None]:
 class AWSAccess:
     @typechecked()
     def __init__(
-        self,
-        resource_name: Union[str, None] = None,
-        profile_name: Union[str, None] = None,
-        aws_access_key_id: Union[str, None] = None,
-        aws_secret_access_key: Union[str, None] = None,
-        region_name: Union[str, None] = None,
+            self,
+            resource_name: Union[str, None] = None,
+            profile_name: Union[str, None] = None,
+            aws_access_key_id: Union[str, None] = None,
+            aws_secret_access_key: Union[str, None] = None,
+            region_name: Union[str, None] = None,
     ):
         """
         AWSAccess - takes care of basic AWS access (e.g. session, client, resource), getting some basic AWS information, and mock support for testing.
@@ -79,20 +79,9 @@ class AWSAccess:
                 self._aws_keys_save[aws_key] = os.environ.get(aws_key)  # will be None if not set
                 os.environ[aws_key] = "testing"
 
-            if self.resource_name == "s3":
-                from moto import mock_s3 as moto_mock
-            elif self.resource_name == "sns":
-                from moto import mock_sns as moto_mock
-            elif self.resource_name == "sqs":
-                from moto import mock_sqs as moto_mock
-            elif self.resource_name == "dynamodb":
-                from moto import mock_dynamodb as moto_mock
-            elif self.resource_name == "logs":
-                from moto import mock_logs as moto_mock
-            else:
-                from moto import mock_iam as moto_mock
+            from moto import mock_aws
 
-            self._moto_mock = moto_mock()
+            self._moto_mock = mock_aws()
             self._moto_mock.start()
             region = "us-east-1"
             if self.resource_name == "logs" or self.resource_name is None:
@@ -164,16 +153,11 @@ class AWSAccess:
 
     def get_account_id(self):
         """
-        Get AWS account ID
+        Get AWS account ID *** HAS BEEN REMOVED ***
 
         :return: account ID
         """
-        if is_using_localstack():
-            arn = self.session.resource("iam", endpoint_url=self._get_localstack_endpoint_url()).CurrentUser().arn
-        else:
-            arn = self.session.resource("iam").CurrentUser().arn
-        log.info("current user {arn=}")
-        return arn.split(":")[4]
+        raise NotImplementedError(".get_account_id() has been removed")
 
     def test(self) -> bool:
         """

awsimple/s3.py

@@ -13,10 +13,11 @@ from typing import Dict, List, Union
 import json
 from logging import getLogger
 
+import boto3
+from botocore.client import Config
 from botocore.exceptions import ClientError, EndpointConnectionError, ConnectionClosedError, SSLError
 from boto3.s3.transfer import TransferConfig
 from s3transfer import S3UploadFailedError
-import urllib3
 import urllib3.exceptions
 from typeguard import typechecked
 from hashy import get_string_sha512, get_file_sha512, get_bytes_sha512, get_dls_sha512  # type: ignore
@@ -31,6 +32,8 @@ json_extension = ".json"
 
 log = getLogger(__application_name__)
 
+connection_errors = (S3UploadFailedError, ClientError, EndpointConnectionError, SSLError, urllib3.exceptions.ProtocolError, ConnectionClosedError)
+
 
 class BucketNotFound(AWSimpleException):
     def __init__(self, bucket_name):
@@ -230,7 +233,7 @@ class S3Access(CacheAccess):
                 try:
                     self.client.upload_file(str(file_path), self.bucket_name, s3_key, ExtraArgs=extra_args, Config=self.get_s3_transfer_config())
                     uploaded_flag = True
-                except (S3UploadFailedError, ClientError, EndpointConnectionError, SSLError, urllib3.exceptions.ProtocolError) as e:
+                except connection_errors as e:
                     log.warning(f"{file_path} to {self.bucket_name}:{s3_key} : {transfer_retry_count=} : {e}")
                     time.sleep(self.retry_sleep_time)
                 except RuntimeError as e:
@@ -282,7 +285,7 @@ class S3Access(CacheAccess):
                     else:
                         s3_object.put(Body=json_as_bytes, Metadata=meta_data)
                     uploaded_flag = True
-                except (S3UploadFailedError, ClientError, EndpointConnectionError, SSLError, urllib3.exceptions.ProtocolError) as e:
+                except connection_errors as e:
                     log.warning(f"{self.bucket_name}:{s3_key} : {transfer_retry_count=} : {e}")
                     transfer_retry_count += 1
                     time.sleep(self.retry_sleep_time)
@@ -298,17 +301,18 @@ class S3Access(CacheAccess):
         Download an S3 object
 
         :param s3_key: S3 key
-        :param dest_path: destination file path
+        :param dest_path: destination file or directory path. If the path is a directory, the file will be downloaded to that directory with the same name as the S3 key.
         :return: True if downloaded successfully
         """
 
         if isinstance(dest_path, str):
             log.info(f"{dest_path} is not Path object.  Non-Path objects will be deprecated in the future")
 
-        if isinstance(dest_path, Path):
-            dest_path = str(dest_path)
+        assert isinstance(dest_path, Path)
+        if dest_path.is_dir():
+            dest_path = Path(dest_path, s3_key)
 
-        log.info(f'S3 download : {self.bucket_name}/{s3_key} to "{dest_path}" ({Path(dest_path).absolute()})')
+        log.info(f'S3 download : {self.bucket_name}:{s3_key} to "{dest_path}" ("{Path(dest_path).absolute()}")')
 
         Path(dest_path).parent.mkdir(parents=True, exist_ok=True)
 
@@ -324,7 +328,7 @@ class S3Access(CacheAccess):
                 mtime_ts = s3_object_metadata.mtime.timestamp()
                 os.utime(dest_path, (mtime_ts, mtime_ts))  # set the file mtime to the mtime in S3
                 success = True
-            except (ClientError, EndpointConnectionError, SSLError, ConnectionClosedError, urllib3.exceptions.ProtocolError) as e:
+            except connection_errors as e:
                 # ProtocolError can happen for a broken connection
                 log.warning(f"{self.bucket_name}/{s3_key} to {dest_path} ({Path(dest_path).absolute()}) : {transfer_retry_count=} : {e}")
                 time.sleep(self.retry_sleep_time)
@@ -337,11 +341,15 @@ class S3Access(CacheAccess):
         """
         download from AWS S3 with caching
 
-        :param dest_path: destination full path
+        :param dest_path: destination full path or directory. If the path is a directory, the file will be downloaded to that directory with the same name as the S3 key.
         :param s3_key: S3 key of source
         :return: S3DownloadStatus instance
         """
 
+        if dest_path.is_dir():
+            dest_path = Path(dest_path, s3_key)
+        log.info(f'S3 download_cached : {self.bucket_name}:{s3_key} to "{dest_path}" ("{dest_path.absolute()}")')
+
         self.download_status = S3DownloadStatus()  # init
 
         s3_object_metadata = self.get_s3_object_metadata(s3_key)
@@ -382,7 +390,6 @@ class S3Access(CacheAccess):
         """
         download object from AWS S3 with caching
 
-        :param dest_path: destination full path
         :param s3_key: S3 key of source
         :return: S3DownloadStatus instance
         """
@@ -467,7 +474,6 @@ class S3Access(CacheAccess):
         """
         determine if an s3 object exists
 
-        :param s3_bucket: the S3 bucket
         :param s3_key: the S3 object key
         :return: True if object exists
         """
@@ -485,8 +491,13 @@ class S3Access(CacheAccess):
 
         :return: True if bucket exists
         """
+
+        # use a "custom" config so that .head_bucket() doesn't take a really long time if the bucket does not exist
+        config = Config(connect_timeout=5, retries={"max_attempts": 3, "mode": "standard"})
+        s3 = boto3.client("s3", config=config)
+        assert self.bucket_name is not None
         try:
-            self.client.head_bucket(Bucket=self.bucket_name)
+            s3.head_bucket(Bucket=self.bucket_name)
             exists = True
         except ClientError as e:
             log.info(f"{self.bucket_name=}{e=}")

{awsimple-3.2.0.dist-info → awsimple-3.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: awsimple
-Version: 3.2.0
+Version: 3.4.0
 Summary: Simple AWS API for S3, DynamoDB, SNS, and SQS
 Home-page: https://github.com/jamesabel/awsimple
 Download-URL: https://github.com/jamesabel/awsimple
@@ -14,8 +14,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: LICENSE.txt
 Requires-Dist: boto3
-Requires-Dist: typeguard <3
-Requires-Dist: hashy >=0.1.1
+Requires-Dist: typeguard<3
+Requires-Dist: hashy>=0.1.1
 Requires-Dist: dictim
 Requires-Dist: appdirs
 Requires-Dist: tobool
@@ -135,6 +135,8 @@ to test for file equivalency.
 S3 objects and DynamoDB tables can be cached locally to reduce network traffic, minimize AWS costs, 
 and potentially offer a speedup.
 
+DynamoDB cached table scans are particularly useful for tables that are infrequently updated.
+
 ## What`awsimple` Is Not
 
 - `awsimple` is not necessarily the most memory and CPU efficient
@@ -143,6 +145,11 @@ and potentially offer a speedup.
 
 - `awsimple` does not provide all the options and features that the regular AWS API (e.g. boto3) does
 
+## Updates/Releases
+
+3.x.x - Cache life for cached DynamoDB scans is now based on most recent table modification time (kept in a separate 
+table). Explict cache life is no longer required (parameter has been removed).
+
 ## Testing using moto mock and localstack
 
 moto mock-ing can improve performance and reduce AWS costs.  `awsimple` supports both moto mock and localstack.

{awsimple-3.2.0.dist-info → awsimple-3.4.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
 awsimple/__init__.py,sha256=8aFfqWFAvRPweoZkKncvHAW2ytTW_5-AJ0nnmYqgUBw,916
-awsimple/__version__.py,sha256=d_wZxTTKvX8oZU2t00iF1rXmYcATj1co9ManOJHyFGg,323
-awsimple/aws.py,sha256=eL7wyLUYvP5IXMfmXMLU4ggCarr_DqhRYxHT-2RNfO0,8381
+awsimple/__version__.py,sha256=QeAaw-gHVlOTWxX7VxuppELAYFtQHcjChg8cH2N11_Q,323
+awsimple/aws.py,sha256=n5Mte2l0uUyLtxHx-Cv2RdVF2H2pvNiQPlrwrwddKcc,7636
 awsimple/cache.py,sha256=tdLeMw2IYW9Y4lGT2SAGUI7u_aTX_TFQs2udXcqW6fI,7163
 awsimple/dynamodb.py,sha256=xVPnRdedm19ORpmC1G0fMaQMnf9D72Ebq2lXKSLgtmc,39076
 awsimple/dynamodb_miv.py,sha256=4xPxQDYkIM-BVDGyAre6uqwJHsxguEbHbof8ztt-V7g,4645
 awsimple/logs.py,sha256=A2RmTT90pfFTthfENd7GSsEHSIBJXO8ICHPdA7sEsHY,4278
 awsimple/mock.py,sha256=eScbnxFF9xAosOAsL-NZgp_P-fezB6StQMkb85Y3TNo,574
 awsimple/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-awsimple/s3.py,sha256=_HoUhpmh3M4SfY_677kGjjo6CGjnY80-PwCzTrHImAw,23256
+awsimple/s3.py,sha256=lwMS8Xr06TB2LkQ7z8yaK6pnH9oOFU3-DEI3Ba6dEwo,23874
 awsimple/sns.py,sha256=dOx3VUS04xxeG1krGudN4A5fqoIpXeHqXNkBvfbr_6Q,3292
 awsimple/sqs.py,sha256=ejV9twP15X8-mZ9IHGEUlYWqufEcasYuPf1xlGQt2a8,15506
-awsimple-3.2.0.dist-info/LICENSE,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-3.2.0.dist-info/LICENSE.txt,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-3.2.0.dist-info/METADATA,sha256=mQye_Gs_b08WScaVCM5NCa9B2-c4WKmBSYmSOHRtOpk,5768
-awsimple-3.2.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-awsimple-3.2.0.dist-info/top_level.txt,sha256=mwqCoH_8vAaK6iYioiRbasXmVCQM7AK3grNWOKp2VHE,9
-awsimple-3.2.0.dist-info/RECORD,,
+awsimple-3.4.0.dist-info/LICENSE,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
+awsimple-3.4.0.dist-info/LICENSE.txt,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
+awsimple-3.4.0.dist-info/METADATA,sha256=nNYscDeRiwPL6X9UU36J7foOlyC9oiKUawl8VLdimGw,6087
+awsimple-3.4.0.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+awsimple-3.4.0.dist-info/top_level.txt,sha256=mwqCoH_8vAaK6iYioiRbasXmVCQM7AK3grNWOKp2VHE,9
+awsimple-3.4.0.dist-info/RECORD,,

{awsimple-3.2.0.dist-info → awsimple-3.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py3-none-any