Skip to content

Public API

These names are the public API. Removing one, or changing it incompatibly, raises MINOR (see the changelog's Versioning section); a pull request that does so fails its Public API check. Every other module documented here may change in any release.

blackbull

BlackBull, serve, AppConfig, RouteInfo, HTTPException, UnprocessableQuery, QUERY, Connection, Headers, read_body, read_json, read_text, parse_cookies, cookies_from_headers, ClientDisconnected, Response, JSONResponse, RedirectResponse, StreamingResponse, EventSourceResponse, WebSocketResponse, cookie_header, WebSocket, WebSocketDisconnect, Depends, Event, EventHandler, ResponseStart, ResponseBody, parse_response_event, ASGIReceiveEvent, ASGISendEvent, ASGIReceiveCallable, ASGISendCallable, CORS, as_middleware, TrustedProxy, BlackBullDeprecationWarning, Listener, Tcp, Unix, InheritedFd

blackbull.client

Abort, Client, ClientConnection, ClientResponse, Fate, HTTP1Client, HTTP1RequestSender, HTTP1ResponseRecipient, HTTP1UpgradeSession, HTTP2Client, ReadResponse, Scenario, ScenarioResult, SendRawBytes, Sleep, Step, WebSocketClient, WebSocketH2Client, WebSocketH2Session, WebSocketSession, ClientError, ConnectionError, HandshakeError, ProtocolError, ResponseTooLarge, StreamReset

blackbull.fault_injection

ExpectResponse, ExpectServerFrame, H1CExpectResponse, H1CWaitForResponse, H2CExpectServerFrame, H2CWaitForServerFrame, HalfClose, WaitForResponse, WaitForServerFrame, response_matches, H2SAbort, H2SCloseGracefully, H2SExpectClientFrame, H2SHalfClose, H2SSendFrame, H2SSendRawBytes, H2SSleep, H2SWaitForClientFrame, ACCEPTED_CATEGORIES, Abort, CLIENT_PREFACE, Category, CloseGracefully, Observed, H1FaultServer, H1SAbort, request_matches, H1SSendStatusLine, H1SSendHeader, H1SSendChunk, H1SEndHeaders, H1SEndChunkedBody, ExpectClientFrame, ExpectRequest, H1SCloseGracefully, H1SHalfClose, H1SSendRawBytes, H1SSleep, H2Abort, H2CAbort, H2CReadResponse, H1CSendRawBytes, H2CHalfClose, H2CSendRawBytes, H2CSendFrame, H2CSendPreface, H2CSleep, H2C_CLIENT_PREFACE, H2FaultServer, H2FaultServerError, H2Sleep, H2Step, PER_REQUEST_TIMEOUT_S, ReadResponse, Scenario, ScenarioH1Server, StepOpH1Server, StepOpH2Client, ScenarioH1ServerResult, ScenarioH2, ScenarioH2Client, ScenarioH2ClientResult, ScenarioH2Result, ScenarioResult, SendFrame, SendRawBytes, SideOutcome, Sleep, Step, StepOp, StepOpH2, WaitForClientFrame, WaitForRequest, categorize, frame_matches, make_self_signed_h2_context, normalize_response, run_scenario, scenario_h1_server_from_json, scenario_h1_server_to_json, scenario_h2_client_from_json, scenario_h2_client_to_json, scenario_h2_from_json, scenario_h2_to_json, serialize_frame

blackbull.fault_injection.catalogue

CATALOGUE, CATALOGUES, CATALOGUE_H1, CATALOGUE_H1_CLIENT, CATALOGUE_H1_SERVER, CATALOGUE_H2, CATALOGUE_H2_CLIENT, CATALOGUE_H2_SERVER, exhausted_window_zero_initial, half_closed_stream_no_data, headers_continuation_dropped, settings_max_frame_size_below_minimum

blackbull.grpc

encode_message, decode_messages, GrpcDecodeError, GrpcServiceRegistry, GrpcStatus, GrpcError, serve_grpc, GrpcContext

blackbull.middleware

Cache, CORS, Compression, StaticFiles, TrustedProxy, as_middleware, websocket

blackbull.mqtt

MQTTExtension, MQTTProtocolDetector, Message, Subscription, Tap, AsyncAPIExtension, BrokerActor, TapActor, serve_connection

blackbull.server

Server, ASGIServer

blackbull.testing

TestClient, WebSocketTestSession, WebSocketDisconnect