Insanic
latest
Contents:
Foreword
Getting Started
Settings
Error Handling
HTTP Status Codes
Request Object
Logging
Authentication and Permissions
Public Route Flagging
Intra Service Communications
Monitoring Insanic
Endpoint Deprecation
Datetime Helper Functions
Change Logs
Legacy Change Logs
Contributing to Insanic
Global Settings
API Reference
API Reference Constants
Insanic
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
ADMINS (in module insanic.conf.global_settings)
after_server_start_connect_database() (in module insanic.listeners)
after_server_stop_clean_up() (in module insanic.listeners)
allow_request() (BaseThrottle method)
(ScopedRateThrottle method)
(SimpleRateThrottle method)
AllowAny (class in insanic.permissions)
allowed_methods() (InsanicView property)
AnonRateThrottle (class in insanic.throttles)
AnonymousRequestService (in module insanic.models)
AnonymousUser (in module insanic.models)
APIException
APPLICATION_VERSION (in module insanic.conf.global_settings)
auth() (Request property)
authentication_credentials_missing (GlobalErrorCodes attribute)
AuthenticationFailed
B
BadRequest
BasePermission (class in insanic.permissions)
BaseThrottle (class in insanic.throttles)
before_server_start_set_task_factory() (in module insanic.listeners)
before_server_start_verify_plugins() (in module insanic.listeners)
C
CACHES (in module insanic.conf.global_settings)
check_permissions() (InsanicView method)
check_throttles() (InsanicView method)
client() (Service property)
client_payload_error (GlobalErrorCodes attribute)
close_client() (Service method)
configure_version() (Insanic method)
D
data() (Request property)
DEBUG (in module insanic.conf.global_settings)
description (UnsupportedMediaType attribute)
destination_service (RequestService attribute)
dispatch_request() (InsanicView method)
E
ENFORCE_APPLICATION_VERSION (in module insanic.conf.global_settings)
ENVIRONMENT (in module insanic.conf.global_settings)
error_code (APIException attribute)
(MethodNotAllowed attribute)
(ResponseTimeoutError attribute)
(SanicMethodNotSupported attribute)
(SanicNotFound attribute)
(Throttled attribute)
error_unspecified (GlobalErrorCodes attribute)
extra_detail (Throttled attribute)
F
FieldError
G
get_authenticators() (InsanicView method)
get_cache_key() (AnonRateThrottle method)
(ScopedRateThrottle method)
(SimpleRateThrottle method)
(UserRateThrottle method)
get_permissions() (InsanicView method)
get_rate() (SimpleRateThrottle method)
get_service() (in module insanic.loading)
get_throttles() (InsanicView method)
get_utc_datetime() (in module insanic.utils.datetime)
get_utc_timestamp() (in module insanic.utils.datetime)
GlobalErrorCodes (class in insanic.errors)
GRACEFUL_SHUTDOWN_TIMEOUT (in module insanic.conf.global_settings)
H
host() (Service property)
HTTP_100_CONTINUE (in module insanic.status)
HTTP_101_SWITCHING_PROTOCOLS (in module insanic.status)
HTTP_200_OK (in module insanic.status)
HTTP_201_CREATED (in module insanic.status)
HTTP_202_ACCEPTED (in module insanic.status)
HTTP_203_NON_AUTHORITATIVE_INFORMATION (in module insanic.status)
HTTP_204_NO_CONTENT (in module insanic.status)
HTTP_205_RESET_CONTENT (in module insanic.status)
HTTP_206_PARTIAL_CONTENT (in module insanic.status)
HTTP_300_MULTIPLE_CHOICES (in module insanic.status)
HTTP_301_MOVED_PERMANENTLY (in module insanic.status)
HTTP_302_FOUND (in module insanic.status)
HTTP_303_SEE_OTHER (in module insanic.status)
HTTP_304_NOT_MODIFIED (in module insanic.status)
HTTP_305_USE_PROXY (in module insanic.status)
HTTP_306_RESERVED (in module insanic.status)
HTTP_307_TEMPORARY_REDIRECT (in module insanic.status)
HTTP_400_BAD_REQUEST (in module insanic.status)
HTTP_401_UNAUTHORIZED (in module insanic.status)
HTTP_402_PAYMENT_REQUIRED (in module insanic.status)
HTTP_403_FORBIDDEN (in module insanic.status)
HTTP_404_NOT_FOUND (in module insanic.status)
HTTP_405_METHOD_NOT_ALLOWED (in module insanic.status)
HTTP_406_NOT_ACCEPTABLE (in module insanic.status)
HTTP_407_PROXY_AUTHENTICATION_REQUIRED (in module insanic.status)
HTTP_408_REQUEST_TIMEOUT (in module insanic.status)
HTTP_409_CONFLICT (in module insanic.status)
HTTP_410_GONE (in module insanic.status)
HTTP_411_LENGTH_REQUIRED (in module insanic.status)
HTTP_412_PRECONDITION_FAILED (in module insanic.status)
HTTP_413_REQUEST_ENTITY_TOO_LARGE (in module insanic.status)
HTTP_414_REQUEST_URI_TOO_LONG (in module insanic.status)
HTTP_415_UNSUPPORTED_MEDIA_TYPE (in module insanic.status)
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE (in module insanic.status)
HTTP_417_EXPECTATION_FAILED (in module insanic.status)
HTTP_422_UNPROCESSABLE_ENTITY (in module insanic.status)
HTTP_428_PRECONDITION_REQUIRED (in module insanic.status)
HTTP_429_TOO_MANY_REQUESTS (in module insanic.status)
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE (in module insanic.status)
HTTP_499_CLIENT_CLOSED_REQUEST (in module insanic.status)
HTTP_500_INTERNAL_SERVER_ERROR (in module insanic.status)
HTTP_501_NOT_IMPLEMENTED (in module insanic.status)
HTTP_502_BAD_GATEWAY (in module insanic.status)
HTTP_503_SERVICE_UNAVAILABLE (in module insanic.status)
HTTP_504_GATEWAY_TIMEOUT (in module insanic.status)
HTTP_505_HTTP_VERSION_NOT_SUPPORTED (in module insanic.status)
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED (in module insanic.status)
http_dispatch() (Service method)
I
i18n (APIException attribute)
id (User attribute)
id() (Request property)
ImproperlyConfigured
inactive_user (GlobalErrorCodes attribute)
initialize_listeners() (Insanic method)
initialize_middleware() (Insanic method)
Insanic (class in insanic.app)
insanic.conf.global_settings
module
insanic.exceptions
module
insanic.listeners
module
insanic.loading
module
insanic.middleware
module
insanic.models
module
insanic.permissions
module
insanic.request
module
insanic.router
module
insanic.status
module
insanic.throttles
module
insanic.utils.datetime
module
insanic.views
module
INSANIC_CACHES (in module insanic.conf.global_settings)
InsanicConfig (class in insanic.conf)
InsanicRouter (class in insanic.router)
InsanicView (class in insanic.views)
INTERNAL_REQUEST_SERVICE_HEADER (in module insanic.conf.global_settings)
INTERNAL_REQUEST_USER_HEADER (in module insanic.conf.global_settings)
invalid_access (GlobalErrorCodes attribute)
invalid_authorization_header (GlobalErrorCodes attribute)
invalid_payload (GlobalErrorCodes attribute)
invalid_query_params (GlobalErrorCodes attribute)
invalid_service_token (GlobalErrorCodes attribute)
invalid_signature (GlobalErrorCodes attribute)
invalid_token (GlobalErrorCodes attribute)
invalid_url (GlobalErrorCodes attribute)
invalid_usage (GlobalErrorCodes attribute)
InvalidUsage
is_active() (User property)
is_authenticated (RequestService attribute)
is_authenticated() (User property)
is_banned() (User property)
is_staff() (User property)
is_valid() (RequestService property)
IsAdminUser (class in insanic.permissions)
IsAnonymousUser (class in insanic.permissions)
IsAuthenticated (class in insanic.permissions)
IsAuthenticatedOrReadOnly (class in insanic.permissions)
iso_to_datetime() (in module insanic.utils.datetime)
iso_to_timestamp() (in module insanic.utils.datetime)
IsOwnerOrAdmin (class in insanic.permissions)
IsServiceOnly (class in insanic.permissions)
K
KEEP_ALIVE_TIMEOUT (in module insanic.conf.global_settings)
L
level (User attribute)
load_from_service() (InsanicConfig method)
M
message (APIException attribute)
(AuthenticationFailed attribute)
(BadRequest attribute)
(InvalidUsage attribute)
(MethodNotAllowed attribute)
(NotAcceptable attribute)
(NotAuthenticated attribute)
(NotFound attribute)
(ParseError attribute)
(PermissionDenied attribute)
(RequestTimeoutError attribute)
(ResponseTimeoutError attribute)
(SanicMethodNotSupported attribute)
(SanicNotFound attribute)
(ServiceAuthenticationFailed attribute)
(ServiceUnavailable503Error attribute)
(Throttled attribute)
(UnprocessableEntity422Error attribute)
(UnsupportedMediaType attribute)
(ValidationError attribute)
method_not_allowed (GlobalErrorCodes attribute)
MethodNotAllowed
module
insanic.conf.global_settings
insanic.exceptions
insanic.listeners
insanic.loading
insanic.middleware
insanic.models
insanic.permissions
insanic.request
insanic.router
insanic.status
insanic.throttles
insanic.utils.datetime
insanic.views
N
not_found (GlobalErrorCodes attribute)
NotAcceptable
NotAuthenticated
NotFound
P
parse_rate() (SimpleRateThrottle method)
ParseError
perform_authentication() (InsanicView method)
permission_denied (GlobalErrorCodes attribute)
permission_denied() (InsanicView method)
PermissionDenied
plugin_initialized() (Insanic method)
port() (Service property)
prepare_http() (InsanicView method)
public_facing() (in module insanic.scopes)
Q
query_params() (Request property)
R
RawPostDataException
redis_unable_to_process (GlobalErrorCodes attribute)
Request (class in insanic.request)
REQUEST_ID_HEADER_FIELD (in module insanic.conf.global_settings)
request_middleware() (in module insanic.middleware)
request_service (RequestService attribute)
request_timeout (GlobalErrorCodes attribute)
RequestService (class in insanic.models)
RequestTimeoutError
REQUIRED_PLUGINS (in module insanic.conf.global_settings)
REQUIRED_SERVICE_CONNECTIONS (in module insanic.conf.global_settings)
ResponseTimeoutError
routes_public() (InsanicRouter property)
run() (Insanic method)
S
SanicInvalidUsage
SanicMethodNotSupported
SanicNotFound
ScopedRateThrottle (class in insanic.throttles)
server_signature_error (GlobalErrorCodes attribute)
Service (class in insanic.services.client)
service() (Request property)
SERVICE_ALIAS (in module insanic.conf.global_settings)
SERVICE_CONNECTION_DEFAULT_RETRY_COUNT (in module insanic.conf.global_settings)
SERVICE_CONNECTION_MAX_RETRY_COUNT (in module insanic.conf.global_settings)
SERVICE_CONNECTIONS (in module insanic.conf.global_settings)
SERVICE_CONNECTOR_MAX (in module insanic.conf.global_settings)
SERVICE_CONNECTOR_MAX_KEEPALIVE (in module insanic.conf.global_settings)
SERVICE_GLOBAL_HOST_TEMPLATE (in module insanic.conf.global_settings)
SERVICE_GLOBAL_PORT (in module insanic.conf.global_settings)
SERVICE_GLOBAL_SCHEMA (in module insanic.conf.global_settings)
service_timeout (GlobalErrorCodes attribute)
SERVICE_TIMEOUT_TOTAL (in module insanic.conf.global_settings)
service_unavailable (GlobalErrorCodes attribute)
ServiceAuthenticationFailed
ServiceUnavailable503Error
signature_expired (GlobalErrorCodes attribute)
signature_not_decodable (GlobalErrorCodes attribute)
SimpleRateThrottle (class in insanic.throttles)
source_ip (RequestService attribute)
status_code (APIException attribute)
(AuthenticationFailed attribute)
(BadRequest attribute)
(InvalidUsage attribute)
(MethodNotAllowed attribute)
(NotAcceptable attribute)
(NotAuthenticated attribute)
(NotFound attribute)
(ParseError attribute)
(PermissionDenied attribute)
(RequestTimeoutError attribute)
(ResponseTimeoutError attribute)
(SanicMethodNotSupported attribute)
(SanicNotFound attribute)
(ServiceAuthenticationFailed attribute)
(ServiceUnavailable503Error attribute)
(Throttled attribute)
(UnprocessableEntity422Error attribute)
(UnsupportedMediaType attribute)
(ValidationError attribute)
stream_error (GlobalErrorCodes attribute)
successful_authenticator() (Request property)
T
TASK_CONTEXT_CORRELATION_ID (in module insanic.conf.global_settings)
TASK_CONTEXT_REQUEST_USER (in module insanic.conf.global_settings)
throttle_failure() (SimpleRateThrottle method)
throttle_success() (SimpleRateThrottle method)
Throttled
throttled (GlobalErrorCodes attribute)
throttled() (InsanicView method)
THROTTLES_DEFAULT_THROTTLE_RATES (in module insanic.conf.global_settings)
timer() (SimpleRateThrottle method)
timestamp_milliseconds_to_datetime() (in module insanic.utils.datetime)
timestamp_seconds_to_datetime() (in module insanic.utils.datetime)
timestamp_to_datetime() (in module insanic.utils.datetime)
timestamp_to_iso() (in module insanic.utils.datetime)
to_header_value() (in module insanic.models)
transport_error (GlobalErrorCodes attribute)
U
unknown_error (GlobalErrorCodes attribute)
UnprocessableEntity422Error
UnsupportedMediaType
User (class in insanic.models)
user() (Request property)
UserRateThrottle (class in insanic.throttles)
V
ValidationError
verify_plugin_requirements() (Insanic method)
W
wait() (BaseThrottle method)
(SimpleRateThrottle method)
Read the Docs
v: latest
Versions
latest
stable
0.9.2
Downloads
On Read the Docs
Project Home
Builds