awsimple 4.2.0__py3-none-any.whl → 6.0.0__py3-none-any.whl

awsimple/__init__.py

@@ -9,5 +9,5 @@ from .dynamodb_miv import DynamoDBMIVUI, miv_string, get_time_us, miv_us_to_time
 from .s3 import S3Access, S3DownloadStatus, S3ObjectMetadata, BucketNotFound
 from .sqs import SQSAccess, SQSPollAccess, aws_sqs_long_poll_max_wait_time, aws_sqs_max_messages, get_all_sqs_queues
 from .sns import SNSAccess
-from .pubsub import PubSub
+from .pubsub import Pub, Sub
 from .logs import LogsAccess

awsimple/__version__.py

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

awsimple/pubsub.py

@@ -6,14 +6,15 @@ import time
 from functools import lru_cache
 from typing import Any, Dict, List, Callable, Union
 from datetime import timedelta
-from multiprocessing import Process, Queue, Event
-from threading import Thread
+from threading import Thread, Event
+from queue import Queue
 from queue import Empty
 from logging import Logger
 import json
 
 from typeguard import typechecked
 from botocore.exceptions import ClientError
+import strif
 
 from .sns import SNSAccess
 from .sqs import SQSPollAccess, get_all_sqs_queues
@@ -25,7 +26,9 @@ log = Logger(__application_name__)
 
 queue_timeout = timedelta(days=30).total_seconds()
 
-sqs_name = "sqs"
+SQS_NAME = "sqs"
+
+AWS_RESOURCE_PREFIX = "ps"  # for pubsub
 
 
 @typechecked()
@@ -41,7 +44,7 @@ def remove_old_queues(
         return removed
     for sqs_queue_name in get_all_sqs_queues(channel):
         sqs_metadata = _DynamoDBMetadataTable(
-            sqs_name, sqs_queue_name, profile_name=profile_name, aws_access_key_id=aws_access_key_id, aws_secret_access_key=aws_secret_access_key, region_name=region_name
+            SQS_NAME, sqs_queue_name, profile_name=profile_name, aws_access_key_id=aws_access_key_id, aws_secret_access_key=aws_secret_access_key, region_name=region_name
         )
         mtime = sqs_metadata.get_table_mtime_f()
         if mtime is not None and time.time() - mtime > queue_timeout:
@@ -100,52 +103,56 @@ def _connect_sns_to_sqs(sqs: SQSPollAccess, sns: SNSAccess) -> None:
 
 class _SubscriptionThread(Thread):
     """
-    Thread to poll SQS for new messages and put them in a queue for the parent process to read.
+    Thread to poll SQS for new messages and put them in a queue for the parent thread to read.
     """
 
     @typechecked()
     def __init__(self, sqs: SQSPollAccess, new_event) -> None:
         super().__init__()
         self._sqs = sqs
-        self.new_event = new_event
         self.sub_queue = Queue()  # type: Queue[str]
+        self._exit_event = Event()
+        self._new_event = new_event
 
     def run(self):
-        # exit by terminating the parent process
-        while True:
+        while not self._exit_event.is_set():
             messages = self._sqs.receive_messages()  # long poll
             for message in messages:
                 message = json.loads(message.message)
                 self.sub_queue.put(message["Message"])
-                self.new_event.set()  # notify parent process that a new message is available
+                self._new_event.set()
+
+    def request_exit(self):
+        self._exit_event.set()
 
 
 @lru_cache
-def make_name_aws_safe(name: str) -> str:
+def make_name_aws_safe(*args: str) -> str:
     """
-    Make a name safe for an SQS queue to subscribe to an SNS topic.
+    Make a name safe for an SQS queue to subscribe to an SNS topic. This ensures we adhere to name restrictions such as acceptable characters and length.
 
-    :param name: input name
+    :params: input name(s)
     :return: AWS safe name
     """
-    safe_name = "".join([c for c in name.strip().lower() if c.isalnum()])  # only allow alphanumeric characters
-    if len(safe_name) < 1:
-        raise ValueError(f'"{name}" is not valid after making AWS safe - result must contain at least one alphanumeric character.')
-    return safe_name
 
+    base36 = strif.hash_string("".join(args)).base36
+    assert len(base36) == 31
+    return base36
 
-class PubSub(Process):
+
+class _PubSub(Thread):
 
     @typechecked()
     def __init__(
         self,
         channel: str,
-        node_name: str = get_node_name(),
-        sub_callback: Callable | 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,
+        node_name: str,
+        sub_callback: Callable | None,
+        use_sub_queue: bool,
+        profile_name: Union[str, None],
+        aws_access_key_id: Union[str, None],
+        aws_secret_access_key: Union[str, None],
+        region_name: Union[str, None],
     ) -> None:
         """
         Pub and Sub.
@@ -154,11 +161,13 @@ class PubSub(Process):
         :param channel: Channel name (used for SNS topic name). This must not be a prefix of other channel names to avoid collisions (don't name one channel "a" and another "ab").
         :param node_name: Node name (SQS queue name suffix). Defaults to a combination of computer name and username, but can be passed in for customization and/or testing.
         :param sub_callback: Optional thread and process safe callback function to be called when a new message is received. The function should accept a single argument, which will be the message as a dictionary.
+        :param use_sub_queue: If True, use an internal queue to store received messages. If False, messages must be handled by the callback function. Default is False.
         """
-
-        self.channel = "ps" + make_name_aws_safe(channel)  # prefix with ps (pubsub) to avoid collisions with other uses of SNS topics and SQS queues
-        self.node_name = make_name_aws_safe(node_name)
+        self.channel = AWS_RESOURCE_PREFIX + make_name_aws_safe(channel)  # prefix with ps (pubsub) to avoid collisions with other uses of SNS topics and SQS queues
+        self.node_name = node_name
+        self.sqs_queue_name = AWS_RESOURCE_PREFIX + make_name_aws_safe(self.channel, self.node_name)
         self.sub_callback = sub_callback
+        self.use_sub_queue = use_sub_queue
 
         self.profile_name = profile_name
         self.aws_access_key_id = aws_access_key_id
@@ -168,14 +177,14 @@ class PubSub(Process):
         self._pub_queue = Queue()  # type: Queue[Dict[str, Any]]
         self._sub_queue = Queue()  # type: Queue[str]
 
-        self._new_event = Event()  # pub or sub sets this when a new message is available or has been sent
+        self._exit_event = Event()  # set this to request exit
+        self._new_event = Event()
+        self._new_event_wait_time = 10  # seconds
 
-        super().__init__()
+        super().__init__(daemon=True)  # make daemon so an instance of this thread exits when the main program exits
 
     def run(self):
 
-        sqs_queue_name = f"{self.channel}{self.node_name}"
-
         sns = SNSAccess(
             self.channel,
             auto_create=True,
@@ -184,12 +193,19 @@ class PubSub(Process):
             aws_secret_access_key=self.aws_secret_access_key,
             region_name=self.region_name,
         )
+        sns.create_topic()
+
         sqs_metadata = _DynamoDBMetadataTable(
-            sqs_name, sqs_queue_name, profile_name=self.profile_name, aws_access_key_id=self.aws_access_key_id, aws_secret_access_key=self.aws_secret_access_key, region_name=self.region_name
+            SQS_NAME,
+            self.sqs_queue_name,
+            profile_name=self.profile_name,
+            aws_access_key_id=self.aws_access_key_id,
+            aws_secret_access_key=self.aws_secret_access_key,
+            region_name=self.region_name,
         )
 
         sqs = SQSPollAccess(
-            sqs_queue_name, profile_name=self.profile_name, aws_access_key_id=self.aws_access_key_id, aws_secret_access_key=self.aws_secret_access_key, region_name=self.region_name
+            self.sqs_queue_name, profile_name=self.profile_name, aws_access_key_id=self.aws_access_key_id, aws_secret_access_key=self.aws_secret_access_key, region_name=self.region_name
         )
         if not sqs.exists():
             sqs.create_queue()
@@ -205,10 +221,14 @@ class PubSub(Process):
         sqs_metadata.update_table_mtime()  # update SQS use time (the existing infrastructure calls it a "table", but we're using it for the SQS queue)
         remove_old_queues(self.channel)  # clean up old queues
 
-        sqs_thread = _SubscriptionThread(sqs, self._new_event)
-        sqs_thread.start()
+        if self.sub_callback is None and not self.use_sub_queue:
+            # not being used as a subscriber
+            sqs_thread = None
+        else:
+            sqs_thread = _SubscriptionThread(sqs, self._new_event)
+            sqs_thread.start()
 
-        while True:
+        while not self._exit_event.is_set():
 
             # pub
             try:
@@ -219,21 +239,26 @@ class PubSub(Process):
                 pass
 
             # sub
-            try:
-                message_string = sqs_thread.sub_queue.get(False)
-                # if a callback is provided, call it, otherwise put the message in the sub queue for later retrieval
-                if self.sub_callback is None:
-                    self._sub_queue.put(message_string)
-                else:
-                    message = json.loads(message_string)
-                    self.sub_callback(message)
-                sqs_metadata.update_table_mtime()
-            except Empty:
-                pass  # no message
-
-            # this helps responsiveness
-            self._new_event.clear()
-            self._new_event.wait(3)  # race conditions can occur, so don't make this wait timeout too long
+            if sqs_thread is not None:
+                try:
+                    message_string = sqs_thread.sub_queue.get(False)
+                    if self.use_sub_queue:
+                        self._sub_queue.put(message_string)
+                    if self.sub_callback is not None:
+                        message = json.loads(message_string)
+                        self.sub_callback(message)
+                    sqs_metadata.update_table_mtime()
+                except Empty:
+                    pass  # no message
+
+            if self._new_event.wait(self._new_event_wait_time):  # timeout in case the new event technique fails
+                self._new_event.clear()
+
+        if sqs_thread is not None:
+            sqs_thread.request_exit()
+            sqs_thread.join(30)
+            if sqs_thread.is_alive():
+                log.error("sqs_thread did not exit cleanly")
 
     @typechecked()
     def publish(self, message: dict) -> None:
@@ -248,10 +273,12 @@ class PubSub(Process):
     @typechecked()
     def get_messages(self) -> List[Dict[str, Any]]:
         """
-        Get all available messages.
+        Get all available messages. Muse set sub_poll=True when creating the PubSub object to use this function.
 
         :return: list of messages as dictionaries
         """
+        if not self.use_sub_queue:
+            raise RuntimeError("use_sub_queue must be True to use get_messages()")
         messages = []
         while True:
             try:
@@ -262,3 +289,74 @@ class PubSub(Process):
             except Empty:
                 break
         return messages
+
+    def request_exit(self) -> None:
+        """
+        Request the process to exit.
+        """
+        self._exit_event.set()
+        self._new_event.set()
+
+
+class Pub(_PubSub):
+
+    @typechecked()
+    def __init__(
+        self,
+        channel: str,
+        node_name: str = get_node_name(),
+        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,
+    ) -> None:
+        """
+        Pub only.
+        Create in a separate process to offload from main thread. Also facilitates use of moto mock in tests.
+
+        :param channel: Channel name (used for SNS topic name). This must not be a prefix of other channel names to avoid collisions (don't name one channel "a" and another "ab").
+        """
+        super().__init__(
+            channel=channel,
+            node_name=node_name,
+            sub_callback=None,  # pub only
+            use_sub_queue=False,  # pub only
+            profile_name=profile_name,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            region_name=region_name,
+        )
+
+
+class Sub(_PubSub):
+
+    @typechecked()
+    def __init__(
+        self,
+        channel: str,
+        node_name: str = get_node_name(),
+        sub_callback: Callable | 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,
+    ) -> None:
+        """
+        Sub only.
+        Create in a separate process to offload from main thread. Also facilitates use of moto mock in tests.
+
+        :param channel: Channel name (used for SNS topic name). This must not be a prefix of other channel names to avoid collisions (don't name one channel "a" and another "ab").
+        :param node_name: Node name (SQS queue name suffix). Defaults to a combination of computer name and username, but can be passed in for customization and/or testing.
+        :param sub_callback: Optional callback function to be called when a new message is received. The function should accept a single argument, which will be the message as a dictionary.
+                             If this is not used, then get_messages() should be used to retrieve messages.
+        """
+        super().__init__(
+            channel=channel,
+            node_name=node_name,
+            sub_callback=sub_callback,
+            use_sub_queue=sub_callback is None,  # if no callback, use internal queue
+            profile_name=profile_name,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            region_name=region_name,
+        )

awsimple/sqs.py

@@ -230,9 +230,9 @@ class SQSAccess(AWSAccess):
                 if (queue := self._get_queue()) is None:
                     log.warning(f"could not get queue {self.queue_name}")
                 else:
-                    aws_messages = queue.receive_messages(
-                        MaxNumberOfMessages=min(max_number_of_messages, aws_sqs_max_messages), VisibilityTimeout=self.calculate_visibility_timeout(), WaitTimeSeconds=call_wait_time
-                    )
+                    visibility_timeout = self.calculate_visibility_timeout()
+                    max_number_of_messages = min(max_number_of_messages, aws_sqs_max_messages)  # AWS limit
+                    aws_messages = queue.receive_messages(MaxNumberOfMessages=max_number_of_messages, VisibilityTimeout=visibility_timeout, WaitTimeSeconds=call_wait_time)
 
                     for m in aws_messages:
                         if self.immediate_delete:

{awsimple-4.2.0.dist-info → awsimple-6.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awsimple
-Version: 4.2.0
+Version: 6.0.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
@@ -22,6 +22,7 @@ Requires-Dist: tobool
 Requires-Dist: urllib3
 Requires-Dist: python-dateutil
 Requires-Dist: yasf
+Requires-Dist: strif
 Dynamic: author
 Dynamic: author-email
 Dynamic: description

{awsimple-4.2.0.dist-info → awsimple-6.0.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-awsimple/__init__.py,sha256=RT9hATlcKnnvJYnSh7tCWEeeT2LyleL_vT1Zdz0nSkM,1051
-awsimple/__version__.py,sha256=fij2OF6RPCHAUREavC9bv6YK4lD3nxXPz58k91OHyT4,323
+awsimple/__init__.py,sha256=1uECRpVL5WHv1HPyn9sKQpEMJHwlbb7vhkEv7cuS5C4,1053
+awsimple/__version__.py,sha256=fkIKzxizC4RTJMw-JGHdn_etsHyWAnkoUeWNC-Ty-Sg,323
 awsimple/aws.py,sha256=NbRu1v_J5j2-pcefNZ5Xggii3mM9nHpeHMz9L9K9r-U,7653
 awsimple/cache.py,sha256=_LvPx76215t8KhAJOin6Pe2b4lWpB6kbKpdzgR4FeA4,7206
 awsimple/dynamodb.py,sha256=7MNxAutOCMTS4JSX-DLOwzaImJ2TzIc7kfQzQPAy5y8,41193
@@ -8,14 +8,14 @@ awsimple/exceptions.py,sha256=Ew-S8YkHVWrZFI_Yik5n0cJ7Ss4Kig5JsEPQ-9z18SU,922
 awsimple/logs.py,sha256=s9FhdDFWjfxGCVDx-FNTPgJ-YN1AOAgz4HNxTVfRARE,4108
 awsimple/mock.py,sha256=eScbnxFF9xAosOAsL-NZgp_P-fezB6StQMkb85Y3TNo,574
 awsimple/platform.py,sha256=TObvLIVgRGh-Mh4ZCxFfxAmrn8KNMHktr6XkDZX8JYE,376
-awsimple/pubsub.py,sha256=Pw5foOHtpd-tAWMRlnSYuRpa4c-fi1tMZfesizn9UDc,10143
+awsimple/pubsub.py,sha256=lsGN9HUQDh4pSVjVB0Y4T5QoiI69kIy8-m0G27PUsWU,14000
 awsimple/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 awsimple/s3.py,sha256=OhWF1uv4oLmBF5jAhKIi918iUQxx4CX8bTEvQ5wLYr8,24050
 awsimple/sns.py,sha256=T_FyN8eSmBPo213HOfB3UBlMrvtBK768IaRo_ks-7do,3526
-awsimple/sqs.py,sha256=9ZY7161CpmYpcxlCFIfW8bvMn9SGl4cgGR79I4MFLDk,17281
-awsimple-4.2.0.dist-info/licenses/LICENSE,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-4.2.0.dist-info/licenses/LICENSE.txt,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-4.2.0.dist-info/METADATA,sha256=TRNowXIo5ZYVRxy37xcGZ4o4UyIikkS1_JcjrqHGnBg,6638
-awsimple-4.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-awsimple-4.2.0.dist-info/top_level.txt,sha256=mwqCoH_8vAaK6iYioiRbasXmVCQM7AK3grNWOKp2VHE,9
-awsimple-4.2.0.dist-info/RECORD,,
+awsimple/sqs.py,sha256=nS_rD38gJObYeoXkDSg8Dv5jZTlxc79VRHFbVfmseis,17376
+awsimple-6.0.0.dist-info/licenses/LICENSE,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
+awsimple-6.0.0.dist-info/licenses/LICENSE.txt,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
+awsimple-6.0.0.dist-info/METADATA,sha256=jaIG-lKNlcttMgVSC0ZDnGAqe-CSxRbhWcmCuLtsZAU,6660
+awsimple-6.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+awsimple-6.0.0.dist-info/top_level.txt,sha256=mwqCoH_8vAaK6iYioiRbasXmVCQM7AK3grNWOKp2VHE,9
+awsimple-6.0.0.dist-info/RECORD,,