4028353162

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/pynamodb/PynamoDB/commit/<a class=hub.com/pynamodb/PynamoDB/commit/885ae5769b5355db4890da244c06a2660e3cd105">885ae5769<a href="https://github.com/pynamodb/PynamoDB/commit/885ae5769b5355db4890da244c06a2660e3cd105">">Merge </a><a class="double-link" href="https://github.com/pynamodb/PynamoDB/commit/<a class="double-link" href="https://github.com/pynamodb/PynamoDB/commit/266a34eb0871ad2401b483b0c5864e2ad582ee3e">266a34eb0</a>">266a34eb0</a><a href="https://github.com/pynamodb/PynamoDB/commit/885ae5769b5355db4890da244c06a2660e3cd105"> into c83578953">c83578953</a>

Pull Request Pull Request #1156: Expose transaction cancellation reasons

Run Details

22 of 26 new or added lines in 3 files covered. (84.62%)

2793 of 2939 relevant lines covered (95.03%)

3.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.59

/pynamodb/exceptions.py

"""
PynamoDB exceptions
"""
from typing import Any
from typing import Dict
from typing import Iterable
from typing import List
from typing import Optional

import botocore.exceptions


class PynamoDBException(Exception):
    msg: str

    """
    A common exception class
    """
    def __init__(self, msg: Optional[str] = None, cause: Optional[Exception] = None) -> None:
        self.msg = msg if msg is not None else self.msg
        self.cause = cause
        super(PynamoDBException, self).__init__(self.msg)

    @property
    def cause_response_code(self) -> Optional[str]:
        return getattr(self.cause, 'response', {}).get('Error', {}).get('Code')

    @property
    def cause_response_message(self) -> Optional[str]:
        return getattr(self.cause, 'response', {}).get('Error', {}).get('Message')


class PynamoDBConnectionError(PynamoDBException):
    """
    A base class for connection errors
    """
    msg = "Connection Error"


class DeleteError(PynamoDBConnectionError):
    """
    Raised when an error occurs deleting an item
    """
    msg = "Error deleting item"


class QueryError(PynamoDBConnectionError):
    """
    Raised when queries fail
    """
    msg = "Error performing query"


class ScanError(PynamoDBConnectionError):
    """
    Raised when a scan operation fails
    """
    msg = "Error performing scan"


class PutError(PynamoDBConnectionError):
    """
    Raised when an item fails to be created
    """
    msg = "Error putting item"


class UpdateError(PynamoDBConnectionError):
    """
    Raised when an item fails to be updated
    """
    msg = "Error updating item"


class GetError(PynamoDBConnectionError):
    """
    Raised when an item fails to be retrieved
    """
    msg = "Error getting item"


class TableError(PynamoDBConnectionError):
    """
    An error involving a dynamodb table operation
    """
    msg = "Error performing a table operation"


class DoesNotExist(PynamoDBException):
    """
    Raised when an item queried does not exist
    """
    msg = "Item does not exist"


class TableDoesNotExist(PynamoDBException):
    """
    Raised when an operation is attempted on a table that doesn't exist
    """
    def __init__(self, table_name: str) -> None:
        msg = "Table does not exist: `{}`".format(table_name)
        super(TableDoesNotExist, self).__init__(msg)


class CancellationReason:
    """
    A reason for a transaction cancellation.
    """
    def __init__(self, *, code: str, message: Optional[str]) -> None:
        self.code = code
        self.message = message

    def __eq__(self, other: Any) -> bool:
        return isinstance(other, CancellationReason) and self.code == other.code and self.message == other.message


class TransactWriteError(PynamoDBException):
    """
    Raised when a TransactWrite operation fails
    """

    @property
    def cancellation_reasons(self) -> List[Optional[CancellationReason]]:
        """
        When :attr:`.cause_response_code` is ``TransactionCanceledException``, this property lists
        cancellation reasons in the same order as the transaction items (one-to-one).
        Items which were not part of the reason for cancellation would have :code:`None` as the value.

        For a list of possible cancellation reasons and their semantics,
        see `TransactWriteItems`_ in the AWS documentation.

        .. _TransactWriteItems: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html
        """
        if not isinstance(self.cause, VerboseClientError):
            return []
        return self.cause.cancellation_reasons


class TransactGetError(PynamoDBException):
    """
    Raised when a TransactGet operation fails
    """
    @property
    def cancellation_reasons(self) -> List[Optional[CancellationReason]]:
        """
        When :attr:`.cause_response_code` is ``TransactionCanceledException``, this property lists
        cancellation reasons in the same order as the transaction items (one-to-one).
        Items which were not part of the reason for cancellation would have :code:`None` as the value.

        For a list of possible cancellation reasons and their semantics,
        see `TransactGetItems`_ in the AWS documentation.

        .. _TransactGetItems: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html
        """
        if not isinstance(self.cause, VerboseClientError):
            return []
        return self.cause.cancellation_reasons


class InvalidStateError(PynamoDBException):
    """
    Raises when the internal state of an operation context is invalid
    """
    msg = "Operation in invalid state"


class AttributeDeserializationError(TypeError):
    """
    Raised when attribute type is invalid
    """
    def __init__(self, attr_name: str, attr_type: str):
        msg = "Cannot deserialize '{}' attribute from type: {}".format(attr_name, attr_type)
        super(AttributeDeserializationError, self).__init__(msg)


class AttributeNullError(ValueError):
    def __init__(self, attr_name: str) -> None:
        self.attr_path = attr_name

    def __str__(self):
        return f"Attribute '{self.attr_path}' cannot be None"

    def prepend_path(self, attr_name: str) -> None:
        self.attr_path = attr_name + '.' + self.attr_path


class VerboseClientError(botocore.exceptions.ClientError):
    def __init__(
        self,
        error_response: Dict[str, Any],
        operation_name: str,
        verbose_properties: Optional[Any] = None,
        *,
        cancellation_reasons: Iterable[Optional[CancellationReason]] = (),
    ) -> None:
        """
        Like ClientError, but with a verbose message.

        :param error_response: Error response in shape expected by ClientError.
        :param operation_name: The name of the operation that failed.
        :param verbose_properties: A dict of properties to include in the verbose message.
        :param cancellation_reasons: For `TransactionCanceledException` error code,
          a list of cancellation reasons in the same order as the transaction's items (one to one).
          For items which were not a reason for the transaction cancellation, :code:`None` will be the value.
        """
        if not verbose_properties:
            verbose_properties = {}

        self.MSG_TEMPLATE = (
            'An error occurred ({{error_code}}) on request ({request_id}) '
            'on table ({table_name}) when calling the {{operation_name}} '
            'operation: {{error_message}}'
        ).format(request_id=verbose_properties.get('request_id'), table_name=verbose_properties.get('table_name'))

        self.cancellation_reasons = list(cancellation_reasons)

        super(VerboseClientError, self).__init__(
            error_response,  # type:ignore[arg-type]  # in stubs: botocore.exceptions._ClientErrorResponseTypeDef
            operation_name,
        )

1	"""
2	PynamoDB exceptions
3	"""
4	from typing import Any	4✔
5	from typing import Dict	4✔
6	from typing import Iterable	4✔
7	from typing import List	4✔
8	from typing import Optional	4✔
9
10	import botocore.exceptions	4✔
11
12
13	class PynamoDBException(Exception):	4✔
14	msg: str	4✔
15
16	"""
17	A common exception class
18	"""
19	def __init__(self, msg: Optional[str] = None, cause: Optional[Exception] = None) -> None:	4✔
20	self.msg = msg if msg is not None else self.msg	4✔
21	self.cause = cause	4✔
22	super(PynamoDBException, self).__init__(self.msg)	4✔
23
24	@property	4✔
25	def cause_response_code(self) -> Optional[str]:	4✔
26	return getattr(self.cause, 'response', {}).get('Error', {}).get('Code')	4✔
27
28	@property	4✔
29	def cause_response_message(self) -> Optional[str]:	4✔
30	return getattr(self.cause, 'response', {}).get('Error', {}).get('Message')	4✔
31
32
33	class PynamoDBConnectionError(PynamoDBException):	4✔
34	"""
35	A base class for connection errors
36	"""
37	msg = "Connection Error"	4✔
38
39
40	class DeleteError(PynamoDBConnectionError):	4✔
41	"""
42	Raised when an error occurs deleting an item
43	"""
44	msg = "Error deleting item"	4✔
45
46
47	class QueryError(PynamoDBConnectionError):	4✔
48	"""
49	Raised when queries fail
50	"""
51	msg = "Error performing query"	4✔
52
53
54	class ScanError(PynamoDBConnectionError):	4✔
55	"""
56	Raised when a scan operation fails
57	"""
58	msg = "Error performing scan"	4✔
59
60
61	class PutError(PynamoDBConnectionError):	4✔
62	"""
63	Raised when an item fails to be created
64	"""
65	msg = "Error putting item"	4✔
66
67
68	class UpdateError(PynamoDBConnectionError):	4✔
69	"""
70	Raised when an item fails to be updated
71	"""
72	msg = "Error updating item"	4✔
73
74
75	class GetError(PynamoDBConnectionError):	4✔
76	"""
77	Raised when an item fails to be retrieved
78	"""
79	msg = "Error getting item"	4✔
80
81
82	class TableError(PynamoDBConnectionError):	4✔
83	"""
84	An error involving a dynamodb table operation
85	"""
86	msg = "Error performing a table operation"	4✔
87
88
89	class DoesNotExist(PynamoDBException):	4✔
90	"""
91	Raised when an item queried does not exist
92	"""
93	msg = "Item does not exist"	4✔
94
95
96	class TableDoesNotExist(PynamoDBException):	4✔
97	"""
98	Raised when an operation is attempted on a table that doesn't exist
99	"""
100	def __init__(self, table_name: str) -> None:	4✔
101	msg = "Table does not exist: `{}`".format(table_name)	4✔
102	super(TableDoesNotExist, self).__init__(msg)	4✔
103
104
105	class CancellationReason:	4✔
106	"""
107	A reason for a transaction cancellation.
108	"""
109	def __init__(self, *, code: str, message: Optional[str]) -> None:	4✔
110	self.code = code	4✔
111	self.message = message	4✔
112
113	def __eq__(self, other: Any) -> bool:	4✔
114	return isinstance(other, CancellationReason) and self.code == other.code and self.message == other.message	4✔
115
116
117	class TransactWriteError(PynamoDBException):	4✔
118	"""
119	Raised when a TransactWrite operation fails
120	"""
121
122	@property	4✔
123	def cancellation_reasons(self) -> List[Optional[CancellationReason]]:	4✔
124	"""
125	When :attr:`.cause_response_code` is ``TransactionCanceledException``, this property lists
126	cancellation reasons in the same order as the transaction items (one-to-one).
127	Items which were not part of the reason for cancellation would have :code:`None` as the value.
128
129	For a list of possible cancellation reasons and their semantics,
130	see `TransactWriteItems`_ in the AWS documentation.
131
132	.. _TransactWriteItems: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html
133	"""
134	if not isinstance(self.cause, VerboseClientError):	4✔
NEW 135	return []	×
136	return self.cause.cancellation_reasons	4✔
137
138
139	class TransactGetError(PynamoDBException):	4✔
140	"""
141	Raised when a TransactGet operation fails
142	"""
143	@property	4✔
144	def cancellation_reasons(self) -> List[Optional[CancellationReason]]:	4✔
145	"""
146	When :attr:`.cause_response_code` is ``TransactionCanceledException``, this property lists
147	cancellation reasons in the same order as the transaction items (one-to-one).
148	Items which were not part of the reason for cancellation would have :code:`None` as the value.
149
150	For a list of possible cancellation reasons and their semantics,
151	see `TransactGetItems`_ in the AWS documentation.
152
153	.. _TransactGetItems: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html
154	"""
NEW 155	if not isinstance(self.cause, VerboseClientError):	×
NEW 156	return []	×
NEW 157	return self.cause.cancellation_reasons	×
158
159
160	class InvalidStateError(PynamoDBException):	4✔
161	"""
162	Raises when the internal state of an operation context is invalid
163	"""
164	msg = "Operation in invalid state"	4✔
165
166
167	class AttributeDeserializationError(TypeError):	4✔
168	"""
169	Raised when attribute type is invalid
170	"""
171	def __init__(self, attr_name: str, attr_type: str):	4✔
172	msg = "Cannot deserialize '{}' attribute from type: {}".format(attr_name, attr_type)	4✔
173	super(AttributeDeserializationError, self).__init__(msg)	4✔
174
175
176	class AttributeNullError(ValueError):	4✔
177	def __init__(self, attr_name: str) -> None:	4✔
178	self.attr_path = attr_name	4✔
179
180	def __str__(self):	4✔
181	return f"Attribute '{self.attr_path}' cannot be None"	4✔
182
183	def prepend_path(self, attr_name: str) -> None:	4✔
184	self.attr_path = attr_name + '.' + self.attr_path	4✔
185
186
187	class VerboseClientError(botocore.exceptions.ClientError):	4✔
188	def __init__(	4✔
189	self,
190	error_response: Dict[str, Any],
191	operation_name: str,
192	verbose_properties: Optional[Any] = None,
193	*,
194	cancellation_reasons: Iterable[Optional[CancellationReason]] = (),
195	) -> None:
196	"""
197	Like ClientError, but with a verbose message.
198
199	:param error_response: Error response in shape expected by ClientError.
200	:param operation_name: The name of the operation that failed.
201	:param verbose_properties: A dict of properties to include in the verbose message.
202	:param cancellation_reasons: For `TransactionCanceledException` error code,
203	a list of cancellation reasons in the same order as the transaction's items (one to one).
204	For items which were not a reason for the transaction cancellation, :code:`None` will be the value.
205	"""
206	if not verbose_properties:	4✔
207	verbose_properties = {}	×
208
209	self.MSG_TEMPLATE = (	4✔
210	'An error occurred ({{error_code}}) on request ({request_id}) '
211	'on table ({table_name}) when calling the {{operation_name}} '
212	'operation: {{error_message}}'
213	).format(request_id=verbose_properties.get('request_id'), table_name=verbose_properties.get('table_name'))
214
215	self.cancellation_reasons = list(cancellation_reasons)	4✔
216
217	super(VerboseClientError, self).__init__(	4✔
218	error_response, # type:ignore[arg-type] # in stubs: botocore.exceptions._ClientErrorResponseTypeDef
219	operation_name,
220	)

pynamodb / PynamoDB / 4028353162

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous