// Copyright (c) Microsoft Corporation. All rights reserved.

// Licensed under the MIT License.

'use strict';

import { Uri } from 'vscode';

import { PythonInterpreter } from '../contracts';

export const IPythonInPathCommandProvider = Symbol('IPythonInPathCommandProvider');

export interface IPythonInPathCommandProvider {

getCommands(): { command: string; args?: string[] }[];

}

export const IPipEnvServiceHelper = Symbol('IPipEnvServiceHelper');

export interface IPipEnvServiceHelper {

getPipEnvInfo(pythonPath: string): Promise<{ workspaceFolder: Uri; envName: string } | undefined>;

trackWorkspaceFolder(pythonPath: string, workspaceFolder: Uri): Promise<void>;

}

/**

* Factory to create a hash provider.

* Getting the hash of an interpreter can vary based on the type of the interpreter.

*

* @export

* @interface IInterpreterHashProviderFactory

*/

export interface IInterpreterHashProviderFactory {

create(options: { pythonPath: string } | { resource: Uri }): Promise<IInterpreterHashProvider>;

}

/**

* Provides the ability to get the has of a given interpreter.

*

* @export

* @interface IInterpreterHashProvider

*/

export interface IInterpreterHashProvider {

/**

* Gets the hash of a given Python Interpreter.

* (hash is calculated based on last modified timestamp of executable)

*

* @param {string} pythonPath

* @returns {Promise<string>}

* @memberof IInterpreterHashProvider

*/

getInterpreterHash(pythonPath: string): Promise<string>;

}

export interface IWindowsStoreInterpreter {

/**

* Whether this is a Windows Store/App Interpreter.

*

* @param {string} pythonPath

* @returns {boolean}

* @memberof WindowsStoreInterpreter

*/

isWindowsStoreInterpreter(pythonPath: string): boolean;

/**

* Whether this is a python executable in a windows app store folder that is internal and can be hidden from users.

*

* @param {string} pythonPath

* @returns {boolean}

* @memberof IInterpreterHelper

*/

isHiddenInterpreter(pythonPath: string): boolean;

}

export interface IInterpreterFilter {

isHiddenInterpreter(interpreter: PythonInterpreter): boolean;

}