From ed47f1a0c31184280a303563237e34c0e53437d7 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Mon, 25 Oct 2021 15:05:02 -0700 Subject: [PATCH] Move cache location. Also, add doctests for exec_utils. --- cached/weather_data.py | 2 +- cached/weather_forecast.py | 2 +- exec_utils.py | 63 ++++++++++++++++++++++++++++++++------ 3 files changed, 56 insertions(+), 11 deletions(-) diff --git a/cached/weather_data.py b/cached/weather_data.py index 89c330a..d2bf787 100644 --- a/cached/weather_data.py +++ b/cached/weather_data.py @@ -23,7 +23,7 @@ cfg = config.add_commandline_args( cfg.add_argument( '--weather_data_cachefile', type=str, - default=f'{os.environ["HOME"]}/.weather_summary_cache', + default=f'{os.environ["HOME"]}/cache/.weather_summary_cache', metavar='FILENAME', help='File in which to cache weather data' ) diff --git a/cached/weather_forecast.py b/cached/weather_forecast.py index a413d9f..2509f43 100644 --- a/cached/weather_forecast.py +++ b/cached/weather_forecast.py @@ -27,7 +27,7 @@ cfg = config.add_commandline_args( cfg.add_argument( '--weather_forecast_cachefile', type=str, - default=f'{os.environ["HOME"]}/.weather_forecast_cache', + default=f'{os.environ["HOME"]}/cache/.weather_forecast_cache', metavar='FILENAME', help='File in which to cache weather data' ) diff --git a/exec_utils.py b/exec_utils.py index 1b58740..7e9dae5 100644 --- a/exec_utils.py +++ b/exec_utils.py @@ -1,29 +1,60 @@ #!/usr/bin/env python3 +import atexit import shlex import subprocess from typing import List, Optional def cmd_with_timeout(command: str, timeout_seconds: Optional[float]) -> int: + """ + Run a command but do not let it run for more than timeout seconds. + + >>> cmd_with_timeout('/bin/echo foo', 10.0) + 0 + + >>> cmd_with_timeout('/bin/sleep 2', 0.1) + Traceback (most recent call last): + ... + subprocess.TimeoutExpired: Command '['/bin/bash', '-c', '/bin/sleep 2']' timed out after 0.1 seconds + + """ return subprocess.check_call( ["/bin/bash", "-c", command], timeout=timeout_seconds ) -def cmd(command: str) -> str: +def cmd(command: str, timeout_seconds: Optional[float] = None) -> str: """Run a command with everything encased in a string and return the output text as a string. Raises subprocess.CalledProcessError. + + >>> cmd('/bin/echo foo')[:-1] + 'foo' + + >>> cmd('/bin/sleep 2', 0.1) + Traceback (most recent call last): + ... + subprocess.TimeoutExpired: Command '/bin/sleep 2' timed out after 0.1 seconds + """ ret = subprocess.run( - command, shell=True, capture_output=True, check=True + command, shell=True, capture_output=True, check=True, timeout=timeout_seconds, ).stdout return ret.decode("utf-8") def run_silently(command: str) -> None: """Run a command silently but raise subprocess.CalledProcessError if - it fails.""" + it fails. + + >>> run_silently("/usr/bin/true") + + >>> run_silently("/usr/bin/false") + Traceback (most recent call last): + ... + subprocess.CalledProcessError: Command '/usr/bin/false' returned non-zero exit status 1. + + """ subprocess.run( command, shell=True, stderr=subprocess.DEVNULL, stdout=subprocess.DEVNULL, capture_output=False, check=True @@ -35,13 +66,22 @@ def cmd_in_background( ) -> subprocess.Popen: args = shlex.split(command) if silent: - return subprocess.Popen(args, - stdin=subprocess.DEVNULL, - stdout=subprocess.DEVNULL, - stderr=subprocess.DEVNULL) + subproc = subprocess.Popen(args, + stdin=subprocess.DEVNULL, + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL) else: - return subprocess.Popen(args, - stdin=subprocess.DEVNULL) + subproc = subprocess.Popen(args, stdin=subprocess.DEVNULL) + def kill_subproc() -> None: + try: + if subproc.poll() is None: + logger.info("At exit handler: killing {}: {}".format(subproc, command)) + subproc.terminate() + subproc.wait(timeout=10.0) + except BaseException as be: + log.error(be) + atexit.register(kill_subproc) + return subproc def cmd_list(command: List[str]) -> str: @@ -50,3 +90,8 @@ def cmd_list(command: List[str]) -> str: """ ret = subprocess.run(command, capture_output=True, check=True).stdout return ret.decode("utf-8") + + +if __name__ == '__main__': + import doctest + doctest.testmod() -- 2.47.1