Skip to content

fix: normalize line endings before parsing pyproject.toml #26232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MOHAMMED WASIM KHAN (wasim-builds) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: normalize line endings before parsing pyproject.toml #26232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/client/pythonEnvironments/creation/provider/venvUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ export async function getPipRequirementsFiles(

function tomlParse(content: string): tomljs.JsonMap {
try {
return tomljs.parse(content);
// Normalize CRLF to LF to prevent @iarna/toml from throwing control-character errors on comments
return tomljs.parse(content.replace(/\r\n?/g, '\n'));
} catch (err) {
traceError('Failed to parse `pyproject.toml`:', err);
}
Expand Down
24 changes: 24 additions & 0 deletions src/test/pythonEnvironments/creation/provider/venvUtils.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import * as workspaceApis from '../../../../client/common/vscodeApis/workspaceAp
import {
ExistingVenvAction,
OPEN_REQUIREMENTS_BUTTON,
isPipInstallableToml,
pickExistingVenvAction,
pickPackagesToInstall,
} from '../../../../client/pythonEnvironments/creation/provider/venvUtils';
Expand Down Expand Up @@ -93,6 +94,29 @@ suite('Venv Utils test', () => {
]);
});

test('Toml with CRLF line endings and comments parses correctly', async () => {
findFilesStub.resolves([]);
pathExistsStub.resolves(true);
readFileStub.resolves(
'[project]\r\n# Project comment\r\nname = "spam"\r\nversion = "2020.0.0"\r\n[build-system]\r\n# Build system comment\r\nrequires = ["setuptools ~= 58.0"]\r\n',
);

const actual = await pickPackagesToInstall(workspace1);
assert.isTrue(showQuickPickWithBackStub.notCalled);
assert.deepStrictEqual(actual, [
{
installType: 'toml',
source: path.join(workspace1.uri.fsPath, 'pyproject.toml'),
},
]);
});

test('isPipInstallableToml handles CRLF and comments correctly', () => {
const crlfContent =
'[project]\r\n# Comment\r\nname = "spam"\r\n[build-system]\r\n# Another comment\r\nrequires = ["setuptools"]\r\n';
assert.isTrue(isPipInstallableToml(crlfContent));
});

test('Toml found with deps, but user presses escape', async () => {
findFilesStub.resolves([]);
pathExistsStub.resolves(true);
Expand Down