Add VultrException

Author: smashedr

README.md

@@ -6,7 +6,6 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cssnr_vultr-python&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=cssnr_vultr-python)
 [![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/vultr-python/lint.yaml?logo=cachet&label=lint)](https://github.com/cssnr/vultr-python/actions/workflows/lint.yaml)
 [![Workflow Test](https://img.shields.io/github/actions/workflow/status/cssnr/vultr-python/test.yaml?logo=cachet&label=test)](https://github.com/cssnr/vultr-python/actions/workflows/test.yaml)
-[![Deployments PyPi](https://img.shields.io/github/deployments/cssnr/vultr-python/pypi?logo=materialformkdocs&logoColor=white&label=pypi)](https://pypi.org/project/vultr-python/)
 [![Deployments Pages](https://img.shields.io/github/deployments/cssnr/vultr-python/github-pages?logo=materialformkdocs&logoColor=white&label=github-pages)](https://cssnr.github.io/vultr-python/)
 [![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/vultr-python?logo=github&label=updated)](https://github.com/cssnr/vultr-python/graphs/commit-activity)
 [![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/vultr-python?logo=bookstack&logoColor=white&label=repo%20size)](https://github.com/cssnr/vultr-python)
@@ -120,6 +119,18 @@ sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
 vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
 ```
 
+Errors Handling
+
+```python
+from vultr import VultrException
+
+try:
+    instance = vultr.create_instance("atl", "vc2-1c-0.5gb-v6", os_id=2284)
+except VultrException as error:
+    print(error.error)  # 'Server add failed: Ubuntu 24.04 LTS x64 requires a plan with at least 1000 MB memory.'
+    print(error.status)  # 400
+```
+
 Full Documentation: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python/)
 
 Vultr API Reference: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)

docs/index.md

@@ -96,6 +96,18 @@ sshkey = vultr.post('ssh-keys', name='key-name', ssh_key='ssh-rsa AAAA...')
 vultr.delete(f"instances/019ad1a8-2aa3-7650-83d1-8520d65ed6af")
 ```
 
+Errors Handling
+
+```python
+from vultr import VultrException
+
+try:
+    instance = vultr.create_instance("atl", "vc2-1c-0.5gb-v6", os_id=2284)
+except VultrException as error:
+    print(error.error)  # 'Server add failed: Ubuntu 24.04 LTS x64 requires a plan with at least 1000 MB memory.'
+    print(error.status)  # 400
+```
+
  
 
 Vultr API Reference: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)

src/vultr/__init__.py

@@ -2,7 +2,7 @@
 ..  include:: ../../docs/index.md
 """
 
-from .vultr import Vultr
+from .vultr import Vultr, VultrException
 
 
-__all__ = ["Vultr"]
+__all__ = ["Vultr", "VultrException"]

src/vultr/vultr.py

@@ -158,25 +158,25 @@ def filter_regions(regions: list, locations: list) -> list:
     def _get(self, url, params: Optional[dict] = None):
         r = self._session.get(url, params=params, timeout=10)
         if not r.ok:
-            r.raise_for_status()
+            raise VultrException(r)
         return r.json()
 
     def _post(self, url, data):
         r = self._session.post(url, json=data, timeout=10)
         if not r.ok:
-            r.raise_for_status()
+            raise VultrException(r)
         return r.json()
 
     def _patch(self, url, data):
         r = self._session.patch(url, json=data, timeout=10)
         if not r.ok:
-            r.raise_for_status()
+            raise VultrException(r)
         return r.json()
 
     def _delete(self, url):
         r = self._session.delete(url, timeout=10)
         if not r.ok:
-            r.raise_for_status()
+            raise VultrException(r)
         return None
 
     @staticmethod
@@ -190,3 +190,16 @@ def _get_obj_key(obj, key="id"):
                 return obj[key]
         else:
             raise ValueError(f"Unable to parse object: {key}")
+
+
+class VultrException(Exception):
+    def __init__(self, response: requests.Response):
+        try:
+            data = response.json()
+            error = data.get("error", response.text)
+        except ValueError:
+            error = response.text
+        status = response.status_code
+        self.error = error
+        self.status = status
+        super().__init__(f"Error {self.status}: {self.error}")