Skip to content

validate import checks in python course environment setup #3538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Dhairya Patel (HABER7789) wants to merge 2 commits into
base: amcasey/PythonLearning
Choose a base branch
from
+15 −2
Draft

validate import checks in python course environment setup #3538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d48697
validate import checks in python course environment setup
HABER7789 Jul 30, 2026
7a48dc0
update notebook explain button to course notebooks
HABER7789 Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/vscode/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@
"notebook/cell/title": [
{
"command": "qsharp-vscode.learningNotebookExplain",
"when": "notebookType == 'jupyter-notebook' && qsharp-vscode.learningWorkspaceDetected",
"when": "qsharp-vscode.learningNotebookActive",
"group": "inline/cell@50"
}
],
Expand Down
15 changes: 14 additions & 1 deletion source/vscode/src/learning/python/environment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ import type {
import { PythonEnvironments } from "@vscode/python-environments";
import * as vscode from "vscode";

/**
* Dotted Python module name. Import checks come from author-supplied
* `course.json`, and reach a `python -c` command line.
*/
const MODULE_NAME = /^[A-Za-z_]\w*(\.[A-Za-z_]\w*)*$/;

/**
* Manages per-course Python environments for `python-notebook` courses.
*
Expand Down Expand Up @@ -146,6 +152,11 @@ export class EnvironmentManager {

const results: { module: string; ok: boolean }[] = [];
for (const module of modules) {
if (!MODULE_NAME.test(module)) {
log.warn(`Not a valid Python module name, skipping: ${module}`);
results.push({ module, ok: false });
continue;
}
const code = await runPython(api, env, ["-c", `import ${module}`]);
results.push({ module, ok: code === 0 });
}
Expand Down Expand Up @@ -196,7 +207,9 @@ export class EnvironmentManager {
return envs[0];
default:
log.warn(
`Found multiple virtual environments, using first: ${envs.join(", ")}`,
`Found multiple virtual environments, using first: ${envs
.map((e) => e.name)
.join(", ")}`,
);
return envs[0];
}
Expand Down