[PATCH net-next v1] tools: ynl: handle broken pipe gracefully in CLI

[PATCH net-next v1] tools: ynl: handle broken pipe gracefully in CLI

[Donald Hunter]

When sending YNL CLI output into a pipe, closing the pipe causes a
BrokenPipeError. E.g. running the following and quitting less:

./tools/net/ynl/pyynl/cli.py --family rt-link --dump getlink | less
Traceback (most recent call last):
  File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 160, in <module>
    main()
    ~~~~^^
  File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 142, in main
    output(reply)
    ~~~~~~^^^^^^^
  File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 97, in output
    pprint.PrettyPrinter().pprint(msg)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^
[...]
BrokenPipeError: [Errno 32] Broken pipe

Consolidate the try block for ops and notifications, and gracefully
handle the BrokenPipeError by adding an exception handler to the
consolidated try block.

Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
---
 tools/net/ynl/pyynl/cli.py | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/tools/net/ynl/pyynl/cli.py b/tools/net/ynl/pyynl/cli.py
index 794e3c7dcc65..33ccc5c1843b 100755
--- a/tools/net/ynl/pyynl/cli.py
+++ b/tools/net/ynl/pyynl/cli.py
@@ -144,16 +144,17 @@ def main():
             ops = [ (item[0], json.loads(item[1]), args.flags or []) for item in args.multi ]
             reply = ynl.do_multi(ops)
             output(reply)
-    except NlError as e:
-        print(e)
-        exit(1)
 
-    if args.ntf:
-        try:
+        if args.ntf:
             for msg in ynl.poll_ntf(duration=args.duration):
                 output(msg)
-        except KeyboardInterrupt:
-            pass
+    except NlError as e:
+        print(e)
+        exit(1)
+    except KeyboardInterrupt:
+        pass
+    except BrokenPipeError:
+        pass
 
 
 if __name__ == "__main__":
-- 
2.49.0

Re: [PATCH net-next v1] tools: ynl: handle broken pipe gracefully in CLI

[Jakub Kicinski]

On Thu,  8 May 2025 12:21:02 +0100 Donald Hunter wrote:
> When sending YNL CLI output into a pipe, closing the pipe causes a
> BrokenPipeError. E.g. running the following and quitting less:
> 
> ./tools/net/ynl/pyynl/cli.py --family rt-link --dump getlink | less
> Traceback (most recent call last):
>   File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 160, in <module>
>     main()
>     ~~~~^^
>   File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 142, in main
>     output(reply)
>     ~~~~~~^^^^^^^
>   File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 97, in output
>     pprint.PrettyPrinter().pprint(msg)
>     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^
> [...]
> BrokenPipeError: [Errno 32] Broken pipe
> 
> Consolidate the try block for ops and notifications, and gracefully
> handle the BrokenPipeError by adding an exception handler to the
> consolidated try block.

Reviewed-by: Jakub Kicinski <kuba@kernel.org>

Re: [PATCH net-next v1] tools: ynl: handle broken pipe gracefully in CLI

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Thu,  8 May 2025 12:21:02 +0100 you wrote:
> When sending YNL CLI output into a pipe, closing the pipe causes a
> BrokenPipeError. E.g. running the following and quitting less:
> 
> ./tools/net/ynl/pyynl/cli.py --family rt-link --dump getlink | less
> Traceback (most recent call last):
>   File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 160, in <module>
>     main()
>     ~~~~^^
>   File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 142, in main
>     output(reply)
>     ~~~~~~^^^^^^^
>   File "/home/donaldh/net-next/./tools/net/ynl/pyynl/cli.py", line 97, in output
>     pprint.PrettyPrinter().pprint(msg)
>     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^
> [...]
> BrokenPipeError: [Errno 32] Broken pipe
> 
> [...]

Here is the summary with links:
  - [net-next,v1] tools: ynl: handle broken pipe gracefully in CLI
    https://git.kernel.org/netdev/net-next/c/0df6932485a0

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html