Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
setup-python/src/find-python.ts at master · un0mic/setup-python · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
un0mic
setup-python
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
setup-python
/
src
/
find-python.ts
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
172 lines (149 loc) · 5.48 KB
master
Breadcrumbs
setup-python
/
src
/
find-python.ts
Copy path
Top
File metadata and controls
Code
Blame
172 lines (149 loc) · 5.48 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
import
*
as
os
from
'os'
;
import
*
as
path
from
'path'
;
import
*
as
semver
from
'semver'
;
let
cacheDirectory
=
process
.
env
[
'RUNNER_TOOLSDIRECTORY'
]
||
''
;
if
(
!
cacheDirectory
)
{
let
baseLocation
;
if
(
process
.
platform
===
'win32'
)
{
// On windows use the USERPROFILE env variable
baseLocation
=
process
.
env
[
'USERPROFILE'
]
||
'C:\\'
;
}
else
{
if
(
process
.
platform
===
'darwin'
)
{
baseLocation
=
'/Users'
;
}
else
{
baseLocation
=
'/home'
;
}
}
cacheDirectory
=
path
.
join
(
baseLocation
,
'actions'
,
'cache'
)
;
}
import
*
as
core
from
'@actions/core'
;
import
*
as
tc
from
'@actions/tool-cache'
;
const
IS_WINDOWS
=
process
.
platform
===
'win32'
;
// Python has "scripts" or "bin" directories where command-line tools that come with packages are installed.
// This is where pip is, along with anything that pip installs.
// There is a seperate directory for `pip install --user`.
//
// For reference, these directories are as follows:
// macOS / Linux:
// <sys.prefix>/bin (by default /usr/local/bin, but not on hosted agents -- see the `else`)
// (--user) ~/.local/bin
// Windows:
// <Python installation dir>\Scripts
// (--user) %APPDATA%\Python\PythonXY\Scripts
// See https://docs.python.org/3/library/sysconfig.html
function
binDir
(
installDir
:
string
)
:
string
{
if
(
IS_WINDOWS
)
{
return
path
.
join
(
installDir
,
'Scripts'
)
;
}
else
{
return
path
.
join
(
installDir
,
'bin'
)
;
}
}
// Note on the tool cache layout for PyPy:
// PyPy has its own versioning scheme that doesn't follow the Python versioning scheme.
// A particular version of PyPy may contain one or more versions of the Python interpreter.
// For example, PyPy 7.0 contains Python 2.7, 3.5, and 3.6-alpha.
// We only care about the Python version, so we don't use the PyPy version for the tool cache.
function
usePyPy
(
majorVersion
:
2
|
3
,
architecture
:
string
)
:
void
{
const
findPyPy
=
tc
.
find
.
bind
(
undefined
,
'PyPy'
,
majorVersion
.
toString
(
)
)
;
let
installDir
:
string
|
null
=
findPyPy
(
architecture
)
;
if
(
!
installDir
&&
IS_WINDOWS
)
{
// PyPy only precompiles binaries for x86, but the architecture parameter defaults to x64.
// On Hosted VS2017, we only install an x86 version.
// Fall back to x86.
installDir
=
findPyPy
(
'x86'
)
;
}
if
(
!
installDir
)
{
// PyPy not installed in $(Agent.ToolsDirectory)
throw
new
Error
(
`PyPy
${
majorVersion
}
not found`
)
;
}
// For PyPy, Windows uses 'bin', not 'Scripts'.
const
_binDir
=
path
.
join
(
installDir
,
'bin'
)
;
// On Linux and macOS, the Python interpreter is in 'bin'.
// On Windows, it is in the installation root.
const
pythonLocation
=
IS_WINDOWS
?
installDir
:
_binDir
;
core
.
exportVariable
(
'pythonLocation'
,
pythonLocation
)
;
core
.
addPath
(
installDir
)
;
core
.
addPath
(
_binDir
)
;
}
async
function
useCpythonVersion
(
version
:
string
,
architecture
:
string
)
:
Promise
<
void
>
{
const
desugaredVersionSpec
=
desugarDevVersion
(
version
)
;
const
semanticVersionSpec
=
pythonVersionToSemantic
(
desugaredVersionSpec
)
;
core
.
debug
(
`Semantic version spec of
${
version
}
is
${
semanticVersionSpec
}
`
)
;
const
installDir
:
string
|
null
=
tc
.
find
(
'Python'
,
semanticVersionSpec
,
architecture
)
;
if
(
!
installDir
)
{
// Fail and list available versions
const
x86Versions
=
tc
.
findAllVersions
(
'Python'
,
'x86'
)
.
map
(
s
=>
`
${
s
}
(x86)`
)
.
join
(
os
.
EOL
)
;
const
x64Versions
=
tc
.
findAllVersions
(
'Python'
,
'x64'
)
.
map
(
s
=>
`
${
s
}
(x64)`
)
.
join
(
os
.
EOL
)
;
throw
new
Error
(
[
`Version
${
version
}
with arch
${
architecture
}
not found`
,
'Available versions:'
,
x86Versions
,
x64Versions
]
.
join
(
os
.
EOL
)
)
;
}
core
.
exportVariable
(
'pythonLocation'
,
installDir
)
;
core
.
addPath
(
installDir
)
;
core
.
addPath
(
binDir
(
installDir
)
)
;
if
(
IS_WINDOWS
)
{
// Add --user directory
// `installDir` from tool cache should look like $AGENT_TOOLSDIRECTORY/Python/<semantic version>/x64/
// So if `findLocalTool` succeeded above, we must have a conformant `installDir`
const
version
=
path
.
basename
(
path
.
dirname
(
installDir
)
)
;
const
major
=
semver
.
major
(
version
)
;
const
minor
=
semver
.
minor
(
version
)
;
const
userScriptsDir
=
path
.
join
(
process
.
env
[
'APPDATA'
]
||
''
,
'Python'
,
`Python
${
major
}
${
minor
}
`
,
'Scripts'
)
;
core
.
addPath
(
userScriptsDir
)
;
}
// On Linux and macOS, pip will create the --user directory and add it to PATH as needed.
}
/** Convert versions like `3.8-dev` to a version like `>= 3.8.0-a0`. */
function
desugarDevVersion
(
versionSpec
:
string
)
{
if
(
versionSpec
.
endsWith
(
'-dev'
)
)
{
const
versionRoot
=
versionSpec
.
slice
(
0
,
-
'-dev'
.
length
)
;
return
`>=
${
versionRoot
}
.0-a0`
;
}
else
{
return
versionSpec
;
}
}
/**
* Python's prelease versions look like `3.7.0b2`.
* This is the one part of Python versioning that does not look like semantic versioning, which specifies `3.7.0-b2`.
* If the version spec contains prerelease versions, we need to convert them to the semantic version equivalent.
*/
export
function
pythonVersionToSemantic
(
versionSpec
:
string
)
{
const
prereleaseVersion
=
/
(
\d
+
\.
\d
+
\.
\d
+
)
(
(?:
a
|
b
|
r
c
)
\d
*
)
/
g
;
return
versionSpec
.
replace
(
prereleaseVersion
,
'$1-$2'
)
;
}
export
async
function
findPythonVersion
(
version
:
string
,
architecture
:
string
)
:
Promise
<
void
>
{
switch
(
version
.
toUpperCase
(
)
)
{
case
'PYPY2'
:
return
usePyPy
(
2
,
architecture
)
;
case
'PYPY3'
:
return
usePyPy
(
3
,
architecture
)
;
default
:
return
await
useCpythonVersion
(
version
,
architecture
)
;
}
}
You can’t perform that action at this time.