forked from Imagelibrary/binutils-gdb
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
80 lines
2.8 KiB
Python
80 lines
2.8 KiB
Python
# Copyright (C) 2013-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/>.
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import perftest.testresult as testresult
|
|
import perftest.reporter as reporter
|
|
from perftest.measure import Measure
|
|
from perftest.measure import MeasurementCpuTime
|
|
from perftest.measure import MeasurementWallTime
|
|
from perftest.measure import MeasurementVmSize
|
|
|
|
|
|
class TestCase(object):
|
|
"""Base class of all performance testing cases.
|
|
|
|
Each sub-class should override methods execute_test, in which
|
|
several GDB operations are performed and measured by attribute
|
|
measure. Sub-class can also override method warm_up optionally
|
|
if the test case needs warm up.
|
|
"""
|
|
|
|
def __init__(self, name, measure):
|
|
"""Constructor of TestCase.
|
|
|
|
Construct an instance of TestCase with a name and a measure
|
|
which is to measure the test by several different measurements.
|
|
"""
|
|
|
|
self.name = name
|
|
self.measure = measure
|
|
|
|
def execute_test(self):
|
|
"""Abstract method to do the actual tests."""
|
|
raise NotImplementedError("Abstract Method.")
|
|
|
|
def warm_up(self):
|
|
"""Do some operations to warm up the environment."""
|
|
pass
|
|
|
|
def run(self, warm_up=True, append=True):
|
|
"""Run this test case.
|
|
|
|
It is a template method to invoke method warm_up,
|
|
execute_test, and finally report the measured results.
|
|
If parameter warm_up is True, run method warm_up. If parameter
|
|
append is True, the test result will be appended instead of
|
|
overwritten.
|
|
"""
|
|
if warm_up:
|
|
self.warm_up()
|
|
|
|
self.execute_test()
|
|
self.measure.report(reporter.TextReporter(append), self.name)
|
|
|
|
|
|
class TestCaseWithBasicMeasurements(TestCase):
|
|
"""Test case measuring CPU time, wall time and memory usage."""
|
|
|
|
def __init__(self, name):
|
|
result_factory = testresult.SingleStatisticResultFactory()
|
|
measurements = [
|
|
MeasurementCpuTime(result_factory.create_result()),
|
|
MeasurementWallTime(result_factory.create_result()),
|
|
MeasurementVmSize(result_factory.create_result()),
|
|
]
|
|
super(TestCaseWithBasicMeasurements, self).__init__(name, Measure(measurements))
|