eric7/Documentation/Source/eric7.Project.Project.html

branch
eric7
changeset 9097
213951c41dcd
parent 8623
fced5aa98d41
child 9117
c6afba2049cf
diff -r f6f7d8f364c3 -r 213951c41dcd eric7/Documentation/Source/eric7.Project.Project.html
--- a/eric7/Documentation/Source/eric7.Project.Project.html	Mon May 23 17:31:02 2022 +0200
+++ b/eric7/Documentation/Source/eric7.Project.Project.html	Mon May 23 18:15:10 2022 +0200
@@ -741,6 +741,10 @@
 <td>Public method to get the names of the project specific dictionaries.</td>
 </tr>
 <tr>
+<td><a href="#Project.getProjectExecPath">getProjectExecPath</a></td>
+<td>Public method to get the executable search path prefix of the project.</td>
+</tr>
+<tr>
 <td><a href="#Project.getProjectFile">getProjectFile</a></td>
 <td>Public method to get the path of the project file.</td>
 </tr>
@@ -749,6 +753,10 @@
 <td>Public method to get the file entries of the given type.</td>
 </tr>
 <tr>
+<td><a href="#Project.getProjectInterpreter">getProjectInterpreter</a></td>
+<td>Public method to get the path of the interpreter used by the project.</td>
+</tr>
+<tr>
 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td>
 <td>Public method to get the project's programming language.</td>
 </tr>
@@ -769,6 +777,10 @@
 <td>Public method to get the project's programming language.</td>
 </tr>
 <tr>
+<td><a href="#Project.getProjectTestingFramework">getProjectTestingFramework</a></td>
+<td>Public method to get the testing framework name of the project.</td>
+</tr>
+<tr>
 <td><a href="#Project.getProjectType">getProjectType</a></td>
 <td>Public method to get the type of the project.</td>
 </tr>
@@ -777,6 +789,10 @@
 <td>Public method to get the list of supported project types.</td>
 </tr>
 <tr>
+<td><a href="#Project.getProjectVenv">getProjectVenv</a></td>
+<td>Public method to get the name of the virtual environment used by the project.</td>
+</tr>
+<tr>
 <td><a href="#Project.getProjectVersion">getProjectVersion</a></td>
 <td>Public mehod to get the version number of the project.</td>
 </tr>
@@ -2557,18 +2573,27 @@
 <p>
         Public method to return the main script filename.
 </p>
+<p>
+        The normalized name is the name of the main script prepended with
+        the project path.
+</p>
 <dl>
 
-<dt><i>normalized</i></dt>
+<dt><i>normalized</i> (bool)</dt>
 <dd>
 flag indicating a normalized filename is wanted
-            (boolean)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-filename of the projects main script (string)
+filename of the projects main script
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Project.getMenu" ID="Project.getMenu"></a>
@@ -2701,6 +2726,25 @@
             project specific word and exclude list
 </dd>
 </dl>
+<a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a>
+<h4>Project.getProjectExecPath</h4>
+<b>getProjectExecPath</b>(<i></i>)
+
+<p>
+        Public method to get the executable search path prefix of the project.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+executable search path prefix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="Project.getProjectFile" ID="Project.getProjectFile"></a>
 <h4>Project.getProjectFile</h4>
 <b>getProjectFile</b>(<i></i>)
@@ -2752,6 +2796,34 @@
 raised when an unsupported file type is given
 </dd>
 </dl>
+<a NAME="Project.getProjectInterpreter" ID="Project.getProjectInterpreter"></a>
+<h4>Project.getProjectInterpreter</h4>
+<b>getProjectInterpreter</b>(<i>resolveGlobal=True</i>)
+
+<p>
+        Public method to get the path of the interpreter used by the project.
+</p>
+<dl>
+
+<dt><i>resolveGlobal</i> (bool)</dt>
+<dd>
+flag indicating to resolve the interpreter using
+            the global interpreter if no project of debugger specific
+            environment was configured
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+path of the project's interpreter
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a>
 <h4>Project.getProjectLanguage</h4>
 <b>getProjectLanguage</b>(<i></i>)
@@ -2820,6 +2892,25 @@
 programming language (string)
 </dd>
 </dl>
+<a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a>
+<h4>Project.getProjectTestingFramework</h4>
+<b>getProjectTestingFramework</b>(<i></i>)
+
+<p>
+        Public method to get the testing framework name of the project.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+testing framework name of the project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a>
 <h4>Project.getProjectType</h4>
 <b>getProjectType</b>(<i></i>)
@@ -2854,6 +2945,34 @@
 reference to the dictionary of project types.
 </dd>
 </dl>
+<a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a>
+<h4>Project.getProjectVenv</h4>
+<b>getProjectVenv</b>(<i>resolveDebugger=True</i>)
+
+<p>
+        Public method to get the name of the virtual environment used by the
+        project.
+</p>
+<dl>
+
+<dt><i>resolveDebugger</i> (bool)</dt>
+<dd>
+flag indicating to resolve the virtual
+            environment name via the debugger settings if none was configured
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+name of the project's virtual environment
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a>
 <h4>Project.getProjectVersion</h4>
 <b>getProjectVersion</b>(<i></i>)
@@ -2926,16 +3045,21 @@
 </p>
 <dl>
 
-<dt><i>normalized</i></dt>
+<dt><i>normalized</i> (bool)</dt>
 <dd>
 flag indicating a normalized filename is wanted
-            (boolean)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of the projects scripts (list of string)
+list of the projects scripts
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a>

eric ide

mercurial