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
|
// Copyright 2015 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.bazel.rules.python;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration.Fragment;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration.LabelConverter;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.ConfigurationEnvironment;
import com.google.devtools.build.lib.analysis.config.ConfigurationFragmentFactory;
import com.google.devtools.build.lib.analysis.config.FragmentOptions;
import com.google.devtools.build.lib.analysis.config.InvalidConfigurationException;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import com.google.devtools.build.lib.util.OS;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.common.options.Converter;
import com.google.devtools.common.options.Option;
import com.google.devtools.common.options.OptionDocumentationCategory;
import com.google.devtools.common.options.OptionEffectTag;
import com.google.devtools.common.options.OptionMetadataTag;
/** Bazel-specific Python configuration. */
@AutoCodec
@Immutable
public class BazelPythonConfiguration extends BuildConfiguration.Fragment {
/**
* A path converter for python3 path
*/
public static class Python3PathConverter implements Converter<String> {
@Override
public String convert(String input) {
if (input.equals("auto")) {
return OS.getCurrent() == OS.WINDOWS ? "python" : "python3";
}
return input;
}
@Override
public String getTypeDescription() {
return "An option for python3 path";
}
}
/** Bazel-specific Python configuration options. */
@AutoCodec(strategy = AutoCodec.Strategy.PUBLIC_FIELDS)
public static final class Options extends FragmentOptions {
@Option(
name = "python2_path",
defaultValue = "python",
category = "version",
documentationCategory = OptionDocumentationCategory.TOOLCHAIN,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = { OptionMetadataTag.DEPRECATED },
help = "Local path to the Python2 executable. "
+ "Deprecated, please use python_path or python_top instead."
)
public String python2Path;
@Option(
name = "python3_path",
converter = Python3PathConverter.class,
defaultValue = "auto",
category = "version",
documentationCategory = OptionDocumentationCategory.TOOLCHAIN,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = { OptionMetadataTag.DEPRECATED },
help = "Local path to the Python3 executable. "
+ "Deprecated, please use python_path or python_top instead."
)
public String python3Path;
@Option(
name = "python_top",
converter = LabelConverter.class,
defaultValue = "null",
category = "version",
documentationCategory = OptionDocumentationCategory.TOOLCHAIN,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS},
help =
"The label of py_runtime rule used for the Python interpreter invoked by Bazel."
)
public Label pythonTop;
@Option(
name = "python_path",
defaultValue = "python",
category = "version",
documentationCategory = OptionDocumentationCategory.TOOLCHAIN,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS},
help =
"The absolute path of the Python interpreter invoked by Bazel."
)
public String pythonPath;
@Option(
name = "experimental_python_import_all_repositories",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
help = "Do not use."
)
public boolean experimentalPythonImportAllRepositories;
/**
* Make Python configuration options available for host configurations as well
*/
@Override
public FragmentOptions getHost() {
return clone(); // host options are the same as target options
}
}
/**
* Loader for the Bazel-specific Python configuration.
*/
public static final class Loader implements ConfigurationFragmentFactory {
@Override
public Fragment create(ConfigurationEnvironment env, BuildOptions buildOptions)
throws InvalidConfigurationException {
BazelPythonConfiguration pythonConfiguration
= new BazelPythonConfiguration(buildOptions.get(Options.class));
String pythonPath = pythonConfiguration.getPythonPath();
if (!pythonPath.startsWith("python") && !PathFragment.create(pythonPath).isAbsolute()) {
throw new InvalidConfigurationException(
"python_path must be an absolute path when it is set.");
}
return pythonConfiguration;
}
@Override
public Class<? extends Fragment> creates() {
return BazelPythonConfiguration.class;
}
@Override
public ImmutableSet<Class<? extends FragmentOptions>> requiredOptions() {
return ImmutableSet.<Class<? extends FragmentOptions>>of(Options.class);
}
}
private final Options options;
@AutoCodec.Instantiator
BazelPythonConfiguration(Options options) {
this.options = options;
}
public String getPython2Path() {
return options.python2Path;
}
public String getPython3Path() {
return options.python3Path;
}
public Label getPythonTop() {
return options.pythonTop;
}
public String getPythonPath() {
return options.pythonPath;
}
public boolean getImportAllRepositories() {
return options.experimentalPythonImportAllRepositories;
}
}
|
