andreas/heartbeat
Public Access
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 44 Wiki Activity

re-format with black

Browse Source
This commit is contained in:
Andreas Wrede
2021-05-03 17:24:04 -04:00
parent 4d7442d70c
commit 62ef10620f
12 changed files with 564 additions and 528 deletions
Download Patch File Download Diff File Expand all files Collapse all files
daemon/daemon.py
+68 -54
View File
@@ -18,7 +18,7 @@
""" Daemon process behaviour.
"""
from __future__ import (absolute_import, unicode_literals)
from __future__ import absolute_import, unicode_literals
import os
import sys
@@ -27,6 +27,7 @@ import errno
import signal
import socket
import atexit
try:
# Python 2 has both ‘str’ (bytes) and ‘unicode’ (text).
basestring = basestring
@@ -36,7 +37,7 @@ except NameError:
basestring = str
unicode = str
class DaemonError(Exception):
""" Base exception class for errors from this module. """
@@ -56,7 +57,7 @@ class DaemonOSEnvironmentError(DaemonError, OSError):
class DaemonProcessDetachError(DaemonError, OSError):
""" Exception raised when process detach fails. """
class DaemonContext:
""" Context for turning the current program into a daemon process.
@@ -231,21 +232,21 @@ class DaemonContext:
__metaclass__ = type
def __init__(
self,
chroot_directory=None,
working_directory="/",
umask=0,
uid=None,
gid=None,
prevent_core=True,
detach_process=None,
files_preserve=None,
pidfile=None,
stdin=None,
stdout=None,
stderr=None,
signal_map=None,
):
self,
chroot_directory=None,
working_directory="/",
umask=0,
uid=None,
gid=None,
prevent_core=True,
detach_process=None,
files_preserve=None,
pidfile=None,
stdin=None,
stdout=None,
stderr=None,
signal_map=None,
):
""" Set up a new instance. """
self.chroot_directory = chroot_directory
self.working_directory = working_directory
@@ -427,8 +428,10 @@ class DaemonContext:
"""
exception = SystemExit(
"Terminating on signal {signal_number!r}".format(
signal_number=signal_number))
"Terminating on signal {signal_number!r}".format(
signal_number=signal_number
)
)
raise exception
def _get_exclude_file_descriptors(self):
@@ -454,8 +457,10 @@ class DaemonContext:
if files_preserve is None:
files_preserve = []
files_preserve.extend(
item for item in [self.stdin, self.stdout, self.stderr]
if hasattr(item, 'fileno'))
item
for item in [self.stdin, self.stdout, self.stderr]
if hasattr(item, "fileno")
)
exclude_descriptors = set()
for item in files_preserve:
@@ -502,8 +507,9 @@ class DaemonContext:
"""
signal_handler_map = dict(
(signal_number, self._make_signal_handler(target))
for (signal_number, target) in self.signal_map.items())
(signal_number, self._make_signal_handler(target))
for (signal_number, target) in self.signal_map.items()
)
return signal_handler_map
@@ -520,7 +526,7 @@ def _get_file_descriptor(obj):
"""
file_descriptor = None
if hasattr(obj, 'fileno'):
if hasattr(obj, "fileno"):
try:
file_descriptor = obj.fileno()
except ValueError:
@@ -529,7 +535,7 @@ def _get_file_descriptor(obj):
return file_descriptor
def change_working_directory(directory):
""" Change the working directory of this process.
@@ -541,7 +547,8 @@ def change_working_directory(directory):
os.chdir(directory)
except Exception as exc:
error = DaemonOSEnvironmentError(
"Unable to change working directory ({exc})".format(exc=exc))
"Unable to change working directory ({exc})".format(exc=exc)
)
raise error
@@ -561,7 +568,8 @@ def change_root_directory(directory):
os.chroot(directory)
except Exception as exc:
error = DaemonOSEnvironmentError(
"Unable to change root directory ({exc})".format(exc=exc))
"Unable to change root directory ({exc})".format(exc=exc)
)
raise error
@@ -576,7 +584,8 @@ def change_file_creation_mask(mask):
os.umask(mask)
except Exception as exc:
error = DaemonOSEnvironmentError(
"Unable to change file creation mask ({exc})".format(exc=exc))
"Unable to change file creation mask ({exc})".format(exc=exc)
)
raise error
@@ -597,10 +606,11 @@ def change_process_owner(uid, gid):
os.setuid(uid)
except Exception as exc:
error = DaemonOSEnvironmentError(
"Unable to change process owner ({exc})".format(exc=exc))
"Unable to change process owner ({exc})".format(exc=exc)
)
raise error
def prevent_core_dump():
""" Prevent this process from generating a core dump.
@@ -618,15 +628,16 @@ def prevent_core_dump():
core_limit_prev = resource.getrlimit(core_resource)
except ValueError as exc:
error = DaemonOSEnvironmentError(
"System does not support RLIMIT_CORE resource limit"
" ({exc})".format(exc=exc))
"System does not support RLIMIT_CORE resource limit"
" ({exc})".format(exc=exc)
)
raise error
# Set hard and soft limits to zero, i.e. no core dump at all.
core_limit = (0, 0)
resource.setrlimit(core_resource, core_limit)
def detach_process_context():
""" Detach the process context from parent and session.
@@ -656,15 +667,17 @@ def detach_process_context():
os._exit(0)
except OSError as exc:
error = DaemonProcessDetachError(
"{message}: [{exc.errno:d}] {exc.strerror}".format(
message=error_message, exc=exc))
"{message}: [{exc.errno:d}] {exc.strerror}".format(
message=error_message, exc=exc
)
)
raise error
fork_then_exit_parent(error_message="Failed first fork")
os.setsid()
fork_then_exit_parent(error_message="Failed second fork")
def is_process_started_by_init():
""" Determine whether the current process is started by `init`.
@@ -699,8 +712,7 @@ def is_socket(fd):
file_socket = socket.fromfd(fd, socket.AF_INET, socket.SOCK_RAW)
try:
socket_type = file_socket.getsockopt(
socket.SOL_SOCKET, socket.SO_TYPE)
socket_type = file_socket.getsockopt(socket.SOL_SOCKET, socket.SO_TYPE)
except socket.error as exc:
exc_errno = exc.args[0]
if exc_errno == errno.ENOTSOCK:
@@ -759,7 +771,7 @@ def is_detach_process_context_required():
return result
def close_file_descriptor_if_open(fd):
""" Close a file descriptor if already open.
@@ -778,13 +790,14 @@ def close_file_descriptor_if_open(fd):
pass
else:
error = DaemonOSEnvironmentError(
"Failed to close file descriptor {fd:d} ({exc})".format(
fd=fd, exc=exc))
"Failed to close file descriptor {fd:d} ({exc})".format(fd=fd, exc=exc)
)
raise error
MAXFD = 2048
def get_maximum_file_descriptors():
""" Get the maximum number of open file descriptors for this process.
@@ -820,7 +833,7 @@ def close_all_open_files(exclude=set()):
if fd not in exclude:
close_file_descriptor_if_open(fd)
def redirect_stream(system_stream, target_stream):
""" Redirect a system stream to a specified file.
@@ -844,7 +857,7 @@ def redirect_stream(system_stream, target_stream):
target_fd = target_stream.fileno()
os.dup2(target_fd, system_stream.fileno())
def make_default_signal_map():
""" Make the default signal map for this system.
@@ -855,15 +868,16 @@ def make_default_signal_map():
"""
name_map = {
'SIGTSTP': None,
'SIGTTIN': None,
'SIGTTOU': None,
'SIGTERM': 'terminate',
}
"SIGTSTP": None,
"SIGTTIN": None,
"SIGTTOU": None,
"SIGTERM": "terminate",
}
signal_map = dict(
(getattr(signal, name), target)
for (name, target) in name_map.items()
if hasattr(signal, name))
(getattr(signal, name), target)
for (name, target) in name_map.items()
if hasattr(signal, name)
)
return signal_map
@@ -895,7 +909,7 @@ def register_atexit_function(func):
"""
atexit.register(func)
def _chain_exception_from_existing_exception_context(exc, as_cause=False):
""" Decorate the specified exception with the existing exception context.
@@ -918,7 +932,7 @@ def _chain_exception_from_existing_exception_context(exc, as_cause=False):
exc.__context__ = existing_exc
exc.__traceback__ = existing_traceback
# Local variables:
# coding: utf-8
# mode: python