1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 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 67 68 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 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
|
# Copyright (c) 2022 Tulir Asokan
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from __future__ import annotations
from typing import Any, AsyncIterable, Awaitable, Iterable, Union, cast
from itertools import chain
from time import time
import argparse
import asyncio
import copy
import inspect
import logging
import logging.config
import signal
import sys
from .config import BaseFileConfig, BaseMissingError, BaseValidatableConfig, ConfigValueError
from .logging import TraceLogger
try:
import uvloop
except ImportError:
uvloop = None
try:
import prometheus_client as prometheus
except ImportError:
prometheus = None
NewTask = Union[Awaitable[Any], Iterable[Awaitable[Any]], AsyncIterable[Awaitable[Any]]]
TaskList = Iterable[Awaitable[Any]]
class Program:
"""
A generic main class for programs that handles argument parsing, config loading, logger setup
and general startup/shutdown lifecycle.
"""
loop: asyncio.AbstractEventLoop
log: TraceLogger
parser: argparse.ArgumentParser
args: argparse.Namespace
config_class: type[BaseFileConfig]
config: BaseFileConfig
startup_actions: TaskList
shutdown_actions: TaskList
module: str
name: str
version: str
command: str
description: str
def __init__(
self,
module: str | None = None,
name: str | None = None,
description: str | None = None,
command: str | None = None,
version: str | None = None,
config_class: type[BaseFileConfig] | None = None,
) -> None:
if module:
self.module = module
if name:
self.name = name
if description:
self.description = description
if command:
self.command = command
if version:
self.version = version
if config_class:
self.config_class = config_class
self.startup_actions = []
self.shutdown_actions = []
self._automatic_prometheus = True
def run(self) -> None:
"""
Prepare and run the program. This is the main entrypoint and the only function that should
be called manually.
"""
self._prepare()
self._run()
def _prepare(self) -> None:
start_ts = time()
self.preinit()
self.log.info(f"Initializing {self.name} {self.version}")
try:
self.prepare()
except Exception:
self.log.critical("Unexpected error in initialization", exc_info=True)
sys.exit(1)
end_ts = time()
self.log.info(f"Initialization complete in {round(end_ts - start_ts, 2)} seconds")
def preinit(self) -> None:
"""
First part of startup: parse command-line arguments, load and update config, prepare logger.
Exceptions thrown here will crash the program immediately. Asyncio must not be used at this
stage, as the loop is only initialized later.
"""
self.prepare_arg_parser()
self.args = self.parser.parse_args()
self.prepare_config()
self.prepare_log()
self.check_config()
@property
def base_config_path(self) -> str:
return f"pkg://{self.module}/example-config.yaml"
def prepare_arg_parser(self) -> None:
"""Pre-init lifecycle method. Extend this if you want custom command-line arguments."""
self.parser = argparse.ArgumentParser(description=self.description, prog=self.command)
self.parser.add_argument(
"-c",
"--config",
type=str,
default="config.yaml",
metavar="<path>",
help="the path to your config file",
)
self.parser.add_argument(
"-n", "--no-update", action="store_true", help="Don't save updated config to disk"
)
def prepare_config(self) -> None:
"""Pre-init lifecycle method. Extend this if you want to customize config loading."""
self.config = self.config_class(self.args.config, self.base_config_path)
self.load_and_update_config()
def load_and_update_config(self) -> None:
self.config.load()
try:
self.config.update(save=not self.args.no_update)
except BaseMissingError:
print(
"Failed to read base config from the default path "
f"({self.base_config_path}). Maybe your installation is corrupted?"
)
sys.exit(12)
def check_config(self) -> None:
"""Pre-init lifecycle method. Extend this if you want to customize config validation."""
if not isinstance(self.config, BaseValidatableConfig):
return
try:
self.config.check_default_values()
except ConfigValueError as e:
self.log.fatal(f"Configuration error: {e}")
sys.exit(11)
def prepare_log(self) -> None:
"""Pre-init lifecycle method. Extend this if you want to customize logging setup."""
logging.config.dictConfig(copy.deepcopy(self.config["logging"]))
self.log = cast(TraceLogger, logging.getLogger("mau.init"))
def prepare(self) -> None:
"""
Lifecycle method where the primary program initialization happens.
Use this to fill startup_actions with async startup tasks.
"""
self.prepare_loop()
def prepare_loop(self) -> None:
"""Init lifecycle method where the asyncio event loop is created."""
if uvloop is not None:
uvloop.install()
self.log.debug("Using uvloop for asyncio")
self.loop = asyncio.new_event_loop()
asyncio.set_event_loop(self.loop)
def start_prometheus(self) -> None:
try:
enabled = self.config["metrics.enabled"]
listen_port = self.config["metrics.listen_port"]
except KeyError:
return
if not enabled:
return
elif not prometheus:
self.log.warning(
"Metrics are enabled in config, but prometheus_client is not installed"
)
return
prometheus.start_http_server(listen_port)
def _run(self) -> None:
signal.signal(signal.SIGINT, signal.default_int_handler)
signal.signal(signal.SIGTERM, signal.default_int_handler)
self._stop_task = self.loop.create_future()
exit_code = 0
try:
self.log.debug("Running startup actions...")
start_ts = time()
self.loop.run_until_complete(self.start())
end_ts = time()
self.log.info(
f"Startup actions complete in {round(end_ts - start_ts, 2)} seconds, "
"now running forever"
)
exit_code = self.loop.run_until_complete(self._stop_task)
self.log.debug("manual_stop() called, stopping...")
except KeyboardInterrupt:
self.log.debug("Interrupt received, stopping...")
except Exception:
self.log.critical("Unexpected error in main event loop", exc_info=True)
self.loop.run_until_complete(self.system_exit())
sys.exit(2)
except SystemExit:
self.loop.run_until_complete(self.system_exit())
raise
self.prepare_stop()
self.loop.run_until_complete(self.stop())
self.prepare_shutdown()
self.loop.close()
asyncio.set_event_loop(None)
self.log.info("Everything stopped, shutting down")
sys.exit(exit_code)
async def system_exit(self) -> None:
"""Lifecycle method that is called if the main event loop exits using ``sys.exit()``."""
async def start(self) -> None:
"""
First lifecycle method called inside the asyncio event loop. Extend this if you want more
control over startup than just filling startup_actions in the prepare step.
"""
if self._automatic_prometheus:
self.start_prometheus()
await asyncio.gather(*(self.startup_actions or []))
def prepare_stop(self) -> None:
"""
Lifecycle method that is called before awaiting :meth:`stop`.
Useful for filling shutdown_actions.
"""
async def stop(self) -> None:
"""
Lifecycle method used to stop things that need awaiting to stop. Extend this if you want
more control over shutdown than just filling shutdown_actions in the prepare_stop method.
"""
await asyncio.gather(*(self.shutdown_actions or []))
def prepare_shutdown(self) -> None:
"""Lifecycle method that is called right before ``sys.exit(0)``."""
def manual_stop(self, exit_code: int = 0) -> None:
"""Tell the event loop to cleanly stop and run the stop lifecycle steps."""
self._stop_task.set_result(exit_code)
def add_startup_actions(self, *actions: NewTask) -> None:
self.startup_actions = self._add_actions(self.startup_actions, actions)
def add_shutdown_actions(self, *actions: NewTask) -> None:
self.shutdown_actions = self._add_actions(self.shutdown_actions, actions)
@staticmethod
async def _unpack_async_iterator(iterable: AsyncIterable[Awaitable[Any]]) -> None:
tasks = []
async for task in iterable:
if inspect.isawaitable(task):
tasks.append(asyncio.create_task(task))
await asyncio.gather(*tasks)
def _add_actions(self, to: TaskList, add: tuple[NewTask, ...]) -> TaskList:
for item in add:
if inspect.isasyncgen(item):
to.append(self._unpack_async_iterator(item))
elif inspect.isawaitable(item):
if isinstance(to, list):
to.append(item)
else:
to = chain(to, [item])
elif isinstance(item, list):
if isinstance(to, list):
to += item
else:
to = chain(to, item)
else:
to = chain(to, item)
return to
|