Docs: "Handling Exceptions" should mention that network errors are not `TwilioRestException`
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the “Handling Exceptions” section in README.md and confirm the behavior in twilio/base/exceptions.py, twilio/http/http_client.py, and twilio/http/async_http_client.py. Update the README to distinguish API error responses from transport exceptions and show how to catch them; done means the examples match the documented sync and async behavior.
Written by the indexing model from the issue text.
Description
Location (twilio/twilio-python @ default branch 74b9629):
README.md:267-284twilio/base/exceptions.py:10-11twilio/http/http_client.py:101-111twilio/http/async_http_client.py:104-110
try:
message = client.messages.create(to="+12316851234", from_="+15555555555",
body="Hello there!")
except TwilioRestException as e:
print(e)
# twilio/http/http_client.py
response = session.send(
prepped_request,
allow_redirects=allow_redirects,
timeout=timeout,
**settings,
)
Problem
The README's "Handling Exceptions" section shows only except TwilioRestException. TwilioRestException is documented as "A generic 400 or 500 level exception from the Twilio API", i.e. it covers responses returned by the API. When the request never gets a response (DNS failure, connection refused, timeout) the default TwilioHttpClient lets the requests exception propagate as-is, so requests.exceptions.ConnectionError / requests.exceptions.Timeout escape that handler. The README doesn't mention this, so code written from the example can miss transport failures entirely.
I think propagating the original requests exception is a reasonable design: it keeps the exact cause and lets callers distinguish timeouts (possibly retryable) from other errors. This request is only about documenting it.
Reproduction
With session.send raising, TwilioHttpClient.request() raises the original exception (observed with mocked Session.send):
requests.exceptions.ConnectionError: Connection refused
requests.exceptions.Timeout: execution expired
Environment:
- Commit:
74b96296b0805986252b798bda4bca90341487ee(main, twilio 9.12.0) - Toolchain: Python 3.13.18
Already fixed in twilio/twilio-ruby
PR: https://github.com/twilio/twilio-ruby/pull/470 — "breaking: Catch and wrap Faraday client errors" (merged 2019-09-16T16:35:47Z, merge commit a5d428281af). The same gap was addressed in the Ruby library, but by a different route: it wraps Faraday client errors in Twilio::REST::TwilioError and adds a "Handling Errors" README section, as a breaking change. The wrapping is shown for context and is not proposed here; only making the behaviour explicit to users is.
How twilio-ruby fixed it:
--- a/lib/twilio-ruby/http/http_client.rb
+++ b/lib/twilio-ruby/http/http_client.rb
@@ -52,6 +50,14 @@ def _request(request)
...
+ def send(request)
+ @connection.send(request.method.downcase.to_sym,
+ request.url,
+ request.method == 'GET' ? request.params : request.data)
+ rescue Faraday::ClientError => e
+ raise Twilio::REST::TwilioError, e
+ end
--- a/README.md
+++ b/README.md
@@ -98,30 +98,38 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
...
+### Handling Errors
...
+```ruby
+begin
+ messages = @client.messages.list(limit: 20)
+rescue Twilio::REST::TwilioError => e
+ puts e.message
+end
+```
Suggested fix
Docs only: after the "Handling Exceptions" example, the README states that TwilioRestException covers API error responses, that transport failures surface as requests (sync) or aiohttp (async) exceptions, and shows how to catch them; wrapping transport errors or adding retries is not proposed:
diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -283,6 +283,23 @@ except TwilioRestException as e:
print(e)
```
+`TwilioRestException` represents an error response returned by the Twilio API. If the request gets no response at all (for example a DNS failure, a refused connection or a timeout), the default `TwilioHttpClient` lets the underlying `requests` exception propagate, so `requests.exceptions.ConnectionError`, `requests.exceptions.Timeout` and the other `requests.exceptions.RequestException` subclasses are not caught by `except TwilioRestException`. The async client (`AsyncTwilioHttpClient`) raises aiohttp's exceptions in the same situation. To handle these failures, catch them separately:
+
+```python
+from requests.exceptions import ConnectionError, Timeout
+from twilio.base.exceptions import TwilioRestException
+
+try:
+ message = client.messages.create(to="+12316851234", from_="+15555555555",
+ body="Hello there!")
+except TwilioRestException as e:
+ print(e.status, e.code) # the API returned an error
+except Timeout:
+ pass # no response in time; the outcome is unknown, decide whether to retry
+except ConnectionError:
+ pass # the API could not be reached
+```
+
### Generating TwiML
To control phone calls, your application needs to output [TwiML][twiml].
Documentation-only change, so there is no failing test; the documented behaviour was checked on 74b9629 (Python 3.13.18) with Session.send mocked to raise ConnectionError and Timeout: TwilioHttpClient.request() re-raises both unchanged, and neither is a TwilioRestException.
I can submit a PR for this.
Checked: #327 (hanging behind proxy), #485 (timeout parameter) and #630 (timeout type hint) don't cover how transport errors are surfaced or documented.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 821
- Avg merge
- 9h 33m
- Merged PRs (30d)
- 3
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from twilio/twilio-python
-
Clearer diagnostic when an API Key SID is passed without `account_sid`Possibly taken @saryeljaramany claimed this 5 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
twilio/twilio-python#985 · 1 comment ·
Maintainers usually reply within 1 day
-
TokenPagination.next_page_async() makes a sync request and fails with an async http clientPossibly taken @sebxt claimed this 31 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
twilio/twilio-python#976 ·
Maintainers usually reply within 1 day
-
AsyncTwilioHttpClient does not JSON-serialize request bodies for application/json endpoints (sync client does) → 400 on JSON-body v2 endpointsPossibly taken @Steve0x2a claimed this 77 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
twilio/twilio-python#932 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
twilio/twilio-python#930 ·
Maintainers usually reply within 1 day
-
[BUG] AsyncTwilioHttpClient.request does not use self.timeoutPossibly taken @Hashim1999164 claimed this 96 days ago. Opentype: bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
twilio/twilio-python#925 ·
Maintainers usually reply within 1 day
All issues in twilio/twilio-python
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day
-
area:cli area:security enhancement priority:medium size:small
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
RonaldHensbergen/composable-data-stack#1338 ·
Maintainers usually reply within 1 day
-
area:stdlib effort:S impact:med platform:linux type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
automated endpoint-dead needs-curation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
almanac-data/climate-almanac#139 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
UKGovernmentBEIS/inspect_ai#6695 · 1 comment ·
Maintainers usually reply within 1 day