Package io.jenkins.plugins.python

Class WithPythonStep

java.lang.Object
hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
org.jenkinsci.plugins.workflow.steps.Step
io.jenkins.plugins.python.WithPythonStep
All Implemented Interfaces:
ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable
public class WithPythonStep extends org.jenkinsci.plugins.workflow.steps.Step implements Serializable
Pipeline step enabling execution inside a specific Python version environment, supporting virtual environments, CUDA hardware acceleration, corporate mirrors, and host system Python runtimes. Example: 
 withPython(version: '3.12.15', venv: '.venv', cuda: true) {
     sh 'python --version'
 }
See Also:

  • Constructor Details

    • WithPythonStep

      @DataBoundConstructor public WithPythonStep(String version)

  • Method Details

    • getVersion

      public String getVersion()

    • setVersion

      @DataBoundSetter public void setVersion(String version)

    • getTool

      public String getTool()

    • setTool

      @DataBoundSetter public void setTool(String tool)

    • isSystem

      public boolean isSystem()

    • setSystem

      @DataBoundSetter public void setSystem(boolean system)

    • getHome

      public String getHome()

    • setHome

      @DataBoundSetter public void setHome(String home)

    • getMirrorUrl

      public String getMirrorUrl()

    • setMirrorUrl

      @DataBoundSetter public void setMirrorUrl(String mirrorUrl)

    • getVenv

      public String getVenv()

    • setVenv

      @DataBoundSetter public void setVenv(String venv)

    • isClear

      public boolean isClear()

    • setClear

      @DataBoundSetter public void setClear(boolean clear)

    • isSystemSitePackages

      public boolean isSystemSitePackages()

    • setSystemSitePackages

      @DataBoundSetter public void setSystemSitePackages(boolean systemSitePackages)

    • isCuda

      public boolean isCuda()

    • setCuda

      @DataBoundSetter public void setCuda(boolean cuda)

    • getCudaHome

      public String getCudaHome()

    • setCudaHome

      @DataBoundSetter public void setCudaHome(String cudaHome)

    • isUv

      public boolean isUv()

    • setUv

      @DataBoundSetter public void setUv(boolean uv)

    • getUvVersion

      public String getUvVersion()

    • setUvVersion

      @DataBoundSetter public void setUvVersion(String uvVersion)

    • getUvMirrorUrl

      public String getUvMirrorUrl()

    • setUvMirrorUrl

      @DataBoundSetter public void setUvMirrorUrl(String uvMirrorUrl)

    • getUvCacheDir

      public String getUvCacheDir()

    • setUvCacheDir

      @DataBoundSetter public void setUvCacheDir(String uvCacheDir)

    • isUvEnabled

      public boolean isUvEnabled()

    • start

      public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context) throws Exception
      Specified by:
      start in class org.jenkinsci.plugins.workflow.steps.Step
      Throws:
      Exception