Adding interfaces for datascience work (#1) (#2688)

* working without inversify

* Working command with service manager

* Initial interfaces

Author: rchiodo

package-lock.json

@@ -85,7 +85,8 @@
         "onCommand:python.setLinter",
         "onCommand:python.enableLinting",
         "onCommand:python.createTerminal",
-        "onCommand:python.discoverTests"
+        "onCommand:python.discoverTests",
+        "onCommand:python.datascience"
     ],
     "main": "./out/client/extension",
     "contributes": {
@@ -222,6 +223,11 @@
                 "command": "python.runLinting",
                 "title": "%python.command.python.runLinting.title%",
                 "category": "Python"
+            },
+            {
+                "command": "python.datascience",
+                "title": "Datascience Command",
+                "category": "Python Datascience"
             }
         ],
         "menus": {

package.json

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';

src/client/datascience/codewatcher.ts

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { inject, injectable } from 'inversify';
+import { Disposable, ExtensionContext } from 'vscode';
+import { IApplicationShell, ICommandManager } from '../common/application/types';
+import { IDisposableRegistry } from '../common/types';
+import { IDataScience } from './types';
+
+@injectable()
+export class DataScience implements IDataScience {
+    constructor(@inject(ICommandManager) private commandManager: ICommandManager,
+        @inject(IDisposableRegistry) private disposableRegistry: Disposable[],
+        @inject(IApplicationShell) private appShell: IApplicationShell) {
+        }
+
+    public async activate(context: ExtensionContext): Promise<void> {
+        this.registerCommands();
+    }
+
+    private registerCommands(): void {
+        const disposable = this.commandManager.registerCommand('python.datascience', this.executeDataScience, this);
+        this.disposableRegistry.push(disposable);
+    }
+
+    private async executeDataScience(): Promise<void> {
+       await this.appShell.showInformationMessage('Hello Data Science');
+    }
+}

src/client/datascience/datascience.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';

src/client/datascience/history.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';

src/client/datascience/historypostoffice.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { injectable } from 'inversify';
+import { IJupyterServer, IJupyterServerProvider } from './types';
+
+@injectable()
+export class JupyterServerProvider implements IJupyterServerProvider {
+    public start(notebookFile: string | undefined): Promise<IJupyterServer> {
+        return new Promise<IJupyterServer>((resolve, reject) => {
+            resolve(undefined);
+        });
+    }
+}

src/client/datascience/jupyterserverprovider.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { IServiceManager } from '../ioc/types';
+import { DataScience } from './datascience';
+import { JupyterServerProvider } from './jupyterserverprovider';
+import { IDataScience, IJupyterServerProvider } from './types';
+
+export function registerTypes(serviceManager: IServiceManager) {
+    serviceManager.addSingleton<IDataScience>(IDataScience, DataScience);
+    serviceManager.addSingleton<IJupyterServerProvider>(IJupyterServerProvider, JupyterServerProvider);
+}

src/client/datascience/serviceRegistry.ts

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { ExtensionContext } from 'vscode';
+
+// Main interface
+export const IDataScience = Symbol('IDataScience');
+export interface IDataScience {
+    activate(context: ExtensionContext): Promise<void>;
+}
+
+// Factory for jupyter servers
+export const IJupyterServerProvider = Symbol('IJupyterServerFactory');
+export interface IJupyterServerProvider {
+    start(notebookFile: string | undefined): Promise<IJupyterServer>;
+}
+
+// Talks to a jupyter kernel to retrieve data for cells
+export const IJupyterServer = Symbol('IJupyterServer');
+export interface IJupyterServer {
+}
+
+// Wraps the VS Code api for creating a web panel
+export const IWebPanelProvider = Symbol('IWebPanelProvider');
+export interface IWebPanelProvider {
+    create(): IWebPanel;
+}
+
+// Wraps the VS Code webview panel
+export const IWebPanel = Symbol('IWebPanel');
+export interface IWebPanel {
+}
+
+// Wraps the vscode API in order to send messages back and forth from a webview
+export const IPostOffice = Symbol('IPostOffice');
+export interface IPostOffice {
+    // tslint:disable-next-line:no-any
+    post(message: string, params: any[] | undefined);
+    // tslint:disable-next-line:no-any
+    listen(message: string, listener: (args: any[] | undefined) => void);
+}
+
+// Basic structure for a cell from a notebook
+export interface ICell {
+    input: string;
+    output: string;
+    id: number;
+}

src/client/datascience/types.ts

@@ -30,6 +30,8 @@ import {
     IMemento, IOutputChannel, WORKSPACE_MEMENTO
 } from './common/types';
 import { registerTypes as variableRegisterTypes } from './common/variables/serviceRegistry';
+import { registerTypes as dataScienceRegisterTypes } from './datascience/serviceRegistry';
+import { IDataScience } from './datascience/types';
 import { AttachRequestArguments, LaunchRequestArguments } from './debugger/Common/Contracts';
 import { BaseConfigurationProvider } from './debugger/configProviders/baseProvider';
 import { registerTypes as debugConfigurationRegisterTypes } from './debugger/configProviders/serviceRegistry';
@@ -105,6 +107,10 @@ export async function activate(context: ExtensionContext): Promise<IExtensionApi
     const lintingEngine = serviceManager.get<ILintingEngine>(ILintingEngine);
     lintingEngine.linkJupiterExtension(jupyterExtension).ignoreErrors();
 
+    // Activate the data science features
+    const dataScience = serviceManager.get<IDataScience>(IDataScience);
+    await dataScience.activate(context);
+
     context.subscriptions.push(new LinterCommands(serviceManager));
     const linterProvider = new LinterProvider(context, serviceManager);
     context.subscriptions.push(linterProvider);
@@ -185,6 +191,7 @@ function registerServices(context: ExtensionContext, serviceManager: ServiceMana
     platformRegisterTypes(serviceManager);
     installerRegisterTypes(serviceManager);
     commonRegisterTerminalTypes(serviceManager);
+    dataScienceRegisterTypes(serviceManager);
     debugConfigurationRegisterTypes(serviceManager);
     debuggerRegisterTypes(serviceManager);
     appRegisterTypes(serviceManager);