Skip to content

proxystore.endpoint.serve

Endpoint serving.

create_app 

create_app(
    endpoint: Endpoint,
    max_content_length: int | None = None,
    body_timeout: int = 300,
) -> quart.Quart

Create quart app for endpoint and registers routes.

Parameters:

  • endpoint (Endpoint) –

    Initialized endpoint to forward quart routes to.

  • max_content_length (int | None) –

    Max request body size in bytes.

  • body_timeout (int) –

    Number of seconds to wait for the body to be completely received.

Returns:

  • quart.Quart –

    Quart app.

Source code in proxystore/endpoint/serve.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def create_app(
    endpoint: Endpoint,
    max_content_length: int | None = None,
    body_timeout: int = 300,
) -> quart.Quart:
    """Create quart app for endpoint and registers routes.

    Args:
        endpoint: Initialized endpoint to forward quart routes to.
        max_content_length: Max request body size in bytes.
        body_timeout: Number of seconds to wait for the body to be
            completely received.

    Returns:
        Quart app.
    """
    app = quart.Quart(__name__)

    app.config['endpoint'] = endpoint

    app.register_blueprint(routes_blueprint, url_prefix='')

    logger.info(
        'quart routes registered to endpoint '
        f'{endpoint.uuid} ({endpoint.name})',
    )

    app.config['MAX_CONTENT_LENGTH'] = max_content_length
    app.config['BODY_TIMEOUT'] = body_timeout

    return app

serve 

serve(
    config: EndpointConfig,
    *,
    log_level: int | str = logging.INFO,
    log_file: str | None = None,
    use_uvloop: bool = True
) -> None

Initialize endpoint and serve Quart app.

Warning

This function does not return until the Quart app is terminated.

Parameters:

  • config (EndpointConfig) –

    Configuration object.

  • log_level (int | str) –

    Logging level of endpoint.

  • log_file (str | None) –

    Optional file path to append log to.

  • use_uvloop (bool) –

    Install uvloop as the default event loop implementation.

Source code in proxystore/endpoint/serve.py 
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def serve(
    config: EndpointConfig,
    *,
    log_level: int | str = logging.INFO,
    log_file: str | None = None,
    use_uvloop: bool = True,
) -> None:
    """Initialize endpoint and serve Quart app.

    Warning:
        This function does not return until the Quart app is terminated.

    Args:
        config: Configuration object.
        log_level: Logging level of endpoint.
        log_file: Optional file path to append log to.
        use_uvloop: Install uvloop as the default event loop implementation.
    """
    if config.host is None:
        raise ValueError('EndpointConfig has NoneType as host.')

    if log_file is not None:
        parent_dir = os.path.dirname(log_file)
        if not os.path.isdir(parent_dir):
            os.makedirs(parent_dir, exist_ok=True)
        logging.getLogger().handlers.append(logging.FileHandler(log_file))

    for handler in logging.getLogger().handlers:
        handler.setFormatter(
            logging.Formatter(
                '[%(asctime)s.%(msecs)03d] %(levelname)-5s (%(name)s) :: '
                '%(message)s',
                datefmt='%Y-%m-%d %H:%M:%S',
            ),
        )
    logging.getLogger().setLevel(log_level)

    kwargs = dataclasses.asdict(config)
    # These are the only two EndpointConfig attributes not passed to the
    # Endpoint constructor
    kwargs.pop('host', None)
    kwargs.pop('port', None)
    # Backwards compatibility hack because EndpointConfig and Endpoint call
    # the signaling server fields differently
    kwargs['signaling_server'] = kwargs.pop('server')

    endpoint = Endpoint(**kwargs)
    app = create_app(endpoint)

    serve_config = hypercorn.config.Config()
    serve_config.bind = [f'{config.host}:{config.port}']
    serve_config.accesslog = logging.getLogger('hypercorn.access')
    serve_config.errorlog = logging.getLogger('hypercorn.error')

    if use_uvloop:  # pragma: no cover
        logger.debug('installing uvloop as default event loop')
        uvloop.install()

    logger.info(
        f'serving endpoint {endpoint.uuid} ({endpoint.name}) on '
        f'{config.host}:{config.port}',
    )
    logger.info(f'config: {config}')
    asyncio.run(hypercorn.asyncio.serve(app, serve_config))