microsoft/pyright
1
1
Fork 0
mirror of https://github.com/microsoft/pyright.git synced 2024-10-27 03:12:44 +03:00
Code Issues Projects Releases Wiki Activity

Use Python built-in json module to format library search paths

Browse Source 
When using the fallback code to get the Python library search paths
from the interpreter (i.e. `sys.path`), use the `json` module to
dump the list of paths as output. This enables us to use
Javascript's built-in parser on the result, rather than an ad-hoc
parsing routine.

Note that the `json` module is available in all versions of Python 3
so backward compatibility should not be an issue.
This commit is contained in:
Rami Chowdhury 2019-10-15 17:10:47 -04:00
parent 099a9b6d2e
commit 382541edff
1 changed files with 13 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
server/src/analyzer/pythonPathUtils.ts
View File

@ -112,7 +112,7 @@ export function getPythonPathFromPythonInterpreter(interpreterPath: string | und
let pythonPaths: string[] = [];
try {
const commandLineArgs: string[] = ['-c', 'import sys; print(sys.path)'];
const commandLineArgs: string[] = ['-c', 'import sys, json; json.dump(sys.path, sys.stdout)'];
let execOutput: string;
if (interpreterPath) {
@ -125,37 +125,26 @@ export function getPythonPathFromPythonInterpreter(interpreterPath: string | und
'python', commandLineArgs, { encoding: 'utf8' });
}
// Parse the execOutput. It should be an array of paths.
execOutput = execOutput.trim();
if (execOutput.startsWith('[') && execOutput.endsWith(']')) {
execOutput = execOutput.substr(1, execOutput.length - 2);
const execSplit = execOutput.split(',');
// Parse the execOutput. It should be a JSON-encoded array of paths.
try {
execSplit: string[] = JSON.parse(execOutput);
for (let execSplitEntry of execSplit) {
execSplitEntry = execSplitEntry.trim();
if (execSplitEntry.length >= 2 && execSplitEntry.startsWith('\'') &&
execSplitEntry.endsWith('\'')) {
execSplitEntry = execSplitEntry.substr(1, execSplitEntry.length - 2);
}
if (execSplitEntry) {
const normalizedPath = normalizePath(execSplitEntry);
// Make sure the path exists and is a directory. We don't currently
// support zip files and other formats.
if (fs.existsSync(normalizedPath) && isDirectory(normalizedPath)) {
pythonPaths.push(normalizedPath);
} else {
importFailureInfo.push(`Skipping '${ normalizedPath }' because it is not a valid directory`);
}
const normalizedPath = normalizePath(execSplitEntry);
// Make sure the path exists and is a directory. We don't currently
// support zip files and other formats.
if (fs.existsSync(normalizedPath) && isDirectory(normalizedPath)) {
pythonPaths.push(normalizedPath);
} else {
importFailureInfo.push(`Skipping '${ normalizedPath }' because it is not a valid directory`);
}
}
if (pythonPaths.length === 0) {
importFailureInfo.push(`Found no valid directories`);
}
} else {
} catch (err) {
importFailureInfo.push(`Could not parse output: '${ execOutput }'`);
throw err;
}
} catch {
pythonPaths = [];