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
|
package config
import (
"path"
"sort"
"gerrit.wikimedia.org/r/blubber/build"
)
// PythonLibPrefix is the path to installed dependency wheels.
//
const PythonLibPrefix = LocalLibPrefix + "/python"
// PythonSitePackages is the path to installed Python packages.
//
const PythonSitePackages = PythonLibPrefix + "/site-packages"
// PythonSiteBin is the path to installed Python packages bin files.
//
const PythonSiteBin = PythonSitePackages + "/bin"
// PythonConfig holds configuration fields related to pre-installation of project
// dependencies via PIP.
//
type PythonConfig struct {
Version string `yaml:"version"` // Python binary to use when installing dependencies
Requirements []string `yaml:"requirements"` // install requirements from given files
}
// Merge takes another PythonConfig and merges its fields into this one's,
// overwriting both the dependencies flag and requirements.
//
func (pc *PythonConfig) Merge(pc2 PythonConfig) {
if pc2.Version != "" {
pc.Version = pc2.Version
}
if pc2.Requirements != nil {
pc.Requirements = pc2.Requirements
}
}
// InstructionsForPhase injects instructions into the build related to Python
// dependency installation.
//
// PhasePrivileged
//
// Ensures that the newest versions of setuptools, wheel, tox, and pip are
// installed.
//
// PhasePreInstall
//
// Sets up Python wheels under the shared library directory (/opt/lib/python)
// for dependencies found in the declared requirements files. Installing
// dependencies during the build.PhasePreInstall phase allows a compiler
// implementation (e.g. Docker) to produce cache-efficient output so only
// changes to the given requirements files will invalidate these steps of the
// image build.
//
// Injects build.Env instructions for PIP_WHEEL_DIR and PIP_FIND_LINKS that
// will cause future executions of `pip install` (and by extension, `tox`) to
// consider packages from the shared library directory first.
//
// PhasePostInstall
//
// Injects a build.Env instruction for PIP_NO_INDEX that will cause future
// executions of `pip install` and `tox` to consider _only_ packages from the
// shared library directory, helping to speed up image builds by reducing
// network requests from said commands.
//
func (pc PythonConfig) InstructionsForPhase(phase build.Phase) []build.Instruction {
if pc.Version != "" {
switch phase {
case build.PhasePrivileged:
if pc.Requirements != nil {
return []build.Instruction{
build.RunAll{[]build.Run{
{pc.version(), []string{"-m", "easy_install", "pip"}},
{pc.version(), []string{"-m", "pip", "install", "-U", "setuptools", "wheel", "tox"}},
}},
}
}
case build.PhasePreInstall:
if pc.Requirements != nil {
envs := build.Env{map[string]string{
"PIP_WHEEL_DIR": PythonLibPrefix,
"PIP_FIND_LINKS": "file://" + PythonLibPrefix,
}}
mkdirs := build.RunAll{
Runs: []build.Run{
build.CreateDirectory(PythonLibPrefix),
},
}
dirs, bydir := pc.RequirementsByDir()
copies := make([]build.Instruction, len(dirs))
// make project subdirectories for requirements files if necessary, and
// copy in requirements files
for i, dir := range dirs {
if dir != "./" {
mkdirs.Runs = append(mkdirs.Runs, build.CreateDirectory(dir))
}
copies[i] = build.Copy{bydir[dir], dir}
}
ins := []build.Instruction{envs, mkdirs}
ins = append(ins, copies...)
if args := pc.RequirementsArgs(); len(args) > 0 {
ins = append(ins, build.RunAll{[]build.Run{
{pc.version(), append([]string{"-m", "pip", "wheel"}, args...)},
{pc.version(), append([]string{"-m", "pip", "install", "--target", PythonSitePackages}, args...)},
}})
}
return ins
}
case build.PhasePostInstall:
env := build.Env{map[string]string{
"PYTHONPATH": PythonSitePackages,
"PATH": PythonSiteBin + ":${PATH}",
}}
if pc.Requirements != nil {
env.Definitions["PIP_NO_INDEX"] = "1"
}
return []build.Instruction{env}
}
}
return []build.Instruction{}
}
// RequirementsArgs returns the configured requirements as pip `-r` arguments.
//
func (pc PythonConfig) RequirementsArgs() []string {
args := make([]string, len(pc.Requirements)*2)
for i, req := range pc.Requirements {
args[i*2] = "-r"
args[(i*2)+1] = req
}
return args
}
// RequirementsByDir returns both the configured requirements files indexed by
// parent directory and a sorted slice of those parent directories. The latter
// is useful in ensuring deterministic iteration since the ordering of map
// keys is not guaranteed.
//
func (pc PythonConfig) RequirementsByDir() ([]string, map[string][]string) {
bydir := make(map[string][]string)
for _, reqpath := range pc.Requirements {
dir := path.Dir(reqpath) + "/"
reqpath = path.Clean(reqpath)
if reqs, found := bydir[dir]; found {
bydir[dir] = append(reqs, reqpath)
} else {
bydir[dir] = []string{reqpath}
}
}
dirs := make([]string, len(bydir))
i := 0
for dir := range bydir {
dirs[i] = dir
i++
}
sort.Strings(dirs)
return dirs, bydir
}
func (pc PythonConfig) version() string {
if pc.Version == "" {
return "python"
}
return pc.Version
}
|
