1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
|
#' Declare Python Requirements
#'
#' `py_require()` allows you to declare Python requirements for the R session,
#' including Python packages, any version constraints on those packages, and any
#' version constraints on Python itself. Reticulate can then automatically
#' create and use an ephemeral Python environment that satisfies all these
#' requirements.
#'
#' Reticulate will only use an ephemeral environment if no other Python
#' installation is found earlier in the [Order of
#' Discovery](https://rstudio.github.io/reticulate/articles/versions.html#order-of-discovery).
#' You can also force reticulate to use an ephemeral environment by setting
#' `Sys.setenv(RETICULATE_USE_MANAGED_VENV="yes")`.
#'
#' The ephemeral virtual environment is not created until the user interacts
#' with Python for the first time in the R session, typically when `import()` is
#' first called.
#'
#' If `py_require()` is called with new requirements after reticulate has
#' already initialized an ephemeral Python environment, a new ephemeral
#' environment is activated on top of the existing one. Once Python is
#' initialized, only adding packages is supported---removing packages, changing
#' the Python version, or modifying `exclude_newer` is not possible.
#'
#' Calling `py_require()` without arguments returns a list of the currently
#' declared requirements.
#'
#' R packages can also call `py_require()` (e.g., in `.onLoad()` or elsewhere)
#' to declare Python dependencies. The print method for `py_require()` displays
#' the Python dependencies declared by R packages in the current session.
#'
#' @note Reticulate uses [`uv`](https://docs.astral.sh/uv/) to resolve Python
#' dependencies. Many `uv` options can be customized via environment
#' variables, as described
#' [here](https://docs.astral.sh/uv/configuration/environment/). For example:
#' - If temporarily offline, set `Sys.setenv(UV_OFFLINE = "1")`.
#' - To use a different index: `Sys.setenv(UV_INDEX = "https://download.pytorch.org/whl/cpu")`.
#' - To allow resolving a prerelease dependency: `Sys.setenv(UV_PRERELEASE = "allow")`.
#'
#' ## Installing from alternate sources
#'
#' The `packages` argument also supports declaring a dependency from a Git
#' repository or a local file. Below are some examples of valid `packages`
#' strings:
#'
#' Install Ruff from a specific Git tag:
#' ```
#' "git+https://github.com/astral-sh/ruff@v0.2.0"
#' ```
#'
#' Install Ruff from a specific Git commit:
#' ```
#' "git+https://github.com/astral-sh/ruff@1fadefa67b26508cc59cf38e6130bde2243c929d"
#' ```
#'
#' Install Ruff from a specific Git branch:
#' ```
#' "git+https://github.com/astral-sh/ruff@main"
#' ```
#'
#' Install MarkItDown from the `main` branch---find the package in the
#' subdirectory 'packages/markitdown':
#' ```
#' "markitdown@git+https://github.com/microsoft/markitdown.git@main#subdirectory=packages/markitdown"
#' ```
#'
#' Install MarkItDown from the local filesystem by providing an absolute path
#' to a directory containing a `pyproject.toml` or `setup.py` file:
#' ```
#' "markitdown@/Users/tomasz/github/microsoft/markitdown/packages/markitdown/"
#' ```
#'
#' See more examples
#' [here](https://docs.astral.sh/uv/pip/packages/#installing-a-package) and
#' [here](https://pip.pypa.io/en/stable/cli/pip_install/#examples).
#'
#'
#' ## Clearing the Cache
#'
#' `reticulate` caches ephemeral environments in the directory returned by
#' `tools::R_user_dir("reticulate", "cache")`. To clear the cache, delete the
#' directory:
#'
#' ```r
#' unlink(tools::R_user_dir("reticulate", "cache"), recursive = TRUE)
#' ```
#'
#' @param packages A character vector of Python packages to be available during
#' the session. These can be simple package names like `"jax"` or names with
#' version constraints like `"jax[cpu]>=0.5"`. Pip style syntax for installing
#' from local files or a git repository is also supported (see details).
#'
#' @param python_version A character vector of Python version constraints \cr
#' (e.g., `"3.10"` or `">=3.9,<3.13"`).
#'
#' @param ... Reserved for future extensions; must be empty.
#'
#' @param action Determines how `py_require()` processes the provided
#' requirements. Options are:
#' - `add`: Adds the entries to the current set of requirements.
#' - `remove`: Removes _exact_ matches from the requirements list. Requests to remove nonexistent entries are
#' ignored. For example, if `"numpy==2.2.2"` is in the list, passing `"numpy"`
#' with `action = "remove"` will not remove it.
#' - `set`: Clears all existing requirements and replaces them with the
#' provided ones. Packages and the Python version can be set independently.
#'
#' @param exclude_newer Limit package versions to those published before a
#' specified date. This offers a lightweight alternative to freezing package
#' versions, helping guard against Python package updates that break a
#' workflow. Accepts strings formatted as RFC 3339 timestamps (e.g.,
#' "2006-12-02T02:07:43Z") and local dates in the same format (e.g.,
#' "2006-12-02") in your system's configured time zone. Once `exclude_newer`
#' is set, only the `set` action can override it.
#'
#' @returns `py_require()` is primarily called for its side effect of modifying
#' the manifest of "Python requirements" for the current R session that
#' reticulate maintains internally. `py_require()` usually returns `NULL`
#' invisibly. If `py_require()` is called with no arguments, it returns the
#' current manifest--a list with names `packages`, `python_version`, and
#' `exclude_newer.` The list also has a class attribute, to provide a print
#' method.
#'
#' @export
py_require <- function(packages = NULL,
python_version = NULL,
...,
exclude_newer = NULL,
action = c("add", "remove", "set")) {
if (length(list(...)))
stop("... must be empty")
pr <- py_reqs_get()
if (missing(packages) && missing(python_version) && missing(exclude_newer)) {
return(pr)
}
action <- match.arg(action)
called_from_package <- isNamespace(topenv(parent.frame()))
ephemeral_venv_initialized <- is_epheremal_venv_initialized()
if (missing(packages))
packages <- NULL
# TODO: called_from_package_onLoad <- in_onload()
signal_and_exit <- if (called_from_package) warn_and_return else stop
if (!is.null(python_version)) {
python_version <- unlist(strsplit(python_version, ",", fixed = TRUE))
if (ephemeral_venv_initialized) {
current_py_version <- py_version(patch = TRUE)
for (check in as_version_constraint_checkers(python_version)) {
if (!isTRUE(check(current_py_version))) {
signal_and_exit(paste0(collapse = "",
"Python version requirements cannot be ",
"changed after Python has been initialized.\n",
"* Python version request: '", python_version, "'",
if (called_from_package) paste0(" (from package:", parent.pkg(), ")"),
"\n",
"* Python version initialized: '", as.character(current_py_version), "'"
))
}
}
} else {
pr$python_version <- py_reqs_action(action,
python_version,
py_reqs_get("python_version"))
}
}
if (!is.null(exclude_newer)) {
if (called_from_package) {
stop("`exclude_newer` cannot be set inside a package")
}
if (ephemeral_venv_initialized) {
if (!identical(exclude_newer, pr$exclude_newer))
stop("`exclude_newer` cannot be changed after Python has initialized.")
} else {
switch(action,
add = {
if (!is.null(pr$exclude_newer)) {
# TODO: we can check if the new request is already satisfied
# by the old request. e.g.,
# as.POSIXct(exclude_newer) >= as.POSIXct(pr$exclude_newer)
stop(
"`exclude_newer` is already set to '",
py_reqs_get("exclude_newer"),
"', use `action = 'set'` to override"
)
}
},
remove = {
if (identical(exclude_newer, pr$exclude_newer)) {
exclude_newer <- NA
}
},
set = {}
)
if (is.na(exclude_newer) || identical(exclude_newer, "")) {
# NA or "" are the sentinel for removing exclude_newer
# (since NULL sentinel already is taken)
exclude_newer <- NULL
}
pr$exclude_newer <- exclude_newer
}
}
if (!is.null(packages)) {
if (ephemeral_venv_initialized) {
switch(action,
add = {
if(all(packages %in% pr$packages)) {
packages <- NULL # no-op, skip activating new env
} else {
bare_name <- function(x) sub("^([^[!=><]+).*", "\\1", x)
if (any(bare_name(packages) %in% bare_name(pr$packages))) {
# e.g., if user calls 'numpy<2' after already initialized with 'numpy>2'
signal_and_exit("After Python has initialized, only `action = 'add'` with new packages is supported.")
packages <- NULL
}
pr$packages <- unique(c(packages, pr$packages))
}
},
remove = {
if (any(packages %in% pr$packages))
signal_and_exit("After Python has initialized, only `action = 'add'` is supported.")
},
set = {
if (!base::setequal(packages, pr$packages))
signal_and_exit("After Python has initialized, only `action = 'add'` is supported.")
})
} else {
pr$packages <- py_reqs_action(action, packages, py_reqs_get("packages"))
}
}
if (ephemeral_venv_initialized && action == "add" && !is.null(packages)) {
tryCatch({
new_path <- uv_get_or_create_env(pr$packages, pr$python_version, pr$exclude_newer)
new_config <- python_config(new_path)
new_config$ephemeral <- TRUE
if (new_config$libpython == .globals$py_config$libpython) {
py_activate_virtualenv(file.path(dirname(new_path), "activate_this.py"))
.globals$py_config <- new_config
.globals$py_config$available <- TRUE
# TODO: sync os.environ with R Sys.getenv()?
} else {
# TODO: Better error message?
stop("New environment does not use the same Python binary")
}
}, error = signal_and_exit)
}
pr$history <- c(pr$history, list(list(
requested_from = environmentName(topenv(parent.frame())),
env_is_package = called_from_package,
packages = packages,
python_version = python_version,
exclude_newer = exclude_newer,
action = action
)))
.globals$python_requirements <- pr
invisible()
}
#' @export
print.python_requirements <- function(x, ...) {
packages <- x$packages
if (is.null(packages)) {
packages <- "[No package(s) specified]"
}
python_version <- x$python_version
if (is.null(python_version)) {
python_version <- paste0("[No Python version specified. Will default to '", resolve_python_version() , "']")
}
requested_from <- as.character(lapply(x$history, function(x) x$requested_from))
history <- x$history[requested_from != "R_GlobalEnv"]
is_package <- as.logical(lapply(history, function(x) x$env_is_package))
if (requireNamespace("cli", quietly = TRUE)) {
withr::with_options(
list("cli.width" = 73),
{
cli::cli_div(
theme = list(rule = list(color = "cyan", "line-type" = "double"))
)
cli::cli_rule(center = "Python requirements")
cli::cli_div(
theme = list(rule = list("line-type" = "single"))
)
cli::cli_rule("Current requirements")
cat(py_reqs_format(
packages = packages,
python_version = python_version,
exclude_newer = x$exclude_newer,
use_cli = TRUE
))
cat("\n")
if (any(is_package)) {
cli::cli_rule("R package requests")
py_reqs_table(history[is_package], "R package", use_cli = TRUE)
}
if (any(!is_package)) {
cli::cli_rule("Environment requests")
py_reqs_table(history[!is_package], "R package", use_cli = TRUE)
}
}
)
} else {
cat(paste0(rep("=", 26), collapse = ""))
cat(" Python requirements ")
cat(paste0(rep("=", 26), collapse = ""), "\n")
cat(py_reqs_format(
packages = packages,
python_version = python_version,
exclude_newer = x$exclude_newer
))
cat("\n")
if (any(is_package)) {
cat("-- R package requests ")
cat(paste0(rep("-", 51), collapse = ""), "\n")
py_reqs_table(history[is_package], "R package")
}
if (any(!is_package)) {
cat("-- Environment requests ")
cat(paste0(rep("-", 49), collapse = ""), "\n")
py_reqs_table(history[!is_package], "R package")
}
}
invisible()
}
# Python requirements - utils --------------------------------------------------
py_reqs_pad <- function(x = "", len, use_cli, is_title = FALSE) {
padding <- paste0(rep(" ", len - nchar(x)), collapse = "")
ret <- paste0(x, padding)
if (use_cli) {
if (is_title) {
ret <- cli::col_blue(ret)
} else {
ret <- cli::col_grey(ret)
}
}
ret
}
py_reqs_table <- function(history, from_label, use_cli = FALSE) {
console_width <- 73
python_width <- 20
requested_from <- as.character(lapply(history, function(x) x$requested_from))
pkg_names <- c(unique(requested_from), from_label)
name_width <- max(nchar(pkg_names)) + 1
pkg_width <- console_width - python_width - name_width
header <- list(list(
requested_from = from_label,
packages = "Python packages",
python_version = "Python version",
is_title = 1
))
history <- lapply(unique(requested_from), py_reqs_flatten, history)
history <- c(header, history)
for (pkg_entry in history) {
pkg_lines <- strwrap(
x = paste0(pkg_entry$packages, collapse = ", "),
width = pkg_width
)
python_lines <- strwrap(
x = paste0(pkg_entry$python_version, collapse = ", "),
width = python_width
)
max_lines <- max(c(length(python_lines), length(pkg_lines)))
for (i in seq_len(max_lines)) {
nm <- ifelse(i == 1, pkg_entry$requested_from, "")
pk <- ifelse(i <= length(pkg_lines), pkg_lines[i], "")
py <- ifelse(i <= length(python_lines), python_lines[i], "")
cat(py_reqs_pad(nm, name_width, use_cli, !is.null(pkg_entry$is_title)))
cat(py_reqs_pad(pk, pkg_width, use_cli, !is.null(pkg_entry$is_title)))
cat(py_reqs_pad(py, python_width, use_cli, !is.null(pkg_entry$is_title)))
cat("\n")
}
}
}
py_reqs_action <- function(action, x, y = NULL) {
if (is.null(x)) {
return(y)
}
switch(action,
add = unique(c(y, x)),
remove = setdiff(y, x),
set = x
)
}
py_reqs_flatten <- function(r_pkg = "", history) {
req_packages <- NULL
req_python <- NULL
for (entry in history) {
if (entry$requested_from == r_pkg | r_pkg == "") {
req_packages <- py_reqs_action(entry$action, entry$packages, req_packages)
req_python <- py_reqs_action(entry$action, entry$python_version, req_python)
}
}
list(
requested_from = r_pkg,
packages = req_packages,
python_version = req_python
)
}
py_reqs_format <- function(packages = NULL,
python_version = NULL,
exclude_newer = NULL,
use_cli = FALSE) {
msg <- c(
if (!use_cli) {
paste0(
"-- Current requirements ", paste0(rep("-", 49), collapse = ""),
collapse = ""
)
},
if (!is.null(python_version)) {
python <- ifelse(use_cli, cli::col_blue("Python:"), "Python:")
python_version <- paste0(python_version, collapse = ", ")
python_version <- ifelse(use_cli, cli::col_grey(python_version), python_version)
paste0(" ", python, " ", python_version)
},
if (!is.null(packages)) {
pkg_lines <- strwrap(paste0(packages, collapse = ", "), 60)
pkgs <- "Packages:"
if (use_cli) {
pkgs <- cli::col_blue(pkgs)
pkg_lines <- as.character(lapply(pkg_lines, cli::col_grey))
}
pkg_col <- c(paste0(" ", pkgs, " "), rep(" ", length(pkg_lines) - 1))
out <- NULL
for (i in seq_along(pkg_lines)) {
out <- c(out, paste0(pkg_col[[i]], pkg_lines[[i]]))
}
out
},
if (!is.null(exclude_newer)) {
exclude <- ifelse(use_cli, cli::col_blue("Exclude:"), "Exclude:")
exclude_newer <- paste0(" Anything newer than ", exclude_newer)
exclude_newer <- ifelse(use_cli, cli::col_grey(exclude_newer), exclude_newer)
paste0(" ", exclude, exclude_newer)
}
)
paste0(msg, collapse = "\n")
}
py_reqs_get <- function(x = NULL) {
pr <- .globals$python_requirements
if (is.null(pr)) {
pr <- structure(
list(
python_version = NULL,
packages = NULL,
exclude_newer = NULL,
history = list()
),
class = "python_requirements"
)
pkg_prime <- c("numpy", if (is_positron()) "ipykernel")
pr$packages <- pkg_prime
pr$history <- list(list(
requested_from = "reticulate",
env_is_package = TRUE,
action = "add",
packages = pkg_prime
))
.globals$python_requirements <- pr
}
if (is.null(x)) {
return(pr)
}
if (x == "python_version") {
if (is_epheremal_venv_initialized())
return(as.character(py_version(TRUE)))
}
pr[[x]]
}
# uv ---------------------------------------------------------------------------
uv_binary <- function(bootstrap_install = TRUE) {
required_version <- numeric_version("0.6.1")
is_usable_uv <- function(uv) {
if (is.null(uv) || is.na(uv) || uv == "" || !file.exists(uv)) {
return(FALSE)
}
ver <- suppressWarnings(system2(uv, "--version", stderr = TRUE, stdout = TRUE))
if (!is.null(attr(ver, "status"))) {
return(FALSE)
}
ver <- numeric_version(sub("uv ([0-9.]+).*", "\\1", ver), strict = FALSE)
!is.na(ver) && ver >= required_version
}
uv <- Sys.getenv("RETICULATE_UV", NA)
if (is_usable_uv(uv)) {
return(path.expand(uv))
}
uv <- getOption("reticulate.uv_binary")
if (is_usable_uv(uv)) {
return(path.expand(uv))
}
uv <- as.character(Sys.which("uv"))
if (is_usable_uv(uv)) {
return(path.expand(uv))
}
uv <- path.expand("~/.local/bin/uv")
if (is_usable_uv(uv)) {
return(path.expand(uv))
}
uv <- reticulate_cache_dir("uv", "bin", if (is_windows()) "uv.exe" else "uv")
if (is_usable_uv(uv))
return(uv)
if (file.exists(uv)) {
# exists, but version too old
unlink(dirname(uv), recursive = TRUE)
## We don't do `system2(uv, "self update")` because self update is only
## supported on a "managed" uv installations, and uv only supports one
## managed installation per system. uv installs and maintains a config file
## for the auto updater in XDG_CONFIG_DIRS/uv/uv-receipt.json and errors if
## multiple uv installations attempt to modify that config file.
}
if (bootstrap_install) {
# Install 'uv' in the 'r-reticulate' sub-folder inside the user's cache directory
# https://github.com/astral-sh/uv/blob/main/docs/configuration/installer.md
dir.create(dirname(uv), showWarnings = FALSE, recursive = TRUE)
file_ext <- if (is_windows()) ".ps1" else ".sh"
url <- paste0("https://astral.sh/uv/install", file_ext)
install_uv <- tempfile("install-uv-", fileext = file_ext)
download.file(url, install_uv, quiet = TRUE)
if (!file.exists(install_uv)) {
return(NULL)
# stop("Unable to download Python dependencies. Please install `uv` manually.")
}
if(debug <- Sys.getenv("_RETICULATE_DEBUG_UV_") == "1")
system2 <- system2t
if (is_windows()) {
withr::with_envvar(c("UV_UNMANAGED_INSTALL" = utils::shortPathName(dirname(uv))), {
system2("powershell", c(
"-ExecutionPolicy", "ByPass", "-c",
sprintf("irm %s | iex", utils::shortPathName(install_uv))),
stdout = if (debug) "" else FALSE,
stderr = if (debug) "" else FALSE
)
})
} else {
Sys.chmod(install_uv, mode = "0755")
withr::with_envvar(c("UV_UNMANAGED_INSTALL" = dirname(uv)), {
system2(install_uv, c(if (!debug) "--quiet"))
})
}
}
if (file.exists(uv)) uv else NULL # print visible
}
uv_get_or_create_env <- function(packages = py_reqs_get("packages"),
python_version = py_reqs_get("python_version"),
exclude_newer = py_reqs_get("exclude_newer")) {
uv <- uv_binary() %||% return() # error?
resolved_python_version <- resolve_python_version(constraints = python_version, uv = uv)
# capture args; maybe used in error message later
call_args <- list(
packages = packages,
python_version = python_version %||%
paste(resolved_python_version, "(reticulate default)"),
exclude_newer = exclude_newer
)
if (length(packages))
packages <- as.vector(rbind("--with", packages))
python_version <- c("--python", resolved_python_version)
if (!is.null(exclude_newer)) {
# todo, accept a POSIXct/lt, format correctly
exclude_newer <- c("--exclude-newer", exclude_newer)
}
# TODO?: use default uv cache if using user-installed uv?
# need to refactor detecting approach in py_install() and py_require()
cache_dir <- c("--cache-dir", reticulate_cache_dir("uv", "cache"))
withr::local_envvar(c(
VIRTUAL_ENV = NA,
if (is_positron())
c(RUST_LOG = NA)
))
uv_output_file <- tempfile()
on.exit(unlink(uv_output_file), add = TRUE)
uv_args <- c(
"run",
"--no-project",
"--python-preference", "only-managed",
cache_dir,
python_version,
exclude_newer,
packages,
"--",
"python", "-c",
# chr(119) == "w", but avoiding a string literal to minimize the need for
# shell quoting shenanigans
"import sys; f=open(sys.argv[-1], chr(119)); f.write(sys.executable); f.close();",
uv_output_file
)
# debug print system call
if (debug <- Sys.getenv("_RETICULATE_DEBUG_UV_") == "1")
message(paste0(c(shQuote(uv), maybe_shQuote(uv_args)), collapse = " "))
error_code <- suppressWarnings(system2(uv, maybe_shQuote(uv_args)))
if (error_code) {
cat("uv error code: ", error_code, "\n", sep = "", file = stderr())
msg <- do.call(py_reqs_format, call_args)
writeLines(c(msg, strrep("-", 73L)), con = stderr())
if (error_code == 2) {
cat(
"Hint: If you are temporarily offline, try setting `Sys.setenv(UV_OFFLINE=1)`.\n",
file = stderr()
)
}
stop("Call `py_require()` to remove or replace conflicting requirements.")
}
ephemeral_python <- readLines(uv_output_file, warn = FALSE)
if (debug)
message("resolved ephemeral python: ", ephemeral_python)
ephemeral_python
}
#' uv run tool
#'
#' Run a Command Line Tool distributed as a Python package. Packages are automatically
#' download and installed into a cached, ephemeral, and isolated environment on the first run.
#'
#' @param tool,args A character vector of command and arguments. Arguments are
#' not quoted for the shell, so you may need to use [`shQuote()`].
#' @param from Use the given python package to provide the command.
#' @param with Run with the given Python packages installed. You can also
#' specify version constraints like `"ruff>=0.3.0"`.
#' @param python_version A python version string, or character vector of python
#' version constraints.
#'
#' @inheritDotParams base::system2 -command
#'
#' @details
#' ## Examples
#' ```r
#' uv_run_tool("pycowsay", shQuote("hello from reticulate"))
#' uv_run_tool("markitdown", shQuote(file.path(R.home("doc"), "NEWS.pdf")), stdout = TRUE)
#' uv_run_tool("kaggle competitions download -c dogs-vs-cats")
#' uv_run_tool("ruff", "--help")
#' uv_run_tool("ruff format", shQuote(Sys.glob("**.py")))
#' uv_run_tool("http", from = "httpie")
#' uv_run_tool("http", "--version", from = "httpie<3.2.4", stdout = TRUE)
#' uv_run_tool("saved_model_cli", "--help", from = "tensorflow")
#' ```
#' @seealso <https://docs.astral.sh/uv/guides/tools/>
#' @returns Return value of [`system2()`]
#' @export
#' @md
uv_run_tool <- function(tool, args = character(), ..., from = NULL, with = NULL, python_version = NULL) {
system2(uv_binary(), c(
"tool",
"run",
"--isolated",
"--python-preference=only-managed",
"--python", resolve_python_version(constraints = python_version),
if (length(from)) c("--from", maybe_shQuote(from)),
if (length(with)) c(rbind("--with", maybe_shQuote(with))),
"--",
tool,
args
), ...)
}
# uv - utils -------------------------------------------------------------------
is_reticulate_managed_uv <- function(uv = uv_binary(bootstrap_install = FALSE)) {
if (is.null(uv) || !file.exists(uv)) {
# no user-installed uv - uv will be bootstrapped by reticulate
return(TRUE)
}
managed_uv <-
reticulate_cache_dir("uv", "bin", if (is_windows()) "uv.exe" else "uv")
uv == managed_uv
}
uv_python_list <- function(uv = uv_binary()) {
x <- system2(uv, c("python list",
"--python-preference only-managed",
"--only-downloads",
"--color never",
"--output-format json"
),
stdout = TRUE
)
x <- jsonlite::parse_json(x)
x <- unlist(lapply(x, `[[`, "version"))
# to parse default `--output-format text`
# x <- grep("^cpython-", x, value = TRUE)
# x <- sub("^cpython-([^-]+)-.*", "\\1", x)
xv <- numeric_version(x, strict = FALSE)
latest_minor_patch <- !duplicated(xv[, -3L]) & !is.na(xv)
x <- x[order(latest_minor_patch, xv, decreasing = TRUE)]
x
}
uvx_binary <- function(...) {
uv <- uv_binary(...)
if(is.null(uv)) {
return()
}
uvx <- file.path(dirname(uv), if (is_windows()) "uvx.exe" else "uvx")
if (file.exists(uvx)) uvx else NULL # print visible
}
resolve_python_version <- function(constraints = NULL, uv = uv_binary()) {
constraints <- as.character(constraints %||% "")
constraints <- trimws(unlist(strsplit(constraints, ",", fixed = TRUE)))
constraints <- constraints[nzchar(constraints)]
if (length(constraints) == 0) {
return(as.character(uv_python_list()[3L])) # default
}
# reflect a direct version specification like "3.11" or "3.14.0a3"
if (length(constraints) == 1 && !substr(constraints, 1, 1) %in% c("=", ">", "<", "!")) {
return(constraints)
}
# We perform custom constraint resolution to prefer slightly older Python releases.
# uv tends to select the latest version, which often lack package support
# See: https://devguide.python.org/versions/
# Get latest patch for each minor version
candidates <- uv_python_list(uv)
# E.g., candidates might be:
# c("3.13.1", "3.12.8", "3.11.11", "3.10.16", "3.9.21", "3.8.20")
# Reorder candidates to prefer stable versions over bleeding edge
ord <- as.integer(c(3, 4, 2, 5, 1))
ord <- union(ord, seq_along(candidates))
candidates <- candidates[ord]
# Maybe add non-latest patch levels to candidates if they're explicitly
# mentioned in constraints
append(candidates) <- sub("^[<>=!]{1,2}", "", constraints)
candidates <- numeric_version(candidates, strict = FALSE)
candidates <- candidates[!is.na(candidates)]
for (check in as_version_constraint_checkers(constraints)) {
satisfies_constraint <- check(candidates)
candidates <- candidates[satisfies_constraint]
}
if (!length(candidates)) {
constraints <- paste0(constraints, collapse = ",")
msg <- paste0(
'Requested Python version constraints could not be satisfied.\n',
' constraints: "', constraints, '"\n',
'Hint: Call `py_require(python_version = <string>, action = "set")` to replace constraints.'
)
stop(msg)
}
as.character(candidates[1L])
}
|