Skip to content

consts

Constants used by the SDK.

PAYLOAD_HTTP_METHODS module-attribute 

PAYLOAD_HTTP_METHODS = {POST, PUT, PATCH}

HTTPMethod

Bases: StrEnum

An enum representing all HTTP methods.

Source code in horde_sdk/consts.py 
11
12
13
14
15
16
17
18
19
20
21
22
class HTTPMethod(StrEnum):
    """An enum representing all HTTP methods."""

    GET = "GET"
    POST = "POST"
    PUT = "PUT"
    DELETE = "DELETE"
    PATCH = "PATCH"
    OPTIONS = "OPTIONS"
    HEAD = "HEAD"
    TRACE = "TRACE"
    CONNECT = "CONNECT"

GET class-attribute instance-attribute 

GET = 'GET'

POST class-attribute instance-attribute 

POST = 'POST'

PUT class-attribute instance-attribute 

PUT = 'PUT'

DELETE class-attribute instance-attribute 

DELETE = 'DELETE'

PATCH class-attribute instance-attribute 

PATCH = 'PATCH'

OPTIONS class-attribute instance-attribute 

OPTIONS = 'OPTIONS'

HEAD class-attribute instance-attribute 

HEAD = 'HEAD'

TRACE class-attribute instance-attribute 

TRACE = 'TRACE'

CONNECT class-attribute instance-attribute 

CONNECT = 'CONNECT'

HTTPStatusCode

Bases: IntEnum

An enum representing all HTTP status codes.

Source code in horde_sdk/consts.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class HTTPStatusCode(IntEnum):
    """An enum representing all HTTP status codes."""

    OK = 200
    CREATED = 201
    ACCEPTED = 202
    NO_CONTENT = 204

    BAD_REQUEST = 400
    UNAUTHORIZED = 401
    FORBIDDEN = 403
    NOT_FOUND = 404
    METHOD_NOT_ALLOWED = 405
    NOT_ACCEPTABLE = 406
    REQUEST_TIMEOUT = 408
    CONFLICT = 409
    GONE = 410
    UNPROCESSABLE_ENTITY = 422
    TOO_MANY_REQUESTS = 429

    INTERNAL_SERVER_ERROR = 500
    NOT_IMPLEMENTED = 501
    SERVICE_UNAVAILABLE = 503
    GATEWAY_TIMEOUT = 504

OK class-attribute instance-attribute 

OK = 200

CREATED class-attribute instance-attribute 

CREATED = 201

ACCEPTED class-attribute instance-attribute 

ACCEPTED = 202

NO_CONTENT class-attribute instance-attribute 

NO_CONTENT = 204

BAD_REQUEST class-attribute instance-attribute 

BAD_REQUEST = 400

UNAUTHORIZED class-attribute instance-attribute 

UNAUTHORIZED = 401

FORBIDDEN class-attribute instance-attribute 

FORBIDDEN = 403

NOT_FOUND class-attribute instance-attribute 

NOT_FOUND = 404

METHOD_NOT_ALLOWED class-attribute instance-attribute 

METHOD_NOT_ALLOWED = 405

NOT_ACCEPTABLE class-attribute instance-attribute 

NOT_ACCEPTABLE = 406

REQUEST_TIMEOUT class-attribute instance-attribute 

REQUEST_TIMEOUT = 408

CONFLICT class-attribute instance-attribute 

CONFLICT = 409

GONE class-attribute instance-attribute 

GONE = 410

UNPROCESSABLE_ENTITY class-attribute instance-attribute 

UNPROCESSABLE_ENTITY = 422

TOO_MANY_REQUESTS class-attribute instance-attribute 

TOO_MANY_REQUESTS = 429

INTERNAL_SERVER_ERROR class-attribute instance-attribute 

INTERNAL_SERVER_ERROR = 500

NOT_IMPLEMENTED class-attribute instance-attribute 

NOT_IMPLEMENTED = 501

SERVICE_UNAVAILABLE class-attribute instance-attribute 

SERVICE_UNAVAILABLE = 503

GATEWAY_TIMEOUT class-attribute instance-attribute 

GATEWAY_TIMEOUT = 504

get_all_success_status_codes 

get_all_success_status_codes() -> list[HTTPStatusCode]

Return a list of all success status codes.

Source code in horde_sdk/consts.py 
54
55
56
def get_all_success_status_codes() -> list[HTTPStatusCode]:
    """Return a list of all success status codes."""
    return [status_code for status_code in HTTPStatusCode if is_success_status_code(status_code)]

get_all_error_status_codes 

get_all_error_status_codes() -> list[HTTPStatusCode]

Return a list of all error status codes.

Source code in horde_sdk/consts.py 
59
60
61
def get_all_error_status_codes() -> list[HTTPStatusCode]:
    """Return a list of all error status codes."""
    return [status_code for status_code in HTTPStatusCode if is_error_status_code(status_code)]

is_success_status_code 

is_success_status_code(status_code: HTTPStatusCode | int) -> bool

Return True if the status code is a success code, False otherwise.

Source code in horde_sdk/consts.py 
64
65
66
67
68
def is_success_status_code(status_code: HTTPStatusCode | int) -> bool:
    """Return True if the status code is a success code, False otherwise."""
    if isinstance(status_code, HTTPStatusCode):
        status_code = status_code.value
    return 200 <= status_code < 300

is_error_status_code 

is_error_status_code(status_code: HTTPStatusCode | int) -> bool

Return True if the status code is an error code, False otherwise.

Source code in horde_sdk/consts.py 
71
72
73
74
75
def is_error_status_code(status_code: HTTPStatusCode | int) -> bool:
    """Return True if the status code is an error code, False otherwise."""
    if isinstance(status_code, HTTPStatusCode):
        status_code = status_code.value
    return 400 <= status_code < 600