API: create environment with name

Author: edvilme

api/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to the `@vscode/python-environments` API package are documen
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.0]
+
+### Added
+
+- Added optional `CreateEnvironmentOptions.name` so API consumers can request a specific name when creating an environment.
+
 ## [1.4.0]
 
 ### Changed

api/package-lock.json

@@ -1,7 +1,7 @@
 {
     "name": "@vscode/python-environments",
     "description": "An API facade for the Python Environments extension in VS Code",
-    "version": "1.4.0",
+    "version": "1.5.0",
     "author": {
         "name": "Microsoft Corporation"
     },

api/package.json

@@ -274,11 +274,13 @@ applies to.
 
 | Field | Type | Required | Description |
 | --- | --- | --- | --- |
+| `name` | `string` | No | Non-empty path segment to use as the new environment's name. Directory separators, `.` and `..` are rejected. When supplied, the manager uses that name without prompting for another. When omitted, the manager may prompt for a name or choose a default. |
 | `quickCreate` | `boolean` | No | `true` creates without any prompts. `false` means the user explicitly declined quick create, so prompts are allowed. `undefined` leaves the decision to the manager, which may offer quick create. |
 | `additionalPackages` | `string[]` | No | Packages to install in addition to whatever the manager installs by default. |
 
 ```typescript
 const env = await api.createEnvironment(projectUri, {
+    name: 'analysis-env',
     quickCreate: true,
     additionalPackages: ['requests', 'pytest'],
 });
@@ -506,7 +508,7 @@ createEnvironment(
 | Parameter | Type | Required | Description |
 | --- | --- | --- | --- |
 | `scope` | [`CreateEnvironmentScope`](#scope-types) | Yes | `Uri` or `Uri[]` for the projects the environment is created for; `'global'` creates one outside any project. |
-| `options` | [`CreateEnvironmentOptions`](#createenvironmentoptions) | No | Controls prompting (`quickCreate`) and extra packages (`additionalPackages`). |
+| `options` | [`CreateEnvironmentOptions`](#createenvironmentoptions) | No | Controls the environment name (`name`), prompting (`quickCreate`), and extra packages (`additionalPackages`). |
 
 **Returns** `Promise<PythonEnvironment | undefined>` - `undefined` when no
 environment was created, for example because the user cancelled the flow.
@@ -516,6 +518,7 @@ errors as well as `undefined`.
 
 ```typescript
 const created = await api.createEnvironment(projectUri, {
+    name: 'analysis-env',
     quickCreate: true,
     additionalPackages: ['requests'],
 });

docs/README.md

@@ -156,6 +156,17 @@ export class PythonEnvironmentApiImpl implements PythonEnvironmentApi {
         scope: CreateEnvironmentScope,
         options: CreateEnvironmentOptions | undefined,
     ): Promise<PythonEnvironment | undefined> {
+        if (
+            options?.name !== undefined &&
+            (options.name.trim().length === 0 ||
+                options.name === '.' ||
+                options.name === '..' ||
+                options.name.includes('/') ||
+                options.name.includes('\\') ||
+                options.name.includes('\0'))
+        ) {
+            throw new Error('Environment name must be a non-empty path segment');
+        }
         if (scope === 'global' || (!Array.isArray(scope) && scope instanceof Uri)) {
             await waitForEnvManager(scope === 'global' ? undefined : [scope]);
             const manager = this.envManagers.getEnvironmentManager(scope === 'global' ? undefined : scope);

src/extensionApi.ts

@@ -185,13 +185,18 @@ export class VenvManager implements EnvironmentManager {
                         this.globalEnv,
                         venvRoot,
                         options?.additionalPackages,
+                        options?.name,
                     );
                 }
             } else {
                 // If quickCreate is not set that means the user triggered this method from
                 // environment manager View, by selecting the venv manager.
                 result = await createPythonVenv(this.nativeFinder, this.api, this.log, this, globals, venvRoot, {
                     showQuickAndCustomOptions: options?.quickCreate === undefined,
+                    ...(options?.name === undefined ? {} : { name: options.name }),
+                    ...(options?.additionalPackages === undefined
+                        ? {}
+                        : { additionalPackages: options.additionalPackages }),
                 });
             }
 

src/managers/builtin/venvManager.ts

@@ -31,6 +31,7 @@ interface VenvCreationState {
 
     // Name for the venv
     venvName?: string;
+    suppliedName?: boolean;
 
     // Packages to install in the venv
     // undefined = not yet set, null = user canceled during package selection
@@ -161,8 +162,7 @@ async function selectBasePython(state: VenvCreationState): Promise<StepFunction
 
         state.basePython = basePython;
 
-        // Next step: input venv name
-        return enterEnvironmentName;
+        return state.venvName === undefined ? enterEnvironmentName : selectPackages;
     } catch (ex) {
         if (ex === QuickInputButtons.Back) {
             // Go back to create type selection if we came from there
@@ -269,8 +269,7 @@ async function selectPackages(state: VenvCreationState): Promise<StepFunction |
         return null;
     } catch (ex) {
         if (ex === QuickInputButtons.Back) {
-            // Go back to environment name input
-            return enterEnvironmentName;
+            return state.suppliedName ? selectBasePython : enterEnvironmentName;
         }
         throw ex;
     }
@@ -299,7 +298,7 @@ export async function createStepBasedVenvFlow(
     manager: EnvironmentManager,
     basePythons: PythonEnvironment[],
     venvRoot: Uri,
-    options: { showQuickAndCustomOptions: boolean; additionalPackages?: string[] },
+    options: { showQuickAndCustomOptions: boolean; additionalPackages?: string[]; name?: string },
 ): Promise<CreateEnvironmentResult | undefined> {
     // Sort and filter available Python environments
     const sortedEnvs = ensureGlobalEnv(basePythons, log);
@@ -308,13 +307,18 @@ export async function createStepBasedVenvFlow(
             envCreationErr: 'No suitable Python environments found',
         };
     }
+    if (options.name !== undefined && (await fse.pathExists(path.join(venvRoot.fsPath, options.name)))) {
+        return { envCreationErr: VenvManagerStrings.venvNameErrorExists };
+    }
 
     // Initialize the state object that will track user selections
     const state: VenvCreationState = {
         sortedEnvs, // Store sorted environments in state to avoid re-sorting
         api, // Store API reference for package selection
         project: [api.getPythonProject(venvRoot)].filter(Boolean) as PythonProject[], // Get project for venvRoot
         venvRoot, // Store venvRoot for path validation
+        venvName: options.name,
+        suppliedName: options.name !== undefined,
     };
 
     try {
@@ -335,8 +339,7 @@ export async function createStepBasedVenvFlow(
         if (state.isQuickCreate && state.basePython) {
             // Use quick create flow
             sendTelemetryEvent(EventNames.VENV_CREATION, undefined, { creationType: 'quick' });
-            // Use the default .venv name for quick create
-            const quickEnvPath = path.join(venvRoot.fsPath, '.venv');
+            const quickEnvPath = path.join(venvRoot.fsPath, options.name ?? '.venv');
 
             // Get workspace dependencies to install
             const project = api.getPythonProject(venvRoot);

src/managers/builtin/venvStepBasedFlow.ts

@@ -514,6 +514,7 @@ export async function quickCreateVenv(
     baseEnv: PythonEnvironment,
     venvRoot: Uri,
     additionalPackages?: string[],
+    name?: string,
 ): Promise<CreateEnvironmentResult | undefined> {
     const project = api.getPythonProject(venvRoot);
 
@@ -535,9 +536,12 @@ export async function quickCreateVenv(
         return undefined;
     }
 
-    // Check if .venv already exists
-    let venvPath = path.join(venvRoot.fsPath, '.venv');
+    const requestedName = name ?? '.venv';
+    let venvPath = path.join(venvRoot.fsPath, requestedName);
     if (await fsapi.pathExists(venvPath)) {
+        if (name !== undefined) {
+            return { envCreationErr: VenvManagerStrings.venvNameErrorExists };
+        }
         // increment to create a unique name, e.g. .venv-1
         let i = 1;
         while (await fsapi.pathExists(`${venvPath}-${i}`)) {
@@ -560,7 +564,7 @@ export async function createPythonVenv(
     manager: EnvironmentManager,
     basePythons: PythonEnvironment[],
     venvRoot: Uri,
-    options: { showQuickAndCustomOptions: boolean; additionalPackages?: string[] },
+    options: { showQuickAndCustomOptions: boolean; additionalPackages?: string[]; name?: string },
 ): Promise<CreateEnvironmentResult | undefined> {
     return createStepBasedVenvFlow(nativeFinder, api, log, manager, basePythons, venvRoot, options);
 }

src/managers/builtin/venvUtils.ts

@@ -217,10 +217,12 @@ export class CondaEnvManager implements EnvironmentManager, Disposable {
             let result: PythonEnvironment | undefined;
             if (options?.quickCreate) {
                 let envRoot: string | undefined = undefined;
-                let name: string | undefined = './.conda';
+                let name: string | undefined = options.name ?? './.conda';
                 if (context === 'global' || (Array.isArray(context) && context.length > 1)) {
                     envRoot = await getDefaultCondaPrefix();
-                    name = await generateName(envRoot);
+                    if (options.name === undefined) {
+                        name = await generateName(envRoot);
+                    }
                 } else {
                     const folder = this.api.getPythonProject(context instanceof Uri ? context : context[0]);
                     envRoot = folder?.uri.fsPath;
@@ -240,6 +242,7 @@ export class CondaEnvManager implements EnvironmentManager, Disposable {
                     this.log,
                     this,
                     context === 'global' ? undefined : context,
+                    options?.name,
                 );
             }
             if (result) {

src/managers/conda/condaEnvManager.ts

@@ -35,6 +35,8 @@ interface CondaCreationState {
 
     // For named environments
     envName?: string;
+    suppliedName?: boolean;
+    cancelled?: boolean;
 
     // For prefix environments
     prefix?: string;
@@ -82,6 +84,7 @@ async function selectEnvironmentType(state: CondaCreationState): Promise<StepFun
         )) as QuickPickItem | undefined;
 
         if (!selection) {
+            state.cancelled = true;
             return null;
         }
 
@@ -128,16 +131,23 @@ async function selectPythonVersion(state: CondaCreationState): Promise<StepFunct
         });
 
         if (!selection) {
+            state.cancelled = true;
             return null;
         }
 
         state.pythonVersion = (selection as QuickPickItem).description;
 
         // Next step depends on environment type
-        return state.envType === getCondaNamedLabel() ? enterEnvironmentName : selectLocation;
+        if (state.envType === getCondaNamedLabel()) {
+            return state.envName === undefined ? enterEnvironmentName : null;
+        }
+        return selectLocation;
     } catch (ex) {
         if (ex === QuickInputButtons.Back) {
-            // Go back to environment type selection
+            if (state.suppliedName) {
+                state.cancelled = true;
+                return null;
+            }
             return selectEnvironmentType;
         }
         throw ex;
@@ -280,28 +290,35 @@ export async function createStepBasedCondaFlow(
     log: LogOutputChannel,
     manager: EnvironmentManager,
     uris?: Uri | Uri[],
+    name?: string,
 ): Promise<PythonEnvironment | undefined> {
     // Initialize the state object that will track user selections
     const state: CondaCreationState = {
         api: api,
         uris: Array.isArray(uris) ? uris : uris ? [uris] : [],
+        envType: name === undefined ? undefined : getCondaNamedLabel(),
+        envName: name,
+        suppliedName: name !== undefined,
     };
 
     try {
         // Start with the first step
-        let currentStep: StepFunction | null = selectEnvironmentType;
+        let currentStep: StepFunction | null = name === undefined ? selectEnvironmentType : selectPythonVersion;
 
         // Execute steps until completion or cancellation
         while (currentStep !== null) {
             currentStep = await currentStep(state);
         }
 
+        if (state.cancelled) {
+            return undefined;
+        }
+
         // If we have all required data, create the environment
         if (state.envType === getCondaNamedLabel() && state.envName) {
             return await createNamedCondaEnvironment(api, log, manager, state.envName, state.pythonVersion);
         } else if (state.envType === CondaStrings.condaPrefix && state.prefix) {
-            // For prefix environments, we need to pass the fsPath where the environment will be created
-            return await createPrefixCondaEnvironment(api, log, manager, state.fsPath, state.pythonVersion);
+            return await createPrefixCondaEnvironment(api, log, manager, state.prefix, state.pythonVersion);
         }
 
         // If we get here, the flow was likely cancelled
@@ -310,7 +327,7 @@ export async function createStepBasedCondaFlow(
         if (ex === QuickInputButtons.Back) {
             // This should not happen as back navigation is handled within each step
             // But if it does, restart the flow
-            return await createStepBasedCondaFlow(api, log, manager, uris);
+            return await createStepBasedCondaFlow(api, log, manager, uris, name);
         }
         throw ex; // Re-throw other errors
     }