eric6/Documentation/Source/index-eric6.DebugClients.Python.html

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
parent 7960
e8fc383322f7
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.DebugClients.Python</title>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric6.DebugClients.Python</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
23
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 Package implementing the standard Python debugger.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
26 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
27 <p>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 It consists of different kinds of debug clients.
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </p>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <h3>Modules</h3>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
34
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <tr>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <td><a href="eric6.DebugClients.Python.AsyncFile.html">AsyncFile</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <td>Module implementing an asynchronous file like socket interface for the debugger.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
38 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
39 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <td><a href="eric6.DebugClients.Python.BreakpointWatch.html">BreakpointWatch</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <td>Module implementing the breakpoint and watch class.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
42 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
43 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <td><a href="eric6.DebugClients.Python.DCTestResult.html">DCTestResult</a></td>
7960
e8fc383322f7 Harmonized some user visible strings and changed the term 'eric6' to the more generic 'eric'.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7887
diff changeset
45 <td>Module implementing a TestResult derivative for the eric debugger.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
46 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
47 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <td><a href="eric6.DebugClients.Python.DebugBase.html">DebugBase</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <td>Module implementing the debug base class which based originally on bdb.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
50 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
51 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <td><a href="eric6.DebugClients.Python.DebugClient.html">DebugClient</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <td>Module implementing the standard debug client.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
54 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
55 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <td><a href="eric6.DebugClients.Python.DebugClientBase.html">DebugClientBase</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td>Module implementing a debug client base class.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
58 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
59 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td><a href="eric6.DebugClients.Python.DebugClientCapabilities.html">DebugClientCapabilities</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <td>Module defining the debug clients capabilities.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
62 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
63 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td><a href="eric6.DebugClients.Python.DebugConfig.html">DebugConfig</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <td>Module defining type strings for the different Python types.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
66 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
67 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <td><a href="eric6.DebugClients.Python.DebugUtilities.html">DebugUtilities</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <td>Module implementing utilities functions for the debug client.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
70 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
71 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="eric6.DebugClients.Python.DebugVariables.html">DebugVariables</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <td>Module implementing classes and functions to dump variable contents.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
74 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
75 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td><a href="eric6.DebugClients.Python.FlexCompleter.html">FlexCompleter</a></td>
7960
e8fc383322f7 Harmonized some user visible strings and changed the term 'eric6' to the more generic 'eric'.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7887
diff changeset
77 <td>Word completion for the eric shell.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
78 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
79 <tr>
7887
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
80 <td><a href="eric6.DebugClients.Python.ModuleLoader.html">ModuleLoader</a></td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
81 <td>Module implementing an import hook patching modules to support debugging.</td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
82 </tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
83 <tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
84 <td><a href="eric6.DebugClients.Python.MultiProcessDebugExtension.html">MultiProcessDebugExtension</a></td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
85 <td>Module implementing a function to patch the process creation functions to support multiprocess debugging.</td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
86 </tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
87 <tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
88 <td><a href="eric6.DebugClients.Python.MultiprocessingExtension.html">MultiprocessingExtension</a></td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
89 <td>Module implementing a function to patch multiprocessing.Process to support debugging of the process.</td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
90 </tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
91 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <td><a href="eric6.DebugClients.Python.PyProfile.html">PyProfile</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <td>Module defining additions to the standard Python profile.py.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
94 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
95 <tr>
7887
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
96 <td><a href="eric6.DebugClients.Python.QProcessExtension.html">QProcessExtension</a></td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
97 <td>Module implementing a function to patch QProcess to support debugging of the process.</td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
98 </tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
99 <tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
100 <td><a href="eric6.DebugClients.Python.SubprocessExtension.html">SubprocessExtension</a></td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
101 <td>Module implementing a function to patch subprocess.Popen to support debugging of the process.</td>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
102 </tr>
c1588f5a83e9 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
103 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <td><a href="eric6.DebugClients.Python.ThreadExtension.html">ThreadExtension</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <td>Module implementing an import hook patching thread modules to get debugged too.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
106 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
107 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <td><a href="eric6.DebugClients.Python.eric6dbgstub.html">eric6dbgstub</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <td>Module implementing a debugger stub for remote debugging.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
110 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
111 <tr>
5245
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <td><a href="eric6.DebugClients.Python.getpass.html">getpass</a></td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <td>Module implementing utilities to get a password and/or the current user name.</td>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 </tr>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 </table>
e1908fd9deac Added the source docu for the merged debugger.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 </body></html>

eric ide

mercurial