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
|
#' @param path The location where Miniconda is (or should be) installed. Note
#' that the Miniconda installer does not support paths containing spaces. See
#' [miniconda_path] for more details on the default path used by `reticulate`.
#'
#' @title miniconda-params
#' @keywords internal
#' @name miniconda-params
NULL
#' Install Miniconda
#'
#' Download the [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
#' installer, and use it to install Miniconda.
#'
#' For arm64 builds of R on macOS, `install_miniconda()` will use
#' binaries from [miniforge](https://github.com/conda-forge/miniforge) instead.
#'
#' @inheritParams miniconda-params
#'
#' @param update Boolean; update to the latest version of Miniconda after
#' installation?
#'
#' @param force Boolean; force re-installation if Miniconda is already installed
#' at the requested path?
#'
#' @note If you encounter binary incompatibilities between R and Miniconda, a
#' scripted build and installation of Python from sources can be performed by
#' [`install_python()`]
#'
#' @family miniconda-tools
#' @export
install_miniconda <- function(path = miniconda_path(),
update = TRUE,
force = FALSE)
{
check_forbidden_install("Miniconda")
path <- path.expand(path)
if (grepl(" ", path, fixed = TRUE))
stop("cannot install Miniconda into a path containing spaces")
# TODO: what behavior when miniconda is already installed?
# fail? validate installed and matches request? reinstall?
install_miniconda_preflight(path, force)
# download the installer
message("* Installing Miniconda -- please wait a moment ...")
url <- miniconda_installer_url()
installer <- miniconda_installer_download(url)
if (force) {
# miniconda installer '-u' (update) flag frequently does not work, errors.
miniconda_uninstall(path)
}
# run the installer
miniconda_installer_run(installer, update, path)
# validate the install succeeded
ok <- miniconda_exists(path) && miniconda_test(path)
if (!ok)
stopf("Miniconda installation failed [unknown reason]")
# update to latest version if requested
if (update)
miniconda_update(path)
# create r-reticulate environment
conda <- miniconda_conda(path)
python <- miniconda_python_package()
conda_create("r-reticulate", packages = c(python, "numpy"), conda = conda)
messagef("* Miniconda has been successfully installed at %s.", pretty_path(path))
path
}
#' Update Miniconda
#'
#' Update Miniconda to the latest version.
#'
#' @inheritParams miniconda-params
#'
#' @family miniconda-tools
#' @export
miniconda_update <- function(path = miniconda_path()) {
conda <- miniconda_conda(path)
local_conda_paths(conda)
system2t(conda, c("update", "--yes", "--name", "base", "conda"))
}
#' Remove Miniconda
#'
#' Uninstall Miniconda.
#'
#' @param path The path in which Miniconda is installed.
#'
#' @family miniconda-tools
#' @export
miniconda_uninstall <- function(path = miniconda_path()) {
unlink(path, recursive = TRUE)
}
install_miniconda_preflight <- function(path, force) {
# if we're forcing installation, then proceed
if (force)
return(invisible(TRUE))
# if the directory doesn't exist, that's fine
if (!file.exists(path))
return(invisible(TRUE))
# check for a miniconda installation
if (miniconda_exists(path)) {
fmt <- paste(
"Miniconda is already installed at path %s.",
"- Use `reticulate::install_miniconda(force = TRUE)` to overwrite the previous installation.",
sep = "\n"
)
stopf(fmt, pretty_path(path))
}
# ok to proceed
invisible(TRUE)
}
miniconda_installer_url <- function(version = "3") {
url <- getOption("reticulate.miniconda.url")
if (!is.null(url))
return(url)
# TODO: miniconda does not yet have arm64 binaries for macOS,
# so we'll just use miniforge instead
info <- as.list(Sys.info())
if (info$sysname == "Darwin" && info$machine == "arm64") {
base <- "https://github.com/conda-forge/miniforge/releases/latest/download"
name <- "Miniforge3-MacOSX-arm64.sh"
return(file.path(base, name))
}
base <- "https://repo.anaconda.com/miniconda"
info <- as.list(Sys.info())
arch <- miniconda_installer_arch(info)
version <- as.character(version)
name <- if (is_windows())
sprintf("Miniconda%s-latest-Windows-%s.exe", version, arch)
else if (is_osx())
sprintf("Miniconda%s-latest-MacOSX-%s.sh", version, arch)
else if (is_linux())
sprintf("Miniconda%s-latest-Linux-%s.sh", version, arch)
else
stopf("unsupported platform %s", shQuote(Sys.info()[["sysname"]]))
file.path(base, name)
}
miniconda_installer_arch <- function(info) {
# allow user override
arch <- getOption("reticulate.miniconda.arch")
if (!is.null(arch))
return(arch)
# miniconda url use x86_64 not x86-64 for Windows
if (info$machine == "x86-64")
return("x86_64")
# otherwise, use arch as-is
info$machine
}
miniconda_installer_download <- function(url) {
# reuse an already-existing installer
installer <- file.path(tempdir(), basename(url))
if (file.exists(installer))
return(installer)
# doesn't exist; try to download it
messagef("* Downloading %s ...", shQuote(url))
status <- download.file(url, destfile = installer, mode = "wb")
if (!file.exists(installer)) {
fmt <- "download of Miniconda installer failed [status = %i]"
stopf(fmt, status)
}
# download successful; provide file path
installer
}
miniconda_installer_run <- function(installer, update, path) {
args <- if (is_windows()) {
if(dir.exists(path))
unlink(path, recursive = TRUE)
c(
"/InstallationType=JustMe",
"/AddToPath=0",
"/RegisterPython=0",
"/NoRegistry=1",
"/S",
paste("/D", utils::shortPathName(path), sep = "=")
)
} else if (is_unix()) {
c("-b", if (update) "-u", "-p", shQuote(path))
} else {
stopf("unsupported platform %s", shQuote(Sys.info()[["sysname"]]))
}
Sys.chmod(installer, mode = "0755")
# work around rpath issues on macOS
#
# dyld: Library not loaded: @rpath/libz.1.dylib
# Referenced from: /Users/kevinushey/Library/r-miniconda/conda.exe
# Reason: image not found
#
# https://github.com/rstudio/reticulate/issues/874
if (is_osx()) {
old <- Sys.getenv("DYLD_FALLBACK_LIBRARY_PATH")
new <- if (nzchar(old))
paste(old, "/usr/lib", sep = ":")
else
"/usr/lib"
Sys.setenv(DYLD_FALLBACK_LIBRARY_PATH = new)
on.exit(Sys.setenv(DYLD_FALLBACK_LIBRARY_PATH = old), add = TRUE)
}
if (is_windows()) {
installer <- normalizePath(installer)
status <- system2t(installer, args)
}
if (is_unix()) {
##check for bash
bash_path <- Sys.which("bash")
if (bash_path[1] == "")
stopf("The miniconda installer requires bash.")
status <- system2t(bash_path[1], c(installer, args))
}
if (status != 0)
stopf("miniconda installation failed [exit code %i]", status)
invisible(path)
}
#' Path to Miniconda
#'
#' The path to the Miniconda installation to use. By default, an OS-specific
#' path is used. If you'd like to instead set your own path, you can set the
#' `RETICULATE_MINICONDA_PATH` environment variable.
#'
#' @family miniconda
#'
#' @export
miniconda_path <- function() {
Sys.getenv("RETICULATE_MINICONDA_PATH", unset = miniconda_path_default())
}
miniconda_path_default <- function() {
if (is_osx()) {
# on macOS, use different path for arm64 miniconda
path <- if (Sys.info()[["machine"]] == "arm64")
"~/Library/r-miniconda-arm64"
else
"~/Library/r-miniconda"
return(path.expand(path))
}
# otherwise, use rappdirs default
root <- normalizePath(user_data_dir(), winslash = "/", mustWork = FALSE)
file.path(root, "r-miniconda")
}
miniconda_exists <- function(path = miniconda_path()) {
conda <- miniconda_conda(path)
file.exists(conda)
}
miniconda_test <- function(path = miniconda_path()) {
python <- python_binary_path(path)
status <- tryCatch(python_version(python), error = identity)
!inherits(status, "error")
}
miniconda_conda <- function(path = miniconda_path()) {
exe <- if (is_windows()) "condabin/conda.bat" else "bin/conda"
file.path(path, exe)
}
miniconda_envpath <- function(env = NULL, path = miniconda_path()) {
env <- env %||% Sys.getenv("RETICULATE_MINICONDA_ENVNAME", unset = "r-reticulate")
if(env == 'base')
return(path)
file.path(path, "envs", env)
}
miniconda_meta_path <- function() {
root <- user_data_dir("r-reticulate")
file.path(root, "miniconda.json")
}
miniconda_meta_read <- function() {
path <- miniconda_meta_path()
if (!file.exists(path))
return(list())
json <- tryCatch(
jsonlite::read_json(path),
error = warning
)
if (is.list(json))
return(json)
list()
}
miniconda_meta_write <- function(data) {
path <- miniconda_meta_path()
dir.create(dirname(path), recursive = TRUE)
json <- jsonlite::toJSON(data, auto_unbox = TRUE, pretty = TRUE)
writeLines(json, con = path)
}
miniconda_installable <- function() {
meta <- miniconda_meta_read()
!identical(meta$DisableInstallationPrompt, TRUE)
}
miniconda_install_prompt <- function() {
if (!is_interactive())
return(FALSE)
text <- paste(
"No non-system installation of Python could be found.",
"Would you like to download and install Miniconda?",
"Miniconda is an open source environment management system for Python.",
"See https://docs.conda.io/en/latest/miniconda.html for more details.",
"",
sep = "\n"
)
message(text)
response <- readline("Would you like to install Miniconda? [Y/n]: ")
repeat {
ch <- tolower(substring(response, 1, 1))
if (ch == "y" || ch == "") {
install_miniconda()
return(TRUE)
}
if (ch == "n") {
meta <- miniconda_meta_read()
meta$DisableInstallationPrompt <- TRUE
miniconda_meta_write(meta)
message("Installation aborted.")
return(FALSE)
}
response <- readline("Please answer yes or no: ")
}
}
# the default environment path to use for miniconda
miniconda_python_envpath <- function() {
Sys.getenv(
"RETICULATE_MINICONDA_PYTHON_ENVPATH",
unset = miniconda_envpath()
)
}
# the version of python to use in the environment
miniconda_python_version <- function() {
Sys.getenv("RETICULATE_MINICONDA_PYTHON_VERSION", unset = "3.10")
}
miniconda_python_package <- function() {
paste("python", miniconda_python_version(), sep = "=")
}
miniconda_enabled <- function() {
enabled <- Sys.getenv("RETICULATE_MINICONDA_ENABLED", unset = "TRUE")
if (tolower(enabled) %in% c("false", "0"))
return(FALSE)
miniconda_installable()
}
|