diff -r 1b59c4ba121e -r 8cd4d08fa9f6 Documentation/Source/eric5.DebugClients.Python.DebugClientBase.html --- a/Documentation/Source/eric5.DebugClients.Python.DebugClientBase.html Fri Mar 11 08:55:14 2011 +0100 +++ b/Documentation/Source/eric5.DebugClients.Python.DebugClientBase.html Fri Mar 11 16:51:57 2011 +0100 @@ -70,12 +70,12 @@ </p><p> The protocol is as follows. First the client opens a connection to the debugger and then sends a series of one line commands. A command is either - >Load<, >Step<, >StepInto<, ... or a Python statement. + >Load<, >Step<, >StepInto<, ... or a Python statement. See DebugProtocol.py for a listing of valid protocol tokens. </p><p> A Python statement consists of the statement to execute, followed (in a separate line) by >OK?<. If the statement was incomplete then the response - is >Continue<. If there was an exception then the response is + is >Continue<. If there was an exception then the response is >Exception<. Otherwise the response is >OK<. The reason for the >OK?< part is to provide a sentinal (ie. the responding >OK<) after any possible output as a @@ -295,17 +295,17 @@ <dt>Returns:</dt> <dd> A tuple consisting of a list of formatted variables. Each - variable entry is a tuple of three elements, the variable name, + variable entry is a tuple of three elements, the variable name, its type and value. </dd> </dl><a NAME="DebugClientBase.__formatVariablesList" ID="DebugClientBase.__formatVariablesList"></a> <h4>DebugClientBase.__formatVariablesList</h4> -<b>__formatVariablesList</b>(<i>keylist, dict, scope, filter = [], formatSequences = 0</i>) +<b>__formatVariablesList</b>(<i>keylist, dict, scope, filter=[], formatSequences=0</i>) <p> Private method to produce a formated variables list. </p><p> The dictionary passed in to it is scanned. Variables are - only added to the list, if their type is not contained + only added to the list, if their type is not contained in the filter list and their name doesn't match any of the filter expressions. The formated variables list (a list of tuples of 3 values) is returned. </p><dl> @@ -324,7 +324,7 @@ </dd><dt><i>filter</i></dt> <dd> the indices of variable types to be filtered. Variables are - only added to the list, if their type is not contained in the filter + only added to the list, if their type is not contained in the filter list. </dd><dt><i>formatSequences</i></dt> <dd> @@ -336,7 +336,7 @@ <dt>Returns:</dt> <dd> A tuple consisting of a list of formatted variables. Each variable - entry is a tuple of three elements, the variable name, its type and + entry is a tuple of three elements, the variable name, its type and value. </dd> </dl><a NAME="DebugClientBase.__generateFilterObjects" ID="DebugClientBase.__generateFilterObjects"></a> @@ -357,7 +357,7 @@ <h4>DebugClientBase.__getSysPath</h4> <b>__getSysPath</b>(<i>firstEntry</i>) <p> - Private slot to calculate a path list including the PYTHONPATH + Private slot to calculate a path list including the PYTHONPATH environment variable. </p><dl> <dt><i>firstEntry</i></dt> @@ -421,7 +421,7 @@ <p> Public method to convert a filename to an absolute name. </p><p> - sys.path is used as a set of possible prefixes. The name stays + sys.path is used as a set of possible prefixes. The name stays relative if a file could not be found. </p><dl> <dt><i>fn</i></dt> @@ -435,11 +435,11 @@ </dd> </dl><a NAME="DebugClientBase.attachThread" ID="DebugClientBase.attachThread"></a> <h4>DebugClientBase.attachThread</h4> -<b>attachThread</b>(<i>target = None, args = None, kwargs = None, mainThread = 0</i>) +<b>attachThread</b>(<i>target=None, args=None, kwargs=None, mainThread=0</i>) <p> Public method to setup a thread for DebugClient to debug. </p><p> - If mainThread is non-zero, then we are attaching to the already + If mainThread is non-zero, then we are attaching to the already started mainthread of the app and the rest of the args are ignored. </p><p> This is just an empty function and is overridden in the threaded @@ -480,9 +480,9 @@ <h4>DebugClientBase.connectDebugger</h4> <b>connectDebugger</b>(<i>port, remoteAddress=None, redirect=1</i>) <p> - Public method to establish a session with the debugger. + Public method to establish a session with the debugger. </p><p> - It opens a network connection to the debugger, connects it to stdin, + It opens a network connection to the debugger, connects it to stdin, stdout and stderr and saves these file objects in case the application being debugged redirects them itself. </p><dl> @@ -498,7 +498,7 @@ </dd> </dl><a NAME="DebugClientBase.eventLoop" ID="DebugClientBase.eventLoop"></a> <h4>DebugClientBase.eventLoop</h4> -<b>eventLoop</b>(<i>disablePolling = False</i>) +<b>eventLoop</b>(<i>disablePolling=False</i>) <p> Public method implementing our event loop. </p><dl> @@ -616,7 +616,7 @@ </dd> </dl><a NAME="DebugClientBase.sessionClose" ID="DebugClientBase.sessionClose"></a> <h4>DebugClientBase.sessionClose</h4> -<b>sessionClose</b>(<i>exit = 1</i>) +<b>sessionClose</b>(<i>exit=1</i>) <p> Public method to close the session with the debugger and optionally terminate. </p><dl> @@ -641,7 +641,7 @@ </dd> </dl><a NAME="DebugClientBase.startDebugger" ID="DebugClientBase.startDebugger"></a> <h4>DebugClientBase.startDebugger</h4> -<b>startDebugger</b>(<i>filename = None, host = None, port = None, enableTrace = 1, exceptions = 1, tracePython = 0, redirect = 1</i>) +<b>startDebugger</b>(<i>filename=None, host=None, port=None, enableTrace=1, exceptions=1, tracePython=0, redirect=1</i>) <p> Public method used to start the remote debugger. </p><dl> @@ -669,7 +669,7 @@ </dd> </dl><a NAME="DebugClientBase.startProgInDebugger" ID="DebugClientBase.startProgInDebugger"></a> <h4>DebugClientBase.startProgInDebugger</h4> -<b>startProgInDebugger</b>(<i>progargs, wd = '', host = None, port = None, exceptions = 1, tracePython = 0, redirect = 1</i>) +<b>startProgInDebugger</b>(<i>progargs, wd='', host=None, port=None, exceptions=1, tracePython=0, redirect=1</i>) <p> Public method used to start the remote debugger. </p><dl>