reformat via black version 22.3.0

Author: rocky

.pre-commit-config.yaml

@@ -1,11 +1,11 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.0.0
+    rev: v4.0.1
     hooks:
     - id: debug-statements
     - id: end-of-file-fixer
 -   repo: https://github.com/psf/black
-    rev: 19.10b0
+    rev: 22.3.0
     hooks:
     - id: black
       language_version: python3

trepan/__main__.py

@@ -88,12 +88,19 @@ def main(dbg=None, sys_argv=list(sys.argv)):
             if is_readable is None:
                 print(
                     "%s: Python script file '%s' does not exist"
-                    % (__title__, mainpyfile,)
+                    % (
+                        __title__,
+                        mainpyfile,
+                    )
                 )
                 sys.exit(1)
             elif not is_readable:
                 print(
-                    "%s: Can't read Python script file '%s'" % (__title__, mainpyfile,)
+                    "%s: Can't read Python script file '%s'"
+                    % (
+                        __title__,
+                        mainpyfile,
+                    )
                 )
                 sys.exit(1)
                 return
@@ -227,7 +234,10 @@ def write_wrapper(*args, **kwargs):
             print("%s: Compiled Python script given and we can't use that." % __title__)
             print(
                 "%s: Substituting non-compiled name: %s"
-                % (__title__, mainpyfile_noopt,)
+                % (
+                    __title__,
+                    mainpyfile_noopt,
+                )
             )
             mainpyfile = mainpyfile_noopt
             pass

trepan/api.py

@@ -127,85 +127,84 @@ def run_exec(statement, debug_opts=None, start_opts=None, globals_=None, locals_
 
 def debug(dbg_opts=None, start_opts=None, post_mortem=True, step_ignore=1, level=0):
     """
-Enter the debugger.
-
-Parameters
-----------
-
-level : how many stack frames go back. Usually it will be
-the default 0. But sometimes though there may be calls in setup to the debugger
-that you may want to skip.
-
-step_ignore : how many line events to ignore after the
-debug() call. 0 means don't even wait for the debug() call to finish.
-
-param dbg_opts : is an optional "options" dictionary that gets fed
-trepan.Debugger(); `start_opts' are the optional "options"
-dictionary that gets fed to trepan.Debugger.core.start().
-
-Use like this:
-
-.. code-block:: python
-
-    ... # Possibly some Python code
-    import trepan.api # Needed only once
-    ... # Possibly some more Python code
-    trepan.api.debug() # You can wrap inside conditional logic too
-    pass  # Stop will be here.
-    # Below is code you want to use the debugger to do things.
-    ....  # more Python code
-    # If you get to a place in the program where you aren't going
-    # want to debug any more, but want to remove debugger trace overhead:
-    trepan.api.stop()
-
-Parameter "level" specifies how many stack frames go back. Usually it will be
-the default 0. But sometimes though there may be calls in setup to the debugger
-that you may want to skip.
-
-Parameter "step_ignore" specifies how many line events to ignore after the
-debug() call. 0 means don't even wait for the debug() call to finish.
-
-In situations where you want an immediate stop in the "debug" call
-rather than the statement following it ("pass" above), add parameter
-step_ignore=0 to debug() like this::
-
-    import trepan.api  # Needed only once
-    # ... as before
-    trepan.api.debug(step_ignore=0)
-    # ... as before
-
-Module variable _debugger_obj_ from module trepan.debugger is used as
-the debugger instance variable; it can be subsequently used to change
-settings or alter behavior. It should be of type Debugger (found in
-module trepan). If not, it will get changed to that type::
-
-   $ python
-   >>> from trepan.debugger import debugger_obj
-   >>> type(debugger_obj)
-   <type 'NoneType'>
-   >>> import trepan.api
-   >>> trepan.api.debug()
-   ...
-   (Trepan) c
-   >>> from trepan.debugger import debugger_obj
-   >>> debugger_obj
-   <trepan.debugger.Debugger instance at 0x7fbcacd514d0>
-   >>>
-
-If however you want your own separate debugger instance, you can
-create it from the debugger _class Debugger()_ from module
-trepan.debugger::
-
-  $ python
-  >>> from trepan.debugger import Debugger
-  >>> dbgr = Debugger()  # Add options as desired
-  >>> dbgr
-  <trepan.debugger.Debugger instance at 0x2e25320>
-
-`dbg_opts' is an optional "options" dictionary that gets fed
-trepan.Debugger(); `start_opts' are the optional "options"
-dictionary that gets fed to trepan.Debugger.core.start().
-"""
+    Enter the debugger.
+
+    Parameters
+    ----------
+
+    level : how many stack frames go back. Usually it will be
+    the default 0. But sometimes though there may be calls in setup to the debugger
+    that you may want to skip.
+
+    step_ignore : how many line events to ignore after the
+    debug() call. 0 means don't even wait for the debug() call to finish.
+
+    param dbg_opts : is an optional "options" dictionary that gets fed
+    trepan.Debugger(); `start_opts' are the optional "options"
+    dictionary that gets fed to trepan.Debugger.core.start().
+
+    Use like this:
+
+    .. code-block:: python
+
+        ... # Possibly some Python code
+        import trepan.api # Needed only once
+        ... # Possibly some more Python code
+        trepan.api.debug() # You can wrap inside conditional logic too
+        pass  # Stop will be here.
+        # Below is code you want to use the debugger to do things.
+        ....  # more Python code
+        # If you get to a place in the program where you aren't going
+        # want to debug any more, but want to remove debugger trace overhead:
+        trepan.api.stop()
+
+    Parameter "level" specifies how many stack frames go back. Usually it will be
+    the default 0. But sometimes though there may be calls in setup to the debugger
+    that you may want to skip.
+
+    Parameter "step_ignore" specifies how many line events to ignore after the
+    debug() call. 0 means don't even wait for the debug() call to finish.
+
+    In situations where you want an immediate stop in the "debug" call
+    rather than the statement following it ("pass" above), add parameter
+    step_ignore=0 to debug() like this::
+
+        import trepan.api  # Needed only once
+        # ... as before
+        trepan.api.debug(step_ignore=0)
+        # ... as before
+
+    Module variable _debugger_obj_ from module trepan.debugger is used as
+    the debugger instance variable; it can be subsequently used to change
+    settings or alter behavior. It should be of type Debugger (found in
+    module trepan). If not, it will get changed to that type::
+
+       $ python
+       >>> from trepan.debugger import debugger_obj
+       >>> type(debugger_obj)
+       <type 'NoneType'>
+       >>> import trepan.api
+       >>> trepan.api.debug()
+       ...
+       (Trepan) c
+       >>> from trepan.debugger import debugger_obj
+       >>> debugger_obj
+       <trepan.debugger.Debugger instance at 0x7fbcacd514d0>
+       >>>
+
+    If however you want your own separate debugger instance, you can
+    create it from the debugger _class Debugger()_ from module
+    trepan.debugger::
+
+      $ python
+      >>> from trepan.debugger import Debugger
+      >>> dbgr = Debugger()  # Add options as desired
+      >>> dbgr
+      <trepan.debugger.Debugger instance at 0x2e25320>
+
+    `dbg_opts' is an optional "options" dictionary that gets fed
+    trepan.Debugger(); `start_opts' are the optional "options"
+    dictionary that gets fed to trepan.Debugger.core.start()."""
     if not isinstance(Mdebugger.debugger_obj, Mdebugger.Trepan):
         Mdebugger.debugger_obj = Mdebugger.Trepan(dbg_opts)
         Mdebugger.debugger_obj.core.add_ignore(debug, stop)

trepan/bwcli.py

@@ -86,7 +86,7 @@ def process_options(debugger_name, pkg_version, sys_argv, option_list=None):
 
 
 def _postprocess_options(dbg, opts):
-    """ Handle options (`opts') that feed into the debugger (`dbg')"""
+    """Handle options (`opts') that feed into the debugger (`dbg')"""
     # Set dbg.settings['printset']
     print_events = []
     if opts.fntrace:
@@ -141,12 +141,19 @@ def main(dbg=None, sys_argv=list(sys.argv)):
             if is_readable is None:
                 print(
                     "%s: Python script file '%s' does not exist"
-                    % (__title__, mainpyfile,)
+                    % (
+                        __title__,
+                        mainpyfile,
+                    )
                 )
                 sys.exit(1)
             elif not is_readable:
                 print(
-                    "%s: Can't read Python script file '%s'" % (__title__, mainpyfile,)
+                    "%s: Can't read Python script file '%s'"
+                    % (
+                        __title__,
+                        mainpyfile,
+                    )
                 )
                 sys.exit(1)
                 return
@@ -158,7 +165,10 @@ def main(dbg=None, sys_argv=list(sys.argv)):
             print("%s: Compiled Python script given and we can't use that." % __title__)
             print(
                 "%s: Substituting non-compiled name: %s"
-                % (__title__, mainpyfile_noopt,)
+                % (
+                    __title__,
+                    mainpyfile_noopt,
+                )
             )
             mainpyfile = mainpyfile_noopt
             pass

trepan/bwprocessor/command/__init__.py

@@ -11,7 +11,7 @@
 #  You should have received a copy of the GNU General Public License
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # """ Copyright (C) 2008, 2009, 2013 Rocky Bernstein <rocky@gnu.org> """
-__import__('pkg_resources').declare_namespace(__name__)
+__import__("pkg_resources").declare_namespace(__name__)
 
 import glob, os
 
@@ -23,13 +23,15 @@
 __command_dir__ = os.path.dirname(__file__)
 
 # A glob pattern that will get all *.py files but not __init__.py
-__py_files__    = glob.glob(os.path.join(__command_dir__, '[a-z]*.py'))
+__py_files__ = glob.glob(os.path.join(__command_dir__, "[a-z]*.py"))
 
 # Take the basename of the filename and drop off '.py'. That minus the
 # files in exclude_files and tha becomes the list of modules that
 # commands.py will use to import
-exclude_files = ['mock.py']
-__modules__ = [ os.path.basename(filename[0:-3]) for
-                filename in __py_files__
-                if os.path.basename(filename) not in exclude_files]
-__all__ =  __modules__  + exclude_files
+exclude_files = ["mock.py"]
+__modules__ = [
+    os.path.basename(filename[0:-3])
+    for filename in __py_files__
+    if os.path.basename(filename) not in exclude_files
+]
+__all__ = __modules__ + exclude_files

trepan/bwprocessor/command/base_cmd.py

@@ -22,14 +22,14 @@
 
 NotImplementedMessage = "This method must be overriden in a subclass"
 
-__all__ = ['DebuggerCommand']
+__all__ = ["DebuggerCommand"]
 
 
 class DebuggerCommand:
     """Base Class for Debugger commands. We pull in some helper
     functions for command from module cmdfns."""
 
-    category = 'misc'
+    category = "misc"
 
     def __init__(self, proc):
         """proc contains the command processor object that this
@@ -42,13 +42,13 @@ def __init__(self, proc):
         # execution like errmsg(), msg(), and msg_nocr() might. (See
         # the note below on these latter 3 methods.)
         #
-        self.core     = proc.core
+        self.core = proc.core
         self.debugger = proc.debugger
         self.settings = self.debugger.settings
         return
 
     aliases = ()
-    name    = 'YourCommandName'
+    name = "YourCommandName"
 
     # Note for errmsg, msg, and msg_nocr we don't want to simply make
     # an assignment of method names like self.msg = self.debugger.intf.msg,
@@ -57,42 +57,44 @@ def __init__(self, proc):
     # in the course of the program and if we made such an method assignemnt
     # we wouldn't pick up that change in our self.msg
     def errmsg(self, msg, opts={}):
-        """ Convenience short-hand for self.debugger.intf.errmsg """
+        """Convenience short-hand for self.debugger.intf.errmsg"""
         try:
-            return(self.debugger.intf[-1].errmsg(msg))
+            return self.debugger.intf[-1].errmsg(msg)
         except EOFError:
             # FIXME: what do we do here?
             pass
         return None
 
     def msg(self, msg, opts={}):
-        """ Convenience short-hand for self.debugger.intf.msg """
+        """Convenience short-hand for self.debugger.intf.msg"""
         try:
-            return(self.debugger.intf[-1].msg(msg))
+            return self.debugger.intf[-1].msg(msg)
         except EOFError:
             # FIXME: what do we do here?
             pass
         return None
 
     def msg_nocr(self, msg, opts={}):
-        """ Convenience short-hand for self.debugger.intf.msg_nocr """
+        """Convenience short-hand for self.debugger.intf.msg_nocr"""
         try:
-            return(self.debugger.intf[-1].msg_nocr(msg))
+            return self.debugger.intf[-1].msg_nocr(msg)
         except EOFError:
             # FIXME: what do we do here?
             pass
         return None
 
     def run(self, args):
-        """ The method that implements the debugger command.
+        """The method that implements the debugger command.
         Help on the command comes from the docstring of this method.
         """
         raise NotImplementedError(NotImplementedMessage)
 
     pass
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     from trepan.bwprocessor.command import mock
+
     d, cp = mock.dbg_setup()
     dd = DebuggerCommand(cp)
     dd.msg("hi")