boto3-assist 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

boto3_assist/connection_tracker.py

@@ -4,6 +4,9 @@ Maintainers: Eric Wilson
 MIT License.  See Project Root for the license information.
 """
 
+import traceback
+import os
+
 
 class ConnectionTracker:
     """
@@ -12,23 +15,45 @@ class ConnectionTracker:
     """
 
     def __init__(self, service_name: str) -> None:
+        self.__stack_trace_env_var: str = "ISSUE_STACK_TRACE"
         self.__connection_couter: int = 0
         self.__service_name: str = service_name
+        self.__issue_stack_trace: bool = (
+            os.getenv(f"{self.__stack_trace_env_var}", "false") == "true"
+        )
 
     def increment_connection(self) -> None:
         """Increments the connection counter"""
         self.__connection_couter += 1
 
         if self.connection_count > 1:
+            service_message = ""
+            stack_trace_message = ""
+            if self.__service_name:
+                service_message = f"Your {self.__service_name} service has more than one connection.\n"
+
+            if not self.__issue_stack_trace:
+                stack_trace_message = (
+                    f"\nTo add addtional information to the log and determine where additional connections are being created"
+                    f", set the environment variable {self.__stack_trace_env_var} to true.\n"
+                )
             self.__log_warning(
+                f"{service_message}"
                 f"Your dynamodb connection count is {self.connection_count}. "
                 "Under most circumstances you should be able to use the same connection "
                 "vs. creating a new one.  Connections are expensive in terms of time / latency. "
                 "If you are seeing perforance issues, check how and where you are creating your "
                 "connections.  You should be able to pass the .db connection to your other objects "
                 "and reuse your dynamodb boto connections."
+                f"{stack_trace_message}"
             )
 
+            # do a stack trace
+            if self.__issue_stack_trace:
+                print("Stack Trace")
+                traceback.print_stack()
+                print("")
+
     def decrement_connection(self) -> None:
         """Decrements the connection counter"""
         self.__connection_couter -= 1

boto3_assist/dynamodb/dynamodb_importer.py

@@ -38,9 +38,11 @@ class DynamoDBImporter:
             raise FileNotFoundError(f"File not found: {json_file_path}")
         if json_file_path.endswith(".gz"):
             data = self.read_gzip_file(json_file_path)
-        else:
+        elif json_file_path.endswith(".json"):
             with open(json_file_path, "r", encoding="utf-8") as json_file:
                 data = json.load(json_file)
+        else:
+            raise ValueError(f"Unsupported file type: {json_file_path}")
 
         # table = self.db.dynamodb_resource.Table(self.table_name)
         # with table.batch_writer() as batch:
@@ -58,7 +60,22 @@ class DynamoDBImporter:
     def import_json_files(self, json_file_paths: list[str]) -> None:
         """Import multiple json files into the database"""
         for json_file_path in json_file_paths:
-            self.import_json_file(json_file_path)
+            if os.path.exists(json_file_path) is False:
+                raise FileNotFoundError(f"File not found: {json_file_path}")
+            else:
+                if json_file_path.endswith(".gz") or json_file_path.endswith(".json"):
+                    self.import_json_file(json_file_path)
+                else:
+                    if os.path.isdir(json_file_path):
+                        logger.warning(
+                            f"Unsupported sub directory import {json_file_path}. "
+                            "Skipping import on this file."
+                        )
+                    else:
+                        logger.warning(
+                            f"Unsupported file type: {json_file_path}. "
+                            "Skipping import on this file.  Files should end with .gz or .json"
+                        )
 
     def read_gzip_file(self, file_path: str) -> List[dict]:
         """

boto3_assist/dynamodb/dynamodb_model_base.py

@@ -18,6 +18,7 @@ from boto3_assist.dynamodb.dynamodb_index import (
     DynamoDBIndexes,
     DynamoDBIndex,
 )
+from boto3_assist.dynamodb.dynamodb_reserved_words import DynamoDBReservedWords
 
 
 def exclude_from_serialization(method):
@@ -41,11 +42,13 @@ class DynamoDBModelBase:
 
     T = TypeVar("T", bound="DynamoDBModelBase")
 
-    def __init__(self) -> None:
+    def __init__(self, auto_generate_projections: bool = True) -> None:
         self.__projection_expression: str | None = None
         self.__projection_expression_attribute_names: dict | None = None
         self.__helpers: DynamoDBHelpers | None = None
         self.__indexes: DynamoDBIndexes | None = None
+        self.__reserved_words: DynamoDBReservedWords = DynamoDBReservedWords()
+        self.auto_generate_projections: bool = auto_generate_projections
 
     @property
     @exclude_from_serialization
@@ -61,6 +64,14 @@ class DynamoDBModelBase:
     @exclude_from_serialization
     def projection_expression(self) -> str | None:
         """Gets the projection expression"""
+        if self.__projection_expression is None and self.auto_generate_projections:
+            props = self.to_dictionary()
+            # turn props to a list[str]
+            prop_list = list(props.keys())
+
+            transformed_list = self.__reserved_words.tranform_projections(prop_list)
+            self.projection_expression = ",".join(transformed_list)
+
         return self.__projection_expression
 
     @projection_expression.setter
@@ -70,7 +81,21 @@ class DynamoDBModelBase:
     @property
     @exclude_from_serialization
     def projection_expression_attribute_names(self) -> dict | None:
-        """Gets the projection expression attribute names"""
+        """
+        Gets the projection expression attribute names
+
+        """
+        if (
+            self.__projection_expression_attribute_names is None
+            and self.auto_generate_projections
+        ):
+            props = self.to_dictionary()
+            # turn props to a list[str]
+            prop_list = list(props.keys())
+            self.projection_expression_attribute_names = (
+                self.__reserved_words.transform_attributes(prop_list)
+            )
+
         return self.__projection_expression_attribute_names
 
     @projection_expression_attribute_names.setter

boto3_assist/dynamodb/dynamodb_reserved_words.py

@@ -0,0 +1,45 @@
+import os
+from typing import List
+
+
+class DynamoDBReservedWords:
+    """Reserved Word"""
+
+    def __init__(self) -> None:
+        self.__list: List[str] = self.__read_list()
+
+    def words(self) -> List[str]:
+        """Gets a list of dynamodb reserved words"""
+        return self.__list
+
+    def __read_list(self) -> List[str]:
+        path = os.path.dirname(__file__)
+        path = os.path.join(path, "dynamodb_reserved_words.txt")
+        with open(path, "r", encoding="utf-8") as f:
+            words = f.read().splitlines()
+            # make sure they are all in uppercase
+            for i, word in enumerate(words):
+                words[i] = word.upper()
+            return words
+
+    def is_reserved_word(self, word: str) -> bool:
+        """Checks if a word is a dynamodb reserved word"""
+        return word.upper() in self.__list
+
+    def tranform_projections(self, projections: List[str] | str) -> List[str]:
+        """Transforms a list of projections to remove reserved words"""
+        if isinstance(projections, str):
+            projections = projections.split(",")
+
+        # any project that exists add a # infront of it
+        projections = ["#" + p if self.is_reserved_word(p) else p for p in projections]
+        return projections
+
+    def transform_attributes(self, attributes: dict) -> dict:
+        """Transforms a dict of attributes to remove reserved words"""
+        transformed_attributes: dict | None = {}
+        for k, v in attributes.items():
+            if self.is_reserved_word(k):
+                transformed_attributes["#" + k] = v
+
+        return transformed_attributes

boto3_assist/dynamodb/dynamodb_reserved_words.txt

@@ -0,0 +1,574 @@
+
+ABORT
+ABSOLUTE
+ACTION
+ADD
+AFTER
+AGENT
+AGGREGATE
+ALL
+ALLOCATE
+ALTER
+ANALYZE
+AND
+ANY
+ARCHIVE
+ARE
+ARRAY
+AS
+ASC
+ASCII
+ASENSITIVE
+ASSERTION
+ASYMMETRIC
+AT
+ATOMIC
+ATTACH
+ATTRIBUTE
+AUTH
+AUTHORIZATION
+AUTHORIZE
+AUTO
+AVG
+BACK
+BACKUP
+BASE
+BATCH
+BEFORE
+BEGIN
+BETWEEN
+BIGINT
+BINARY
+BIT
+BLOB
+BLOCK
+BOOLEAN
+BOTH
+BREADTH
+BUCKET
+BULK
+BY
+BYTE
+CALL
+CALLED
+CALLING
+CAPACITY
+CASCADE
+CASCADED
+CASE
+CAST
+CATALOG
+CHAR
+CHARACTER
+CHECK
+CLASS
+CLOB
+CLOSE
+CLUSTER
+CLUSTERED
+CLUSTERING
+CLUSTERS
+COALESCE
+COLLATE
+COLLATION
+COLLECTION
+COLUMN
+COLUMNS
+COMBINE
+COMMENT
+COMMIT
+COMPACT
+COMPILE
+COMPRESS
+CONDITION
+CONFLICT
+CONNECT
+CONNECTION
+CONSISTENCY
+CONSISTENT
+CONSTRAINT
+CONSTRAINTS
+CONSTRUCTOR
+CONSUMED
+CONTINUE
+CONVERT
+COPY
+CORRESPONDING
+COUNT
+COUNTER
+CREATE
+CROSS
+CUBE
+CURRENT
+CURSOR
+CYCLE
+DATA
+DATABASE
+DATE
+DATETIME
+DAY
+DEALLOCATE
+DEC
+DECIMAL
+DECLARE
+DEFAULT
+DEFERRABLE
+DEFERRED
+DEFINE
+DEFINED
+DEFINITION
+DELETE
+DELIMITED
+DEPTH
+DEREF
+DESC
+DESCRIBE
+DESCRIPTOR
+DETACH
+DETERMINISTIC
+DIAGNOSTICS
+DIRECTORIES
+DISABLE
+DISCONNECT
+DISTINCT
+DISTRIBUTE
+DO
+DOMAIN
+DOUBLE
+DROP
+DUMP
+DURATION
+DYNAMIC
+EACH
+ELEMENT
+ELSE
+ELSEIF
+EMPTY
+ENABLE
+END
+EQUAL
+EQUALS
+ERROR
+ESCAPE
+ESCAPED
+EVAL
+EVALUATE
+EXCEEDED
+EXCEPT
+EXCEPTION
+EXCEPTIONS
+EXCLUSIVE
+EXEC
+EXECUTE
+EXISTS
+EXIT
+EXPLAIN
+EXPLODE
+EXPORT
+EXPRESSION
+EXTENDED
+EXTERNAL
+EXTRACT
+FAIL
+FALSE
+FAMILY
+FETCH
+FIELDS
+FILE
+FILTER
+FILTERING
+FINAL
+FINISH
+FIRST
+FIXED
+FLATTERN
+FLOAT
+FOR
+FORCE
+FOREIGN
+FORMAT
+FORWARD
+FOUND
+FREE
+FROM
+FULL
+FUNCTION
+FUNCTIONS
+GENERAL
+GENERATE
+GET
+GLOB
+GLOBAL
+GO
+GOTO
+GRANT
+GREATER
+GROUP
+GROUPING
+HANDLER
+HASH
+HAVE
+HAVING
+HEAP
+HIDDEN
+HOLD
+HOUR
+IDENTIFIED
+IDENTITY
+IF
+IGNORE
+IMMEDIATE
+IMPORT
+IN
+INCLUDING
+INCLUSIVE
+INCREMENT
+INCREMENTAL
+INDEX
+INDEXED
+INDEXES
+INDICATOR
+INFINITE
+INITIALLY
+INLINE
+INNER
+INNTER
+INOUT
+INPUT
+INSENSITIVE
+INSERT
+INSTEAD
+INT
+INTEGER
+INTERSECT
+INTERVAL
+INTO
+INVALIDATE
+IS
+ISOLATION
+ITEM
+ITEMS
+ITERATE
+JOIN
+KEY
+KEYS
+LAG
+LANGUAGE
+LARGE
+LAST
+LATERAL
+LEAD
+LEADING
+LEAVE
+LEFT
+LENGTH
+LESS
+LEVEL
+LIKE
+LIMIT
+LIMITED
+LINES
+LIST
+LOAD
+LOCAL
+LOCALTIME
+LOCALTIMESTAMP
+LOCATION
+LOCATOR
+LOCK
+LOCKS
+LOG
+LOGED
+LONG
+LOOP
+LOWER
+MAP
+MATCH
+MATERIALIZED
+MAX
+MAXLEN
+MEMBER
+MERGE
+METHOD
+METRICS
+MIN
+MINUS
+MINUTE
+MISSING
+MOD
+MODE
+MODIFIES
+MODIFY
+MODULE
+MONTH
+MULTI
+MULTISET
+NAME
+NAMES
+NATIONAL
+NATURAL
+NCHAR
+NCLOB
+NEW
+NEXT
+NO
+NONE
+NOT
+NULL
+NULLIF
+NUMBER
+NUMERIC
+OBJECT
+OF
+OFFLINE
+OFFSET
+OLD
+ON
+ONLINE
+ONLY
+OPAQUE
+OPEN
+OPERATOR
+OPTION
+OR
+ORDER
+ORDINALITY
+OTHER
+OTHERS
+OUT
+OUTER
+OUTPUT
+OVER
+OVERLAPS
+OVERRIDE
+OWNER
+PAD
+PARALLEL
+PARAMETER
+PARAMETERS
+PARTIAL
+PARTITION
+PARTITIONED
+PARTITIONS
+PATH
+PERCENT
+PERCENTILE
+PERMISSION
+PERMISSIONS
+PIPE
+PIPELINED
+PLAN
+POOL
+POSITION
+PRECISION
+PREPARE
+PRESERVE
+PRIMARY
+PRIOR
+PRIVATE
+PRIVILEGES
+PROCEDURE
+PROCESSED
+PROJECT
+PROJECTION
+PROPERTY
+PROVISIONING
+PUBLIC
+PUT
+QUERY
+QUIT
+QUORUM
+RAISE
+RANDOM
+RANGE
+RANK
+RAW
+READ
+READS
+REAL
+REBUILD
+RECORD
+RECURSIVE
+REDUCE
+REF
+REFERENCE
+REFERENCES
+REFERENCING
+REGEXP
+REGION
+REINDEX
+RELATIVE
+RELEASE
+REMAINDER
+RENAME
+REPEAT
+REPLACE
+REQUEST
+RESET
+RESIGNAL
+RESOURCE
+RESPONSE
+RESTORE
+RESTRICT
+RESULT
+RETURN
+RETURNING
+RETURNS
+REVERSE
+REVOKE
+RIGHT
+ROLE
+ROLES
+ROLLBACK
+ROLLUP
+ROUTINE
+ROW
+ROWS
+RULE
+RULES
+SAMPLE
+SATISFIES
+SAVE
+SAVEPOINT
+SCAN
+SCHEMA
+SCOPE
+SCROLL
+SEARCH
+SECOND
+SECTION
+SEGMENT
+SEGMENTS
+SELECT
+SELF
+SEMI
+SENSITIVE
+SEPARATE
+SEQUENCE
+SERIALIZABLE
+SESSION
+SET
+SETS
+SHARD
+SHARE
+SHARED
+SHORT
+SHOW
+SIGNAL
+SIMILAR
+SIZE
+SKEWED
+SMALLINT
+SNAPSHOT
+SOME
+SOURCE
+SPACE
+SPACES
+SPARSE
+SPECIFIC
+SPECIFICTYPE
+SPLIT
+SQL
+SQLCODE
+SQLERROR
+SQLEXCEPTION
+SQLSTATE
+SQLWARNING
+START
+STATE
+STATIC
+STATUS
+STORAGE
+STORE
+STORED
+STREAM
+STRING
+STRUCT
+STYLE
+SUB
+SUBMULTISET
+SUBPARTITION
+SUBSTRING
+SUBTYPE
+SUM
+SUPER
+SYMMETRIC
+SYNONYM
+SYSTEM
+TABLE
+TABLESAMPLE
+TEMP
+TEMPORARY
+TERMINATED
+TEXT
+THAN
+THEN
+THROUGHPUT
+TIME
+TIMESTAMP
+TIMEZONE
+TINYINT
+TO
+TOKEN
+TOTAL
+TOUCH
+TRAILING
+TRANSACTION
+TRANSFORM
+TRANSLATE
+TRANSLATION
+TREAT
+TRIGGER
+TRIM
+TRUE
+TRUNCATE
+TTL
+TUPLE
+TYPE
+UNDER
+UNDO
+UNION
+UNIQUE
+UNIT
+UNKNOWN
+UNLOGGED
+UNNEST
+UNPROCESSED
+UNSIGNED
+UNTIL
+UPDATE
+UPPER
+URL
+USAGE
+USE
+USER
+USERS
+USING
+UUID
+VACUUM
+VALUE
+VALUED
+VALUES
+VARCHAR
+VARIABLE
+VARIANCE
+VARINT
+VARYING
+VIEW
+VIEWS
+VIRTUAL
+VOID
+WAIT
+WHEN
+WHENEVER
+WHERE
+WHILE
+WINDOW
+WITH
+WITHIN
+WITHOUT
+WORK
+WRAPPED
+WRITE
+YEAR
+ZONE 

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.1.4'
+__version__ = '0.1.6'

{boto3_assist-0.1.4.dist-info → boto3_assist-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3_assist
-Version: 0.1.4
+Version: 0.1.6
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 License-File: LICENSE-EXPLAINED.txt

{boto3_assist-0.1.4.dist-info → boto3_assist-0.1.6.dist-info}/RECORD

@@ -1,18 +1,20 @@
 boto3_assist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/boto3session.py,sha256=J20E2lkqJOaey4Ohi-xRe2xABj7QsA8DrggzK29-5es,6415
-boto3_assist/connection_tracker.py,sha256=k59-7CdEvo5Slab80wwYz65sE1-sxVP1-wpQhZZXBZo,1632
-boto3_assist/version.py,sha256=aBEbDvx4LMg8A1TJJR6dEHu8rQODVin528hLS_EDvuA,22
+boto3_assist/connection_tracker.py,sha256=WYRdDSozJlxbFY_oYQAlGRpDgFWsF_nAiN7CIzh_yVo,2637
+boto3_assist/version.py,sha256=gW5NUxwGdPsiQjn0cOuuQT11pfthByI5DITDg_HMhLQ,22
 boto3_assist/dynamodb/dynamodb.py,sha256=vV0HvFCESnVK6BcAfcrWsMsNxIIsctvDX_3xdzOVCT0,14623
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=JMCmWOsMzy45rikGl3Z2xqlG2vUTEKSYqi6dpsfJ750,4418
 boto3_assist/dynamodb/dynamodb_connection_tracker.py,sha256=nTNQ99sIidDoLMhMbBju2umgLmcttsmnvmd_DMy_J9M,1582
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=ajpTJ5bJOm9PDgE2Zx9p2zkTRFV4xswqJRS81SOTn1s,12198
-boto3_assist/dynamodb/dynamodb_importer.py,sha256=8SlT2W03Dvb3LIs6xqtzXP4IShyv655PgMCDNr4kmPk,2559
+boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu0hcUzZnBli610,3471
 boto3_assist/dynamodb/dynamodb_index.py,sha256=LRQgSci222s-pU-JXgnaAoOa71ABX9h3uJPeCVPl1GE,6315
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=2AuaKxt7DUZbB-GpBBtPtPMpAlgZkumkAldm8vy7-sg,701
 boto3_assist/dynamodb/dynamodb_key.py,sha256=X3I3gUPx2T858vjRDi9SN8qn8ez5UJUo0vZiKBeeUWg,1776
-boto3_assist/dynamodb/dynamodb_model_base.py,sha256=IIcqdMN1SMvaDAvN2x1j8FMUPyVp8SdH8Vai8Qr4Nfs,11308
+boto3_assist/dynamodb/dynamodb_model_base.py,sha256=oFO5xRjLy8bDK7CFUFhAdPCQNTgVF7ffSTFUuCg6qRw,12366
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=yT4zDRI8vP15WVOHnCvY3FsEy_QSIta5-bnUby70Xow,747
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=_I-W7Ply-82fRHnhsRZuquRYxEIXubuWGq7E7B4Pa7I,6204
+boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=rXLNJrvdBxqir8HC0AZ15P8eQKiRYvQoF8ZeGQetMYY,1614
+boto3_assist/dynamodb/dynamodb_reserved_words.txt,sha256=CanugFPh7rpgJ_jH9k4t8ANycrZJWTjT09sWiW4LC68,4137
 boto3_assist/dynamodb/readme.md,sha256=wNMzdRwk0qRV0kE88UUYnJos3pEK0HNjEIVkq2PATf8,1490
 boto3_assist/dynamodb/troubleshooting.md,sha256=uGpBaBUt_MyzjzwFOLOe0udTgcvaOpiTFxfj7ilLNkM,136
 boto3_assist/ec2/ec2_connection.py,sha256=KN1AivKY6yYpx_AjmaA3aQUZtUwKIvWk4FO8OPq1aTY,3182
@@ -23,8 +25,8 @@ boto3_assist/utilities/datetime_utility.py,sha256=TbqGQkJDTahqvaZAIV550nhYnW1Bsq
 boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/utilities/serialization_utility.py,sha256=s_QQRIhtwIE7xN5nU13mNk2wtWyErBX_Sg7n0gbHj-M,4308
 boto3_assist/utilities/string_utility.py,sha256=w8l063UT3GE48tuJopETyZrjG4CgAzWkyDWMAYMg5Og,7432
-boto3_assist-0.1.4.dist-info/METADATA,sha256=m0RXVLD_x6l3VwV3g_EaXvmpwnXfJgDVQNvbrfG0N3M,1804
-boto3_assist-0.1.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-boto3_assist-0.1.4.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.1.4.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.1.4.dist-info/RECORD,,
+boto3_assist-0.1.6.dist-info/METADATA,sha256=F1oXRaLZiWtSBnd6aVv72rh_i7GvGqyrPdv9luI5KvY,1804
+boto3_assist-0.1.6.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+boto3_assist-0.1.6.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.1.6.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.1.6.dist-info/RECORD,,