91867b915b1a38d316fbd16b70d5ea93751047d0
[idea/community.git] / python / src / com / jetbrains / python / PythonHelper.java
1 /*
2  * Copyright 2000-2015 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.jetbrains.python;
17
18 import com.google.common.collect.Lists;
19 import com.intellij.execution.configurations.GeneralCommandLine;
20 import com.intellij.execution.configurations.ParamsGroup;
21 import com.intellij.openapi.projectRoots.Sdk;
22 import com.intellij.openapi.util.io.FileUtil;
23 import com.jetbrains.python.psi.LanguageLevel;
24 import com.jetbrains.python.sdk.PythonEnvUtil;
25 import com.jetbrains.python.sdk.PythonSdkType;
26 import org.jetbrains.annotations.NotNull;
27
28 import java.io.File;
29 import java.util.List;
30 import java.util.Map;
31
32 import static com.jetbrains.python.PythonHelpersLocator.getHelperFile;
33 import static com.jetbrains.python.PythonHelpersLocator.getHelpersRoot;
34
35 /**
36  * @author traff
37  */
38 public enum PythonHelper implements HelperPackage {
39   COVERAGEPY("coveragepy", ""),
40   COVERAGE("coverage_runner", "run_coverage"),
41   DEBUGGER("pydev", "pydevd"),
42   
43   ATTACH_DEBUGGER("pydev/pydevd_attach_to_process/attach_pydevd.py"),
44
45   CONSOLE("pydev", "pydevconsole"),
46   RUN_IN_CONSOLE("pydev", "pydev_run_in_console"),
47   PROFILER("profiler", "run_profiler"),
48
49   LOAD_ENTRY_POINT("pycharm", "pycharm_load_entry_point"),
50
51   // Test runners
52   UT("pycharm", "utrunner"),
53   TOX("pycharm", "_jb_tox_runner"),
54   SETUPPY("pycharm", "pycharm_setup_runner"),
55   NOSE("pycharm", "noserunner"),
56   PYTEST("pycharm", "pytestrunner"),
57   ATTEST("pycharm", "attestrunner"),
58   DOCSTRING("pycharm", "docrunner"),
59
60   BEHAVE("pycharm", "behave_runner"),
61   LETTUCE("pycharm", "lettuce_runner"),
62
63   DJANGO_TEST_MANAGE("pycharm", "django_test_manage"),
64   DJANGO_MANAGE("pycharm", "django_manage"),
65   MANAGE_TASKS_PROVIDER("pycharm", "_jb_manage_tasks_provider"),
66
67   APPCFG_CONSOLE("pycharm", "appcfg_fetcher"),
68
69   BUILDOUT_ENGULFER("pycharm", "buildout_engulfer"),
70
71   EPYDOC_FORMATTER("epydoc_formatter.py"),
72   REST_FORMATTER("rest_formatter.py"),
73   GOOGLE_FORMATTER("google_formatter.py"),
74   NUMPY_FORMATTER("numpy_formatter.py"),
75
76   EXTRA_SYSPATH("extra_syspath.py"),
77   SYSPATH("syspath.py"),
78
79   PYCODESTYLE("pycodestyle.py"),
80
81   REST_RUNNER("rest_runners/rst2smth.py"),
82
83   SPHINX_RUNNER("rest_runners/sphinx_runner.py");
84
85   public static final String PY3_HELPER_DEPENDENCIES_DIR = "py3only";
86   public static final String PY2_HELPER_DEPENDENCIES_DIR = "py2only";
87
88   @NotNull
89   private static PathHelperPackage findModule(String moduleEntryPoint, String path, boolean asModule) {
90     if (getHelperFile(path + ".zip").isFile()) {
91       return new ModuleHelperPackage(moduleEntryPoint, path + ".zip");
92     }
93
94     if (!asModule && new File(getHelperFile(path), moduleEntryPoint + ".py").isFile()) {
95       return new ScriptPythonHelper(moduleEntryPoint + ".py", getHelperFile(path));
96     }
97
98     return new ModuleHelperPackage(moduleEntryPoint, path);
99   }
100
101   private final PathHelperPackage myModule;
102
103   PythonHelper(String pythonPath, String moduleName) {
104     this(pythonPath, moduleName, false);
105   }
106
107   PythonHelper(String pythonPath, String moduleName, boolean asModule) {
108     myModule = findModule(moduleName, pythonPath, asModule);
109   }
110
111   PythonHelper(String helperScript) {
112     myModule = new ScriptPythonHelper(helperScript, getHelpersRoot());
113   }
114
115   public abstract static class PathHelperPackage implements HelperPackage {
116     protected final File myPath;
117
118     PathHelperPackage(String path) {
119       myPath = new File(path);
120     }
121
122     @Override
123     public void addToPythonPath(@NotNull Map<String, String> environment) {
124       PythonEnvUtil.addToPythonPath(environment, getPythonPathEntry());
125     }
126
127     @Override
128     public void addToGroup(@NotNull ParamsGroup group, @NotNull GeneralCommandLine cmd) {
129       addToPythonPath(cmd.getEnvironment());
130       group.addParameter(asParamString());
131     }
132
133     @NotNull
134     @Override
135     public String asParamString() {
136       return FileUtil.toSystemDependentName(myPath.getAbsolutePath());
137     }
138
139     @NotNull
140     @Override
141     public GeneralCommandLine newCommandLine(@NotNull String sdkPath, @NotNull List<String> parameters) {
142       final List<String> args = Lists.newArrayList();
143       args.add(sdkPath);
144       args.add(asParamString());
145       args.addAll(parameters);
146       final GeneralCommandLine cmd = new GeneralCommandLine(args);
147       final Map<String, String> env = cmd.getEnvironment();
148       addToPythonPath(env);
149       PythonEnvUtil.resetHomePathChanges(sdkPath, env);
150       return cmd;
151     }
152
153     @NotNull
154     @Override
155     public GeneralCommandLine newCommandLine(@NotNull Sdk pythonSdk, @NotNull List<String> parameters) {
156       final String sdkHomePath = pythonSdk.getHomePath();
157       assert sdkHomePath != null;
158       final GeneralCommandLine cmd = newCommandLine(sdkHomePath, parameters);
159       final LanguageLevel version = PythonSdkType.getLanguageLevelForSdk(pythonSdk);
160       final String perVersionDependenciesDir = version.isPy3K() ? PY3_HELPER_DEPENDENCIES_DIR : PY2_HELPER_DEPENDENCIES_DIR;
161       PythonEnvUtil.addToPythonPath(cmd.getEnvironment(), FileUtil.join(getPythonPathEntry(), perVersionDependenciesDir));
162       return cmd;
163     }
164   }
165
166   /**
167    * Module Python helper can be executed from zip-archive
168    */
169   public static class ModuleHelperPackage extends PathHelperPackage {
170     private final String myModuleName;
171
172     public ModuleHelperPackage(String moduleName, String relativePath) {
173       super(getHelperFile(relativePath).getAbsolutePath());
174       this.myModuleName = moduleName;
175     }
176
177     @NotNull
178     @Override
179     public String asParamString() {
180       return "-m" + myModuleName;
181     }
182
183     @NotNull
184     @Override
185     public String getPythonPathEntry() {
186       return FileUtil.toSystemDependentName(myPath.getAbsolutePath());
187     }
188   }
189
190   /**
191    * Script Python helper can be executed as a Python script, therefore
192    * PYTHONDONTWRITEBYTECODE option is set not to spoil installation
193    * with .pyc files
194    */
195   public static class ScriptPythonHelper extends PathHelperPackage {
196     private final String myPythonPath;
197
198     public ScriptPythonHelper(String script, File pythonPath) {
199       super(new File(pythonPath, script).getAbsolutePath());
200       myPythonPath = pythonPath.getAbsolutePath();
201     }
202
203     @Override
204     public void addToPythonPath(@NotNull Map<String, String> environment) {
205       PythonEnvUtil.setPythonDontWriteBytecode(environment);
206       super.addToPythonPath(environment);
207     }
208
209     @NotNull
210     @Override
211     public String getPythonPathEntry() {
212       return myPythonPath;
213     }
214   }
215
216   
217   @NotNull
218   @Override
219   public String getPythonPathEntry() {
220     return myModule.getPythonPathEntry();
221   }
222
223   @Override
224   public void addToPythonPath(@NotNull Map<String, String> environment) {
225     myModule.addToPythonPath(environment);
226   }
227
228   @Override
229   public void addToGroup(@NotNull ParamsGroup group, @NotNull GeneralCommandLine cmd) {
230     myModule.addToGroup(group, cmd);
231   }
232
233   @NotNull
234   @Override
235   public String asParamString() {
236     return myModule.asParamString();
237   }
238
239   @NotNull
240   @Override
241   public GeneralCommandLine newCommandLine(@NotNull String sdkPath, @NotNull List<String> parameters) {
242     return myModule.newCommandLine(sdkPath, parameters);
243   }
244
245   @NotNull
246   @Override
247   public GeneralCommandLine newCommandLine(@NotNull Sdk pythonSdk, @NotNull List<String> parameters) {
248     return myModule.newCommandLine(pythonSdk, parameters);
249   }
250
251 }