mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

gh-39615: Add warnings.warn() skip_file_prefixes support (#100840)

Browse source 
`warnings.warn()` gains the ability to skip stack frames based on code
filename prefix rather than only a numeric `stacklevel=` via a new
`skip_file_prefixes=` keyword argument.
This commit is contained in:
Gregory P. Smith 2023-01-27 18:35:14 -08:00 • committed by GitHub
parent 8cef9c0f92
commit 052f53d65d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 264 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

50
Python/clinic/_warnings.c.h generated
View file

@ -9,17 +9,32 @@ preserve
PyDoc_STRVAR(warnings_warn__doc__,
"warn($module, /, message, category=None, stacklevel=1, source=None)\n"
"warn($module, /, message, category=None, stacklevel=1, source=None, *,\n"
" skip_file_prefixes=<unrepresentable>)\n"
"--\n"
"\n"
"Issue a warning, or maybe ignore it or raise an exception.");
"Issue a warning, or maybe ignore it or raise an exception.\n"
"\n"
" message\n"
" Text of the warning message.\n"
" category\n"
" The Warning category subclass. Defaults to UserWarning.\n"
" stacklevel\n"
" How far up the call stack to make this warning appear. A value of 2 for\n"
" example attributes the warning to the caller of the code calling warn().\n"
" source\n"
" If supplied, the destroyed object which emitted a ResourceWarning\n"
" skip_file_prefixes\n"
" An optional tuple of module filename prefixes indicating frames to skip\n"
" during stacklevel computations for stack frame attribution.");
#define WARNINGS_WARN_METHODDEF \
{"warn", _PyCFunction_CAST(warnings_warn), METH_FASTCALL|METH_KEYWORDS, warnings_warn__doc__},
static PyObject *
warnings_warn_impl(PyObject *module, PyObject *message, PyObject *category,
Py_ssize_t stacklevel, PyObject *source);
Py_ssize_t stacklevel, PyObject *source,
PyTupleObject *skip_file_prefixes);
static PyObject *
warnings_warn(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
@ -27,14 +42,14 @@ warnings_warn(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObjec
PyObject *return_value = NULL;
#if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
#define NUM_KEYWORDS 4
#define NUM_KEYWORDS 5
static struct {
PyGC_Head _this_is_not_used;
PyObject_VAR_HEAD
PyObject *ob_item[NUM_KEYWORDS];
} _kwtuple = {
.ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
.ob_item = { &_Py_ID(message), &_Py_ID(category), &_Py_ID(stacklevel), &_Py_ID(source), },
.ob_item = { &_Py_ID(message), &_Py_ID(category), &_Py_ID(stacklevel), &_Py_ID(source), &_Py_ID(skip_file_prefixes), },
};
#undef NUM_KEYWORDS
#define KWTUPLE (&_kwtuple.ob_base.ob_base)
@ -43,19 +58,20 @@ warnings_warn(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObjec
# define KWTUPLE NULL
#endif // !Py_BUILD_CORE
static const char * const _keywords[] = {"message", "category", "stacklevel", "source", NULL};
static const char * const _keywords[] = {"message", "category", "stacklevel", "source", "skip_file_prefixes", NULL};
static _PyArg_Parser _parser = {
.keywords = _keywords,
.fname = "warn",
.kwtuple = KWTUPLE,
};
#undef KWTUPLE
PyObject *argsbuf[4];
PyObject *argsbuf[5];
Py_ssize_t noptargs = nargs + (kwnames ? PyTuple_GET_SIZE(kwnames) : 0) - 1;
PyObject *message;
PyObject *category = Py_None;
Py_ssize_t stacklevel = 1;
PyObject *source = Py_None;
PyTupleObject *skip_file_prefixes = NULL;
args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser, 1, 4, 0, argsbuf);
if (!args) {
@ -88,9 +104,23 @@ warnings_warn(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObjec
goto skip_optional_pos;
}
}
source = args[3];
if (args[3]) {
source = args[3];
if (!--noptargs) {
goto skip_optional_pos;
}
}
skip_optional_pos:
return_value = warnings_warn_impl(module, message, category, stacklevel, source);
if (!noptargs) {
goto skip_optional_kwonly;
}
if (!PyTuple_Check(args[4])) {
_PyArg_BadArgument("warn", "argument 'skip_file_prefixes'", "tuple", args[4]);
goto exit;
}
skip_file_prefixes = (PyTupleObject *)args[4];
skip_optional_kwonly:
return_value = warnings_warn_impl(module, message, category, stacklevel, source, skip_file_prefixes);
exit:
return return_value;
@ -216,4 +246,4 @@ warnings_filters_mutated(PyObject *module, PyObject *Py_UNUSED(ignored))
{
return warnings_filters_mutated_impl(module);
}
/*[clinic end generated code: output=0d264d1ddfc37100 input=a9049054013a1b77]*/
/*[clinic end generated code: output=20429719d7223bdc input=a9049054013a1b77]*/