13123da89a
Re-format all Python files using black [1] version 21.4b0. The goal is
that from now on, we keep all Python files formatted using black. And
that we never have to discuss formatting during review (for these files
at least) ever again.
One change is needed in gdb.python/py-prettyprint.exp, because it
matches the string representation of an exception, which shows source
code. So the change in formatting must be replicated in the expected
regexp.
To document our usage of black I plan on adding this to the "GDB Python
Coding Standards" wiki page [2]:
--8<--
All Python source files under the `gdb/` directory must be formatted
using black version 21.4b0.
This specific version can be installed using:
$ pip3 install 'black == 21.4b0'
All you need to do to re-format files is run `black <file/directory>`,
and black will re-format any Python file it finds in there. It runs
quite fast, so the simplest is to do:
$ black gdb/
from the top-level.
If you notice that black produces changes unrelated to your patch, it's
probably because someone forgot to run it before you. In this case,
don't include unrelated hunks in your patch. Push an obvious patch
fixing the formatting and rebase your work on top of that.
-->8--
Once this is merged, I plan on setting a up an `ignoreRevsFile`
config so that git-blame ignores this commit, as described here:
https://github.com/psf/black#migrating-your-code-style-without-ruining-git-blame
I also plan on working on a git commit hook (checked in the repo) to
automatically check the formatting of the Python files on commit.
[1] https://pypi.org/project/black/
[2] https://sourceware.org/gdb/wiki/Internals%20GDB-Python-Coding-Standards
gdb/ChangeLog:
* Re-format all Python files using black.
gdb/testsuite/ChangeLog:
* Re-format all Python files using black.
* gdb.python/py-prettyprint.exp (run_lang_tests): Adjust.
Change-Id: I28588a22c2406afd6bc2703774ddfff47cd61919
95 lines
3 KiB
Python
95 lines
3 KiB
Python
# Copyright (C) 2015-2021 Free Software Foundation, Inc.
|
|
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""Unwinder class and register_unwinder function."""
|
|
|
|
import gdb
|
|
|
|
|
|
class Unwinder(object):
|
|
"""Base class (or a template) for frame unwinders written in Python.
|
|
|
|
An unwinder has a single method __call__ and the attributes
|
|
described below.
|
|
|
|
Attributes:
|
|
name: The name of the unwinder.
|
|
enabled: A boolean indicating whether the unwinder is enabled.
|
|
"""
|
|
|
|
def __init__(self, name):
|
|
"""Constructor.
|
|
|
|
Args:
|
|
name: An identifying name for the unwinder.
|
|
"""
|
|
self.name = name
|
|
self.enabled = True
|
|
|
|
def __call__(self, pending_frame):
|
|
"""GDB calls this method to unwind a frame.
|
|
|
|
Arguments:
|
|
pending_frame: gdb.PendingFrame instance.
|
|
|
|
Returns:
|
|
gdb.UnwindInfo instance.
|
|
"""
|
|
raise NotImplementedError("Unwinder __call__.")
|
|
|
|
|
|
def register_unwinder(locus, unwinder, replace=False):
|
|
"""Register unwinder in given locus.
|
|
|
|
The unwinder is prepended to the locus's unwinders list. Unwinder
|
|
name should be unique.
|
|
|
|
Arguments:
|
|
locus: Either an objfile, progspace, or None (in which case
|
|
the unwinder is registered globally).
|
|
unwinder: An object of a gdb.Unwinder subclass
|
|
replace: If True, replaces existing unwinder with the same name.
|
|
Otherwise, raises exception if unwinder with the same
|
|
name already exists.
|
|
|
|
Returns:
|
|
Nothing.
|
|
|
|
Raises:
|
|
RuntimeError: Unwinder name is not unique
|
|
TypeError: Bad locus type
|
|
"""
|
|
if locus is None:
|
|
if gdb.parameter("verbose"):
|
|
gdb.write("Registering global %s unwinder ...\n" % unwinder.name)
|
|
locus = gdb
|
|
elif isinstance(locus, gdb.Objfile) or isinstance(locus, gdb.Progspace):
|
|
if gdb.parameter("verbose"):
|
|
gdb.write(
|
|
"Registering %s unwinder for %s ...\n" % (unwinder.name, locus.filename)
|
|
)
|
|
else:
|
|
raise TypeError("locus should be gdb.Objfile or gdb.Progspace or None")
|
|
|
|
i = 0
|
|
for needle in locus.frame_unwinders:
|
|
if needle.name == unwinder.name:
|
|
if replace:
|
|
del locus.frame_unwinders[i]
|
|
else:
|
|
raise RuntimeError("Unwinder %s already exists." % unwinder.name)
|
|
i += 1
|
|
locus.frame_unwinders.insert(0, unwinder)
|
|
gdb.invalidate_cached_frames()
|