Merge.
[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.util.io.FileUtil;
22 import com.jetbrains.python.sdk.PythonEnvUtil;
23 import org.jetbrains.annotations.NotNull;
24
25 import java.io.File;
26 import java.util.List;
27 import java.util.Map;
28
29 import static com.jetbrains.python.PythonHelpersLocator.getHelperFile;
30 import static com.jetbrains.python.PythonHelpersLocator.getHelpersRoot;
31
32 /**
33  * @author traff
34  */
35 public enum PythonHelper implements HelperPackage {
36   COVERAGEPY("coveragepy", ""), COVERAGE("coverage_runner", "run_coverage"),
37   DEBUGGER("pydev", "pydevd"),
38   ATTACH_DEBUGGER("pydev", "pydevd_attach_to_process.attach_pydevd"),
39
40   CONSOLE("pydev", "pydevconsole"),
41   RUN_IN_CONSOLE("pydev", "pydev_run_in_console"),
42   PROFILER("profiler", "run_profiler"),
43
44   LOAD_ENTRY_POINT("pycharm", "pycharm_load_entry_point"),
45
46   // Test runners
47   UT("pycharm", "utrunner"),
48   SETUPPY("pycharm", "pycharm_setup_runner"),
49   NOSE("pycharm", "noserunner"),
50   PYTEST("pycharm", "pytestrunner"),
51   ATTEST("pycharm", "attestrunner"),
52   DOCSTRING("pycharm", "docrunner"),
53
54   BEHAVE("pycharm", "behave_runner"),
55   LETTUCE("pycharm", "lettuce_runner"),
56
57   DJANGO_TEST_MANAGE("pycharm", "django_test_manage"),
58   DJANGO_MANAGE("pycharm", "django_manage"),
59   MANAGE_TASKS_PROVIDER("pycharm", "_jb_manage_tasks_provider"),
60
61   BUILDOUT_ENGULFER("pycharm", "buildout_engulfer"),
62
63   EPYDOC_FORMATTER("epydoc_formatter.py"),
64   REST_FORMATTER("rest_formatter.py"),
65
66   EXTRA_SYSPATH("extra_syspath.py"),
67   SYSPATH("syspath.py"),
68
69   PEP8("pep8.py"),
70
71   REST_RUNNER("rest_runners/rst2smth.py"),
72
73   SPHINX_RUNNER("rest_runners/sphinx_runner.py");
74
75   @NotNull
76   private static PathHelperPackage findModule(String moduleEntryPoint, String path, boolean asModule) {
77     if (getHelperFile(path + ".zip").isFile()) {
78       return new ModuleHelperPackage(moduleEntryPoint, path + ".zip");
79     }
80
81     if (!asModule && new File(getHelperFile(path), moduleEntryPoint + ".py").isFile()) {
82       return new ScriptPythonHelper(moduleEntryPoint + ".py", getHelperFile(path));
83     }
84
85     return new ModuleHelperPackage(moduleEntryPoint, path);
86   }
87
88   private PathHelperPackage myModule;
89
90   PythonHelper(String pythonPath, String moduleName) {
91     this(pythonPath, moduleName, false);
92   }
93
94   PythonHelper(String pythonPath, String moduleName, boolean asModule) {
95     myModule = findModule(moduleName, pythonPath, asModule);
96   }
97
98   PythonHelper(String helperScript) {
99     myModule = new ScriptPythonHelper(helperScript, getHelpersRoot());
100   }
101
102
103   public String getPythonPath() {
104     return myModule.getPythonPath();
105   }
106
107   public abstract static class PathHelperPackage implements HelperPackage {
108     protected final File myPath;
109
110     PathHelperPackage(String path) {
111       myPath = new File(path);
112     }
113
114     @Override
115     public void addToPythonPath(@NotNull Map<String, String> environment) {
116       PythonEnvUtil.addToPythonPath(environment, myPath.getAbsolutePath());
117     }
118
119     @Override
120     public void addToGroup(@NotNull ParamsGroup group, @NotNull GeneralCommandLine cmd) {
121       addToPythonPath(cmd.getEnvironment());
122       group.addParameter(asParamString());
123     }
124
125     @Override
126     public String asParamString() {
127       return FileUtil.toSystemDependentName(myPath.getAbsolutePath());
128     }
129
130     @Override
131     public GeneralCommandLine newCommandLine(String sdkPath, List<String> parameters) {
132       List<String> args = Lists.newArrayList();
133       args.add(sdkPath);
134       args.add(asParamString());
135       args.addAll(parameters);
136       GeneralCommandLine cmd = new GeneralCommandLine(args);
137       addToPythonPath(cmd.getEnvironment());
138       return cmd;
139     }
140   }
141
142   /**
143    * Module Python helper can be executed from zip-archive
144    */
145   public static class ModuleHelperPackage extends PathHelperPackage {
146     private final String myModuleName;
147
148     public ModuleHelperPackage(String moduleName, String relativePath) {
149       super(getHelperFile(relativePath).getAbsolutePath());
150       this.myModuleName = moduleName;
151     }
152
153     @Override
154     public String asParamString() {
155       return "-m" + myModuleName;
156     }
157
158     @Override
159     public String getPythonPath() {
160       return FileUtil.toSystemDependentName(myPath.getAbsolutePath());
161     }
162   }
163
164   /**
165    * Script Python helper can be executed as a Python script, therefore
166    * PYTHONDONTWRITEBYTECODE option is set not to spoil installation
167    * with .pyc files
168    */
169   public static class ScriptPythonHelper extends PathHelperPackage {
170     private String myPythonPath;
171
172     public ScriptPythonHelper(String script, File pythonPath) {
173       super(new File(pythonPath, script).getAbsolutePath());
174       myPythonPath = pythonPath.getAbsolutePath();
175     }
176
177     @Override
178     public void addToPythonPath(@NotNull Map<String, String> environment) {
179       PythonEnvUtil.setPythonDontWriteBytecode(environment);
180       PythonEnvUtil.addToPythonPath(environment, myPythonPath);
181     }
182
183     @Override
184     public String getPythonPath() {
185       return myPythonPath;
186     }
187   }
188
189
190   @Override
191   public void addToPythonPath(@NotNull Map<String, String> environment) {
192     myModule.addToPythonPath(environment);
193   }
194
195   @Override
196   public void addToGroup(@NotNull ParamsGroup group, @NotNull GeneralCommandLine cmd) {
197     myModule.addToGroup(group, cmd);
198   }
199
200
201   @Override
202   public String asParamString() {
203     return myModule.asParamString();
204   }
205
206   @Override
207   public GeneralCommandLine newCommandLine(String sdkPath, List<String> parameters) {
208     return myModule.newCommandLine(sdkPath, parameters);
209   }
210
211 }