Package io.jenkins.plugins.python

Class UvInstaller

java.lang.Object

io.jenkins.plugins.python.UvInstaller

All Implemented Interfaces:

Serializable

public final class UvInstaller
extends Object
implements Serializable

Provisions standalone Astral uv (and uvx) binaries across Linux, macOS, and Windows agents, supporting version pinning, local agent tool caching, and corporate mirrors.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_UV_BASE_URL

Method Summary

Modifier and Type	Method	Description
static String	buildDownloadUrl(String uvVersion, String platformKey, String customMirrorUrl)	Builds the download URL for the uv archive, honoring custom mirror overrides or system properties.
static FilePath	findExistingUvBinDir(FilePath pythonHome)	Checks whether an existing Python installation directory already contains a pre-installed uv binary.
static String	getArchiveFilename(String platformKey)	Returns the archive filename for a given platformKey (from PlatformUtils.detectPlatformKey(hudson.model.Node, hudson.model.TaskListener)).
static FilePath	getUvExecutable(FilePath uvBinDir, boolean isUnix)	Resolves the executable path for uv inside a directory known to contain it.
static void	installIntoPythonHome(FilePath pyHome, Node node, TaskListener log, String uvVersion, String customMirrorUrl)	Installs uv and uvx binaries directly into an existing standalone Python home directory (bin/ on Unix or Scripts/ on Windows).
static String	normalizeVersion(String uvVersion)	Normalizes a user-supplied uv version string (e.g.
static FilePath	provisionUv(Node node, FilePath workspaceFallback, TaskListener log, String uvVersion, String customMirrorUrl)	Provisions uv into the agent's shared tool cache directory and returns the directory containing the uv binary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_UV_BASE_URL

public static final String DEFAULT_UV_BASE_URL

See Also:

• Constant Field Values

Method Details

normalizeVersion

public static String normalizeVersion(String uvVersion)

Normalizes a user-supplied uv version string (e.g. null, "", "latest", "v0.13.1" -> "0.13.1").

getArchiveFilename

public static String getArchiveFilename(String platformKey)

Returns the archive filename for a given platformKey (from PlatformUtils.detectPlatformKey(hudson.model.Node, hudson.model.TaskListener)).

buildDownloadUrl

public static String buildDownloadUrl(String uvVersion,
 String platformKey,
 String customMirrorUrl)

Builds the download URL for the uv archive, honoring custom mirror overrides or system properties.

findExistingUvBinDir

public static FilePath findExistingUvBinDir(FilePath pythonHome)
                                     throws IOException,
InterruptedException

Checks whether an existing Python installation directory already contains a pre-installed uv binary.

Throws:

IOException

InterruptedException

getUvExecutable

public static FilePath getUvExecutable(FilePath uvBinDir,
 boolean isUnix)
                                throws IOException,
InterruptedException

Resolves the executable path for uv inside a directory known to contain it.

Throws:

IOException

InterruptedException

provisionUv

public static FilePath provisionUv(Node node,
 FilePath workspaceFallback,
 TaskListener log,
 String uvVersion,
 String customMirrorUrl)
                            throws IOException,
InterruptedException

Provisions uv into the agent's shared tool cache directory and returns the directory containing the uv binary.

Throws:

IOException

InterruptedException

installIntoPythonHome

public static void installIntoPythonHome(FilePath pyHome,
 Node node,
 TaskListener log,
 String uvVersion,
 String customMirrorUrl)
                                  throws IOException,
InterruptedException

Installs uv and uvx binaries directly into an existing standalone Python home directory (bin/ on Unix or Scripts/ on Windows).

Throws:

IOException

InterruptedException