feat: setup exception hierarchy (#199)

* feat: setup exception hierarchy

* fix: improve ActionTimeoutException message

* refactor: move APIException in _exceptions module

* chore: typo

Co-authored-by: Julian Tölle <julian.toelle97@gmail.com>

* chore: wording

Co-authored-by: Julian Tölle <julian.toelle97@gmail.com>

---------

Co-authored-by: Julian Tölle <julian.toelle97@gmail.com>

docs/api.rst

@@ -19,9 +19,15 @@ API Clients
 Exceptions
 ---------------
 
+.. autoclass:: hcloud.HCloudException
+    :members:
+
 .. autoclass:: hcloud.APIException
     :members:
 
+.. autoclass:: hcloud.actions.domain.ActionException
+    :members:
+
 .. autoclass:: hcloud.actions.domain.ActionFailedException
     :members:
 

hcloud/__init__.py

@@ -1 +1,2 @@
-from .hcloud import APIException, Client  # noqa
+from ._exceptions import APIException, HCloudException  # noqa
+from .hcloud import Client  # noqa

hcloud/_exceptions.py

@@ -0,0 +1,14 @@
+class HCloudException(Exception):
+    """There was an error while using the hcloud library"""
+
+
+class APIException(HCloudException):
+    """There was an error while performing an API Request"""
+
+    def __init__(self, code, message, details):
+        self.code = code
+        self.message = message
+        self.details = details
+
+    def __str__(self):
+        return self.message

hcloud/actions/domain.py

@@ -2,6 +2,8 @@
 
 from hcloud.core.domain import BaseDomain
 
+from .._exceptions import HCloudException
+
 
 class Action(BaseDomain):
     """Action Domain
@@ -56,15 +58,16 @@ def __init__(
         self.error = error
 
 
-class ActionFailedException(Exception):
-    """The Action you was waiting for failed"""
+class ActionException(HCloudException):
+    """A generic action exception"""
 
     def __init__(self, action):
         self.action = action
 
 
-class ActionTimeoutException(Exception):
-    """The Action you was waiting for timeouted in hcloud-python."""
+class ActionFailedException(ActionException):
+    """The Action you were waiting for failed"""
 
-    def __init__(self, action):
-        self.action = action
+
+class ActionTimeoutException(ActionException):
+    """The Action you were waiting for timed out"""

hcloud/hcloud.py

@@ -21,18 +21,7 @@
 from hcloud.volumes.client import VolumesClient
 
 from .__version__ import VERSION
-
-
-class APIException(Exception):
-    """There was an error while performing an API Request"""
-
-    def __init__(self, code, message, details):
-        self.code = code
-        self.message = message
-        self.details = details
-
-    def __str__(self):
-        return self.message
+from ._exceptions import APIException
 
 
 class Client: