^V&
@ s` d Z d d l m Z m Z d d l Z d d l Z d d l Z d d l Z y e Wn e k
rn e
Z Yn Xd d l Z d d l m
Z
d d l m Z m Z d d l m Z d d l m Z Gd d
d
e Z Gd d d e e Z Gd
d d e e Z Gd d d e e Z Gd d d Z d d d Z d d Z d d Z d S)z Daemon runner library.
)absolute_importunicode_literalsN )pidfile)
basestringunicode)
DaemonContext)0_chain_exception_from_existing_exception_contextc s4 e Z d Z d Z f d d Z d d Z S)DaemonRunnerErrorz3 Abstract base class for errors from DaemonRunner. c s' | j t t | j | | d S)N)_chain_from_contextsuperr
__init__)selfargskwargs) __class__
/runner.pyr
, s
zDaemonRunnerError.__init__c C s t | d d d S)Nas_causeT)r )r r r r r 1 s z%DaemonRunnerError._chain_from_context)__name__
__module__ __qualname____doc__r
r r r )r r r
) s r
c @ s" e Z d Z d Z d d Z d S) DaemonRunnerInvalidActionErrorz; Raised when specified action for DaemonRunner is invalid. c C s t | d d d S)Nr F)r )r r r r r 8 s z2DaemonRunnerInvalidActionError._chain_from_contextN)r r r r r r r r r r 5 s r c @ s e Z d Z d Z d S) DaemonRunnerStartFailureErrorz, Raised when failure starting DaemonRunner. N)r r r r r r r r r = s r c @ s e Z d Z d Z d S) DaemonRunnerStopFailureErrorz, Raised when failure stopping DaemonRunner. N)r r r r r r r r r A s r c @ s e Z d Z d Z e Z d Z d d Z d d Z d d d Z d
d Z
d d
Z d d Z d d Z
d e
d e d e
i Z d d Z d d Z d S) DaemonRunnera4 Controller for a callable running in a separate background process.
The first command-line argument is the action to take:
* 'start': Become a daemon and call `app.run()`.
* 'stop': Exit the daemon process specified in the PID file.
* 'restart': Stop, then start.
zstarted with pid {pid:d}c C s | j | | _ t | _ t | j d | j _ t | j d | j _ t | j d d d | j _
d | _ | j d k r t
| j | j | _ | j | j _ d S)a# Set up the parameters of a new runner.
:param app: The application instance; see below.
:return: ``None``.
The `app` argument must have the following attributes:
* `stdin_path`, `stdout_path`, `stderr_path`: Filesystem paths
to open and replace the existing `sys.stdin`, `sys.stdout`,
`sys.stderr`.
* `pidfile_path`: Absolute filesystem path to a file that will
be used as the PID file for the daemon. If ``None``, no PID
file will be used.
* `pidfile_timeout`: Used as the default acquisition timeout
value supplied to the runner's PID lock file.
* `run`: Callable that will be invoked when the daemon is
started.
Zrtzw+t bufferingr N)
parse_argsappr daemon_contextopenZ
stdin_pathstdinZ stdout_pathstdoutZ stderr_pathstderrr Z pidfile_pathmake_pidlockfileZpidfile_timeout)r r r r r r
T s
zDaemonRunner.__init__c C sg t j j | d } d } d j | j j } d j d | d | } t | t j | d S)z Emit a usage message, then exit.
:param argv: The command-line arguments used to invoke the
program, as a sequence of strings.
:return: ``None``.
r |zusage: {progname} {usage}prognameusageN)
ospathbasenamejoin action_funcskeysformat emit_messagesysexit)r argvr( Zusage_exit_codeZ action_usagemessager r r _usage_exity s
zDaemonRunner._usage_exitNc C sp | d k r t j } d } t | | k r: | j | t | d | _ | j | j k rl | j | d S)a Parse command-line arguments.
:param argv: The command-line arguments used to invoke the
program, as a sequence of strings.
:return: ``None``.
The parser expects the first argument as the program name, the
second argument as the action to perform.
If the parser fails to parse the arguments, emit a usage
message and exit the program.
Nr& r )r2 r4 lenr6 r actionr. )r r4 Zmin_argsr r r r s
zDaemonRunner.parse_argsc C s t | j r | j j y | j j Wn6 t j k
re t d j d | j } | Yn Xt j
} | j j d | } t | | j
j d S)z Open the daemon context and run the application.
:return: ``None``.
:raises DaemonRunnerStartFailureError: If the PID file cannot
be locked by this process.
z(PID file {pidfile.path!r} already lockedr pidN)is_pidfile_staler
break_lockr r! lockfileZ
AlreadyLockedr r0 r* getpid
start_messager1 r run)r errorr9 r5 r r r _start s
zDaemonRunner._startc C sv | j j } y t j | t j WnI t k
rq } z) t d j d | d | } | WYd d } ~ Xn Xd S)z Terminate the daemon process specified in the current PID file.
:return: ``None``.
:raises DaemonRunnerStopFailureError: If terminating the daemon
fails with an OS error.
z"Failed to terminate {pid:d}: {exc}r9 excN) r read_pidr* killsignalSIGTERMOSErrorr r0 )r r9 rB r@ r r r _terminate_daemon_process s z&DaemonRunner._terminate_daemon_processc C s] | j j s0 t d j d | j } | t | j rO | j j n
| j d S)z Exit the daemon process specified in the current PID file.
:return: ``None``.
:raises DaemonRunnerStopFailureError: If the PID file is not
already locked.
z$PID file {pidfile.path!r} not lockedr N)r Z is_lockedr r0 r: r; rH )r r@ r r r _stop s zDaemonRunner._stopc C s | j | j d S)z Stop, then start.
N)rI rA )r r r r _restart s
zDaemonRunner._restartstartstopZrestartc C sN y | j | j } Wn3 t k
rI t d j d | j } | Yn X| S)ae Get the function for the specified action.
:return: The function object corresponding to the specified
action.
:raises DaemonRunnerInvalidActionError: if the action is
unknown.
The action is specified by the `action` attribute, which is set
during `parse_args`.
zUnknown action: {action!r}r8 )r. r8 KeyErrorr r0 )r funcr@ r r r _get_action_func s
z DaemonRunner._get_action_funcc C s | j } | | d S)z Perform the requested action.
:return: ``None``.
The action is specified by the `action` attribute, which is set
during `parse_args`.
N)rO )r rN r r r do_action s zDaemonRunner.do_action)r r r r typeZ
__metaclass__r> r
r6 r rA rH rI rJ r. rO rP r r r r r E s % r c C s< | d k r t j } | j d j d | | j d S)z@ Emit a message to the specified stream (default `sys.stderr`). Nz
{message}
r5 )r2 r$ writer0 flush)r5 streamr r r r1 s r1 c C ss t | t s- t d j d | } | t j j | s] t d j d | } | t j | | } | S)z= Make a PIDLockFile instance with the given filesystem path. z Not a filesystem path: {path!r}r+ z Not an absolute path: {path!r})
isinstancer
ValueErrorr0 r* r+ isabsr ZTimeoutPIDLockFile)r+ Zacquire_timeoutr@ r< r r r r% s r% c C s d } | j } | d k r y t j | t j WnT t k
rO d } Yn= t k
r } z | j t j k ry d } WYd d } ~ Xn X| S)u Determine whether a PID file is stale.
:return: ``True`` iff the PID file is stale; otherwise ``False``.
The PID file is “stale” if its contents are valid but do not
match the PID of a currently-running process.
FNT) rC r* rD rE SIG_DFLProcessLookupErrorrG errnoZESRCH)r resultZ pidfile_pidrB r r r r: % s
r: ) r Z
__future__r r r2 r* rE rZ rY NameErrorNotImplementedr< r daemonr r r r Exceptionr
rV r RuntimeErrorr r r r1 r% r: r r r r <module> s,