Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit deb92b5

Browse files
birkenfeldbirkenfeld
committed
Closes #15969: rename new API to have consistent names in the faulthandler module.
1 parent ebf7f95 commit deb92b5

4 files changed

Lines changed: 41 additions & 37 deletions

File tree

‎Doc/library/faulthandler.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Fault handler state
7171
Dump the tracebacks after a timeout
7272
-----------------------------------
7373

74-
.. function:: dump_tracebacks_later(timeout, repeat=False, file=sys.stderr, exit=False)
74+
.. function:: dump_traceback_later(timeout, repeat=False, file=sys.stderr, exit=False)
7575

7676
Dump the tracebacks of all threads, after a timeout of *timeout* seconds, or
7777
every *timeout* seconds if *repeat* is ``True``. If *exit* is ``True``, call
@@ -84,9 +84,9 @@ Dump the tracebacks after a timeout
8484
This function is implemented using a watchdog thread and therefore is not
8585
available if Python is compiled with threads disabled.
8686

87-
.. function:: cancel_dump_tracebacks_later()
87+
.. function:: cancel_dump_traceback_later()
8888

89-
Cancel the last call to :func:`dump_tracebacks_later`.
89+
Cancel the last call to :func:`dump_traceback_later`.
9090

9191

9292
Dump the traceback on a user signal
@@ -112,7 +112,7 @@ Dump the traceback on a user signal
112112
File descriptor issue
113113
---------------------
114114

115-
:func:`enable`, :func:`dump_tracebacks_later` and :func:`register` keep the
115+
:func:`enable`, :func:`dump_traceback_later` and :func:`register` keep the
116116
file descriptor of their *file* argument. If the file is closed and its file
117117
descriptor is reused by a new file, or if :func:`os.dup2` is used to replace
118118
the file descriptor, the traceback will be written into a different file. Call

‎Lib/test/test_faulthandler.py‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ def test_dump_traceback_threads_file(self):
407407
with temporary_filename() as filename:
408408
self.check_dump_traceback_threads(filename)
409409

410-
def _check_dump_tracebacks_later(self, repeat, cancel, filename, loops):
410+
def _check_dump_traceback_later(self, repeat, cancel, filename, loops):
411411
"""
412412
Check how many times the traceback is written in timeout x 2.5 seconds,
413413
or timeout x 3.5 seconds if cancel is True: 1, 2 or 3 times depending
@@ -422,11 +422,11 @@ def _check_dump_tracebacks_later(self, repeat, cancel, filename, loops):
422422
423423
def func(timeout, repeat, cancel, file, loops):
424424
for loop in range(loops):
425-
faulthandler.dump_tracebacks_later(timeout, repeat=repeat, file=file)
425+
faulthandler.dump_traceback_later(timeout, repeat=repeat, file=file)
426426
if cancel:
427-
faulthandler.cancel_dump_tracebacks_later()
427+
faulthandler.cancel_dump_traceback_later()
428428
time.sleep(timeout * 5)
429-
faulthandler.cancel_dump_tracebacks_later()
429+
faulthandler.cancel_dump_traceback_later()
430430
431431
timeout = {timeout}
432432
repeat = {repeat}
@@ -462,35 +462,35 @@ def func(timeout, repeat, cancel, file, loops):
462462
self.assertEqual(trace, '')
463463
self.assertEqual(exitcode, 0)
464464

465-
@unittest.skipIf(not hasattr(faulthandler, 'dump_tracebacks_later'),
466-
'need faulthandler.dump_tracebacks_later()')
467-
def check_dump_tracebacks_later(self, repeat=False, cancel=False,
465+
@unittest.skipIf(not hasattr(faulthandler, 'dump_traceback_later'),
466+
'need faulthandler.dump_traceback_later()')
467+
def check_dump_traceback_later(self, repeat=False, cancel=False,
468468
file=False, twice=False):
469469
if twice:
470470
loops = 2
471471
else:
472472
loops = 1
473473
if file:
474474
with temporary_filename() as filename:
475-
self._check_dump_tracebacks_later(repeat, cancel,
475+
self._check_dump_traceback_later(repeat, cancel,
476476
filename, loops)
477477
else:
478-
self._check_dump_tracebacks_later(repeat, cancel, None, loops)
478+
self._check_dump_traceback_later(repeat, cancel, None, loops)
479479

480-
def test_dump_tracebacks_later(self):
481-
self.check_dump_tracebacks_later()
480+
def test_dump_traceback_later(self):
481+
self.check_dump_traceback_later()
482482

483-
def test_dump_tracebacks_later_repeat(self):
484-
self.check_dump_tracebacks_later(repeat=True)
483+
def test_dump_traceback_later_repeat(self):
484+
self.check_dump_traceback_later(repeat=True)
485485

486-
def test_dump_tracebacks_later_cancel(self):
487-
self.check_dump_tracebacks_later(cancel=True)
486+
def test_dump_traceback_later_cancel(self):
487+
self.check_dump_traceback_later(cancel=True)
488488

489-
def test_dump_tracebacks_later_file(self):
490-
self.check_dump_tracebacks_later(file=True)
489+
def test_dump_traceback_later_file(self):
490+
self.check_dump_traceback_later(file=True)
491491

492-
def test_dump_tracebacks_later_twice(self):
493-
self.check_dump_tracebacks_later(twice=True)
492+
def test_dump_traceback_later_twice(self):
493+
self.check_dump_traceback_later(twice=True)
494494

495495
@unittest.skipIf(not hasattr(faulthandler, "register"),
496496
"need faulthandler.register")

‎Misc/NEWS‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ Extension Modules
2828
- Issue #15977: Fix memory leak in Modules/_ssl.c when the function
2929
_set_npn_protocols() is called multiple times, thanks to Daniel Sommermann.
3030

31+
- Issue #5969: faulthandler module: rename dump_tracebacks_later() to
32+
dump_traceback_later() and cancel_dump_tracebacks_later() to
33+
cancel_dump_traceback_later().
34+
3135

3236
What's New in Python 3.3.0 Release Candidate 2?
3337
===============================================

‎Modules/faulthandler.c‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ faulthandler_thread(void *unused)
462462
}
463463

464464
static void
465-
cancel_dump_tracebacks_later(void)
465+
cancel_dump_traceback_later(void)
466466
{
467467
/* Notify cancellation */
468468
PyThread_release_lock(thread.cancel_event);
@@ -509,7 +509,7 @@ format_timeout(double timeout)
509509
}
510510

511511
static PyObject*
512-
faulthandler_dump_tracebacks_later(PyObject *self,
512+
faulthandler_dump_traceback_later(PyObject *self,
513513
PyObject *args, PyObject *kwargs)
514514
{
515515
static char *kwlist[] = {"timeout", "repeat", "file", "exit", NULL};
@@ -524,7 +524,7 @@ faulthandler_dump_tracebacks_later(PyObject *self,
524524
size_t header_len;
525525

526526
if (!PyArg_ParseTupleAndKeywords(args, kwargs,
527-
"d|iOi:dump_tracebacks_later", kwlist,
527+
"d|iOi:dump_traceback_later", kwlist,
528528
&timeout, &repeat, &file, &exit))
529529
return NULL;
530530
if ((timeout * 1e6) >= (double) PY_TIMEOUT_MAX) {
@@ -552,7 +552,7 @@ faulthandler_dump_tracebacks_later(PyObject *self,
552552
header_len = strlen(header);
553553

554554
/* Cancel previous thread, if running */
555-
cancel_dump_tracebacks_later();
555+
cancel_dump_traceback_later();
556556

557557
Py_XDECREF(thread.file);
558558
Py_INCREF(file);
@@ -582,9 +582,9 @@ faulthandler_dump_tracebacks_later(PyObject *self,
582582
}
583583

584584
static PyObject*
585-
faulthandler_cancel_dump_tracebacks_later_py(PyObject *self)
585+
faulthandler_cancel_dump_traceback_later_py(PyObject *self)
586586
{
587-
cancel_dump_tracebacks_later();
587+
cancel_dump_traceback_later();
588588
Py_RETURN_NONE;
589589
}
590590
#endif /* FAULTHANDLER_LATER */
@@ -970,16 +970,16 @@ static PyMethodDef module_methods[] = {
970970
"dump the traceback of the current thread, or of all threads "
971971
"if all_threads is True, into file")},
972972
#ifdef FAULTHANDLER_LATER
973-
{"dump_tracebacks_later",
974-
(PyCFunction)faulthandler_dump_tracebacks_later, METH_VARARGS|METH_KEYWORDS,
975-
PyDoc_STR("dump_tracebacks_later(timeout, repeat=False, file=sys.stderrn, exit=False):\n"
973+
{"dump_traceback_later",
974+
(PyCFunction)faulthandler_dump_traceback_later, METH_VARARGS|METH_KEYWORDS,
975+
PyDoc_STR("dump_traceback_later(timeout, repeat=False, file=sys.stderrn, exit=False):\n"
976976
"dump the traceback of all threads in timeout seconds,\n"
977977
"or each timeout seconds if repeat is True. If exit is True, "
978978
"call _exit(1) which is not safe.")},
979-
{"cancel_dump_tracebacks_later",
980-
(PyCFunction)faulthandler_cancel_dump_tracebacks_later_py, METH_NOARGS,
981-
PyDoc_STR("cancel_dump_tracebacks_later():\ncancel the previous call "
982-
"to dump_tracebacks_later().")},
979+
{"cancel_dump_traceback_later",
980+
(PyCFunction)faulthandler_cancel_dump_traceback_later_py, METH_NOARGS,
981+
PyDoc_STR("cancel_dump_traceback_later():\ncancel the previous call "
982+
"to dump_traceback_later().")},
983983
#endif
984984

985985
#ifdef FAULTHANDLER_USER
@@ -1120,7 +1120,7 @@ void _PyFaulthandler_Fini(void)
11201120
#ifdef FAULTHANDLER_LATER
11211121
/* later */
11221122
if (thread.cancel_event) {
1123-
cancel_dump_tracebacks_later();
1123+
cancel_dump_traceback_later();
11241124
PyThread_release_lock(thread.cancel_event);
11251125
PyThread_free_lock(thread.cancel_event);
11261126
thread.cancel_event = NULL;

0 commit comments

Comments
 (0)