twilio.TwilioRestException - Docs bug, or import problem?

[foxx]

The docs say that TwilioRestException can be accessed from twilio.TwilioRestException, but this is not the case.

You instead need to use twilio.rest.exceptions.TwilioRestException.

Is this a documentation bug, or should twilio.TwilioRestException actually work?

[tdierks]

This problem was introduced in 4a2f191, which moved the class. I agree that this is a breaking change, because the documented API and implementations prior to 3.6.7 offered that class in twilio.TwilioRestException. It needs to be reimported into the appropriate namespace.

[phalt]

The exceptions should still be importable like so:

from twilio import TwilioRestException

and also like so:

from twilio.rest.exceptions import TwilioRestException

This should prevent any backwards compatibility issues. I have no problems with version 3.6.7, which version are you on?

[tdierks]

Sure, you can change your code to be compatible with the change and still work with old binaries, and I've done so, but that doesn't change the fact that this change and minor release broke code which relied on the documented API, and will presumably continue to break developers as they update. What's the problem with importing the exception into the spot in the namespace that it's documented to live?

Edit: sorry, I wasn't thinking (still drinking coffee), and misremembered the problem as being with twilio.rest.TwilioRestException. @foxx is right; the problem is that twilio.TwilioRestException doesn't work.

[foxx]

@phalt That's the point, the exception is currently not importable using;

from twilio import TwilioRestException

You are right that it should be working, but it isn't (as per latest release from 16 days ago).

[phalt]

@tdierks I think the issue here is I changed how we separated the exceptions and I missed this in the documentation. I'm looking into fixing the backwards compatible namespace issue now.

@foxx - can you run pip freeze and see what version you have? I'm on 3.6.7 and I have no issues.

[phalt]

Sorry this took me so long, I was stuck in my own personal logic loop (in my head) seeing code that I thought was running, when I was actually running an installed version and not my local, new, code.

[foxx]

Here you go;

$ pip freeze | grep twilio
twilio==3.6.7

>>> from twilio import TwilioRestException
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: cannot import name TwilioRestException

>>> twilio.__version_info__
('3', '6', '7')

[phalt]

Thanks @foxx - I think I found the issue.

[foxx]

@phalt Could you ref the commit which fixes this?

[phalt]

Sure. Fixed with 7df5a01

[GregKaleka]

In case anyone (like me) came here trying to figure out where to import from, it's now from twilio.base.exceptions import TwilioRestException (as of 64fc4e0).

[robechun]

can we update the docs located here? https://twilio-python.readthedocs.io/en/latest/api/rest/
I would do it but I can't seem to find the file associated with it.