...
Configuration File Parameter | Description and Expected Behavior | If True | If False | Default | Command Line Parameter Available? |
---|---|---|---|---|---|
python.resolveDependencies | Whether to resolve python dependencies. "requirements.txt" or "pipfile" are required. | Resolves python dependencies | Will not resolve python dependencies. | True | No |
python.ignoreSourceFiles | When using the dependency resolver, it will only include package dependencies, not source files. NOTE: Only relevant when fileSystemScan is true. | Ignores *.py files in scan. | Will not ignore files which have ".py" extension. | True | No |
python.ignorePipInstallErrors | Whether to ignore errors of 'pip download -r requirements.txt' command. | Ignores download errors, and try to download packages one by one | Will consider such errors and react accordingly | False | No |
python.installVirtualenv | Whether to install the pip 'virtualenv' package on --user. | Installs a virtual environment the virtualenv package by running "python -m pip install --user virtualenv" | Will not run install the command virtualenv package | False | No |
python.resolveHierarchyTree | Whether to resolve the hierarchy tree or a flat list of dependencies, requires "requirements.txt" like files. | Will install pipdeptree and use it to resolve and find the dependency hierarchy tree | Will resolve a flat list only | True | No |
python.requirementsFileIncludes | Space-delimited list of dependency filenames specifying which files to be scanned for dependencies, instead of "requirements.txt", when using pip package manager. | N/A | N/A | requirements.txt | No |
python.resolveSetupPyFiles | Whether to resolve python dependencies in setup.py files, and if so, it executes the setup.py script in order to install and resolve dependencies. | Executes setup.py in order to install and resolve dependencies | Will ignore setup.py files | False | No |
python.runPipenvPreStep | Whether to run pipenv install command. If so, it requires "pipfile". | Runs the 'pipenv install' command. | Will not run the command | False | No |
python.pipenvDevDependencies | Whether or not to install "dev" dependencies, if so it requires "python.runPipenvPreStep=true" | Adds --dev to the command, resulting in: "pipenv install --dev" | Will not adds --dev to the command | False | No |
python.IgnorePipenvInstallErrors | Whether to ignore errors of the 'pipenv run pip download' command. | Ignores download errors, and try to download packages one by one | Will consider such errors and react accordingly | False | No |
python.resolveGlobalPackages | Whether to resolve global packages or not. If so, it requires global package folders called site-packages or dist-packages in your scan directory. | If set to True and there is a site-packages or dist-packages folder, the resolution will be based on the packages under those folders. | Will not resolve global packages | False | No |
python.resolvePipEditablePackages | The parameter handles requirements.txt files with rows (packages) with the -e flag. | Resolves the dev dependencies on the first scan. | Will not resolve the dev dependencies on the first scan. | False | No |
python.path | Points to the python executable path. If the executable path is already set in the environment variables, then just the executable name can be defined, e.g. in Linux "python2.7". NOTE: This parameter replaces "python" executable with the value defined. | N/A | N/A | python | No |
python.pipPath | Enables you to use different versions of pip. If set to pip3, will run "pip3" and "python -m pip3" instead of "pip" and "python -m pip". | N/A | N/A | pip | No |
python.runPoetryPreStep | Whether to run "poetry install" command. | Will run the "poetry install" command | Will not run the "poetry install" command | False | No |
python.includePoetryDevDependencies | Whether to scan Poetry project dev dependencies. | Scans Poetry project dev dependencies | Will ignore dev dependencies | False | No |
python.localPackagePathsToInstall | A space-delimited list of local package paths that will be installed during the pre-step, if is required. | N/A | N/A | Empty | No |
python.indexUrl | The local Pypi repository url, besides the official Pypi repository. Use if you have dependencies downloaded from a different source than the default pypi. | N/A | N/A | No | |
python.includePipenvDevDependencies | Enables you to include or exclude dev dependencies. | Include dev dependencies in the resolution. | Exclude dev dependencies in the resolution. | True | No |
...