Add platform-specific default paths for Poetry cache and virtualenvs (#1218)

karthiknadig · web-flow · commit 0b9d32735568 · 2026-02-19T12:04:51.000+11:00
Fixes #1182 Fixes #1184
diff --git a/src/common/utils/platformUtils.ts b/src/common/utils/platformUtils.ts
@@ -1,3 +1,7 @@
 export function isWindows(): boolean {
     return process.platform === 'win32';
 }
+
+export function isMac(): boolean {
+    return process.platform === 'darwin';
+}
diff --git a/src/managers/poetry/poetryUtils.ts b/src/managers/poetry/poetryUtils.ts
@@ -7,8 +7,8 @@ import { execProcess } from '../../common/childProcess.apis';
 import { ENVS_EXTENSION_ID } from '../../common/constants';
 import { traceError, traceInfo } from '../../common/logging';
 import { getWorkspacePersistentState } from '../../common/persistentState';
-import { getUserHomeDir, untildify } from '../../common/utils/pathUtils';
-import { isWindows } from '../../common/utils/platformUtils';
+import { getUserHomeDir, normalizePath, untildify } from '../../common/utils/pathUtils';
+import { isMac, isWindows } from '../../common/utils/platformUtils';
 import { getSettingWorkspaceScope } from '../../features/settings/settingHelpers';
 import {
     isNativeEnvInfo,
@@ -214,14 +214,14 @@ export async function getPoetryVirtualenvsPath(poetryExe?: string): Promise<stri
             if (stdout) {
                 const venvPath = stdout.trim();
                 // Poetry might return the path with placeholders like {cache-dir}
-                // If it doesn't start with / or C:\ etc., assume it's using default
-                if (!path.isAbsolute(venvPath) || venvPath.includes('{')) {
-                    const home = getUserHomeDir();
-                    if (home) {
-                        poetryVirtualenvsPath = path.join(home, '.cache', 'pypoetry', 'virtualenvs');
-                    }
-                } else {
+                // Resolve the placeholder if present
+                if (venvPath.includes('{cache-dir}')) {
+                    poetryVirtualenvsPath = await resolveVirtualenvsPath(poetry, venvPath);
+                } else if (path.isAbsolute(venvPath)) {
                     poetryVirtualenvsPath = venvPath;
+                } else {
+                    // Not an absolute path and no placeholder, use platform-specific default
+                    poetryVirtualenvsPath = getDefaultPoetryVirtualenvsPath();
                 }
 
                 if (poetryVirtualenvsPath) {
@@ -234,17 +234,99 @@ export async function getPoetryVirtualenvsPath(poetryExe?: string): Promise<stri
         }
     }
 
-    // Fallback to default location
-    const home = getUserHomeDir();
-    if (home) {
-        poetryVirtualenvsPath = path.join(home, '.cache', 'pypoetry', 'virtualenvs');
+    // Fallback to platform-specific default location
+    poetryVirtualenvsPath = getDefaultPoetryVirtualenvsPath();
+    if (poetryVirtualenvsPath) {
         await state.set(POETRY_VIRTUALENVS_PATH_KEY, poetryVirtualenvsPath);
         return poetryVirtualenvsPath;
     }
 
     return undefined;
 }
 
+/**
+ * Returns the default Poetry cache directory based on the current platform.
+ * - Windows: %LOCALAPPDATA%\pypoetry\Cache or %APPDATA%\pypoetry\Cache
+ * - macOS: ~/Library/Caches/pypoetry
+ * - Linux: ~/.cache/pypoetry
+ */
+export function getDefaultPoetryCacheDir(): string | undefined {
+    if (isWindows()) {
+        const localAppData = process.env.LOCALAPPDATA;
+        if (localAppData) {
+            return path.join(localAppData, 'pypoetry', 'Cache');
+        }
+        const appData = process.env.APPDATA;
+        if (appData) {
+            return path.join(appData, 'pypoetry', 'Cache');
+        }
+        return undefined;
+    }
+
+    const home = getUserHomeDir();
+    if (!home) {
+        return undefined;
+    }
+
+    if (isMac()) {
+        return path.join(home, 'Library', 'Caches', 'pypoetry');
+    }
+
+    // Linux default
+    return path.join(home, '.cache', 'pypoetry');
+}
+
+/**
+ * Returns the default Poetry virtualenvs path based on the current platform.
+ * - Windows: %LOCALAPPDATA%\pypoetry\Cache\virtualenvs or %APPDATA%\pypoetry\Cache\virtualenvs
+ * - macOS: ~/Library/Caches/pypoetry/virtualenvs
+ * - Linux: ~/.cache/pypoetry/virtualenvs
+ */
+export function getDefaultPoetryVirtualenvsPath(): string | undefined {
+    const cacheDir = getDefaultPoetryCacheDir();
+    if (cacheDir) {
+        return path.join(cacheDir, 'virtualenvs');
+    }
+    return undefined;
+}
+
+/**
+ * Resolves the {cache-dir} placeholder in a Poetry virtualenvs path.
+ * First tries to query Poetry's cache-dir config, then falls back to platform-specific default.
+ * @param poetry Path to the poetry executable
+ * @param virtualenvsPath The path possibly containing {cache-dir} placeholder
+ * @returns The resolved path, or undefined if the placeholder cannot be resolved
+ */
+async function resolveVirtualenvsPath(poetry: string, virtualenvsPath: string): Promise<string | undefined> {
+    if (!virtualenvsPath.includes('{cache-dir}')) {
+        return virtualenvsPath;
+    }
+
+    // Try to get the actual cache-dir from Poetry
+    try {
+        const { stdout } = await execProcess(`"${poetry}" config cache-dir`);
+        if (stdout) {
+            const cacheDir = stdout.trim();
+            if (cacheDir && path.isAbsolute(cacheDir)) {
+                const resolved = virtualenvsPath.replace('{cache-dir}', cacheDir);
+                return path.normalize(resolved);
+            }
+        }
+    } catch (e) {
+        traceError('Error getting Poetry cache-dir config', e);
+    }
+
+    // Fall back to platform-specific default cache dir
+    const defaultCacheDir = getDefaultPoetryCacheDir();
+    if (defaultCacheDir) {
+        const resolved = virtualenvsPath.replace('{cache-dir}', defaultCacheDir);
+        return path.normalize(resolved);
+    }
+
+    // Cannot resolve the placeholder - return undefined instead of unresolved path
+    return undefined;
+}
+
 export async function getPoetryVersion(poetry: string): Promise<string | undefined> {
     try {
         const { stdout } = await execProcess(`"${poetry}" --version`);
@@ -274,8 +356,8 @@ export async function nativeToPythonEnv(
     const displayName = info.displayName || `poetry (${sv})`;
 
     // Check if this is a global Poetry virtualenv by checking if it's in Poetry's virtualenvs directory
-    // We need to use path.normalize() to ensure consistent path format comparison
-    const normalizedPrefix = path.normalize(info.prefix);
+    // We use normalizePath() for case-insensitive path comparison on Windows
+    const normalizedPrefix = normalizePath(info.prefix);
 
     // Determine if the environment is in Poetry's global virtualenvs directory
     let isGlobalPoetryEnv = false;
@@ -284,19 +366,17 @@ export async function nativeToPythonEnv(
     if (!isPoetryVirtualenvsInProject() || !info.project) {
         const virtualenvsPath = poetryVirtualenvsPath; // Use the cached value if available
         if (virtualenvsPath) {
-            const normalizedVirtualenvsPath = path.normalize(virtualenvsPath);
+            const normalizedVirtualenvsPath = normalizePath(virtualenvsPath);
             isGlobalPoetryEnv = normalizedPrefix.startsWith(normalizedVirtualenvsPath);
         } else {
-            // Fall back to checking the default location if we haven't cached the path yet
-            const homeDir = getUserHomeDir();
-            if (homeDir) {
-                const defaultPath = path.normalize(path.join(homeDir, '.cache', 'pypoetry', 'virtualenvs'));
-                isGlobalPoetryEnv = normalizedPrefix.startsWith(defaultPath);
+            // Fall back to checking the platform-specific default location if we haven't cached the path yet
+            const defaultPath = getDefaultPoetryVirtualenvsPath();
+            if (defaultPath) {
+                const normalizedDefaultPath = normalizePath(defaultPath);
+                isGlobalPoetryEnv = normalizedPrefix.startsWith(normalizedDefaultPath);
 
                 // Try to get the actual path asynchronously for next time
-                getPoetryVirtualenvsPath(_poetry).catch((e) =>
-                    traceError(`Error getting Poetry virtualenvs path: ${e}`),
-                );
+                getPoetryVirtualenvsPath(_poetry).catch((e) => traceError('Error getting Poetry virtualenvs path', e));
             }
         }
     }
diff --git a/src/test/constants.ts b/src/test/constants.ts
@@ -26,7 +26,7 @@ export function isMultiRootTest(): boolean {
         return false;
     }
     try {
-        // eslint-disable-next-line @typescript-eslint/no-require-imports
+         
         const vscode = require('vscode');
         return Array.isArray(vscode.workspace.workspaceFolders) && vscode.workspace.workspaceFolders.length > 1;
     } catch {
diff --git a/src/test/features/projectManager.initialize.unit.test.ts b/src/test/features/projectManager.initialize.unit.test.ts
@@ -310,8 +310,8 @@ suite('Project Manager Initialization - Settings Preservation', () => {
         test('adding a workspace folder should NOT write project settings', async () => {
             const mockConfig = new MockWorkspaceConfiguration();
             (mockConfig as any).get = <T>(key: string, defaultValue?: T): T | undefined => {
-                if (key === 'pythonProjects') return [] as unknown as T;
-                if (key === 'defaultEnvManager') return 'ms-python.python:venv' as T;
+                if (key === 'pythonProjects') {return [] as unknown as T;}
+                if (key === 'defaultEnvManager') {return 'ms-python.python:venv' as T;}
                 return defaultValue;
             };
             mockConfig.update = () => Promise.resolve();
@@ -347,8 +347,8 @@ suite('Project Manager Initialization - Settings Preservation', () => {
         test('removing a workspace folder should NOT write additional settings', async () => {
             const mockConfig = new MockWorkspaceConfiguration();
             (mockConfig as any).get = <T>(key: string, defaultValue?: T): T | undefined => {
-                if (key === 'pythonProjects') return [] as unknown as T;
-                if (key === 'defaultEnvManager') return 'ms-python.python:venv' as T;
+                if (key === 'pythonProjects') {return [] as unknown as T;}
+                if (key === 'defaultEnvManager') {return 'ms-python.python:venv' as T;}
                 return defaultValue;
             };
             mockConfig.update = () => Promise.resolve();
diff --git a/src/test/managers/poetry/poetryUtils.unit.test.ts b/src/test/managers/poetry/poetryUtils.unit.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,7 @@`
`1`	`1`	`export function isWindows(): boolean {`
`2`	`2`	`return process.platform === 'win32';`
`3`	`3`	`}`
	`4`	`+`
	`5`	`+export function isMac(): boolean {`
	`6`	`+ return process.platform === 'darwin';`
	`7`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ export function isMultiRootTest(): boolean {`
`26`	`26`	`return false;`
`27`	`27`	`}`
`28`	`28`	`try {`
`29`		`- // eslint-disable-next-line @typescript-eslint/no-require-imports`
	`29`	`+`
`30`	`30`	`const vscode = require('vscode');`
`31`	`31`	`return Array.isArray(vscode.workspace.workspaceFolders) && vscode.workspace.workspaceFolders.length > 1;`
`32`	`32`	`} catch {`