Field Detail

• public static final java.lang.String PIP_NAME

Property Detail

• final java.io.File location

• final java.lang.String name

• final java.lang.String path

Constructor Detail

• Virtualenv(org.gradle.api.Project project, java.lang.String path)

• Virtualenv(org.gradle.api.Project project, java.lang.String pythonPath, java.lang.String binary, java.lang.String path)

  Create virtualenv utility.

  Parameters:

  project - gradle project instance

  pythonPath - python path (null to use global)

  binary - python binary name (null to use default python3 or python)

  path - environment path relative to project

Method Detail

• @java.lang.SuppressWarnings('BuilderMethodWithSideEffects') void create(boolean copy = false)

  Create virtualenv with setuptools and pip. Do nothing if already exists. To copy environment instead of symlinking, use copy ( true ) otherwise don't specify parameter.

• @java.lang.SuppressWarnings('BuilderMethodWithSideEffects') void create(boolean setuptools, boolean pip, boolean copy = false)

  Create virtualenv. Do nothing if already exists. To copy environment instead if symlinking, use copy ( ? , ? , true ) otherwise omit last parameter.

  Parameters:

  setuptools - do not install setuptools (--no-setuptools)

  pip - do not install pip and wheel (--no-pip --no-wheel)

  copy - copy virtualenv instead if symlink (--always-copy)

• @java.lang.SuppressWarnings('BuilderMethodWithSideEffects') void createPythonOnly(boolean copy = false)

  Create the lightest env without setuptools and pip. Do nothing if already exists. To copy environment instead of symlinking, use copy ( true ) otherwise don't specify parameter.

• boolean exists()

  Returns:

  true if virtualenv exists

• @groovy.transform.Memoized java.lang.String getPythonPath()

  Returns:

  python path to use for environment

• @groovy.transform.Memoized java.lang.String getVersion()

  Returns:

  virtualenv version (major.minor.micro)