Update version and packages for release (#362)

Author: karthiknadig

.github/workflows/pr-check.yml

@@ -45,7 +45,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python: ['3.8', '3.9', '3.10', '3.11-dev']
+        python: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     steps:
       - name: Checkout

.github/workflows/push-check.yml

@@ -50,7 +50,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python: ['3.8', '3.9', '3.10', '3.11']
+        python: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     steps:
       - name: Checkout

package-lock.json

@@ -2,7 +2,7 @@
     "name": "black-formatter",
     "displayName": "Black Formatter",
     "description": "%extension.description%",
-    "version": "2023.5.0-dev",
+    "version": "2023.6.0",
     "preview": true,
     "serverInfo": {
         "name": "Black",
@@ -157,6 +157,7 @@
         ]
     },
     "dependencies": {
+        "@vscode/python-extension": "^1.0.5",
         "fs-extra": "^11.1.1",
         "vscode-languageclient": "^8.1.0"
     },

package.json

@@ -1,5 +1,5 @@
 {
-    "extension.description": "Formatting support for Python files using `black`.",
+    "extension.description": "Formatting support for Python files using Black formatter.",
     "command.restartServer": "Restart Server",
     "settings.args.description": "Arguments passed in. Each argument is a separate string in the array.",
     "settings.path.description": "When set to a path to `black` binary, extension will use that for linting. NOTE: Using this option may slowdown formatting.",

package.nls.json

@@ -2,214 +2,9 @@
 // Licensed under the MIT License.
 
 /* eslint-disable @typescript-eslint/naming-convention */
-import { commands, Disposable, Event, EventEmitter, extensions, Uri, WorkspaceFolder } from 'vscode';
+import { commands, Disposable, Event, EventEmitter, Uri } from 'vscode';
 import { traceError, traceLog } from './logging';
-
-type Environment = EnvironmentPath & {
-    /**
-     * Carries details about python executable.
-     */
-    readonly executable: {
-        /**
-         * Uri of the python interpreter/executable. Carries `undefined` in case an executable does not belong to
-         * the environment.
-         */
-        readonly uri: Uri | undefined;
-        /**
-         * Bitness if known at this moment.
-         */
-        readonly bitness: Bitness | undefined;
-        /**
-         * Value of `sys.prefix` in sys module if known at this moment.
-         */
-        readonly sysPrefix: string | undefined;
-    };
-    /**
-     * Carries details if it is an environment, otherwise `undefined` in case of global interpreters and others.
-     */
-    readonly environment:
-        | {
-              /**
-               * Type of the environment.
-               */
-              readonly type: EnvironmentType;
-              /**
-               * Name to the environment if any.
-               */
-              readonly name: string | undefined;
-              /**
-               * Uri of the environment folder.
-               */
-              readonly folderUri: Uri;
-              /**
-               * Any specific workspace folder this environment is created for.
-               */
-              readonly workspaceFolder: Uri | undefined;
-          }
-        | undefined;
-    /**
-     * Carries Python version information known at this moment.
-     */
-    readonly version: VersionInfo & {
-        /**
-         * Value of `sys.version` in sys module if known at this moment.
-         */
-        readonly sysVersion: string | undefined;
-    };
-    /**
-     * Tools/plugins which created the environment or where it came from. First value in array corresponds
-     * to the primary tool which manages the environment, which never changes over time.
-     *
-     * Array is empty if no tool is responsible for creating/managing the environment. Usually the case for
-     * global interpreters.
-     */
-    readonly tools: readonly EnvironmentTools[];
-};
-
-/**
- * Derived form of {@link Environment} where certain properties can no longer be `undefined`. Meant to represent an
- * {@link Environment} with complete information.
- */
-type ResolvedEnvironment = Environment & {
-    /**
-     * Carries complete details about python executable.
-     */
-    readonly executable: {
-        /**
-         * Uri of the python interpreter/executable. Carries `undefined` in case an executable does not belong to
-         * the environment.
-         */
-        readonly uri: Uri | undefined;
-        /**
-         * Bitness of the environment.
-         */
-        readonly bitness: Bitness;
-        /**
-         * Value of `sys.prefix` in sys module.
-         */
-        readonly sysPrefix: string;
-    };
-    /**
-     * Carries complete Python version information.
-     */
-    readonly version: ResolvedVersionInfo & {
-        /**
-         * Value of `sys.version` in sys module if known at this moment.
-         */
-        readonly sysVersion: string;
-    };
-};
-
-type EnvironmentsChangeEvent = {
-    readonly env: Environment;
-    /**
-     * * "add": New environment is added.
-     * * "remove": Existing environment in the list is removed.
-     * * "update": New information found about existing environment.
-     */
-    readonly type: 'add' | 'remove' | 'update';
-};
-
-type ActiveEnvironmentPathChangeEvent = EnvironmentPath & {
-    /**
-     * Workspace folder the environment changed for.
-     */
-    readonly resource: WorkspaceFolder | undefined;
-};
-
-/**
- * Uri of a file inside a workspace or workspace folder itself.
- */
-type Resource = Uri | WorkspaceFolder;
-
-type EnvironmentPath = {
-    /**
-     * The ID of the environment.
-     */
-    readonly id: string;
-    /**
-     * Path to environment folder or path to python executable that uniquely identifies an environment. Environments
-     * lacking a python executable are identified by environment folder paths, whereas other envs can be identified
-     * using python executable path.
-     */
-    readonly path: string;
-};
-
-/**
- * Tool/plugin where the environment came from. It can be {@link KnownEnvironmentTools} or custom string which
- * was contributed.
- */
-type EnvironmentTools = KnownEnvironmentTools | string;
-/**
- * Tools or plugins the Python extension currently has built-in support for. Note this list is expected to shrink
- * once tools have their own separate extensions.
- */
-type KnownEnvironmentTools =
-    | 'Conda'
-    | 'Pipenv'
-    | 'Poetry'
-    | 'VirtualEnv'
-    | 'Venv'
-    | 'VirtualEnvWrapper'
-    | 'Pyenv'
-    | 'Unknown';
-
-/**
- * Type of the environment. It can be {@link KnownEnvironmentTypes} or custom string which was contributed.
- */
-type EnvironmentType = KnownEnvironmentTypes | string;
-/**
- * Environment types the Python extension is aware of. Note this list is expected to shrink once tools have their
- * own separate extensions, in which case they're expected to provide the type themselves.
- */
-type KnownEnvironmentTypes = 'VirtualEnvironment' | 'Conda' | 'Unknown';
-
-/**
- * Carries bitness for an environment.
- */
-type Bitness = '64-bit' | '32-bit' | 'Unknown';
-
-/**
- * The possible Python release levels.
- */
-type PythonReleaseLevel = 'alpha' | 'beta' | 'candidate' | 'final';
-
-/**
- * Release information for a Python version.
- */
-type PythonVersionRelease = {
-    readonly level: PythonReleaseLevel;
-    readonly serial: number;
-};
-
-type VersionInfo = {
-    readonly major: number | undefined;
-    readonly minor: number | undefined;
-    readonly micro: number | undefined;
-    readonly release: PythonVersionRelease | undefined;
-};
-
-type ResolvedVersionInfo = {
-    readonly major: number;
-    readonly minor: number;
-    readonly micro: number;
-    readonly release: PythonVersionRelease;
-};
-
-interface IExtensionApi {
-    ready: Promise<void>;
-    debug: {
-        getRemoteLauncherCommand(host: string, port: number, waitUntilDebuggerAttaches: boolean): Promise<string[]>;
-        getDebuggerPackagePath(): Promise<string | undefined>;
-    };
-    environments: {
-        getActiveEnvironmentPath(resource?: Resource): EnvironmentPath;
-        resolveEnvironment(
-            environment: Environment | EnvironmentPath | string,
-        ): Promise<ResolvedEnvironment | undefined>;
-        readonly onDidChangeActiveEnvironmentPath: Event<ActiveEnvironmentPathChangeEvent>;
-    };
-}
+import { PythonExtension, ResolvedEnvironment } from '@vscode/python-extension';
 
 export interface IInterpreterDetails {
     path?: string[];
@@ -219,19 +14,13 @@ export interface IInterpreterDetails {
 const onDidChangePythonInterpreterEvent = new EventEmitter<IInterpreterDetails>();
 export const onDidChangePythonInterpreter: Event<IInterpreterDetails> = onDidChangePythonInterpreterEvent.event;
 
-async function activateExtension() {
-    const extension = extensions.getExtension('ms-python.python');
-    if (extension) {
-        if (!extension.isActive) {
-            await extension.activate();
-        }
+let _api: PythonExtension | undefined;
+async function getPythonExtensionAPI(): Promise<PythonExtension | undefined> {
+    if (_api) {
+        return _api;
     }
-    return extension;
-}
-
-async function getPythonExtensionAPI(): Promise<IExtensionApi | undefined> {
-    const extension = await activateExtension();
-    return extension?.exports as IExtensionApi;
+    _api = await PythonExtension.api();
+    return _api;
 }
 
 export async function initializePython(disposables: Disposable[]): Promise<void> {
@@ -275,7 +64,7 @@ export async function getDebuggerPath(): Promise<string | undefined> {
 }
 
 export async function runPythonExtensionCommand(command: string, ...rest: any[]) {
-    await activateExtension();
+    await getPythonExtensionAPI();
     return await commands.executeCommand(command, ...rest);
 }
 

src/common/python.ts

@@ -15,7 +15,7 @@ import { traceError, traceInfo, traceVerbose } from './logging';
 import { getDebuggerPath } from './python';
 import { getExtensionSettings, getGlobalSettings, ISettings } from './settings';
 import { getLSClientTraceLevel } from './utilities';
-import { isVirtualWorkspace } from './vscodeapi';
+import { getDocumentSelector } from './vscodeapi';
 import { updateStatus } from './status';
 import { unregisterEmptyFormatter } from './nullFormatter';
 
@@ -62,14 +62,7 @@ async function createServer(
     // Options to control the language client
     const clientOptions: LanguageClientOptions = {
         // Register the server for python documents
-        documentSelector: isVirtualWorkspace()
-            ? [{ language: 'python' }]
-            : [
-                  { scheme: 'file', language: 'python' },
-                  { scheme: 'untitled', language: 'python' },
-                  { scheme: 'vscode-notebook', language: 'python' },
-                  { scheme: 'vscode-notebook-cell', language: 'python' },
-              ],
+        documentSelector: getDocumentSelector(),
         outputChannel: outputChannel,
         traceOutputChannel: outputChannel,
         revealOutputChannelOn: RevealOutputChannelOn.Never,