Skip to content

pick leftmost version-shaped token in _parse_tool_version#778

Open
HrachShah wants to merge 1 commit into
microsoft:mainfrom
HrachShah:fix/parse-tool-version-robust-nowf
Open

pick leftmost version-shaped token in _parse_tool_version#778
HrachShah wants to merge 1 commit into
microsoft:mainfrom
HrachShah:fix/parse-tool-version-robust-nowf

Conversation

@HrachShah

Copy link
Copy Markdown

Pull the parsing into a tested _parse_tool_version(stdout) helper:

  • Scan the first line for any token shaped like X.Y or X.Y.Z followed by an optional pre-release / dev / local segment, so "3.12.0)" no longer gets returned as "3.12.0" (the trailing ")" is no longer swallowed by \S*).
  • When multiple candidates appear, return the leftmost — the tool name always appears before any parenthesized environment info.
  • Return "0.0.0" only when no candidate is found, so the existing ">=" check still produces a clear "NOT supported" line.

Added bundled/tool/tests/test_parse_tool_version.py with 13 cases: standard black output, bare version, pre-release, dev with local segment, compiled and Python in parens (two forms), trailing newline, CRLF line endings, empty stdout, whitespace-only stdout, no version token, only a Python banner, and a check that the helper uses the first line only.

The inline regex in _update_workspace_settings_with_version_info took a
"--version" stdout, split the first line on whitespace, and kept the
result only when exactly one version-shaped token appeared. When black's
output also mentioned a Python version — e.g. "black, 22.3.0 (Python
3.11.4)" or "black, 26.3.1 (compiled: yes, Python 3.12.1)" — the second
token would push len(parts) above 1 and the code silently fell back to
"0.0.0". That literal is a valid (very old) SemVer, so the >= 22.3.0
check passed, the workspace was added to VERSION_LOOKUP, and the user
saw a misleading "NOT supported" line in the log for every workspace.

Pull the parsing into a tested _parse_tool_version(stdout) helper:
- Scan the first line for any token shaped like X.Y or X.Y.Z followed by
  an optional pre-release / dev / local segment, so "3.12.0)" no longer
  gets returned as "3.12.0" (the trailing ")" is no longer swallowed
  by \S*).
- When multiple candidates appear, return the leftmost — the tool name
  always appears before any parenthesized environment info.
- Return "0.0.0" only when no candidate is found, so the existing
  ">=" check still produces a clear "NOT supported" line.

Added bundled/tool/tests/test_parse_tool_version.py with 13 cases:
standard black output, bare version, pre-release, dev with local
segment, compiled and Python in parens (two forms), trailing newline,
CRLF line endings, empty stdout, whitespace-only stdout, no version
token, only a Python banner, and a check that the helper uses the
first line only. All pass under pytest 8.4.
@microsoft-github-policy-service

Copy link
Copy Markdown

@HrachShah 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.

@rchiodo

rchiodo commented Jul 7, 2026

Copy link
Copy Markdown

🔒 Automated review in progress — @rchiodo is auto-reviewing this PR.

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.

Pull request overview

This PR refactors the logic that extracts Black’s version from black --version output into a dedicated _parse_tool_version(stdout) helper and adds focused unit tests to prevent regressions across common real-world stdout formats.

Changes:

  • Added lsp_server._parse_tool_version(stdout) to pick the leftmost “version-shaped” token from the first stdout line, returning "0.0.0" only when no candidate exists.
  • Replaced the prior inline version-parsing logic in _update_workspace_settings_with_version_info with the new helper.
  • Added a new pytest module with coverage for standard, pre-release/dev/local, parenthetical Python info, CRLF, empty/whitespace output, and multi-line stdout cases.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
bundled/tool/lsp_server.py Introduces _parse_tool_version and wires it into workspace version detection; also includes newly added module-level tool configuration/constants (currently problematic).
bundled/tool/tests/test_parse_tool_version.py Adds unit tests covering many black --version stdout variants to validate version parsing behavior.

Comment on lines +91 to +111
TOOL_MODULE = "black"
TOOL_DISPLAY = "Black Formatter"

# Default arguments always passed to black.
TOOL_ARGS = []

# Minimum version of black supported.
MIN_VERSION = "22.3.0"

BLACK_CONFIG = ToolServerConfig(
tool_module=TOOL_MODULE,
tool_display=TOOL_DISPLAY,
tool_args=TOOL_ARGS,
min_version=MIN_VERSION,
runner_script=str(RUNNER),
)

tool_server = ToolServer(BLACK_CONFIG, server=LSP_SERVER)

WORKSPACE_SETTINGS = tool_server.workspace_settings
GLOBAL_SETTINGS = tool_server.global_settings
Comment on lines +113 to +121
# Minimum version of black that supports the `--line-ranges` CLI option.
LINE_RANGES_MIN_VERSION = (23, 11, 0)

# Timeout in seconds for formatting operations to prevent indefinite blocking.
FORMATTING_TIMEOUT = 120

# Versions of black found by workspace
VERSION_LOOKUP: Dict[str, Tuple[int, int, int]] = {}

return "0.0.0"
# When multiple version-shaped tokens are present, prefer the leftmost so
# the real tool version beats any "Python 3.12" fragment in parentheses.
return candidates[0]

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The "leftmost version-shaped token wins" heuristic only fails safe for black by coincidence: a leading Python 3.x banner is always < 22.3.0 (black's CalVer), so it correctly lands on "NOT supported". Since this file is the shared vscode-python-tools template and the helper is generically named _parse_tool_version, copying it to a tool whose real version is in the 2.x/3.x range (e.g. isort/autopep8) would mistake a leading Python banner for a supported version. Consider anchoring selection on TOOL_MODULE, or at least add a comment noting the leftmost rule is only safe here because black's version numbers exceed CPython's.


import lsp_server # noqa: E402


Copy link
Copy Markdown

Choose a reason for hiding this comment

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

bundled/ is the shipped VSIX payload. Please confirm .vscodeignore excludes bundled/**/tests/** (or relocate these tests to the conventional src/test/python_tests/ location) so test code isn't shipped in the extension.


def test_dev_version_with_local_segment(self):
# PEP 440 dev / local-version: 24.3.0.dev1+g1234
assert (

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The PR headline is that a trailing ) (e.g. 3.12.0)) is no longer swallowed, but in every test the returned leftmost token is followed by whitespace, so the )-stripping only ever affects the non-returned second candidate. Add a case that pins the headline behavior on the returned token, e.g. assert _parse_tool_version("black, 22.3.0)") == "22.3.0" (and ideally the no-space "black,22.3.0)" form).

@rchiodo

rchiodo commented Jul 7, 2026

Copy link
Copy Markdown

The core change is solid and nicely tested. A few small, non-blocking suggestions below (pin the trailing-) headline behavior in a test, confirm the tests aren't shipped in the VSIX, and note why the leftmost-token heuristic is safe for black specifically). Approving.

@rchiodo rchiodo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved via Review Center.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants