docs: clarify usage of close() method in PipeTransport docstring

2026-01-19 11:45:05 +08:00 · 2025-12-30 20:58:51 +08:00
parent 4d81455a83
commit 0a97e87a8e
1 changed files with 2 additions and 0 deletions
--- a/api/core/virtual_environment/channel/pipe_transport.py
+++ b/api/core/virtual_environment/channel/pipe_transport.py
@ -9,6 +9,8 @@ class PipeTransport(Transport):
    one for reading and one for writing.

    NOTE: r_fd and w_fd must be a pair created by os.pipe(). or returned from subprocess.Popen
+
+    NEVER FORGET TO CALL `close()` METHOD TO AVOID FILE DESCRIPTOR LEAKAGE.
    """

    def __init__(self, r_fd: int, w_fd: int):