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
|
// Copyright 2014 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.rules.python;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Root;
import com.google.devtools.build.lib.analysis.FilesToRunProvider;
import com.google.devtools.build.lib.analysis.RuleConfiguredTarget;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.Runfiles;
import com.google.devtools.build.lib.analysis.actions.SpawnAction;
import com.google.devtools.build.lib.util.FileType;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Various utility methods for Python support.
*/
public final class PythonUtils {
public static final PathFragment INIT_PY = new PathFragment("__init__.py");
private static final FileType REQUIRES_INIT_PY = FileType.of(".py", ".so", ".pyc");
public static final Runfiles.EmptyFilesSupplier GET_INIT_PY_FILES =
new Runfiles.EmptyFilesSupplier() {
@Override
public Iterable<PathFragment> getExtraPaths(Set<PathFragment> manifestPaths) {
return getInitPyFiles(manifestPaths);
}
};
private PythonUtils() {
// This is a utility class, not to be instantiated
}
/**
* Returns the set of empty __init__.py files to be added to a given set of files to allow
* the Python runtime to find the <code>.py</code> and <code>.so</code> files present in the
* tree.
*/
public static Set<PathFragment> getInitPyFiles(Set<PathFragment> manifestFiles) {
Set<PathFragment> result = new HashSet<>();
for (PathFragment source : manifestFiles) {
// If we have a python or .so file at this level...
if (REQUIRES_INIT_PY.matches(source)) {
// ...then record that we need an __init__.py in this directory...
while (source.segmentCount() > 1) {
source = source.getParentDirectory();
PathFragment initpy = source.getRelative(INIT_PY);
if (!manifestFiles.contains(initpy)) {
result.add(initpy);
}
}
}
}
return ImmutableSet.copyOf(result);
}
/**
* Get the artifact generated by the 2to3 action. The artifact is in a python3
* subdirectory to avoid conflicts (eg. when the input file is generated).
*/
private static Artifact get2to3OutputArtifact(RuleContext ruleContext, Artifact input) {
Root root = ruleContext.getConfiguration().getGenfilesDirectory();
PathFragment path = new PathFragment("python3").getRelative(input.getRootRelativePath());
return ruleContext.getShareableArtifact(path, root);
}
/**
* Create an action for each Python 2 file to convert to Python 3
*/
public static Map<PathFragment, Artifact> generate2to3Actions(RuleContext ruleContext,
Iterable<Artifact> inputs) {
// This creates many actions, but this is fine. Creating one action per library leads
// to some problems (when the same file is generated by two different actions), with
// little benefits and negligible memory improvement.
Map<PathFragment, Artifact> symlinks = new HashMap<>();
for (Artifact input : inputs) {
Artifact output = generate2to3Action(ruleContext, input);
symlinks.put(input.getRootRelativePath(), output);
}
return symlinks;
}
private static Artifact generate2to3Action(RuleContext ruleContext, Artifact input) {
FilesToRunProvider py2to3converter =
ruleContext.getExecutablePrerequisite("$python2to3", RuleConfiguredTarget.Mode.HOST);
Artifact output = get2to3OutputArtifact(ruleContext, input);
List<String> argv = new ArrayList<>();
argv.add("--no-diffs");
argv.add("--nobackups");
argv.add("--write");
argv.add("--output-dir");
argv.add(output.getExecPath().getParentDirectory().toString());
argv.add("--write-unchanged-files");
argv.add(input.getExecPathString());
ruleContext.registerAction(new SpawnAction.Builder()
.addInput(input)
.addOutput(output)
.setExecutable(py2to3converter)
.addArguments(argv)
.setProgressMessage("Converting to Python 3: " + input.prettyPrint())
.setMnemonic("2to3")
.build(ruleContext));
return output;
}
}
|
