fix: make create environment options an optional argument

Author: karthiknadig

examples/sample1/src/api.ts

@@ -316,6 +316,18 @@ export type DidChangeEnvironmentsEventArgs = {
  */
 export type ResolveEnvironmentContext = Uri;
 
+export interface QuickCreateConfig {
+    /**
+     * The description of the quick create step.
+     */
+    readonly description: string;
+
+    /**
+     * The detail of the quick create step.
+     */
+    readonly detail?: string;
+}
+
 /**
  * Interface representing an environment manager.
  */
@@ -360,12 +372,19 @@ export interface EnvironmentManager {
      */
     readonly log?: LogOutputChannel;
 
+    /**
+     * The quick create details for the environment manager. Having this method also enables the quick create feature
+     * for the environment manager.
+     */
+    quickCreateConfig?(): QuickCreateConfig | undefined;
+
     /**
      * Creates a new Python environment within the specified scope.
      * @param scope - The scope within which to create the environment.
+     * @param options - Optional parameters for creating the Python environment.
      * @returns A promise that resolves to the created Python environment, or undefined if creation failed.
      */
-    create?(scope: CreateEnvironmentScope): Promise<PythonEnvironment | undefined>;
+    create?(scope: CreateEnvironmentScope, options?: CreateEnvironmentOptions): Promise<PythonEnvironment | undefined>;
 
     /**
      * Removes the specified Python environment.
@@ -705,6 +724,9 @@ export interface DidChangePythonProjectsEventArgs {
     removed: PythonProject[];
 }
 
+/**
+ * Options for package management.
+ */
 export type PackageManagementOptions =
     | {
           /**
@@ -747,6 +769,28 @@ export type PackageManagementOptions =
           uninstall: string[];
       };
 
+/**
+ * Options for creating a Python environment.
+ */
+export interface CreateEnvironmentOptions {
+    /**
+     * Provides some context about quick create based on user input.
+     *   - if true, the environment should be created without any user input or prompts.
+     *   - if false, the environment creation can show user input or prompts.
+     *     This also means user explicitly skipped the quick create option.
+     *   - if undefined, the environment creation can show user input or prompts.
+     *     You can show quick create option to the user if you support it.
+     */
+    quickCreate?: boolean;
+    /**
+     * Packages to install in addition to the automatically picked packages as a part of creating environment.
+     */
+    additionalPackages?: string[];
+}
+
+/**
+ * Object representing the process started using run in background API.
+ */
 export interface PythonProcess {
     /**
      * The process ID of the Python process.
@@ -807,9 +851,13 @@ export interface PythonEnvironmentManagementApi {
      * Create a Python environment using environment manager associated with the scope.
      *
      * @param scope Where the environment is to be created.
+     * @param options Optional parameters for creating the Python environment.
      * @returns The Python environment created. `undefined` if not created.
      */
-    createEnvironment(scope: CreateEnvironmentScope): Promise<PythonEnvironment | undefined>;
+    createEnvironment(
+        scope: CreateEnvironmentScope,
+        options?: CreateEnvironmentOptions,
+    ): Promise<PythonEnvironment | undefined>;
 
     /**
      * Remove a Python environment.

examples/sample1/src/sampleEnvManager.ts

@@ -1,5 +1,6 @@
 import { MarkdownString, LogOutputChannel, Event } from 'vscode';
 import {
+    CreateEnvironmentOptions,
     CreateEnvironmentScope,
     DidChangeEnvironmentEventArgs,
     DidChangeEnvironmentsEventArgs,
@@ -8,6 +9,7 @@ import {
     GetEnvironmentsScope,
     IconPath,
     PythonEnvironment,
+    QuickCreateConfig,
     RefreshEnvironmentsScope,
     ResolveEnvironmentContext,
     SetEnvironmentScope,
@@ -31,7 +33,13 @@ export class SampleEnvManager implements EnvironmentManager {
         this.log = log;
     }
 
-    create?(scope: CreateEnvironmentScope): Promise<PythonEnvironment | undefined> {
+    quickCreateConfig(): QuickCreateConfig | undefined {
+        // Code to provide quick create configuration goes here
+
+        throw new Error('Method not implemented.');
+    }
+
+    create?(scope: CreateEnvironmentScope, options?: CreateEnvironmentOptions): Promise<PythonEnvironment | undefined> {
         // Code to handle creating environments goes here
 
         throw new Error('Method not implemented.');

src/api.ts

@@ -384,10 +384,7 @@ export interface EnvironmentManager {
      * @param options - Optional parameters for creating the Python environment.
      * @returns A promise that resolves to the created Python environment, or undefined if creation failed.
      */
-    create?(
-        scope: CreateEnvironmentScope,
-        options: CreateEnvironmentOptions | undefined,
-    ): Promise<PythonEnvironment | undefined>;
+    create?(scope: CreateEnvironmentScope, options?: CreateEnvironmentOptions): Promise<PythonEnvironment | undefined>;
 
     /**
      * Removes the specified Python environment.
@@ -788,6 +785,9 @@ export interface CreateEnvironmentOptions {
     additionalPackages?: string[];
 }
 
+/**
+ * Object representing the process started using run in background API.
+ */
 export interface PythonProcess {
     /**
      * The process ID of the Python process.
@@ -853,7 +853,7 @@ export interface PythonEnvironmentManagementApi {
      */
     createEnvironment(
         scope: CreateEnvironmentScope,
-        options: CreateEnvironmentOptions | undefined,
+        options?: CreateEnvironmentOptions,
     ): Promise<PythonEnvironment | undefined>;
 
     /**