Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Prefix request ID to the error message as `[req_xxx]` if a request ID exists
---

`str(error)` is now `[req_xxx] message` instead of `Request req_xxx: message`. Use `error.user_message` for the message without the prefix.
6 changes: 3 additions & 3 deletions stripe/_error.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,14 @@ def __init__(
def __str__(self):
msg = self._message or "<empty message>"
if self.request_id is not None:
return "Request {0}: {1}".format(self.request_id, msg)
return "[{0}] {1}".format(self.request_id, msg)
else:
return msg

# Returns the underlying `Exception` (base class) message, which is usually
# the raw message returned by Stripe's API. This was previously available
# in python2 via `error.message`. Unlike `str(error)`, it omits "Request
# req_..." from the beginning of the string.
# in python2 via `error.message`. Unlike `str(error)`, it omits the "[req_...]"
# prefix from the beginning of the string.
@property
def user_message(self):
return self._message
Expand Down
4 changes: 2 additions & 2 deletions tests/test_error.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ def test_formatting(self):

def test_formatting_with_request_id(self):
err = StripeError("öre", headers={"request-id": "123"})
assert str(err) == "Request 123: öre"
assert str(err) == "[123] öre"

def test_formatting_with_none(self):
err = StripeError(None, headers={"request-id": "123"})
assert str(err) == "Request 123: <empty message>"
assert str(err) == "[123] <empty message>"

def test_formatting_with_message_none_and_request_id_none(self):
err = StripeError(None)
Expand Down
Loading