Document HTTPException attributes
authorHarmon <Harmon758@gmail.com>
Sun, 31 Oct 2021 18:55:26 +0000 (13:55 -0500)
committerHarmon <Harmon758@gmail.com>
Sun, 31 Oct 2021 18:55:26 +0000 (13:55 -0500)
tweepy/errors.py

index 3312ec5ff670b1e981ab90ecddfa05b759b682b5..6da55756672586e66f9094ac2cff0bfd3fb13383 100644 (file)
@@ -20,7 +20,19 @@ class TweepyException(Exception):
 
 
 class HTTPException(TweepyException):
-    """Exception raised when an HTTP request fails"""
+    """Exception raised when an HTTP request fails
+
+    Attributes
+    ----------
+    response : requests.Response
+        Requests Response from the Twitter API
+    api_errors : List[dict[str, Union[int, str]]]
+        The errors the Twitter API responded with, if any
+    api_codes : List[int]
+        The error codes the Twitter API responded with, if any
+    api_messages : List[str]
+        The error messages the Twitter API responded with, if any
+    """
 
     def __init__(self, response):
         self.response = response