René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Git.execute output_stream is not documented to suppress kill_after_timeout, but does","articleBody":"When calling `Git.execute`, including indirectly through the dynamic methods of a `Git` object, passing a non-`None` value of `output_stream` suppresses the effect of `kill_after_timeout`. [The `threading.Timer` object is created](https://github.com/gitpython-developers/GitPython/blob/a58a6be043f62e6552ef1638ec497f3b805c5480/git/cmd.py#L1040-L1042) with the local `kill_process` function as its callback, but `start` is never called on it.\r\n\r\nhttps://github.com/gitpython-developers/GitPython/blob/a58a6be043f62e6552ef1638ec497f3b805c5480/git/cmd.py#L1050-L1079\r\n\r\nThis situation appears not entirely intentional, because:\r\n\r\n- The \"watchdog\" `Timer` is created, even though it is never used.\r\n- The docstring, even as it documents [that `as_process` suppresses `kill_after_timeout`](https://github.com/gitpython-developers/GitPython/blob/a58a6be043f62e6552ef1638ec497f3b805c5480/git/cmd.py#L880) (and that [`as_process` suppresses `output_stream`](https://github.com/gitpython-developers/GitPython/blob/a58a6be043f62e6552ef1638ec497f3b805c5480/git/cmd.py#L867)), does not mention any effect of `output_stream` on `kill_after_timeout`.\r\n\r\nSo either `kill_after_timeout` should be honored even when `output_stream` is used, *or* the docstring should be updated to mention that it does not (and the code possibly modified to not create the `Timer` object in the case that it is unused).\r\n\r\nI am not sure which change should be made, so I'm opening this rather than a PR to propose one of them.\r\n\r\nThis is effectively separate from #1756. (One quality this shares with #1756 is that it is relevant only to the behavior of `Git.execute` and functions that use it. Functions that use `handle_process_output` are unaffected; its `kill_after_timeout` is implemented differently with nonequivalent behavior and separate code. `handle_process_output` also does not take an `output_stream` argument.)","author":{"url":"https://github.com/EliahKagan","@type":"Person","name":"EliahKagan"},"datePublished":"2023-12-10T08:30:22.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":5},"url":"https://github.com/1762/GitPython/issues/1762"}