From 3973c476c47cf5f760281b6c9e9bec57aa72c04e Mon Sep 17 00:00:00 2001 From: Mohammad Kazemi Date: Mon, 24 Feb 2025 10:40:42 +0330 Subject: [PATCH 1/4] catch SIGINT signal properly in 'up' function and call compose 'down' function for a graceful shutdown Signed-off-by: Mohammad Kazemi --- podman_compose.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/podman_compose.py b/podman_compose.py index 8920065..32f8dfe 100755 --- a/podman_compose.py +++ b/podman_compose.py @@ -2778,9 +2778,17 @@ async def compose_up(compose: PodmanCompose, args): max_service_length = curr_length if curr_length > max_service_length else max_service_length tasks = set() + + async def handle_sigint(): + log.info("Caught SIGINT, shutting down...") + down_args = argparse.Namespace(**dict(args.__dict__, volumes=False)) + await compose.commands["down"](compose, down_args) + for task in tasks: + task.cancel() + if sys.platform != 'win32': loop = asyncio.get_event_loop() - loop.add_signal_handler(signal.SIGINT, lambda: [t.cancel("User exit") for t in tasks]) + loop.add_signal_handler(signal.SIGINT, lambda: asyncio.create_task(handle_sigint())) for i, cnt in enumerate(compose.containers): # Add colored service prefix to output by piping output through sed From b748c2666cc3c92d382f2d57379f5f9c15c1f5fc Mon Sep 17 00:00:00 2001 From: Mohammad Kazemi Date: Mon, 24 Feb 2025 15:18:45 +0330 Subject: [PATCH 2/4] add try-except block to handle error in case of shutdown error Signed-off-by: Mohammad Kazemi --- podman_compose.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/podman_compose.py b/podman_compose.py index 32f8dfe..c7a1f56 100755 --- a/podman_compose.py +++ b/podman_compose.py @@ -2780,11 +2780,16 @@ async def compose_up(compose: PodmanCompose, args): tasks = set() async def handle_sigint(): - log.info("Caught SIGINT, shutting down...") - down_args = argparse.Namespace(**dict(args.__dict__, volumes=False)) - await compose.commands["down"](compose, down_args) - for task in tasks: - task.cancel() + log.info("Caught SIGINT or Ctrl+C, shutting down...") + try: + log.info("Shutting down gracefully, please wait...") + down_args = argparse.Namespace(**dict(args.__dict__, volumes=False)) + await compose.commands["down"](compose, down_args) + except Exception as e: + log.error(f"Error during shutdown: {e}") + finally: + for task in tasks: + task.cancel() if sys.platform != 'win32': loop = asyncio.get_event_loop() From f106ea0c012098b341a9b9abec5b3f5fb63b396c Mon Sep 17 00:00:00 2001 From: Mohammad Kazemi Date: Sat, 1 Mar 2025 12:34:58 +0330 Subject: [PATCH 3/4] modifications to pass pylint test Signed-off-by: Mohammad Kazemi --- .pylintrc | 2 +- podman_compose.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index 75169ce..05cf9e1 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,7 +1,7 @@ [MESSAGES CONTROL] # C0111 missing-docstring: missing-class-docstring, missing-function-docstring, missing-method-docstring, missing-module-docstrin # consider-using-with: we need it for color formatter pipe -disable=too-many-lines,too-many-branches,too-many-locals,too-many-statements,too-many-arguments,too-many-instance-attributes,fixme,multiple-statements,missing-docstring,line-too-long,consider-using-f-string,consider-using-with,unnecessary-lambda-assignment +disable=too-many-lines,too-many-branches,too-many-locals,too-many-statements,too-many-arguments,too-many-instance-attributes,fixme,multiple-statements,missing-docstring,line-too-long,consider-using-f-string,consider-using-with,unnecessary-lambda-assignment,broad-exception-caught # allow _ for ignored variables # allow generic names like a,b,c and i,j,k,l,m,n and x,y,z # allow k,v for key/value diff --git a/podman_compose.py b/podman_compose.py index c7a1f56..844027a 100755 --- a/podman_compose.py +++ b/podman_compose.py @@ -2786,7 +2786,7 @@ async def compose_up(compose: PodmanCompose, args): down_args = argparse.Namespace(**dict(args.__dict__, volumes=False)) await compose.commands["down"](compose, down_args) except Exception as e: - log.error(f"Error during shutdown: {e}") + log.error("Error during shutdown: %s", e) finally: for task in tasks: task.cancel() From f5a6df6dc4cea912c9de9e070ffe523085035752 Mon Sep 17 00:00:00 2001 From: Mohammad Kazemi Date: Wed, 19 Mar 2025 16:02:34 +0330 Subject: [PATCH 4/4] added changes to release notes Signed-off-by: Mohammad Kazemi --- newsfragments/sigint-up.bugfix | 1 + 1 file changed, 1 insertion(+) create mode 100644 newsfragments/sigint-up.bugfix diff --git a/newsfragments/sigint-up.bugfix b/newsfragments/sigint-up.bugfix new file mode 100644 index 0000000..8edd22c --- /dev/null +++ b/newsfragments/sigint-up.bugfix @@ -0,0 +1 @@ +- Fixed handling SIGINT when running "up" command to shutdown gracefully \ No newline at end of file