Add cwd setting and support for env, interpreter and fileDirname substitutions (#106)

* Add support for interpreter and env substitution

* Add cwd setting

* Update README variable substitution

- fix showNotification typo

* Update variable substitution table in README

* Fix missing closing brace

* Fix missing blank line for Black formatting

Author: PaulMarisOUMary

README.md

@@ -19,16 +19,20 @@ There are several settings you can configure to customize the behavior of this e
 | `bandit.path`             | `[]`                 | Path or command used by the extension to run Bandit. Accepts an array of strings (each arg separate). <br> Examples: <br> - `"bandit.path": ["~/global_env/bandit"]` <br> - `"bandit.path": ["bandit"]` <br> - `"bandit.path": ["${interpreter}", "-m", "bandit"]` <br> If set to `["bandit"]`, it uses the Bandit available in your `PATH`. Note: Using a custom path may slow down linting. |
 | `bandit.interpreter`      | `[]`                 | Python executable or command used to launch Bandit. Accepts an array of strings (each arg separate). If left as `[]`, it uses the selected Python interpreter.                                                                                                                                                                                                                                |
 | `bandit.importStrategy`   | `useBundled`         | Specifies which Bandit binary to use. `useBundled` uses the version shipped with the extension. `fromEnvironment` uses the Bandit in the current Python environment. If it can't find one, it falls back to the bundled version. Overridden if `bandit.path` is set.                                                                                                                          |
-| `bandit.showNotification` | `off`                | Controls when extension notifications appear. Options: `onError`, `onWarning`, `always`, `off`.                                                                                                                                                                                                                                                                                               |
+| `bandit.showNotifications` | `off`                | Controls when extension notifications appear. Options: `onError`, `onWarning`, `always`, `off`.                                                                                                                                                                                                                                                                                               |
 
-The following variables are supported for substitution in the `bandit.args`, `bandit.cwd`, `bandit.path`, and `bandit.interpreter` settings:
+### Variable Substitution
 
--   `${workspaceFolder}`
--   `${workspaceFolder:FolderName}`
--   `${userHome}`
--   `${env:EnvVarName}`
+The following variables are supported for substitution in the `bandit.args`, `bandit.cwd`, and `bandit.path` settings:
 
-The `bandit.path` setting also supports the `${interpreter}` variable as one of the entries of the array. This variable is subtituted based on the value of the `bandit.interpreter` setting.
+| Variable                        | Description                                                                    | Supported In          |
+|---------------------------------|--------------------------------------------------------------------------------|-----------------------|
+| `${workspaceFolder}`            | Root directory of the currently active workspace folder                        | `args`, `cwd`, `path` |
+| `${workspaceFolder:FolderName}` | Root directory of a specific workspace folder in a multi-root workspace        | `args`, `path`        |
+| `${userHome}`                   | Path to the current user's home directory                                      | `args`, `path`        |
+| `${env:EnvVarName}`             | Value of the environment variable `EnvVarName`                                 | `args`, `path`        |
+| `${interpreter}`                | Python executable used by Bandit (workspace interpreter or bandit.interpreter) | `path`                |
+| `${fileDirname}`                | Directory of the file being linted                                             | `cwd`                 |
 
 ## Commands
 

bundled/tool/lsp_server.py

@@ -9,7 +9,7 @@
 import pathlib
 import sys
 import traceback
-from typing import Any, Optional, Sequence
+from typing import Any, Dict, Optional, Sequence
 
 
 # **********************************************************
@@ -341,6 +341,19 @@ def _get_settings_by_document(document: workspace.Document | None):
 # *****************************************************
 # Internal execution APIs.
 # *****************************************************
+def get_cwd(settings: Dict[str, Any], document: Optional[workspace.Document]) -> str:
+    """Returns cwd for the given settings and document."""
+    if settings["cwd"] == "${workspaceFolder}":
+        return settings["workspaceFS"]
+
+    if settings["cwd"] == "${fileDirname}":
+        if document is not None:
+            return os.fspath(pathlib.Path(document.path).parent)
+        return settings["workspaceFS"]
+
+    return settings["cwd"]
+
+
 # pylint: disable=too-many-branches,too-many-statements
 def _run_tool_on_document(
     document: workspace.Document,
@@ -374,7 +387,7 @@ def _run_tool_on_document(
         return None
 
     code_workspace = settings["workspaceFS"]
-    cwd = settings["cwd"]
+    cwd = get_cwd(settings, document)
 
     use_path = False
     use_rpc = False
@@ -469,7 +482,7 @@ def _run_tool(extra_args: Sequence[str]) -> utils.RunResult:
     settings = copy.deepcopy(_get_settings_by_document(None))
 
     code_workspace = settings["workspaceFS"]
-    cwd = settings["workspaceFS"]
+    cwd = get_cwd(settings, None)
 
     use_path = False
     use_rpc = False

package.json

@@ -86,6 +86,16 @@
                     "scope": "resource",
                     "type": "array"
                 },
+                "bandit.cwd": {
+                    "default": "${workspaceFolder}",
+                    "markdownDescription": "%settings.cwd.description%",
+                    "scope": "resource",
+                    "type": "string",
+                    "examples": [
+                        "${workspaceFolder}/src",
+                        "${fileDirname}"
+                    ]
+                },
                 "bandit.enabled": {
                     "default": true,
                     "markdownDescription": "%settings.enabled.description%",

package.nls.json

@@ -2,6 +2,7 @@
     "command.restartServer": "Restart Server",
     "extension.description": "The official Bandit extension developed by PyCQA",
     "settings.args.description": "Arguments passed in. Each argument is a separate item in the array.",
+    "settings.cwd.description": "Working directory for Bandit. Defaults to workspace folder if not set.",
     "settings.enabled.description": "Enable/disable linting Python files with Bandit.",
     "settings.path.description": "When set to a path to bandit binary, extension will use that. NOTE: Using this option may slowdown server response time.",
     "settings.importStrategy.description": "Defines where `bandit` is imported from. This setting may be ignored if `bandit.path` is set.",

src/common/server.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import * as fsapi from 'fs-extra';
-import { Disposable, env, LogOutputChannel } from 'vscode';
+import { Disposable, env, LogOutputChannel, Uri } from 'vscode';
 import { State } from 'vscode-languageclient';
 import {
     LanguageClient,
@@ -27,7 +27,7 @@ async function createServer(
     initializationOptions: IInitOptions,
 ): Promise<LanguageClient> {
     const command = settings.interpreter[0];
-    const cwd = settings.cwd;
+    const cwd = settings.cwd === '${fileDirname}' ? Uri.parse(settings.workspace).fsPath : settings.cwd;
 
     // Set debugger path needed for debugging python code.
     const newEnv = { ...process.env };

src/common/settings.ts

@@ -19,7 +19,7 @@ export function getExtensionSettings(namespace: string, includeInterpreter?: boo
     return Promise.all(getWorkspaceFolders().map((w) => getWorkspaceSettings(namespace, w, includeInterpreter)));
 }
 
-function resolveVariables(value: string[], workspace?: WorkspaceFolder): string[] {
+function resolveVariables(value: string[], workspace?: WorkspaceFolder, interpreter?: string[]): string[] {
     const substitutions = new Map<string, string>();
     const home = process.env.HOME || process.env.USERPROFILE;
     if (home) {
@@ -32,6 +32,14 @@ function resolveVariables(value: string[], workspace?: WorkspaceFolder): string[
     getWorkspaceFolders().forEach((w) => {
         substitutions.set('${workspaceFolder:' + w.name + '}', w.uri.fsPath);
     });
+    for (const [envVar, envValue] of Object.entries(process.env)) {
+        if (envValue) {
+            substitutions.set('${env:' + envVar + '}', envValue);
+        }
+    }
+    if (interpreter) {
+        value = value.flatMap((v) => (v === '${interpreter}' ? interpreter : v));
+    }
 
     return value.map((s) => {
         for (const [key, value] of substitutions) {
@@ -41,6 +49,11 @@ function resolveVariables(value: string[], workspace?: WorkspaceFolder): string[
     });
 }
 
+function getCwd(config: WorkspaceConfiguration, workspace: WorkspaceFolder): string {
+    const cwd = config.get<string>('cwd', workspace.uri.fsPath);
+    return resolveVariables([cwd], workspace)[0];
+}
+
 export function getInterpreterFromSetting(namespace: string, scope?: ConfigurationScope) {
     const config = getConfiguration(namespace, scope);
     return config.get<string[]>('interpreter');
@@ -59,15 +72,16 @@ export async function getWorkspaceSettings(
         if (interpreter.length === 0) {
             interpreter = (await getInterpreterDetails(workspace.uri)).path ?? [];
         }
+        interpreter = resolveVariables(interpreter, workspace);
     }
 
     const workspaceSetting = {
         enabled: config.get<boolean>('enabled', true),
-        cwd: workspace.uri.fsPath,
+        cwd: getCwd(config, workspace),
         workspace: workspace.uri.toString(),
         args: resolveVariables(config.get<string[]>(`args`) ?? [], workspace),
-        path: resolveVariables(config.get<string[]>(`path`) ?? [], workspace),
-        interpreter: resolveVariables(interpreter, workspace),
+        path: resolveVariables(config.get<string[]>(`path`) ?? [], workspace, interpreter),
+        interpreter: interpreter,
         importStrategy: config.get<string>(`importStrategy`) ?? 'useBundled',
         showNotifications: config.get<string>(`showNotifications`) ?? 'off',
     };
@@ -91,7 +105,7 @@ export async function getGlobalSettings(namespace: string, includeInterpreter?:
     }
 
     const setting = {
-        cwd: process.cwd(),
+        cwd: getGlobalValue<string>(config, 'cwd', process.cwd()),
         enabled: getGlobalValue<boolean>(config, 'enabled', true),
         workspace: process.cwd(),
         args: getGlobalValue<string[]>(config, 'args', []),
@@ -106,6 +120,7 @@ export async function getGlobalSettings(namespace: string, includeInterpreter?:
 export function checkIfConfigurationChanged(e: ConfigurationChangeEvent, namespace: string): boolean {
     const settings = [
         `${namespace}.args`,
+        `${namespace}.cwd`,
         `${namespace}.enabled`,
         `${namespace}.path`,
         `${namespace}.interpreter`,

src/test/python_tests/lsp_test_client/utils.py

@@ -69,5 +69,6 @@ def get_initialization_options():
 
     setting["workspace"] = as_uri(str(PROJECT_ROOT))
     setting["interpreter"] = []
+    setting["cwd"] = str(PROJECT_ROOT)
 
     return {"settings": [setting]}