src/eric7/DebugClients/Python/DebugBase.py

branch
eric7-maintenance
changeset 10460
3b34efa2857c
parent 10439
21c28b0f9e41
child 10542
e46910b0ce73
--- a/src/eric7/DebugClients/Python/DebugBase.py	Sun Dec 03 14:54:00 2023 +0100
+++ b/src/eric7/DebugClients/Python/DebugBase.py	Mon Jan 01 11:10:45 2024 +0100
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2002 - 2023 Detlev Offenbach <detlev@die-offenbachs.de>
+# Copyright (c) 2002 - 2024 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 
 """
@@ -37,6 +37,7 @@
     Module function used for debugging the debug client.
 
     @param s data to be printed
+    @type str
     """
     sys.__stderr__.write("{0!s}\n".format(s))
     sys.__stderr__.flush()
@@ -46,7 +47,8 @@
     """
     Module function to set the recursion limit.
 
-    @param limit recursion limit (integer)
+    @param limit recursion limit
+    @type int
     """
     global gRecursionLimit
     gRecursionLimit = limit
@@ -75,6 +77,7 @@
         Constructor
 
         @param dbgClient the owning client
+        @type DebugClient
         """
         self._dbgClient = dbgClient
 
@@ -151,8 +154,10 @@
         or a frame below.
 
         @param frmnr distance of frame to get locals dictionary of. 0 is
-            the current frame (int)
+            the current frame
+        @type int
         @return locals dictionary of the frame
+        @rtype dict
         """
         try:
             f = self.frameList[frmnr]
@@ -166,7 +171,8 @@
         frame.f_locals returns the last data.
 
         @param frmnr distance of frame to store locals dictionary to. 0 is
-            the current frame (int)
+            the current frame
+        @type int
         """
         with contextlib.suppress(IndexError):
             cf = self.frameList[frmnr]
@@ -186,6 +192,7 @@
 
         @param traceMode If it is True, then the step is a step into,
               otherwise it is a step over.
+        @type bool
         """
         if traceMode:
             self.set_step()
@@ -205,6 +212,7 @@
         It resumes the thread stopping only at breakpoints or exceptions.
 
         @param special flag indicating a special continue operation
+        @type bool
         """
         self.set_continue(special)
 
@@ -213,6 +221,7 @@
         Public method to determine the current recursion depth.
 
         @param frame The current stack frame.
+        @type frame object
         """
         self.__recursionDepth = 0
         while frame is not None:
@@ -771,8 +780,9 @@
         @type frame object or list
         @param applyTrace flag to assign trace function to fr.f_trace
         @type bool
-        @return list of lists with file name (string), line number (integer)
-            and function name (string)
+        @return list of lists with file name, line number, function name
+            and function arguments
+        @rtype list of list of [str, int, str, str]
         """
         tb_lineno = None
         if frame is None:
@@ -841,7 +851,8 @@
         Public method reimplemented to handle the program about to execute a
         particular line.
 
-        @param frame the frame object
+        @param frame reference to the frame object
+        @type frame object
         """
         # We never stop on line 0.
         if frame.f_lineno == 0:
@@ -1002,7 +1013,9 @@
         type object.
 
         @param exctype type of the exception
-        @return exception name (string)
+        @type type
+        @return exception name
+        @rtype str
         """
         return str(exctype).replace("<class '", "").replace("'>", "")
 
@@ -1011,7 +1024,9 @@
         Private member to return a list of stack frames.
 
         @param exctb exception traceback
+        @type traceback
         @return list of stack frames
+        @rtype list of frame
         """
         tb = exctb
         stack = []

eric ide

mercurial