keble-exceptions 0.0.14

No project description provided

keble-exceptions

This package provides a set of predefined exceptions for various error scenarios within the Keble codebase. These exceptions inherit from the base KebleException class.

Base KebleException Signature

def __init__(
    self,
    *,
    alert_admin: bool = False,
    function_identifier: Optional[str] = None,
    admin_note: Optional[str] = None,
    status_code: int = 400,
    how_to_resolve: Optional[HowToResolve] = None,
    fingerprint: Optional[List[str]] = None,
):
    ...

Predefined Exceptions Signatures

Authentication and Authorization Exceptions

• TokenExpired

  def __init__(self, *args, **kwargs):
      ...
  

• TokenPurposeUnmatched

  def __init__(self, *args, **kwargs):
      ...
  

• InactiveUser

  def __init__(self, *args, **kwargs):
      ...
  

• UserNotFound

  def __init__(self, *args, **kwargs):
      ...
  

• UserIdentityVerificationIsRequired

  def __init__(self, *args, **kwargs):
      ...
  

• UserOrOrgIdentityNoSufficientToken

  def __init__(self, *args, **kwargs):
      ...
  

• NoObjectPermission

  def __init__(self, *, object_id: str, object_type: Optional[str] = None, *args, **kwargs):
      ...
  

• NoRolePermission

  def __init__(self, *, current_role: str, require_role: str, *args, **kwargs):
      ...
  

Email and Registration Exceptions

• EmailNotRegistered

  def __init__(self, *args, **kwargs):
      ...
  

• EmailRegistered

  def __init__(self, *args, **kwargs):
      ...
  

• InvalidEmailConfirmationCode

  def __init__(self, *args, **kwargs):
      ...
  

• InvalidEmailOrPassword

  def __init__(self, *args, **kwargs):
      ...
  

Parameter Validation Exceptions

• ServerSideMissingParams

  def __init__(self, *, missing_params: str, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

• ClientSideMissingParams

  def __init__(self, *, missing_params: str, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

• ServerSideInvalidParams

  def __init__(self, *, invalid_params: str | int, expected: str | int | Type, but_got: str | int | Type, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

• ClientSideInvalidParams

  def __init__(self, *, invalid_params: str | int, expected: str | int | Type, but_got: str | int | Type, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

Data and Object Exceptions

• ObjectNotFound

  def __init__(self, *, object_name: str, id: Any, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

• DataIntegrityCompromised

  def __init__(self, *, object_name: Optional[str] = None, id: Any = None, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

Processing and Iteration Exceptions

• MaxIterationReached

  def __init__(self, *, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

• UnhandledScenarioOrCase

  def __init__(self, *, unhandled_case: str, alert_admin: bool, admin_note: Optional[Any] = None, *args, **kwargs):
      ...
  

Request and Response Exceptions

• RequestFailure

  def __init__(self, *, admin_note: Any, function_identifier: str, alert_admin: bool, *args, **kwargs):
      ...
  

• LlmInvalidResponse

  def __init__(self, *, alert_admin: bool, admin_note: Optional[Any] = None, function_identifier: Optional[str] = None, *args, **kwargs):
      ...
  

Rate Limiting Exceptions

• EmailSendingLimitReached

  def __init__(self, *, wait_minutes: str | float | int, alert_admin: bool, function_identifier: Optional[str] = None, *args, **kwargs):
      ...
  

• SmsSendingLimitReached

  def __init__(self, *, wait_minutes: str | float | int, alert_admin: bool, function_identifier: Optional[str] = None, *args, **kwargs):
      ...
  

• FrequencyLimitReached

  def __init__(self, *, wait_minutes: str | float | int, alert_admin: bool, function_identifier: Optional[str] = None, *args, **kwargs):
      ...
  

• WechatBindingLimitExceeded

  def __init__(self, *, limit: int = 3, alert_admin: bool, admin_note: Any | None = None, *args, **kwargs):
      ...
  

raise_if_not Function

def raise_if_not(condition: bool | List[bool], exception: KebleException):
    # raise when condition is not TRUE or not all TRUE
    ...