File: exceptions.py

package info (click to toggle)
python-crownstone-cloud 1.4.11-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 240 kB
  • sloc: python: 1,126; makefile: 4
file content (41 lines) | stat: -rw-r--r-- 1,318 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
"""Exceptions for crownstone cloud connection cloud"""
from __future__ import annotations

AuthError = {
    "LOGIN_FAILED": "Wrong email or password provided",
    "USERNAME_EMAIL_REQUIRED": "Email or password not provided",
    "LOGIN_FAILED_EMAIL_NOT_VERIFIED": "Email has not been verified, please do that first",
}

AbilityError = {
    "NOT_ENABLED": "This ability is not enabled. Use the Crownstone App to enable it.",
}


class CrownstoneException(Exception):
    """Raised when authentication with API ended in error"""

    def __init__(self, exception_type: str, message: str | None = None):
        super().__init__(exception_type, message)
        self.type = exception_type
        self.message = message


class CrownstoneAuthenticationError(CrownstoneException):
    """Raised when authentication with API ended in error"""


class CrownstoneUnknownError(Exception):
    """Raised when the error is not known / no data"""


class CrownstoneConnectionError(Exception):
    """Raised when a connection to the Crownstone Cloud can't be made."""


class CrownstoneAbilityError(CrownstoneException):
    """Raised when when e.g. dimming command is requested when it is not enabled."""


class CrownstoneNotFoundError(Exception):
    """Raised when searching for a Crownstone object, but it is not found."""