Exceptions

cyhole.core.exception

CyholeException

CyholeException(description)

Bases: Exception

              flowchart TD
              cyhole.core.exception.CyholeException[CyholeException]

              

              click cyhole.core.exception.CyholeException href "" "cyhole.core.exception.CyholeException"
            

General exception of Cyhole library

Source code in src/cyhole/core/exception.py

def __init__(self, description):
    self.description = description

description instance-attribute

description = description

__str__

__str__()

Source code in src/cyhole/core/exception.py

def __str__(self):
    return self.description

RequestTypeNotSupported

RequestTypeNotSupported(description)

Bases: CyholeException

              flowchart TD
              cyhole.core.exception.RequestTypeNotSupported[RequestTypeNotSupported]
              cyhole.core.exception.CyholeException[CyholeException]

                              cyhole.core.exception.CyholeException --> cyhole.core.exception.RequestTypeNotSupported
                


              click cyhole.core.exception.RequestTypeNotSupported href "" "cyhole.core.exception.RequestTypeNotSupported"
              click cyhole.core.exception.CyholeException href "" "cyhole.core.exception.CyholeException"
            

Source code in src/cyhole/core/exception.py

def __init__(self, description):
    self.description = description

AuthorizationAPIKeyError

AuthorizationAPIKeyError(description)

Bases: CyholeException

              flowchart TD
              cyhole.core.exception.AuthorizationAPIKeyError[AuthorizationAPIKeyError]
              cyhole.core.exception.CyholeException[CyholeException]

                              cyhole.core.exception.CyholeException --> cyhole.core.exception.AuthorizationAPIKeyError
                


              click cyhole.core.exception.AuthorizationAPIKeyError href "" "cyhole.core.exception.AuthorizationAPIKeyError"
              click cyhole.core.exception.CyholeException href "" "cyhole.core.exception.CyholeException"
            

Source code in src/cyhole/core/exception.py

def __init__(self, description):
    self.description = description

MissingAPIKeyError

MissingAPIKeyError(description)

Bases: CyholeException

              flowchart TD
              cyhole.core.exception.MissingAPIKeyError[MissingAPIKeyError]
              cyhole.core.exception.CyholeException[CyholeException]

                              cyhole.core.exception.CyholeException --> cyhole.core.exception.MissingAPIKeyError
                


              click cyhole.core.exception.MissingAPIKeyError href "" "cyhole.core.exception.MissingAPIKeyError"
              click cyhole.core.exception.CyholeException href "" "cyhole.core.exception.CyholeException"
            

Source code in src/cyhole/core/exception.py

def __init__(self, description):
    self.description = description

ParamUnknownError

ParamUnknownError(param_value: Any, param_enum: Type[Enum])

Bases: CyholeException

              flowchart TD
              cyhole.core.exception.ParamUnknownError[ParamUnknownError]
              cyhole.core.exception.CyholeException[CyholeException]

                              cyhole.core.exception.CyholeException --> cyhole.core.exception.ParamUnknownError
                


              click cyhole.core.exception.ParamUnknownError href "" "cyhole.core.exception.ParamUnknownError"
              click cyhole.core.exception.CyholeException href "" "cyhole.core.exception.CyholeException"
            

General error used to manage a wrong input API param.

Source code in src/cyhole/core/exception.py

def __init__(self, param_value: Any, param_enum: Type[Enum]):
    description = f"param '{str(param_value)}' not supported in {param_enum.__name__} enum class. \nAdmissible values: {[(param.name, param.value) for param in param_enum]}"
    super().__init__(description)

AsyncClientAPISessionNotAvailable

AsyncClientAPISessionNotAvailable(description)

Bases: CyholeException

              flowchart TD
              cyhole.core.exception.AsyncClientAPISessionNotAvailable[AsyncClientAPISessionNotAvailable]
              cyhole.core.exception.CyholeException[CyholeException]

                              cyhole.core.exception.CyholeException --> cyhole.core.exception.AsyncClientAPISessionNotAvailable
                


              click cyhole.core.exception.AsyncClientAPISessionNotAvailable href "" "cyhole.core.exception.AsyncClientAPISessionNotAvailable"
              click cyhole.core.exception.CyholeException href "" "cyhole.core.exception.CyholeException"
            

Exception raised when the AsyncAPIClient has not an open session to use.

Source code in src/cyhole/core/exception.py

def __init__(self, description):
    self.description = description