GitHub

hypercorn_server

API reference for hypercorn_server.

An HttpServer on hypercorn (extra pyfect-dev[http2]), which speaks HTTP/2 as Effect's NodeHttpServer does when given node:http2's server: cleartext (h2c) by default, with ALPN when config gives certfile and keyfile::

main = server.serve(app).pipe(layer.provide(hypercorn_server.layer(port=8080)))

Otherwise as uvicorn_server, on the same request handling and shutdown.

Re-exports

Classes

Functions

make

make(**options) -> Effect[HttpServerService, SocketServerError, ScopeTag]

An HttpServer on hypercorn, listening on host:port until the scope closes.

ParameterTypeDescription
optionsUnpack[Options] = {}

Returns Effect[HttpServerService, SocketServerError, ScopeTag]

def make(**options: Unpack[Options]) -> Effect[HttpServerService, SocketServerError, ScopeTag]:
    """An ``HttpServer`` on hypercorn, listening on ``host:port`` until the
    scope closes."""
    return make_listener(options, lambda dispatch: _Hypercorn(dispatch, options))

layer_server

layer_server(**options) -> Layer[HttpServer, SocketServerError]
ParameterTypeDescription
optionsUnpack[Options] = {}

Returns Layer[HttpServer, SocketServerError]

def layer_server(**options: Unpack[Options]) -> Layer[HttpServer, SocketServerError]:
    return layer_effect(HttpServer, make(**options))

layer

layer(**options) -> Layer[HttpServer | Path | HttpPlatform | FileSystem | Generator, SocketServerError]

The server and the services its apps use (live_server.layer_services).

ParameterTypeDescription
optionsUnpack[Options] = {}

Returns Layer[HttpServer | Path | HttpPlatform | FileSystem | Generator, SocketServerError]

def layer(
    **options: Unpack[Options],
) -> Layer[HttpServer | Path | HttpPlatform | FileSystem | Generator, SocketServerError]:
    """The server and the services its apps use (``live_server.layer_services``)."""
    return merge(layer_server(**options), layer_services)

layer_test

layer_test(**options) -> Layer[HttpServer | Path | HttpPlatform | FileSystem | Generator | HttpClient, SocketServerError]

A server on a free loopback port, its services, and an HttpClient (httpx) sending to it.

ParameterTypeDescription
optionsUnpack[Options] = {}

Returns Layer[HttpServer | Path | HttpPlatform | FileSystem | Generator | HttpClient, SocketServerError]

def layer_test(
    **options: Unpack[Options],
) -> Layer[
    HttpServer | Path | HttpPlatform | FileSystem | Generator | HttpClient, SocketServerError
]:
    """A server on a free loopback port, its services, and an ``HttpClient``
    (httpx) sending to it."""
    server = layer(**{"host": "127.0.0.1", **options})
    return layer_test_client.pipe(provide_merge(httpx_layer)).pipe(provide_merge(server))