Title: docs(cmd): clarify Git.execute() string vs list command argument by mvanhorn · Pull Request #2144 · gitpython-developers/GitPython · GitHub
Open Graph Title: docs(cmd): clarify Git.execute() string vs list command argument by mvanhorn · Pull Request #2144 · gitpython-developers/GitPython
X Title: docs(cmd): clarify Git.execute() string vs list command argument by mvanhorn · Pull Request #2144 · gitpython-developers/GitPython
Description: What changed Rewrites the :param command: docstring on Git.execute() in git/cmd.py to clarify the string-vs-sequence semantics. The previous wording ("the program to execute is the first item in the args sequence or string") was misleading: with shell=False (the default), subprocess.Popen treats the entire string as a single executable name, so "git log -n 1" looks for an executable literally named "git log -n 1" and raises GitCommandNotFound. The new docstring: Recommends the sequence form (["git", "log", "-n", "1"]) for the default shell=False case. Documents that a string is accepted but is passed as a single executable name when shell=False, with the exact failure mode users see in #2016. Points users at shlex.split(...) (sequence) or shell=True (with the existing warning) for the case where they want a string that gets tokenised. Closes #2016 Why This is the third recurrence of this confusion that surfaces in issues — string commands look like the obvious shape for "run this git invocation", and the failure mode is opaque. The subprocess.Popen semantics are doing exactly what they always do; the GitPython docstring was the surface that misled users into expecting otherwise. Updating it costs ~10 lines and short-circuits the next round of issues. I deliberately kept this docs-only. Auto-splitting a string when it contains spaces would be a behavior change that could break existing callers who do pass a single executable path with whitespace. The acknowledged label on the issue suggests maintainer interest without committing to a specific behavior fix; clarifying the docs is the smallest useful step. Verification python -c "import git; help(git.cmd.Git.execute)" renders the new param block cleanly. python -m py_compile git/cmd.py is clean. No tests were modified or broken.
Open Graph Description: What changed Rewrites the :param command: docstring on Git.execute() in git/cmd.py to clarify the string-vs-sequence semantics. The previous wording ("the program to execute is the first item ...
X Description: What changed Rewrites the :param command: docstring on Git.execute() in git/cmd.py to clarify the string-vs-sequence semantics. The previous wording ("the program to execute is the first i...
Opengraph URL: https://github.com/gitpython-developers/GitPython/pull/2144
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:d4fc367f-ddd6-186c-fa91-1df664dc5120 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | C18C:B2552:69BDA:8C008:6A59690F |
| html-safe-nonce | 55bf0b6473ecdced36a8521bcef163581d9abdd5c090d8a171cb2529854d096c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMThDOkIyNTUyOjY5QkRBOjhDMDA4OjZBNTk2OTBGIiwidmlzaXRvcl9pZCI6IjE1Njc5MTYzOTQ4ODAyNjQ0NjMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | dd6fcb6696c6e77fdff2ff7981f78983edac9cecfc994e083b3e54f7fc750f0a |
| hovercard-subject-tag | pull_request:3642360661 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/gitpython-developers/GitPython/pull/2144/files |
| twitter:image | https://avatars.githubusercontent.com/u/455140?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/455140?s=400&v=4 |
| og:image:alt | What changed Rewrites the :param command: docstring on Git.execute() in git/cmd.py to clarify the string-vs-sequence semantics. The previous wording ("the program to execute is the first item ... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | a540949572872b935b393b36db38922db390ae71c859537d741b8f3eb7e545b5 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/gitpython-developers/GitPython git https://github.com/gitpython-developers/GitPython.git |
| octolytics-dimension-user_id | 503709 |
| octolytics-dimension-user_login | gitpython-developers |
| octolytics-dimension-repository_id | 1126087 |
| octolytics-dimension-repository_nwo | gitpython-developers/GitPython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1126087 |
| octolytics-dimension-repository_network_root_nwo | gitpython-developers/GitPython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 4aa391d605ba491481565840251a4b0fec3f4807 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width