X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=lockfile.py;h=2bbe6f4e2124419bd788312f17a0e6645d921232;hb=36fea7f15ed17150691b5b3ead75450e575229ef;hp=d275f407ff237c38ceaec83c94a1abf92174b04a;hpb=d1fdbad2a4b96a374fdd23e8c8550484a9e6523a;p=python_utils.git diff --git a/lockfile.py b/lockfile.py index d275f40..2bbe6f4 100644 --- a/lockfile.py +++ b/lockfile.py @@ -8,6 +8,7 @@ import os import signal import sys from typing import Optional +import warnings import config import datetime_utils @@ -15,14 +16,14 @@ import decorator_utils cfg = config.add_commandline_args( - f'Lockfile ({__file__})', - 'Args related to lockfiles') + f'Lockfile ({__file__})', 'Args related to lockfiles' +) cfg.add_argument( '--lockfile_held_duration_warning_threshold_sec', type=float, default=10.0, metavar='SECONDS', - help='If a lock is held for longer than this threshold we log a warning' + help='If a lock is held for longer than this threshold we log a warning', ) logger = logging.getLogger(__name__) @@ -49,13 +50,14 @@ class LockFile(object): # some logic for detecting stale locks. """ + def __init__( - self, - lockfile_path: str, - *, - do_signal_cleanup: bool = True, - expiration_timestamp: Optional[float] = None, - override_command: Optional[str] = None, + self, + lockfile_path: str, + *, + do_signal_cleanup: bool = True, + expiration_timestamp: Optional[float] = None, + override_command: Optional[str] = None, ) -> None: self.is_locked = False self.lockfile = lockfile_path @@ -87,20 +89,20 @@ class LockFile(object): return True except OSError: pass - logger.warning(f'Could not acquire {self.lockfile}.') + msg = f'Could not acquire {self.lockfile}.' + logger.warning(msg) return False def acquire_with_retries( - self, - *, - initial_delay: float = 1.0, - backoff_factor: float = 2.0, - max_attempts = 5 + self, + *, + initial_delay: float = 1.0, + backoff_factor: float = 2.0, + max_attempts=5, ) -> bool: - - @decorator_utils.retry_if_false(tries = max_attempts, - delay_sec = initial_delay, - backoff = backoff_factor) + @decorator_utils.retry_if_false( + tries=max_attempts, delay_sec=initial_delay, backoff=backoff_factor + ) def _try_acquire_lock_with_retries() -> bool: success = self.try_acquire_lock_once() if not success and os.path.exists(self.lockfile): @@ -130,9 +132,16 @@ class LockFile(object): if self.locktime: ts = datetime.datetime.now().timestamp() duration = ts - self.locktime - if duration >= config.config['lockfile_held_duration_warning_threshold_sec']: - str_duration = datetime_utils.describe_duration_briefly(duration) - logger.warning(f'Held {self.lockfile} for {str_duration}') + if ( + duration + >= config.config['lockfile_held_duration_warning_threshold_sec'] + ): + str_duration = datetime_utils.describe_duration_briefly( + duration + ) + msg = f'Held {self.lockfile} for {str_duration}' + logger.warning(msg) + warnings.warn(msg, stacklevel=2) self.release() def __del__(self): @@ -148,11 +157,10 @@ class LockFile(object): cmd = self.override_command else: cmd = ' '.join(sys.argv) - print(cmd) contents = LockFileContents( - pid = os.getpid(), - commandline = cmd, - expiration_timestamp = self.expiration_timestamp, + pid=os.getpid(), + commandline=cmd, + expiration_timestamp=self.expiration_timestamp, ) return json.dumps(contents.__dict__) @@ -170,16 +178,16 @@ class LockFile(object): try: os.kill(contents.pid, 0) except OSError: - logger.warning(f'Lockfile {self.lockfile}\'s pid ({contents.pid}) is stale; ' + - 'force acquiring') + msg = f'Lockfile {self.lockfile}\'s pid ({contents.pid}) is stale; force acquiring' + logger.warning(msg) self.release() # Has the lock expiration expired? if contents.expiration_timestamp is not None: now = datetime.datetime.now().timestamp() if now > contents.expiration_datetime: - logger.warning(f'Lockfile {self.lockfile} expiration time has passed; ' + - 'force acquiring') + msg = f'Lockfile {self.lockfile} expiration time has passed; force acquiring' + logger.warning(msg) self.release() except Exception: pass