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

awsimple/__version__.py

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

awsimple/pubsub.py

@@ -3,6 +3,7 @@ pub/sub abstraction on top of AWS SNS and SQS using boto3.
 """
 
 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
@@ -119,6 +120,20 @@ class _SubscriptionThread(Thread):
                 self.new_event.set()  # notify parent process that a new message is available
 
 
+@lru_cache
+def make_name_aws_safe(name: str) -> str:
+    """
+    Make a name safe for an SQS queue to subscribe to an SNS topic.
+
+    :param name: input name
+    :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
+
+
 class PubSub(Process):
 
     @typechecked()
@@ -136,12 +151,13 @@ class PubSub(Process):
         Pub and Sub.
         Create in a separate process to offload from main thread. Also facilitates use of moto mock in tests.
 
-        :param channel: Channel name (SNS topic name).
+        :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.
         """
-        self.channel = channel.lower()  # when subscribing SQS queues to SNS topics, the names must all be lowercase (bizarre AWS "gotcha")
-        self.node_name = node_name.lower()  # e.g., computer name or user and computer name
+
+        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.sub_callback = sub_callback
 
         self.profile_name = profile_name
@@ -158,8 +174,7 @@ class PubSub(Process):
 
     def run(self):
 
-        sqs_prefix = f"{self.channel}-"
-        sqs_queue_name = f"{sqs_prefix}{self.node_name}"
+        sqs_queue_name = f"{self.channel}{self.node_name}"
 
         sns = SNSAccess(
             self.channel,
@@ -188,7 +203,7 @@ class PubSub(Process):
             _connect_sns_to_sqs(sqs, sns)
 
         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(sqs_prefix)  # clean up old queues
+        remove_old_queues(self.channel)  # clean up old queues
 
         sqs_thread = _SubscriptionThread(sqs, self._new_event)
         sqs_thread.start()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awsimple
-Version: 4.1.0
+Version: 4.2.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

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

@@ -1,5 +1,5 @@
 awsimple/__init__.py,sha256=RT9hATlcKnnvJYnSh7tCWEeeT2LyleL_vT1Zdz0nSkM,1051
-awsimple/__version__.py,sha256=_8-4yMvCFU2QJpF5V0ofTEvVAuRaDuwWi01mBIjSNkU,323
+awsimple/__version__.py,sha256=fij2OF6RPCHAUREavC9bv6YK4lD3nxXPz58k91OHyT4,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=exWZWWI9NrE36fESZprhxU5Qj9BSgK5diYKQZHBOqBs,9546
+awsimple/pubsub.py,sha256=Pw5foOHtpd-tAWMRlnSYuRpa4c-fi1tMZfesizn9UDc,10143
 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.1.0.dist-info/licenses/LICENSE,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-4.1.0.dist-info/licenses/LICENSE.txt,sha256=d956YAgtDaxgxQmccyUk__EfhORZyBjvmJ8pq6zYTxk,1093
-awsimple-4.1.0.dist-info/METADATA,sha256=AYF-IUhIYqU2zGs9K_L6J3XCq4RVzOaf2RP5lu1YRek,6638
-awsimple-4.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-awsimple-4.1.0.dist-info/top_level.txt,sha256=mwqCoH_8vAaK6iYioiRbasXmVCQM7AK3grNWOKp2VHE,9
-awsimple-4.1.0.dist-info/RECORD,,
+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,,