PY-14976 Rename getPythonPath() to getPythonPathEntry(), improve javadoc of HelperPackage pycharm/144.621
authorMikhail Golubev <mikhail.golubev@jetbrains.com>
Fri, 23 Oct 2015 12:04:18 +0000 (15:04 +0300)
committerMikhail Golubev <mikhail.golubev@jetbrains.com>
Mon, 26 Oct 2015 18:02:17 +0000 (21:02 +0300)
as it was suggested in IDEA-CR-5936.

python/src/com/jetbrains/python/HelperPackage.java
python/src/com/jetbrains/python/PythonHelper.java

index 92821528c5ac42e8747f5266a46aea65581996e8..08574b49eee1ac9f4c688d858ba07d7e75e83c43 100644 (file)
@@ -29,11 +29,18 @@ import java.util.Map;
 public interface HelperPackage {
   void addToPythonPath(@NotNull Map<String, String> environment);
 
+  /**
+   * @return entry (directory or ZIP archive) that will be added to <tt>PYTHONPATH</tt> environment variable before the process is started.
+   */
   @NotNull
-  String getPythonPath();
+  String getPythonPathEntry();
 
   void addToGroup(@NotNull ParamsGroup group, @NotNull GeneralCommandLine cmd);
 
+  /**
+   * @return the first parameter passed to Python interpreter that indicates which script to run. For scripts started as modules it's 
+   * module name with <tt>-m</tt> flag, like <tt>-mpackage.module.name</tt>, and for average helpers it's full path to the script.
+   */
   @NotNull
   String asParamString();
 
index 978d6d56b54d9d74804e2b09d08e7d796489da4d..7616af9d9072cd940f8e724d5b52660ffc9d2294 100644 (file)
@@ -118,7 +118,7 @@ public enum PythonHelper implements HelperPackage {
 
     @Override
     public void addToPythonPath(@NotNull Map<String, String> environment) {
-      PythonEnvUtil.addToPythonPath(environment, getPythonPath());
+      PythonEnvUtil.addToPythonPath(environment, getPythonPathEntry());
     }
 
     @Override
@@ -153,7 +153,7 @@ public enum PythonHelper implements HelperPackage {
       final GeneralCommandLine cmd = newCommandLine(sdkHomePath, parameters);
       final LanguageLevel version = PythonSdkType.getLanguageLevelForSdk(pythonSdk);
       final String perVersionDependenciesDir = version.isPy3K() ? PY3_HELPER_DEPENDENCIES_DIR : PY2_HELPER_DEPENDENCIES_DIR;
-      PythonEnvUtil.addToPythonPath(cmd.getEnvironment(), FileUtil.join(getPythonPath(), perVersionDependenciesDir));
+      PythonEnvUtil.addToPythonPath(cmd.getEnvironment(), FileUtil.join(getPythonPathEntry(), perVersionDependenciesDir));
       return cmd;
     }
   }
@@ -177,7 +177,7 @@ public enum PythonHelper implements HelperPackage {
 
     @NotNull
     @Override
-    public String getPythonPath() {
+    public String getPythonPathEntry() {
       return FileUtil.toSystemDependentName(myPath.getAbsolutePath());
     }
   }
@@ -203,7 +203,7 @@ public enum PythonHelper implements HelperPackage {
 
     @NotNull
     @Override
-    public String getPythonPath() {
+    public String getPythonPathEntry() {
       return myPythonPath;
     }
   }
@@ -211,8 +211,8 @@ public enum PythonHelper implements HelperPackage {
   
   @NotNull
   @Override
-  public String getPythonPath() {
-    return myModule.getPythonPath();
+  public String getPythonPathEntry() {
+    return myModule.getPythonPathEntry();
   }
 
   @Override