Activate the conda environment before running jupyter (microsoft#3506)

Run the conda activate script and scrape all of the environment from it prior to launching jupyter (or any other command with the same interpreter) I'm hoping this will finally fix #3341.

Author: rchiodo

news/2 Fixes/3341.md

@@ -0,0 +1 @@
+Activate conda prior to running jupyter for the python interactive window.

src/client/common/process/proc.ts

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import { spawn } from 'child_process';
+import { exec, spawn } from 'child_process';
 import { Observable } from 'rxjs/Observable';
 import * as tk from 'tree-kill';
 import { Disposable } from 'vscode';
@@ -14,6 +14,7 @@ import {
  IProcessService,
  ObservableExecutionResult,
  Output,
+ ShellOptions,
  SpawnOptions,
  StdErrError
 } from './types';
@@ -37,23 +38,11 @@ export class ProcessService implements IProcessService {
  } catch {
  // Ignore.
  }
-
  }
- public execObservable(file: string, args: string[], options: SpawnOptions = {}): ObservableExecutionResult<string> {
- const encoding = options.encoding = typeof options.encoding === 'string' && options.encoding.length > 0 ? options.encoding : DEFAULT_ENCODING;
- delete options.encoding;
- const spawnOptions = { ...options };
- if (!spawnOptions.env || Object.keys(spawnOptions).length === 0) {
- const env = this.env ? this.env : process.env;
- spawnOptions.env = { ...env };
- }
-
- // Always ensure we have unbuffered output.
- spawnOptions.env.PYTHONUNBUFFERED = '1';
- if (!spawnOptions.env.PYTHONIOENCODING) {
- spawnOptions.env.PYTHONIOENCODING = 'utf-8';
- }
 
+ public execObservable(file: string, args: string[], options: SpawnOptions = {}): ObservableExecutionResult<string> {
+ const spawnOptions = this.getDefaultOptions(options);
+ const encoding = spawnOptions.encoding ? spawnOptions.encoding : 'utf8';
  const proc = spawn(file, args, spawnOptions);
  let procExited = false;
 
@@ -109,19 +98,8 @@ export class ProcessService implements IProcessService {
  };
  }
  public exec(file: string, args: string[], options: SpawnOptions = {}): Promise<ExecutionResult<string>> {
- const encoding = options.encoding = typeof options.encoding === 'string' && options.encoding.length > 0 ? options.encoding : DEFAULT_ENCODING;
- delete options.encoding;
- const spawnOptions = { ...options };
- if (!spawnOptions.env || Object.keys(spawnOptions).length === 0) {
- const env = this.env ? this.env : process.env;
- spawnOptions.env = { ...env };
- }
-
- // Always ensure we have unbuffered output.
- spawnOptions.env.PYTHONUNBUFFERED = '1';
- if (!spawnOptions.env.PYTHONIOENCODING) {
- spawnOptions.env.PYTHONIOENCODING = 'utf-8';
- }
+ const spawnOptions = this.getDefaultOptions(options);
+ const encoding = spawnOptions.encoding ? spawnOptions.encoding : 'utf8';
  const proc = spawn(file, args, spawnOptions);
  const deferred = createDeferred<ExecutionResult<string>>();
  const disposables: Disposable[] = [];
@@ -171,4 +149,45 @@ export class ProcessService implements IProcessService {
 
  return deferred.promise;
  }
+
+ public shellExec(command: string, options: ShellOptions = {}): Promise<ExecutionResult<string>> {
+ const shellOptions = this.getDefaultOptions(options);
+ return new Promise((resolve, reject) => {
+ exec(command, shellOptions, (e, stdout, stderr) => {
+ if (e && e !== null) {
+ reject(e);
+ } else if (shellOptions.throwOnStdErr && stderr && stderr.length) {
+ reject(new Error(stderr));
+ } else {
+ // Make sure stderr is undefined if we actually had none. This is checked
+ // elsewhere because that's how exec behaves.
+ resolve({ stderr: stderr && stderr.length > 0 ? stderr : undefined, stdout: stdout });
+ }
+ });
+ });
+ }
+
+ private getDefaultOptions<T extends (ShellOptions | SpawnOptions)>(options: T) : T {
+ const execOptions = options as SpawnOptions;
+ const defaultOptions = JSON.parse(JSON.stringify(options));
+ if (execOptions)
+ {
+ const encoding = execOptions.encoding = typeof execOptions.encoding === 'string' && execOptions.encoding.length > 0 ? execOptions.encoding : DEFAULT_ENCODING;
+ delete execOptions.encoding;
+ defaultOptions.encoding = encoding;
+ }
+ if (!defaultOptions.env || Object.keys(defaultOptions).length === 0) {
+ const env = this.env ? this.env : process.env;
+ defaultOptions.env = { ...env };
+ }
+
+ // Always ensure we have unbuffered output.
+ defaultOptions.env.PYTHONUNBUFFERED = '1';
+ if (!defaultOptions.env.PYTHONIOENCODING) {
+ defaultOptions.env.PYTHONIOENCODING = 'utf-8';
+ }
+
+ return defaultOptions;
+ }
+
 }

src/client/common/process/types.ts

@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-
-import { ChildProcess, SpawnOptions as ChildProcessSpawnOptions } from 'child_process';
+import { ChildProcess, ExecOptions, SpawnOptions as ChildProcessSpawnOptions } from 'child_process';
 import { Observable } from 'rxjs/Observable';
 import { CancellationToken, Uri } from 'vscode';
+
 import { ExecutionInfo } from '../types';
 import { Architecture } from '../utils/platform';
 import { EnvironmentVariables } from '../variables/types';
@@ -31,6 +31,9 @@ export type SpawnOptions = ChildProcessSpawnOptions & {
  throwOnStdErr?: boolean;
 };
 
+// tslint:disable-next-line:interface-name
+export type ShellOptions = ExecOptions & { throwOnStdErr? : boolean };
+
 export type ExecutionResult<T extends string | Buffer> = {
  stdout: T;
  stderr?: T;
@@ -39,6 +42,7 @@ export type ExecutionResult<T extends string | Buffer> = {
 export interface IProcessService {
  execObservable(file: string, args: string[], options?: SpawnOptions): ObservableExecutionResult<string>;
  exec(file: string, args: string[], options?: SpawnOptions): Promise<ExecutionResult<string>>;
+ shellExec(command: string, options?: ShellOptions): Promise<ExecutionResult<string>>;
 }
 
 export const IProcessServiceFactory = Symbol('IProcessServiceFactory');

src/client/datascience/jupyterExecution.ts

@@ -106,7 +106,7 @@ class JupyterCommand {
  */
  // Base Node.js SpawnOptions uses any for environment, so use that here as well
  // tslint:disable-next-line:no-any
- private fixupCondaEnv = async (inputEnv: any | undefined): Promise<any> => {
+ private fixupCondaEnv = async (inputEnv?: NodeJS.ProcessEnv): Promise<any> => {
  if (!inputEnv) {
  inputEnv = process.env;
  }
@@ -324,6 +324,7 @@ export class JupyterExecution implements IJupyterExecution, Disposable {
 
  return undefined;
  }
+
  private getJupyterServerInfo = async () : Promise<JupyterServerInfo[] | undefined> => {
  // We have a small python file here that we will execute to get the server info from all running Jupyter instances
  const bestInterpreter = await this.getUsableJupyterPython();
@@ -469,7 +470,7 @@ export class JupyterExecution implements IJupyterExecution, Disposable {
  */
  // Base Node.js SpawnOptions uses any for environment, so use that here as well
  // tslint:disable-next-line:no-any
- private fixupCondaEnv = async (inputEnv: any | undefined, interpreter: PythonInterpreter): Promise<any> => {
+ private fixupCondaEnv = async (inputEnv: NodeJS.ProcessEnv, interpreter: PythonInterpreter): Promise<any> => {
  if (!inputEnv) {
  inputEnv = process.env;
  }

src/client/interpreter/contracts.ts

@@ -53,9 +53,7 @@ export interface ICondaService {
  getInterpreterPath(condaEnvironmentPath: string): string;
  isCondaEnvironment(interpreterPath: string): Promise<boolean>;
  getCondaEnvironment(interpreterPath: string): Promise<{ name: string; path: string } | undefined>;
- // Base Node.js SpawnOptions uses any for environment, so use that here as well
- // tslint:disable-next-line:no-any
- getActivatedCondaEnvironment(interpreter: PythonInterpreter, inputEnvironment: any): Promise<any>;
+ getActivatedCondaEnvironment(interpreter: PythonInterpreter, inputEnvironment?: NodeJS.ProcessEnv): Promise<NodeJS.ProcessEnv>;
 }
 
 export enum InterpreterType {