Updated source documentation. eric7

Tue, 24 Aug 2021 18:10:24 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 24 Aug 2021 18:10:24 +0200
branch
eric7
changeset 8541
927d57b6aae0
parent 8540
ddeace12034a
child 8542
f8d3b4511358

Updated source documentation.

eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.Preferences.__init__.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html file | annotate | diff | comparison | revisions
eric7/Documentation/Source/eric7.UI.PythonDisViewer.html file | annotate | diff | comparison | revisions
eric7/UI/PythonDisViewer.py file | annotate | diff | comparison | revisions
--- a/eric7/APIs/Python3/eric7.api	Tue Aug 24 18:06:48 2021 +0200
+++ b/eric7/APIs/Python3/eric7.api	Tue Aug 24 18:10:24 2021 +0200
@@ -9517,6 +9517,8 @@
 eric7.UI.PythonDisViewer.PythonDisViewer?1(viewmanager, mode=PythonDisViewerModes.SOURCEDISASSEMBLY, parent=None)
 eric7.UI.PythonDisViewer.PythonDisViewerModes.SOURCEDISASSEMBLY?7
 eric7.UI.PythonDisViewer.PythonDisViewerModes.TRACEBACK?7
+eric7.UI.PythonDisViewer.linestarts?4(co, filename="", getall=True)
+eric7.UI.PythonDisViewer.tryCompile?4(source, name)
 eric7.UI.SearchWidget.SearchWidget.keyPressEvent?4(event)
 eric7.UI.SearchWidget.SearchWidget.on_closeButton_clicked?4()
 eric7.UI.SearchWidget.SearchWidget.on_findNextButton_clicked?4()
Binary file eric7/Documentation/Help/source.qch has changed
--- a/eric7/Documentation/Help/source.qhp	Tue Aug 24 18:06:48 2021 +0200
+++ b/eric7/Documentation/Help/source.qhp	Tue Aug 24 18:10:24 2021 +0200
@@ -11875,6 +11875,10 @@
       <keyword name="ProjectSourcesBrowser.__addSourceDirectory" id="ProjectSourcesBrowser.__addSourceDirectory" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__addSourceDirectory" />
       <keyword name="ProjectSourcesBrowser.__addSourceFiles" id="ProjectSourcesBrowser.__addSourceFiles" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__addSourceFiles" />
       <keyword name="ProjectSourcesBrowser.__closeAllWindows" id="ProjectSourcesBrowser.__closeAllWindows" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__closeAllWindows" />
+      <keyword name="ProjectSourcesBrowser.__contextMenuCoverageScript" id="ProjectSourcesBrowser.__contextMenuCoverageScript" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__contextMenuCoverageScript" />
+      <keyword name="ProjectSourcesBrowser.__contextMenuDebugScript" id="ProjectSourcesBrowser.__contextMenuDebugScript" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__contextMenuDebugScript" />
+      <keyword name="ProjectSourcesBrowser.__contextMenuProfileScript" id="ProjectSourcesBrowser.__contextMenuProfileScript" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__contextMenuProfileScript" />
+      <keyword name="ProjectSourcesBrowser.__contextMenuRunScript" id="ProjectSourcesBrowser.__contextMenuRunScript" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__contextMenuRunScript" />
       <keyword name="ProjectSourcesBrowser.__createJavaScriptPopupMenus" id="ProjectSourcesBrowser.__createJavaScriptPopupMenus" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__createJavaScriptPopupMenus" />
       <keyword name="ProjectSourcesBrowser.__createPythonPopupMenus" id="ProjectSourcesBrowser.__createPythonPopupMenus" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__createPythonPopupMenus" />
       <keyword name="ProjectSourcesBrowser.__createRubyPopupMenus" id="ProjectSourcesBrowser.__createRubyPopupMenus" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__createRubyPopupMenus" />
@@ -12248,7 +12252,6 @@
       <keyword name="PythonDisViewer.__showCodeInfo" id="PythonDisViewer.__showCodeInfo" ref="eric7.UI.PythonDisViewer.html#PythonDisViewer.__showCodeInfo" />
       <keyword name="PythonDisViewer.__showCodeInfoData" id="PythonDisViewer.__showCodeInfoData" ref="eric7.UI.PythonDisViewer.html#PythonDisViewer.__showCodeInfoData" />
       <keyword name="PythonDisViewer.__styleLabels" id="PythonDisViewer.__styleLabels" ref="eric7.UI.PythonDisViewer.html#PythonDisViewer.__styleLabels" />
-      <keyword name="PythonDisViewer.__tryCompile" id="PythonDisViewer.__tryCompile" ref="eric7.UI.PythonDisViewer.html#PythonDisViewer.__tryCompile" />
       <keyword name="PythonDisViewer.__updateItemEndLine" id="PythonDisViewer.__updateItemEndLine" ref="eric7.UI.PythonDisViewer.html#PythonDisViewer.__updateItemEndLine" />
       <keyword name="PythonDisViewer.clear" id="PythonDisViewer.clear" ref="eric7.UI.PythonDisViewer.html#PythonDisViewer.clear" />
       <keyword name="PythonDisViewer.createCodeInfoItems" id="PythonDisViewer.createCodeInfoItems" ref="eric7.UI.PythonDisViewer.html#PythonDisViewer.createCodeInfoItems" />
@@ -18186,6 +18189,7 @@
       <keyword name="linerange" id="linerange" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html#linerange" />
       <keyword name="linerange_fix" id="linerange_fix" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html#linerange_fix" />
       <keyword name="linesep" id="linesep" ref="eric7.Utilities.__init__.html#linesep" />
+      <keyword name="linestarts" id="linestarts" ref="eric7.UI.PythonDisViewer.html#linestarts" />
       <keyword name="listdirStat" id="listdirStat" ref="eric7.MicroPython.MicroPythonFileSystemUtilities.html#listdirStat" />
       <keyword name="loadTranslatorForLocale" id="loadTranslatorForLocale" ref="eric7.Toolbox.Startup.html#loadTranslatorForLocale" />
       <keyword name="loadTranslators" id="loadTranslators" ref="eric7.Toolbox.Startup.html#loadTranslators" />
@@ -18503,6 +18507,7 @@
       <keyword name="translations (Module)" id="translations (Module)" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.translations.html" />
       <keyword name="translations (Module)" id="translations (Module)" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Simplify.translations.html" />
       <keyword name="translations (Module)" id="translations (Module)" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.translations.html" />
+      <keyword name="tryCompile" id="tryCompile" ref="eric7.UI.PythonDisViewer.html#tryCompile" />
       <keyword name="tryExcept (Module)" id="tryExcept (Module)" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tryExcept.html" />
       <keyword name="uiStartUp" id="uiStartUp" ref="eric7.eric7.html#uiStartUp" />
       <keyword name="uic (Module)" id="uic (Module)" ref="eric7.Utilities.uic.html" />
--- a/eric7/Documentation/Source/eric7.Preferences.__init__.html	Tue Aug 24 18:06:48 2021 +0200
+++ b/eric7/Documentation/Source/eric7.Preferences.__init__.html	Tue Aug 24 18:10:24 2021 +0200
@@ -675,11 +675,11 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
 the key of the value to get
 </dd>
-<dt><i>prefClass</i></dt>
+<dt><i>prefClass</i> (Prefs)</dt>
 <dd>
 preferences class used as the storage area
 </dd>
@@ -690,6 +690,12 @@
 the requested debugger setting
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -2139,15 +2145,15 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
 the key of the setting to be set
 </dd>
-<dt><i>value</i></dt>
+<dt><i>value</i> (Any)</dt>
 <dd>
 the value to be set
 </dd>
-<dt><i>prefClass</i></dt>
+<dt><i>prefClass</i> (Prefs)</dt>
 <dd>
 preferences class used as the storage area
 </dd>
--- a/eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html	Tue Aug 24 18:06:48 2021 +0200
+++ b/eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html	Tue Aug 24 18:10:24 2021 +0200
@@ -98,6 +98,22 @@
 <td>Private method to close all project related windows.</td>
 </tr>
 <tr>
+<td><a href="#ProjectSourcesBrowser.__contextMenuCoverageScript">__contextMenuCoverageScript</a></td>
+<td>Private method to run a coverage test of the editor script.</td>
+</tr>
+<tr>
+<td><a href="#ProjectSourcesBrowser.__contextMenuDebugScript">__contextMenuDebugScript</a></td>
+<td>Private method to debug the editor script.</td>
+</tr>
+<tr>
+<td><a href="#ProjectSourcesBrowser.__contextMenuProfileScript">__contextMenuProfileScript</a></td>
+<td>Private method to profile the editor script.</td>
+</tr>
+<tr>
+<td><a href="#ProjectSourcesBrowser.__contextMenuRunScript">__contextMenuRunScript</a></td>
+<td>Private method to run the editor script.</td>
+</tr>
+<tr>
 <td><a href="#ProjectSourcesBrowser.__createJavaScriptPopupMenus">__createJavaScriptPopupMenus</a></td>
 <td>Private method to generate the popup menus for a Python project.</td>
 </tr>
@@ -246,6 +262,34 @@
 <p>
         Private method to close all project related windows.
 </p>
+<a NAME="ProjectSourcesBrowser.__contextMenuCoverageScript" ID="ProjectSourcesBrowser.__contextMenuCoverageScript"></a>
+<h4>ProjectSourcesBrowser.__contextMenuCoverageScript</h4>
+<b>__contextMenuCoverageScript</b>(<i></i>)
+
+<p>
+        Private method to run a coverage test of the editor script.
+</p>
+<a NAME="ProjectSourcesBrowser.__contextMenuDebugScript" ID="ProjectSourcesBrowser.__contextMenuDebugScript"></a>
+<h4>ProjectSourcesBrowser.__contextMenuDebugScript</h4>
+<b>__contextMenuDebugScript</b>(<i></i>)
+
+<p>
+        Private method to debug the editor script.
+</p>
+<a NAME="ProjectSourcesBrowser.__contextMenuProfileScript" ID="ProjectSourcesBrowser.__contextMenuProfileScript"></a>
+<h4>ProjectSourcesBrowser.__contextMenuProfileScript</h4>
+<b>__contextMenuProfileScript</b>(<i></i>)
+
+<p>
+        Private method to profile the editor script.
+</p>
+<a NAME="ProjectSourcesBrowser.__contextMenuRunScript" ID="ProjectSourcesBrowser.__contextMenuRunScript"></a>
+<h4>ProjectSourcesBrowser.__contextMenuRunScript</h4>
+<b>__contextMenuRunScript</b>(<i></i>)
+
+<p>
+        Private method to run the editor script.
+</p>
 <a NAME="ProjectSourcesBrowser.__createJavaScriptPopupMenus" ID="ProjectSourcesBrowser.__createJavaScriptPopupMenus"></a>
 <h4>ProjectSourcesBrowser.__createJavaScriptPopupMenus</h4>
 <b>__createJavaScriptPopupMenus</b>(<i></i>)
--- a/eric7/Documentation/Source/eric7.UI.PythonDisViewer.html	Tue Aug 24 18:06:48 2021 +0200
+++ b/eric7/Documentation/Source/eric7.UI.PythonDisViewer.html	Tue Aug 24 18:10:24 2021 +0200
@@ -47,7 +47,15 @@
 <h3>Functions</h3>
 
 <table>
-<tr><td>None</td></tr>
+
+<tr>
+<td><a href="#linestarts">linestarts</a></td>
+<td>Function to get the line starts for the given code object.</td>
+</tr>
+<tr>
+<td><a href="#tryCompile">tryCompile</a></td>
+<td>Function to attempt to compile the given source, first as an expression and then as a statement if the first approach fails.</td>
+</tr>
 </table>
 <hr />
 <hr />
@@ -191,10 +199,6 @@
 <td>Private method to style the info labels iaw.</td>
 </tr>
 <tr>
-<td><a href="#PythonDisViewer.__tryCompile">__tryCompile</a></td>
-<td>Private method to attempt to compile the given source, first as an expression and then as a statement if the first approach fails.</td>
-</tr>
-<tr>
 <td><a href="#PythonDisViewer.__updateItemEndLine">__updateItemEndLine</a></td>
 <td>Private method to update an items end line based on its children.</td>
 </tr>
@@ -655,37 +659,6 @@
 <p>
         Private method to style the info labels iaw. selected colors.
 </p>
-<a NAME="PythonDisViewer.__tryCompile" ID="PythonDisViewer.__tryCompile"></a>
-<h4>PythonDisViewer.__tryCompile</h4>
-<b>__tryCompile</b>(<i>source, name</i>)
-
-<p>
-        Private method to attempt to compile the given source, first as an
-        expression and then as a statement if the first approach fails.
-</p>
-<dl>
-
-<dt><i>source</i> (str)</dt>
-<dd>
-source code string to be compiled
-</dd>
-<dt><i>name</i> (str)</dt>
-<dd>
-name of the file containing the source
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-compiled code
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-code object
-</dd>
-</dl>
 <a NAME="PythonDisViewer.__updateItemEndLine" ID="PythonDisViewer.__updateItemEndLine"></a>
 <h4>PythonDisViewer.__updateItemEndLine</h4>
 <b>__updateItemEndLine</b>(<i>itm</i>)
@@ -815,4 +788,75 @@
 
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="linestarts" ID="linestarts"></a>
+<h2>linestarts</h2>
+<b>linestarts</b>(<i>co, filename="", getall=True</i>)
+
+<p>
+    Function to get the line starts for the given code object.
+</p>
+<dl>
+
+<dt><i>co</i> (code object or str)</dt>
+<dd>
+reference to the compiled code object or the source code
+</dd>
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the source file (optional)
+</dd>
+<dt><i>getall</i> (bool)</dt>
+<dd>
+flag indicating to get all line starts recursively
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of lines starting some byte code instruction block
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of int
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="tryCompile" ID="tryCompile"></a>
+<h2>tryCompile</h2>
+<b>tryCompile</b>(<i>source, name</i>)
+
+<p>
+    Function to attempt to compile the given source, first as an
+    expression and then as a statement if the first approach fails.
+</p>
+<dl>
+
+<dt><i>source</i> (str)</dt>
+<dd>
+source code string to be compiled
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the file containing the source
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+compiled code
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+code object
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file
--- a/eric7/UI/PythonDisViewer.py	Tue Aug 24 18:06:48 2021 +0200
+++ b/eric7/UI/PythonDisViewer.py	Tue Aug 24 18:10:24 2021 +0200
@@ -893,7 +893,7 @@
 
 def linestarts(co, filename="", getall=True):
     """
-    Function to get the line starts for the given code object
+    Function to get the line starts for the given code object.
     
     @param co reference to the compiled code object or the source code
     @type code object or str

eric ide

mercurial