cleanup

dcoraid/api/ckan_api.py

@@ -6,7 +6,7 @@
 import logging
 import pathlib
 import traceback
-from typing import Any, Dict
+import numbers
 
 from dclab.external.packaging import parse as parse_version
 import requests
@@ -37,7 +37,7 @@ def __init__(self,
                  api_key: str | None = "",
                  ssl_verify: bool = True,
                  check_ckan_version: bool = True,
-                 caching: bool = True):
+                 caching: bool | str | pathlib.Path = True):
         """User-convenient interface to the CKAN API
 
         Parameters
@@ -259,7 +259,7 @@ def is_available(self, with_api_key=False, with_correct_version=False):
                 status = True
         return status
 
-    def get(self, api_call: str, **kwargs: Dict[Any]):
+    def get(self, api_call: str, **kwargs: str | numbers.Number):
         """GET request
 
         Parameters

dcoraid/api/errors.py

@@ -1,30 +1,38 @@
 class APIError(BaseException):
+    """General CKANAPI error"""
     pass
 
 
 class APIAuthorizationError(APIError):
+    """User credentials are invalid"""
     pass
 
 
 class APIBadGatewayError(APIError):
+    """Cannot connect to DCOR server"""
     pass
 
 
 class APIConflictError(APIError):
+    """Invalid payload to DCOR server"""
     pass
 
 
 class APIGatewayTimeoutError(APIError):
+    """Timeout due to network connection"""
     pass
 
 
 class APINotFoundError(APIError):
+    """Requested object not found on DCOR"""
     pass
 
 
 class APIOutdatedError(APIError):
+    """DCOR-Aid is outdated, the server requests a newer version"""
     pass
 
 
 class NoAPIKeyError(APIError):
+    """DCOR does not have an API key"""
     pass