Skip to content

gh-126579: Adapt sys.audit() to Argument Clinic #126580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
serhiy-storchaka merged 1 commit into from
Nov 8, 2024
Merged

gh-126579: Adapt sys.audit() to Argument Clinic #126580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 50 additions & 1 deletion Python/clinic/sysmodule.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 13 additions & 41 deletions Python/sysmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,56 +499,28 @@ sys_addaudithook_impl(PyObject *module, PyObject *hook)
Py_RETURN_NONE;
}

PyDoc_STRVAR(audit_doc,
"audit($module, event, /, *args)\n\
--\n\
\n\
Passes the event to any audit hooks that are attached.");
/*[clinic input]
sys.audit

event: str
/
*args: tuple

Passes the event to any audit hooks that are attached.
Comment thread
erlend-aasland marked this conversation as resolved.
[clinic start generated code]*/

static PyObject *
sys_audit(PyObject *self, PyObject *const *args, Py_ssize_t argc)
sys_audit_impl(PyObject *module, const char *event, PyObject *args)
/*[clinic end generated code: output=1d0fc82da768f49d input=ec3b688527945109]*/
{
PyThreadState *tstate = _PyThreadState_GET();
_Py_EnsureTstateNotNULL(tstate);

if (argc == 0) {
_PyErr_SetString(tstate, PyExc_TypeError,
"audit() missing 1 required positional argument: "
"'event'");
return NULL;
}

assert(args[0] != NULL);

if (!should_audit(tstate->interp)) {
Py_RETURN_NONE;
}

PyObject *auditEvent = args[0];
if (!auditEvent) {
_PyErr_SetString(tstate, PyExc_TypeError,
"expected str for argument 'event'");
return NULL;
}
if (!PyUnicode_Check(auditEvent)) {
_PyErr_Format(tstate, PyExc_TypeError,
"expected str for argument 'event', not %.200s",
Py_TYPE(auditEvent)->tp_name);
return NULL;
}
const char *event = PyUnicode_AsUTF8(auditEvent);
if (!event) {
return NULL;
}

PyObject *auditArgs = _PyTuple_FromArray(args + 1, argc - 1);
if (!auditArgs) {
return NULL;
}

int res = _PySys_Audit(tstate, event, "O", auditArgs);
Py_DECREF(auditArgs);

int res = _PySys_Audit(tstate, event, "O", args);
if (res < 0) {
return NULL;
}
Expand Down Expand Up @@ -2564,7 +2536,7 @@ PyAPI_FUNC(int) PyUnstable_CopyPerfMapFile(const char* parent_filename) {
static PyMethodDef sys_methods[] = {
/* Might as well keep this in alphabetic order */
SYS_ADDAUDITHOOK_METHODDEF
{"audit", _PyCFunction_CAST(sys_audit), METH_FASTCALL, audit_doc },
SYS_AUDIT_METHODDEF
{"breakpointhook", _PyCFunction_CAST(sys_breakpointhook),
METH_FASTCALL | METH_KEYWORDS, breakpointhook_doc},
SYS__CLEAR_INTERNAL_CACHES_METHODDEF
Expand Down