Property Detail

• boolean alwaysInstallModules

  By default, plugin will not call "pip install" for modules already installed (with exactly the same version). Enable option if you need to always call "pip install module" (for example, to make sure correct dependencies installed).

• boolean envCopy

  Copy virtual environment instead of symlink (see --always-copy virtualenv option). By default use default virtualenv behaviour: symlink environment.

• java.lang.String envPath

  Virtual environment path to use. Used only when scope is configured to use virtualenv. Virtualenv will be created automatically if not yet exists.

• boolean installVirtualenv

  Automatically install virtualenv (if pip modules used). Will install for current user only (--user). Installed virtualenv will not be modified later, so you will need to manually update it in case of problems. When disabled, plugin will still check if virtualenv is available, but will not try to install it if not.

• java.lang.String minPipVersion

  Minimal required pip version. Format is teh same as python version: "major.minor.micro". Any precision could be used (9, 8.2, etc). By default pip 9 is required.

• java.lang.String minPythonVersion

  Minimal required python version. Full format: "major.minor.micro". Any precision could be used, for example: '3' (python 3 or above), '3.2' (python. 3.2 or above), '3.6.1' (python 3.6.1 or above).

• java.util.List<java.lang.String> modules

  Pip modules to install. Modules are installed in the declaration order. Duplicates are allowed: only the latest declaration will be used. So it is possible to pre-define some modules (for example, in plugin) and then override module version by adding new declaration (with pip ( .. ) method).

  Use pip ( .. ) methods for modules declaration.

• java.lang.String pythonBinary

  Python binary name to use. By default, for linux it would be python3 (if installed) or python and for windows - python.

  Useful when you want to force python 2 usage on linux or python binary name differs.

• java.lang.String pythonPath

  Path to python binary (folder where python executable is located). When not set, global python is called. NOTE: automatically set when virtualenv is used (see {scope).

• PythonExtension.Scope scope

  Installed pip packages scope.

• boolean showInstalledVersions

  Calls 'pip list' to show all installed python modules (for problem investigations). Enabled by default for faster problems detection (mostly to highlight used transitive dependencies versions).

Method Detail

• boolean isModuleDeclared(java.lang.String name)

  Checks if module is already declared. Could be used by other plugins to test if required module is manually declared or not (in order to apply defaults).

  Parameters:

  name - module name to check

  Returns:

  true of module already declared, false otherwise

• void pip(java.lang.String... modules)

  Shortcut for pip(java.lang.Iterable).

  Parameters:

  modules - pip modules to install

• void pip(java.lang.Iterable<java.lang.String> modules)

  Declare pip modules to install. Format: "moduleName:version". Only exact version matching is supported (pip support ranges, but this is intentionally not supported in order to avoid side effects).

  Duplicate declarations are allowed: in this case the latest declaration will be used.

  Note: if newer package version is already installed, pip will remove it and install correct version.

  Parameters:

  modules - pip modules to install