Skip to content

Python: preserve Windows backslashes and quotes in LocalShellTool shell paths - #10145

Open
Johnny Wilson Dougherty (JohnnyWilson16) wants to merge 1 commit into
microsoft:mainfrom
JohnnyWilson16:fix/9819-windows-shell-parsing
Open

Johnny Wilson Dougherty (JohnnyWilson16) wants to merge 1 commit into
microsoft:mainfrom
JohnnyWilson16:fix/9819-windows-shell-parsing

Conversation

@JohnnyWilson16

Copy link
Copy Markdown

Motivation & Context

On Windows, configuring LocalShellTool(shell=r"C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe") or setting AGENT_FRAMEWORK_SHELL to an unquoted Windows path fails with FileNotFoundError: [WinError 2]. resolve_shell used POSIX shlex.split, which strips backslashes as escape characters and fails to identify the binary as PowerShell.

Prior PR #9858 was closed by maintainer Eduard van Valkenburg (@eavanvalkenburg) with a request for a fresh PR with a complete Windows command-line parser that preserves escaped quotes and explicitly quoted empty arguments without dropping tokens.

Description & Review Guide

  • What are the major changes?
    • Added _split_windows_command_line in agent_framework_tools/shell/_resolve.py implementing CommandLineToArgvW rules:
      • Retains literal backslashes in unquoted and quoted file paths.
      • Preserves double-quoted parameters with whitespace.
      • Preserves explicitly empty arguments ("").
      • Handles escaped quotes (\") and consecutive backslash sequences preceding quotes ($2N$ / $2N+1$ rules).
    • Added _split_shell_override to dispatch to _split_windows_command_line on sys.platform == "win32" while preserving standard shlex.split behavior on POSIX systems.
    • Updated is_powershell to normalize backslashes before os.path.basename so Windows executable paths evaluate correctly across platforms.
    • Added unit tests in test_shell_resolve.py covering unquoted Windows paths, environment variable overrides, empty arguments, and adjacent quoted/unquoted tokens under win32 platform mocks.
  • What is the impact of these changes?
    • Windows users can supply standard backslash paths to LocalShellTool and AGENT_FRAMEWORK_SHELL. POSIX behavior is unchanged.
  • What do you want reviewers to focus on?
    • Adherence of _split_windows_command_line to Windows CommandLineToArgvW argument tokenization rules.

Related Issue

Fixes #9819

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: Used an AI coding assistant to help draft the Windows tokenizer following CommandLineToArgvW rules, write the regression tests, and prepare this description.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change.

@microsoft-github-policy-service

Copy link
Copy Markdown

Johnny Wilson Dougherty (@JohnnyWilson16) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

1 similar comment
@microsoft-github-policy-service

Copy link
Copy Markdown

Johnny Wilson Dougherty (@JohnnyWilson16) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The Windows shell parser drops literal quotes encoded as consecutive quotation marks, silently changing arguments supplied through shell= or AGENT_FRAMEWORK_SHELL.

1 open issue
What changed in this PR

This PR addresses #9819 by adding Windows-specific parsing for LocalShellTool shell overrides, preserving path backslashes while retaining POSIX parsing elsewhere.

Changes:

  • Adds Windows tokenization for explicit and environment-based overrides.
  • Updates PowerShell detection and adds regression tests for Windows paths, quoting, and empty arguments.
  • Adds implementation plans for this fix and a separate tool-approval budget cleanup.
File Description
python/​packages/​tools/​tests/​test_shell_resolve.py Adds Windows shell parsing regression tests.
python/​packages/​tools/​agent_framework_tools/​shell/​_resolve.py Adds platform-specific tokenization and normalizes paths for PowerShell detection.
docs/​superpowers/​plans/​2026-11-06-issue-9819-windows-shell-parsing.md Documents the Windows parsing implementation plan.
docs/​superpowers/​plans/​2026-11-06-issue-9677-tool-approval-budget-cleanup.md Adds an unrelated tool-approval budget cleanup plan; no runtime changes.

Review effort: Balanced

Comment on lines +54 to +55
elif c == '"':
in_quotes = not in_quotes

@BlueRaddish BlueRaddish left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is a concrete follow-up patch for the existing consecutive-quote finding, based on 8b47e6664be404472a06f28f357375653808e57b.

It preserves a doubled quote while already inside quotes, in both the ordinary quote branch and the even-backslash-before-quote branch. The eight regression cases exercise the explicit shell and AGENT_FRAMEWORK_SHELL paths; the existing 16 owning cases are unchanged. This keeps the current backslash, empty-argument, PowerShell detection and POSIX behavior.

--- a/python/packages/tools/agent_framework_tools/shell/_resolve.py
+++ b/python/packages/tools/agent_framework_tools/shell/_resolve.py
@@ -45,16 +45,24 @@
                     has_token = True
                     i += 1
                 else:
-                    in_quotes = not in_quotes
+                    if in_quotes and i + 1 < n and cmd[i + 1] == '"':
+                        buf.append('"')
+                        i += 2
+                    else:
+                        in_quotes = not in_quotes
+                        i += 1
                     has_token = True
-                    i += 1
             else:
                 buf.append("\\" * num_slashes)
                 has_token = True
         elif c == '"':
-            in_quotes = not in_quotes
+            if in_quotes and i + 1 < n and cmd[i + 1] == '"':
+                buf.append('"')
+                i += 2
+            else:
+                in_quotes = not in_quotes
+                i += 1
             has_token = True
-            i += 1
         else:
             buf.append(c)
             has_token = True
--- a/python/packages/tools/tests/test_shell_resolve.py
+++ b/python/packages/tools/tests/test_shell_resolve.py
@@ -135,3 +135,24 @@
     assert argv[0] == r"C:\Program Files\PowerShell\7\pwsh.exe"
     assert argv[1] == "-NoProfile"
     assert argv[-1] == "-Command"
+
+
+@pytest.mark.parametrize("from_env", [False, True], ids=["explicit", "env"])
+@pytest.mark.parametrize(
+    ("command_line", "expected"),
+    [
+        ('bash "a""b"', ["bash", 'a"b']),
+        ('bash "a"""', ["bash", 'a"']),
+        ('bash """a', ["bash", '"a']),
+        (r'bash "a\\""b"', ["bash", 'a\\"b']),
+    ],
+)
+def test_win32_consecutive_quotes(
+    command_line: str, expected: list[str], from_env: bool, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    import agent_framework_tools.shell._resolve as resolve_module
+
+    monkeypatch.setattr(resolve_module.sys, "platform", "win32")
+    if from_env:
+        monkeypatch.setenv("AGENT_FRAMEWORK_SHELL", command_line)
+    assert resolve_shell(None if from_env else command_line, interactive=True) == expected

Verification on Windows 11 / Python 3.11.17 / pytest 9.1.1:

  • Current complete resolver module with the final test file: 16 passed, 8 failed, 0 skipped. With this patch: 24 passed, 0 failed, 0 skipped.
  • Compared 21 argument vectors to the actual Windows CommandLineToArgvW API: current parser has 4 mismatches, patched parser has 0. Cases include empty arguments, escaped quotes, trailing backslashes, adjacent fragments and consecutive quotes. The oracle prepends a dummy executable to test ordinary argument parsing; it deliberately excludes Windows' special executable-token rule, preserving this PR's adjacent-fragment behavior.
  • The PR's declared Ruff 0.17.3 check and format check pass on the two proposed files under the exact root/package configuration.

Scope: the owning run executes the full resolver module and exact current test bodies with real pytest/MonkeyPatch and the exact ShellExecutionError class. Import-only package shims isolate unrelated SDK initialization. This does not claim full package initialization, repository-wide fixtures/suites, actual shell launch, native commit hooks or full workspace acceptance. The probes execute in their own verified, bounded processes; no model/provider calls were made.

AI assistance was used for implementation, regression tests and verification preparation. This is working implementation assistance for the already-reported gap, rather than a competing PR or a new report of that same finding.

This branch was successfully deployed

No deployments
github-app-auth — 8b47e666 Deployed Nov 6, 2026 by JohnnyWilson16 via team_check #8871
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python: [Bug]: LocalShellTool shell= / AGENT_FRAMEWORK_SHELL strips backslashes from Windows paths

3 participants