Packaging: Use pip list --format=json for better parsing

src/managers/builtin/pipListUtils.ts

@@ -4,34 +4,22 @@ export interface PipPackage {
     displayName: string;
     description: string;
 }
-export function isValidVersion(version: string): boolean {
-    return /^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$/.test(
-        version,
-    );
-}
-export function parsePipList(data: string): PipPackage[] {
-    const collection: PipPackage[] = [];
 
-    const lines = data.split('\n').splice(2);
-    for (let line of lines) {
-        if (line.trim() === '' || line.startsWith('Package') || line.startsWith('----') || line.startsWith('[')) {
-            continue;
-        }
-        const parts = line.split(' ').filter((e) => e);
-        if (parts.length === 2) {
-            const name = parts[0].trim();
-            const version = parts[1].trim();
-            if (!isValidVersion(version)) {
-                continue;
-            }
-            const pkg = {
-                name,
-                version,
-                displayName: name,
-                description: version,
-            };
-            collection.push(pkg);
+export function parsePipListJson(data: string): PipPackage[] {
+    try {
+        const json = JSON.parse(data);
+        if (Array.isArray(json)) {
+            return json
+                .filter((item) => item.name && item.version)
+                .map(({ name, version }) => ({
+                    name,
+                    version,
+                    displayName: name,
+                    description: version,
+                }));
         }
+    } catch (_) {
+        // If JSON parsing fails, return an empty array. The caller can decide how to handle this case.
     }
-    return collection;
+    return [];
 }

src/managers/builtin/utils.ts

@@ -23,7 +23,7 @@ import {
 } from '../common/nativePythonFinder';
 import { shortVersion, sortEnvironments } from '../common/utils';
 import { runPython, runUV, shouldUseUv } from './helpers';
-import { parsePipList, PipPackage } from './pipListUtils';
+import { parsePipListJson, PipPackage } from './pipListUtils';
 
 const PIXI_EXTENSION_ID = 'renan-r-santos.pixi-code';
 const PIXI_RECOMMEND_DONT_ASK_KEY = 'pixi-extension-recommend-dont-ask';
@@ -190,7 +190,7 @@ async function refreshPipPackagesRaw(environment: PythonEnvironment, log?: LogOu
     const useUv = await shouldUseUv(log, environment.environmentPath.fsPath);
     if (useUv) {
         return await runUV(
-            ['pip', 'list', '--python', environment.execInfo.run.executable],
+            ['pip', 'list', '--python', environment.execInfo.run.executable, '--format=json'],
             undefined,
             log,
             undefined,
@@ -200,7 +200,7 @@ async function refreshPipPackagesRaw(environment: PythonEnvironment, log?: LogOu
     try {
         return await runPython(
             environment.execInfo.run.executable,
-            ['-m', 'pip', 'list'],
+            ['-m', 'pip', 'list', '--format=json'],
             undefined,
             log,
             undefined,
@@ -235,7 +235,7 @@ export async function refreshPipPackages(
             data = await refreshPipPackagesRaw(environment, log);
         }
 
-        return parsePipList(data);
+        return parsePipListJson(data);
     } catch (e) {
         log?.error('Error refreshing packages', e);
         showErrorMessageWithLogs(SysManagerStrings.packageRefreshError, log);

src/test/managers/builtin/pipListUtils.unit.test.ts

@@ -1,22 +1,22 @@
 import assert from 'assert';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { parsePipList } from '../../../managers/builtin/pipListUtils';
+import { parsePipListJson } from '../../../managers/builtin/pipListUtils';
 import { EXTENSION_TEST_ROOT } from '../../constants';
 
 const TEST_DATA_ROOT = path.join(EXTENSION_TEST_ROOT, 'managers', 'builtin');
 
-suite('Pip List Parser tests', () => {
+suite('Pip List JSON Parser tests', () => {
     const testNames = ['piplist1', 'piplist2', 'piplist3'];
 
     testNames.forEach((testName) => {
-        test(`Test parsing pip list output ${testName}`, async () => {
-            const pipListOutput = await fs.readFile(path.join(TEST_DATA_ROOT, `${testName}.actual.txt`), 'utf8');
+        test(`Test parsing pip list JSON output ${testName}`, async () => {
             const expected = JSON.parse(
                 await fs.readFile(path.join(TEST_DATA_ROOT, `${testName}.expected.json`), 'utf8'),
             );
+            const pipListOutput = JSON.stringify(expected.packages);
 
-            const actualPackages = parsePipList(pipListOutput);
+            const actualPackages = parsePipListJson(pipListOutput);
 
             assert.equal(actualPackages.length, expected.packages.length, 'Unexpected number of packages');
             actualPackages.forEach((actualPackage) => {
@@ -34,4 +34,23 @@ suite('Pip List Parser tests', () => {
             });
         });
     });
+
+    test('Returns an empty array for invalid JSON input', () => {
+        assert.deepStrictEqual(parsePipListJson('not json'), []);
+    });
+
+    test('Skips items without a name or version', () => {
+        const actualPackages = parsePipListJson(
+            JSON.stringify([{ name: 'pip', version: '24.0' }, { name: 'setuptools' }, { version: '1.0.0' }]),
+        );
+
+        assert.deepStrictEqual(actualPackages, [
+            {
+                name: 'pip',
+                version: '24.0',
+                displayName: 'pip',
+                description: '24.0',
+            },
+        ]);
+    });
 });