Merge pull request #88 from Pylons/graceful-shutdown

support triggering a graceful shutdown from within the worker process

CHANGES.rst

@@ -12,6 +12,10 @@ unreleased
 - Fix issues with watchman when the server shuts down unexpectedly and when
   subscriptions are canceled.
 
+- Add ``hupper.get_reloader().graceful_shutdown()`` which can be used within
+  your own app to trigger a full shutdown of the worker as well as the
+  monitoring.
+
 
 1.12.1 (2023-08-27)
 ===================

src/hupper/interfaces.py

@@ -10,6 +10,10 @@ def watch_files(self, files):
     def trigger_reload(self):
         """Signal the monitor to execute a reload."""
 
+    @abstractmethod
+    def graceful_shutdown(self):
+        """Signal the monitor to gracefully shutdown."""
+
 
 class IFileMonitorFactory(ABC):
     @abstractmethod

src/hupper/reloader.py

@@ -316,6 +316,9 @@ def handle_packet(packet):
                     for path in cmd[1]:
                         self.monitor.add_path(path)
 
+                elif cmd[0] == 'graceful_shutdown':
+                    os.write(self.control_w, ControlSignal.SIGTERM)
+
                 else:  # pragma: no cover
                     raise RuntimeError('received unknown control signal', cmd)
 

src/hupper/worker.py

@@ -242,6 +242,9 @@ def watch_files(self, files):
     def trigger_reload(self):
         self.pipe.send(('reload',))
 
+    def graceful_shutdown(self):
+        self.pipe.send(('graceful_shutdown',))
+
 
 def watch_control_pipe(pipe):
     def handle_packet(packet):