PR#61: Set the “inheritable” flag on MS Windows file handles for system streams. - python-daemon

Ben Finney • 7 months ago

3a05ea9

Ben Finney • 7 months ago

cdbbca2

Ben Finney • 7 months ago

e69c961

Juern Brodersen • 7 months ago

f477ff1

ChangeLog

file modified

		`@@ -84,6 +84,12 @@`

		`Closes: Pagure #72. Thanks to Anton Anton for the report.`

		`+ * Set file handles (MS Windows only) of standard streams to be`
		`+ inheritable.`
		`+`
		`+ Closes: Pagure #57. Thanks to Juern Brodersen for the report and`
		`+ test case.`
		`+`
		`Added:`

		* Document a `ServiceRunner` class as an example of using `DaemonContext`.

daemon/daemon.py

file modified

+21

		`@@ -978,6 +978,27 @@`
		`else:`
		`target_fd = target_stream.fileno()`
		`os.dup2(target_fd, system_stream.fileno())`
		`+ _set_file_handle_inheritable(target_fd)`
		`+`
		`+`
		`+ def _set_file_handle_inheritable(handle):`
		+ """ Set the “inheritable” flag of file handle `handle`.
		`+`
		`+ :param handle: The file handle value.`
		+ :return: ``None``.
		`+`
		+ See the Python standard library `os` module. Only the
		+ `windows` platform uses file handles; the “inheritable” flag
		`+ only exists in Python 3.4 or later.`
		`+ """`
		`+ try:`
		`+ set_handle_inheritable = os.set_handle_inheritable`
		`+ except AttributeError:`
		`+ # Not available (and not needed) if Python < 3.4, or if the`
		`+ # platform is not MS Windows.`
		`+ pass`
		`+ else:`
		`+ set_handle_inheritable(handle)`


		`def make_default_signal_map():`

setup.py

file modified

+1 -1

test/test_daemon.py

file modified

+21

		`@@ -19,6 +19,7 @@`
		`import sys`
		`import tempfile`
		`from types import ModuleType`
		`+ import unittest`
		`import unittest.mock`
		`import warnings`

		`@@ -375,6 +376,7 @@`
		`self.mock_module_daemon.attach_mock(`
		`unittest.mock.Mock(), 'DaemonContext')`

		`+ make_fake_streams(self)`
		`self.test_files_preserve_fds = object()`
		`self.test_signal_handler_map = object()`
		`daemoncontext_method_return_values = {`
		`@@ -553,6 +555,25 @@`
		`self.mock_module_daemon.redirect_stream.assert_has_calls(`
		`expected_calls, any_order=True)`

		`+ @unittest.skipIf(`
		`+ sys.platform != 'windows',`
		`+ "File handles implemented only on MS Windows")`
		`+ @unittest.mock.patch.object(os, "set_inheritable")`
		`+ def test_duplicate_is_inheritable(`
		`+ self, mock_func_os_set_inheritable):`
		`+ """ The system streams should be inheritable.`
		`+`
		`+ dup2 sets the new file descriptors to be inhertiable. But if the`
		`+ old and new file descriptors are equal, the inheritable attribute`
		`+ is not changed.`
		`+ If the system streams aren't inheritable they would not be copied`
		`+ to any children of the daemon.`
		`+ """`
		`+ test_stream = self.fake_streams['stdout']`
		`+ stream_fileno = test_stream.fileno()`
		`+ daemon.daemon.redirect_stream(test_stream, test_stream)`
		`+ mock_func_os_set_inheritable.assert_called_with(stream_fileno, True)`
		`+`
		`def test_enters_pidfile_context(self):`
		`""" Should enter the PID file context manager. """`
		`instance = self.test_instance`