rebased/python/src/com/jetbrains/python/PythonHelper.java at master · DetachHead/rebased · GitHub

History

301 lines (241 loc) · 10.9 KB

Raw

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

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

package com.jetbrains.python;

import com.intellij.execution.configurations.GeneralCommandLine;

import com.intellij.execution.configurations.ParamsGroup;

import com.intellij.openapi.projectRoots.Sdk;

import com.intellij.openapi.util.io.FileUtil;

import com.intellij.util.containers.ContainerUtil;

import com.jetbrains.python.psi.LanguageLevel;

import com.jetbrains.python.sdk.PythonEnvUtil;

import com.jetbrains.python.sdk.PythonSdkType;

import org.jetbrains.annotations.NotNull;

import java.io.File;

import java.nio.file.Path;

import java.util.ArrayList;

import java.util.Collections;

import java.util.List;

import java.util.Map;

import java.util.stream.Collectors;

import static com.intellij.python.community.helpersLocator.PythonHelpersLocator.findPathInHelpers;

import static com.intellij.python.community.helpersLocator.PythonHelpersLocator.findPathInHelpersPossibleNull;

import static com.intellij.python.community.helpersLocator.PythonHelpersLocator.findPathStringInHelpers;

import static com.intellij.python.community.helpersLocator.PythonHelpersLocator.getCommunityHelpersRoot;

import static com.intellij.python.venv.VenvKt.LEGACY_VIRTUALENV_ZIPAPP_NAME;

import static com.intellij.python.venv.VenvKt.VIRTUALENV_ZIPAPP_NAME;

import static com.jetbrains.python.packaging.pip.PipPackageManagerEngine.PACKAGING_TOOL_NAME;

public enum PythonHelper implements HelperPackage {

GENERATOR3("generator3/__main__.py"),

REMOTE_SYNC("remote_sync.py"),

// Packaging tools

PACKAGING_TOOL(PACKAGING_TOOL_NAME),

VIRTUALENV_ZIPAPP(VIRTUALENV_ZIPAPP_NAME),

LEGACY_VIRTUALENV_ZIPAPP(LEGACY_VIRTUALENV_ZIPAPP_NAME), // virtualenv used to create virtual environments for python 2.7, 3.6, 3.7

COVERAGEPY_OLD("coveragepy_old", ""),

COVERAGEPY_NEW("coveragepy_new", ""),

COVERAGE("coverage_runner", "run_coverage"),

DEBUGGER("pydev", "pydevd", HelperDependency.THRIFTPY),

ATTACH_DEBUGGER("pydev/pydevd_attach_to_process/attach_pydevd.py"),

CONSOLE("pydev", "pydevconsole", HelperDependency.THRIFTPY),

PROFILER("profiler", "run_profiler", HelperDependency.THRIFTPY),

LOAD_PSTAT("profiler", "load_pstat", HelperDependency.THRIFTPY),

LOAD_ENTRY_POINT("pycharm", "pycharm_load_entry_point"),

// Test runners

UT_OLD("pycharm", "utrunner"),

TOX("pycharm", "_jb_tox_runner"),

SETUPPY("pycharm", "pycharm_setup_runner"),

NOSE_OLD("pycharm", "noserunner"),

PYTEST_OLD("pycharm", "pytestrunner"),

DOCSTRING("pycharm", "docrunner"),

// Runners for new test runner API.

UNITTEST("pycharm", "_jb_unittest_runner"),

PYTEST("pycharm", "_jb_pytest_runner"),

TRIAL("pycharm", "_jb_trialtest_runner"),

NOSE("pycharm", "_jb_nosetest_runner"),

BEHAVE("pycharm", "behave_runner"),

DJANGO_TEST_MANAGE("pycharm", "django_test_manage"),

DJANGO_MANAGE("pycharm", "django_manage"),

DJANGO_PROJECT_CREATOR("pycharm", "_jb_django_project_creator"),

MANAGE_TASKS_PROVIDER("pycharm", "_jb_manage_tasks_provider"),

APPCFG_CONSOLE("pycharm", "appcfg_fetcher"),

DOCSTRING_FORMATTER("docstring_formatter.py"),

EXTRA_SYSPATH("extra_syspath.py"),

SYSPATH("syspath.py"),

// Compatible with 3.8+

PYCODESTYLE("pycodestyle.py"),

// Compatible with 3.6+

PYCODESTYLE_2_10_0("pycodestyle-2.10.0.py"),

// Compatible with 2.7 and 3.5+

PYCODESTYLE_2_8_0("pycodestyle-2.8.0.py"),

REST_RUNNER("rest_runners/rst2smth.py"),

SPHINX_RUNNER("rest_runners/sphinx_runner.py"),

JUPYTER("pycharm", "jupyter");

public static final String PY3_HELPER_DEPENDENCIES_DIR = "py3only";

public static final String PY2_HELPER_DEPENDENCIES_DIR = "py2only";

private static @NotNull PathHelperPackage findModule(String moduleEntryPoint, String path, boolean asModule, String[] thirdPartyDependencies) {

List<HelperDependency> dependencies = HelperDependency.findThirdPartyDependencies(thirdPartyDependencies);

if (findPathInHelpersPossibleNull(path + ".zip") != null) {

return new ModuleHelperPackage(moduleEntryPoint, path + ".zip", dependencies);

}

Path pathInHelpers = findPathInHelpersPossibleNull(path);

if (!asModule && pathInHelpers != null && new File(pathInHelpers.toFile(), moduleEntryPoint + ".py").isFile()) {

return new ScriptPythonHelper(moduleEntryPoint + ".py", pathInHelpers.toFile(), dependencies);

}

return new ModuleHelperPackage(moduleEntryPoint, path, dependencies);

}

private final PathHelperPackage myModule;

PythonHelper(String pythonPath, String moduleName, String... dependencies) {

this(pythonPath, moduleName, false, dependencies);

}

PythonHelper(String pythonPath, String moduleName, boolean asModule, String... dependencies) {

myModule = findModule(moduleName, pythonPath, asModule, dependencies);

}

PythonHelper(String helperScript) {

myModule = new ScriptPythonHelper(helperScript, getCommunityHelpersRoot().toFile(), Collections.emptyList());

}

public abstract static class PathHelperPackage implements HelperPackage {

protected final File myPath;

protected final @NotNull List<HelperDependency> myDependencies;

PathHelperPackage(String path, @NotNull List<HelperDependency> dependencies) {

myPath = new File(path);

myDependencies = dependencies;

}

@Override

public void addToPythonPath(@NotNull Map<String, String> environment) {

// at first add dependencies

myDependencies.forEach(dependency -> dependency.addToPythonPath(environment));

// then add helper script

PythonEnvUtil.addToPythonPath(environment, getPythonPathEntry());

}

@Override

public @NotNull List<String> getPythonPathEntries() {

// at first add dependencies

ArrayList<String> entries = myDependencies.stream()

.flatMap(dependency -> dependency.getPythonPathEntries().stream())

.collect(Collectors.toCollection(ArrayList::new));

// then add helper script

entries.add(getPythonPathEntry());

return entries;

}

@Override

public void addToGroup(@NotNull ParamsGroup group, @NotNull GeneralCommandLine cmd) {

addToPythonPath(cmd.getEnvironment());

group.addParameter(asParamString());

}

@Override

public @NotNull String asParamString() {

return FileUtil.toSystemDependentName(myPath.getAbsolutePath());

}

@Override

public @NotNull GeneralCommandLine newCommandLine(@NotNull String sdkPath, @NotNull List<String> parameters) {

final List<String> args = new ArrayList<>();

args.add(sdkPath);

args.add(asParamString());

args.addAll(parameters);

final GeneralCommandLine cmd = new GeneralCommandLine(args);

final Map<String, String> env = cmd.getEnvironment();

addToPythonPath(env);

PythonEnvUtil.resetHomePathChanges(sdkPath, env);

return cmd;

}

@NotNull

private GeneralCommandLine newCommandLine(@NotNull Sdk pythonSdk, @NotNull List<String> parameters) {

final String sdkHomePath = pythonSdk.getHomePath();

assert sdkHomePath != null;

final GeneralCommandLine cmd = newCommandLine(sdkHomePath, parameters);

final LanguageLevel version = PythonSdkType.getLanguageLevelForSdk(pythonSdk);

final String perVersionDependenciesDir = version.isPython2() ? PY2_HELPER_DEPENDENCIES_DIR : PY3_HELPER_DEPENDENCIES_DIR;

PythonEnvUtil.addToPythonPath(cmd.getEnvironment(), FileUtil.join(getPythonPathEntry(), perVersionDependenciesDir));

return cmd;

}

/**

* Module Python helper can be executed from zip-archive

public static class ModuleHelperPackage extends PathHelperPackage {

private final String myModuleName;

public ModuleHelperPackage(String moduleName, String relativePath, @NotNull List<HelperDependency> dependencies) {

super(findPathStringInHelpers(relativePath), dependencies);

this.myModuleName = moduleName;

}

@Override

public @NotNull String asParamString() {

return "-m" + myModuleName;

}

@Override

public @NotNull String getPythonPathEntry() {

return FileUtil.toSystemDependentName(myPath.getAbsolutePath());

}

/**

* Script Python helper can be executed as a Python script, therefore

* PYTHONDONTWRITEBYTECODE option is set not to spoil installation

* with .pyc files

public static class ScriptPythonHelper extends PathHelperPackage {

private final String myPythonPath;

public ScriptPythonHelper(String script, File pythonPath, @NotNull List<HelperDependency> dependencies) {

super(new File(pythonPath, script).getAbsolutePath(), dependencies);

myPythonPath = pythonPath.getAbsolutePath();

}

@Override

public void addToPythonPath(@NotNull Map<String, String> environment) {

PythonEnvUtil.setPythonDontWriteBytecode(environment);

super.addToPythonPath(environment);

}

@Override

public @NotNull String getPythonPathEntry() {

return myPythonPath;

}

private static final class HelperDependency {

private static final String THRIFTPY = "thriftpy";

private final @NotNull String myPythonPath;

private HelperDependency(@NotNull String pythonPath) { myPythonPath = pythonPath; }

public void addToPythonPath(@NotNull Map<String, String> environment) {

PythonEnvUtil.addToPythonPath(environment, myPythonPath);

}

public @NotNull List<String> getPythonPathEntries() {

return Collections.singletonList(myPythonPath);

}

private static @NotNull List<HelperDependency> findThirdPartyDependencies(String... dependencies) {

if (dependencies == null) {

return Collections.emptyList();

}

return ContainerUtil.map(dependencies, s -> getThirdPartyDependency(s));

}

private static @NotNull HelperDependency getThirdPartyDependency(@NotNull String name) {

String path = new File(getHelpersThirdPartyDir(), name).getAbsolutePath();

return new HelperDependency(path);

}

private static @NotNull File getHelpersThirdPartyDir() {

return findPathInHelpers("third_party").toFile();

}

@Override

public @NotNull String getPythonPathEntry() {

return myModule.getPythonPathEntry();

}

@Override

public @NotNull List<String> getPythonPathEntries() {

return myModule.getPythonPathEntries();

}

@Override

public void addToPythonPath(@NotNull Map<String, String> environment) {

myModule.addToPythonPath(environment);

}

@Override

public void addToGroup(@NotNull ParamsGroup group, @NotNull GeneralCommandLine cmd) {

myModule.addToGroup(group, cmd);

}

@Override

public @NotNull String asParamString() {

return myModule.asParamString();

}

@Override

public @NotNull GeneralCommandLine newCommandLine(@NotNull String sdkPath, @NotNull List<String> parameters) {

return myModule.newCommandLine(sdkPath, parameters);

}

public @NotNull GeneralCommandLine newCommandLine(@NotNull Sdk pythonSdk, @NotNull List<String> parameters) {

return myModule.newCommandLine(pythonSdk, parameters);

}

rebased/python/src/com/jetbrains/python/PythonHelper.java at master · DetachHead/rebased · GitHub

Uh oh!

Expand file tree

Breadcrumbs

PythonHelper.java

Latest commit

History

Breadcrumbs

PythonHelper.java

File metadata and controls