File: py_discover_config.Rd

package info (click to toggle)
r-cran-reticulate 1.41.0.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,088 kB
  • sloc: cpp: 5,154; python: 620; sh: 13; makefile: 2
file content (27 lines) | stat: -rw-r--r-- 897 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/config.R
\name{py_discover_config}
\alias{py_discover_config}
\title{Discover the version of Python to use with reticulate.}
\usage{
py_discover_config(required_module = NULL, use_environment = NULL)
}
\arguments{
\item{required_module}{A optional module name that will be used to select the
Python environment used.}

\item{use_environment}{An optional virtual/conda environment name to prefer
in the search.}
}
\value{
Python configuration object.
}
\description{
This function enables callers to check which versions of Python will be
discovered on a system as well as which one will be chosen for use with
reticulate.
}
\details{
The order of discovery is documented in \code{vignette("versions")}, also available online
\href{https://rstudio.github.io/reticulate/articles/versions.html#order-of-discovery}{here}
}