Coverage for faststream/_internal/cli/supervisors/basereload.py: 98%

36 statements  

« prev     ^ index     » next       coverage.py v7.17.3, created at 2026-11-17 21:20 +0000

1import os 

2from multiprocessing.context import SpawnProcess 

3from typing import TYPE_CHECKING 

4 

5from faststream._internal.cli.supervisors.utils import ( 

6 ExitEvent, 

7 get_subprocess, 

8 set_exit, 

9 stop_process, 

10) 

11from faststream._internal.logger import logger 

12 

13if TYPE_CHECKING: 

14 from faststream._internal.cli.dto import RunArgs, RunFunction 

15 

16 

17class BaseReload: 

18 """A base class for implementing a reloader process.""" 

19 

20 __slots__ = ( 

21 "_args", 

22 "_process", 

23 "_target", 

24 "pid", 

25 "reload_delay", 

26 "should_exit", 

27 ) 

28 

29 _process: SpawnProcess 

30 

31 reload_delay: float | None 

32 should_exit: ExitEvent 

33 pid: int 

34 reloader_name: str = "" 

35 

36 def __init__( 

37 self, 

38 target: "RunFunction", 

39 args: "RunArgs", 

40 reload_delay: float | None = 0.5, 

41 ) -> None: 

42 self._target = target 

43 self._args = args 

44 

45 self.should_exit = ExitEvent() 

46 self.pid = os.getpid() 

47 self.reload_delay = reload_delay 

48 

49 set_exit(lambda *_: self.should_exit.set(), sync=True) 

50 

51 def run(self) -> None: 

52 self.startup() 

53 while not self.should_exit.wait(self.reload_delay): 

54 if self.should_restart(): # pragma: no branch 

55 self.restart() 

56 self.shutdown() 

57 

58 def startup(self) -> None: 

59 logger.info( 

60 "Started reloader process [%s] using %s", 

61 self.pid, 

62 self.reloader_name, 

63 ) 

64 self._process = self.start_process() 

65 

66 def restart(self) -> None: 

67 self._stop_process() 

68 logger.info("Process successfully reloaded") 

69 self._process = self.start_process() 

70 

71 def shutdown(self) -> None: 

72 self._stop_process() 

73 logger.info("Stopping reloader process [%s]", self.pid) 

74 

75 def _stop_process(self) -> None: 

76 stop_process(self._process) 

77 

78 def start_process(self, worker_id: int | None = None) -> SpawnProcess: 

79 self._args.extra_options["worker_id"] = worker_id 

80 process = get_subprocess(target=self._target, args=(self._args,)) 

81 process.start() 

82 return process 

83 

84 def should_restart(self) -> bool: 

85 msg = "Reload strategies should override should_restart()" 

86 raise NotImplementedError(msg)