Skip to content

Match CPython Clinic layout for 56 raw text signatures #9758

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

Draft
youknowdot wants to merge 5 commits into
base: main
Choose a base branch
from
+943 −227
Draft

Match CPython Clinic layout for 56 raw text signatures #9758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dfc44fd
Match CPython Clinic text signature line wrapping
youknowdot Nov 9, 2026
286292a
Limit platform-specific signature assertions to their targets
youknowdot Nov 9, 2026
ab00082
Generate module-bound decoder signatures through pyfunction
youknowdot Nov 10, 2026
c7002a2
Source binascii decoder documentation from rustpython-doc
youknowdot Nov 11, 2026
1ca28a0
Pass defining modules outside native Python arguments
youknowdot Nov 12, 2026
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
191 changes: 115 additions & 76 deletions crates/capi/src/methodobject.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ use crate::object::PyTypeObject;
use crate::object::define_py_check;
use crate::pystate::with_vm;
use crate::util::{CStrExt, FfiPtrExt};
use alloc::borrow::Cow;
use core::ffi::{c_char, c_int};
use core::fmt::Debug;
use rustpython_vm::function::{FuncArgs, HeapMethodDef, ItemDoc, PosArgs, PyMethodFlags};
use rustpython_vm::function::{Callee, FuncArgs, HeapMethodDef, ItemDoc, PosArgs, PyMethodFlags};
use rustpython_vm::types::c_slots::{kwargs_ptr, split_args};
use rustpython_vm::{AsObject, PyObjectRef, PyRef, PyResult, VirtualMachine};

Expand Down Expand Up @@ -68,57 +69,52 @@ impl PyMethodDef {

bitflags::bitflags_match!(call_flags, {
PyMethodFlags::NOARGS => {
if has_self {
let callable = move |zelf: PyObjectRef, vm: &VirtualMachine| unsafe {
let f = method.PyCFunction;
f(zelf.as_raw().cast_mut(), core::ptr::null_mut()).assume_owned_or_err(vm)
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
} else {
let callable = move |vm: &VirtualMachine| unsafe {
let f = method.PyCFunction;
f(core::ptr::null_mut(), core::ptr::null_mut()).assume_owned_or_err(vm)
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
}
let callable = move |vm: &VirtualMachine, mut args: FuncArgs, callee: Callee<'_>| {
let slf = take_self_arg(&mut args, has_self, callee);
args.bind_for::<()>(vm, callee.with_instance_arg(false))?;
let slf_ptr = self_ptr(slf.as_deref());
unsafe {
(method.PyCFunction)(slf_ptr, core::ptr::null_mut()).assume_owned_or_err(vm)
}
};
Ok(vm.ctx.new_raw_method_def(name, callable, flags, doc))
},
PyMethodFlags::VARARGS => {
let callable = move |args: PosArgs, vm: &VirtualMachine| unsafe {
call_function(vm, method, has_self, Some(args))
let callable = move |vm: &VirtualMachine, args: FuncArgs, callee: Callee<'_>| {
let (args,) = args.bind_for::<(PosArgs,)>(vm, callee)?;
unsafe { call_function(vm, method, has_self, args.into(), callee) }
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
Ok(vm.ctx.new_raw_method_def(name, callable, flags, doc))
},
PyMethodFlags::VARARGS | PyMethodFlags::KEYWORDS => {
let callable = move | args: FuncArgs, vm: &VirtualMachine| unsafe {
call_function_with_keywords(vm, method, has_self, args)
let callable = move |vm: &VirtualMachine, args: FuncArgs, callee: Callee<'_>| unsafe {
call_function_with_keywords(vm, method, has_self, args, callee)
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
Ok(vm.ctx.new_raw_method_def(name, callable, flags, doc))
},
PyMethodFlags::FASTCALL | PyMethodFlags::KEYWORDS => {
let callable = move |args: FuncArgs, vm: &VirtualMachine| unsafe {
call_fast_function_with_keywords(vm, method, has_self, args)
let callable = move |vm: &VirtualMachine, args: FuncArgs, callee: Callee<'_>| unsafe {
call_fast_function_with_keywords(vm, method, has_self, args, callee)
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
Ok(vm.ctx.new_raw_method_def(name, callable, flags, doc))
},
PyMethodFlags::FASTCALL => {
let callable = move |args: PosArgs, vm: &VirtualMachine| unsafe {
call_fast_function(vm, method, has_self, args)
let callable = move |vm: &VirtualMachine, args: FuncArgs, callee: Callee<'_>| {
let (args,) = args.bind_for::<(PosArgs,)>(vm, callee)?;
unsafe { call_fast_function(vm, method, has_self, args, callee) }
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
Ok(vm.ctx.new_raw_method_def(name, callable, flags, doc))
},
PyMethodFlags::O => {
let f = unsafe { method.PyCFunction };
if has_self {
let callable = move |zelf: PyObjectRef, arg: PyObjectRef, vm: &VirtualMachine| -> PyResult {
unsafe { f(zelf.as_raw().cast_mut(), arg.as_raw().cast_mut()).assume_owned_or_err(vm) }
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
} else {
let callable = move |arg: PyObjectRef, vm: &VirtualMachine| -> PyResult {
unsafe { f(core::ptr::null_mut(), arg.as_raw().cast_mut()).assume_owned_or_err(vm) }
};
Ok(vm.ctx.new_method_def(name, callable, flags, doc))
}
let callable = move |vm: &VirtualMachine, mut args: FuncArgs, callee: Callee<'_>| {
let slf = take_self_arg(&mut args, has_self, callee);
let (arg,) = args.bind_for::<(PyObjectRef,)>(vm, callee.with_instance_arg(false))?;
let slf_ptr = self_ptr(slf.as_deref());
unsafe {
(method.PyCFunction)(slf_ptr, arg.as_raw().cast_mut()).assume_owned_or_err(vm)
}
};
Ok(vm.ctx.new_raw_method_def(name, callable, flags, doc))
},
_ => {
Err(vm.new_system_error(format!(
Expand Down Expand Up @@ -167,46 +163,30 @@ impl Debug for PyMethodPointer {
}
}

unsafe fn call_function<A: Into<FuncArgs>>(
unsafe fn call_function(
vm: &VirtualMachine,
method: PyMethodPointer,
has_self: bool,
args: Option<A>,
mut args: FuncArgs,
callee: Callee<'_>,
) -> PyResult {
let f = unsafe { method.PyCFunction };
let (slf, arg_tuple) = if let Some(mut args) = args.map(Into::into) {
let slf = take_self_arg(&mut args, has_self);
let arg_tuple = vm.ctx.new_tuple(args.args);
(slf, Some(arg_tuple))
} else {
(None, None)
};

let slf_ptr = slf
.as_ref()
.map(|obj| obj.as_object().as_raw().cast_mut())
.unwrap_or_default();

let arg_ptr = arg_tuple
.as_ref()
.map(|tuple| tuple.as_object().as_raw().cast_mut())
.unwrap_or_default();

unsafe { f(slf_ptr, arg_ptr).assume_owned_or_err(vm) }
let slf = take_self_arg(&mut args, has_self, callee);
let arg_tuple = vm.ctx.new_tuple(args.args);
let slf_ptr = self_ptr(slf.as_deref());
unsafe { f(slf_ptr, arg_tuple.as_object().as_raw().cast_mut()).assume_owned_or_err(vm) }
}

unsafe fn call_function_with_keywords(
vm: &VirtualMachine,
method: PyMethodPointer,
has_self: bool,
mut args: FuncArgs,
callee: Callee<'_>,
) -> PyResult {
let f = unsafe { method.PyCFunctionWithKeywords };
let slf = take_self_arg(&mut args, has_self);
let slf_ptr = slf
.as_ref()
.map(|obj| obj.as_object().as_raw().cast_mut())
.unwrap_or_default();
let slf = take_self_arg(&mut args, has_self, callee);
let slf_ptr = self_ptr(slf.as_deref());
let (arg_tuple, kwargs) = split_args(vm, args)?;
unsafe {
f(
Expand All @@ -223,13 +203,11 @@ unsafe fn call_fast_function_with_keywords(
method: PyMethodPointer,
has_self: bool,
mut args: FuncArgs,
callee: Callee<'_>,
) -> PyResult {
let f = unsafe { method.PyCFunctionFastWithKeywords };
let slf = take_self_arg(&mut args, has_self);
let slf_ptr = slf
.as_ref()
.map(|obj| obj.as_object().as_raw().cast_mut())
.unwrap_or_default();
let slf = take_self_arg(&mut args, has_self, callee);
let slf_ptr = self_ptr(slf.as_deref());
let nargs = args.args.len();
let mut fastcall_args = args.args;
let kwnames_tuple = if !args.kwargs.is_empty() {
Expand Down Expand Up @@ -258,29 +236,37 @@ unsafe fn call_fast_function(
method: PyMethodPointer,
has_self: bool,
args: PosArgs,
callee: Callee<'_>,
) -> PyResult {
let f = unsafe { method.PyCFunctionFast };
let mut args: FuncArgs = args.into();
let slf = take_self_arg(&mut args, has_self);
let slf_ptr = slf
.as_ref()
.map(|obj| obj.as_object().as_raw().cast_mut())
.unwrap_or_default();
let slf = take_self_arg(&mut args, has_self, callee);
let slf_ptr = self_ptr(slf.as_deref());
// SAFETY: PyObjectRef is repr(transparent) over a pointer to PyObject, so a
// Vec<PyObjectRef> has a layout-compatible contiguous backing buffer. The
// vector is kept alive for the duration of the call.
let fastcall_arg_ptrs = args.args.as_mut_ptr().cast::<*mut PyObject>();
unsafe { f(slf_ptr, fastcall_arg_ptrs, args.args.len() as isize).assume_owned_or_err(vm) }
}

fn take_self_arg(args: &mut FuncArgs, has_self: bool) -> Option<PyObjectRef> {
fn take_self_arg<'a>(
args: &mut FuncArgs,
has_self: bool,
callee: Callee<'a>,
) -> Option<Cow<'a, rustpython_vm::PyObject>> {
if !has_self {
None
} else if let Some(module) = callee.module() {
Some(Cow::Borrowed(module.as_object()))
} else {
args.take_positional()
args.take_positional().map(Cow::Owned)
}
}

fn self_ptr(slf: Option<&rustpython_vm::PyObject>) -> *mut PyObject {
slf.map_or(core::ptr::null_mut(), |obj| obj.as_raw().cast_mut())
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyCMethod_New(
ml: *mut PyMethodDef,
Expand Down Expand Up @@ -406,6 +392,59 @@ mod tests {
});
}

#[test]
fn module_receiver_is_not_a_python_argument() {
#[pyfunction(pass_module)]
fn module_noargs(module: &Bound<'_, PyModule>) -> Py<PyModule> {
module.clone().unbind()
}

#[pyfunction(pass_module, signature = (value, /))]
fn module_one(module: &Bound<'_, PyModule>, value: i64) -> (Py<PyModule>, i64) {
(module.clone().unbind(), value)
}

#[pyfunction(pass_module, signature = (*args, **kwargs))]
fn module_variadic(
module: &Bound<'_, PyModule>,
args: &Bound<'_, pyo3::types::PyTuple>,
kwargs: Option<&Bound<'_, pyo3::types::PyDict>>,
) -> (Py<PyModule>, usize, usize) {
(
module.clone().unbind(),
args.len(),
kwargs.map_or(0, |kwargs| kwargs.len()),
)
}

Python::attach(|py| {
let module = PyModule::new(py, "receiver_module").unwrap();
let noargs = wrap_pyfunction!(module_noargs, &module).unwrap();
assert!(noargs.getattr("__self__").unwrap().is(&module));
assert!(noargs.call0().unwrap().is(&module));
assert!(noargs.call1((1,)).is_err());

let one = wrap_pyfunction!(module_one, &module).unwrap();
let (receiver, value): (Py<PyModule>, i64) =
one.call1((7,)).unwrap().extract().unwrap();
assert!(receiver.bind(py).is(&module));
assert_eq!(value, 7);
assert!(one.call0().is_err());
assert!(one.call1((7, 8)).is_err());

let variadic = wrap_pyfunction!(module_variadic, &module).unwrap();
let kwargs = pyo3::types::PyDict::new(py);
kwargs.set_item("keyword", 3).unwrap();
let (receiver, positional, keywords): (Py<PyModule>, usize, usize) = variadic
.call((1, 2), Some(&kwargs))
.unwrap()
.extract()
.unwrap();
assert!(receiver.bind(py).is(&module));
assert_eq!((positional, keywords), (2, 1));
});
}

#[test]
fn no_keywords_before_arity() {
Python::attach(|py| {
Expand Down
4 changes: 2 additions & 2 deletions crates/derive-impl/src/from_args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -894,7 +894,7 @@ fn impl_borrowed_from_args(input: &DeriveInput, fields: &syn::Fields) -> Result<
fn bind<#lifetime>(
args: &#lifetime ::rustpython_vm::function::FuncArgs,
vm: &::rustpython_vm::VirtualMachine,
callee: ::rustpython_vm::function::Callee,
callee: ::rustpython_vm::function::Callee<'_>,
) -> ::rustpython_vm::PyResult<Self::Bound<#lifetime>> {
let slots = args.bind_borrowed::<#n, Self>(vm, callee)?;
Ok(#name { #(#values)* })
Expand Down Expand Up @@ -995,7 +995,7 @@ pub(crate) fn impl_from_args(input: DeriveInput) -> Result<TokenStream> {
_: &::std::ops::RangeInclusive<usize>,
_: usize,
_: usize,
_: ::rustpython_vm::function::Callee,
_: ::rustpython_vm::function::Callee<'_>,
_: &::rustpython_vm::VirtualMachine,
) -> ::core::option::Option<::rustpython_vm::builtins::PyBaseExceptionRef> {
None
Expand Down
18 changes: 15 additions & 3 deletions crates/derive-impl/src/pymodule.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,7 @@ struct FunctionNurseryItem {
ident: Ident,
/// One internal doc per [`py_names`](Self::py_names) entry.
docs: Vec<TokenStream>,
binds_module: bool,
}

impl FunctionNursery {
Expand Down Expand Up @@ -569,12 +570,17 @@ impl ToTokens for ValidatedFunctionNursery {
let ident = &item.ident;
let cfgs = &item.cfgs;
let cfgs = quote!(#(#cfgs)*);
let function = if item.binds_module {
quote!(rustpython_vm::function::ModuleFunction(#ident))
} else {
quote!(#ident)
};
for (py_name, doc) in item.py_names.iter().zip(&item.docs) {
inner_tokens.extend(quote![
#cfgs
rustpython_vm::function::PyMethodDef::new_const(
#py_name,
#ident,
#function,
rustpython_vm::function::PyMethodFlags::empty(),
#doc,
),
Expand Down Expand Up @@ -678,6 +684,7 @@ impl ModuleItem for FunctionItem {

let py_name = item_meta.simple_name()?;
let mut flags_signatures = vec![item_meta.signature_from_flags()?];
let binds_module = crate::util::has_module_receiver(func.sig())?;
let mut py_names = vec![py_name];
for attr_index in self.py_attrs.iter().rev() {
let mut loop_unit = || {
Expand All @@ -699,6 +706,10 @@ impl ModuleItem for FunctionItem {
args.context.errors.ok_or_push(r);
}

let mut doc_signature = func.sig().clone();
if binds_module {
doc_signature.inputs = doc_signature.inputs.into_iter().skip(1).collect();
}
let module = args.doc_module();
let rust_doc = args.attrs.doc().filter(|doc| !doc.is_empty());
let docs = py_names
Expand All @@ -714,9 +725,9 @@ impl ModuleItem for FunctionItem {
};
let doc = crate::class_docs::item_doc_tokens(db_doc, rust_doc.clone());
if from_flags {
flags_signature_doc_tokens(func.sig(), py_name, doc)
flags_signature_doc_tokens(&doc_signature, py_name, doc)
} else {
internal_doc_tokens(func.sig(), py_name, None, doc, None, Some("$module"))
internal_doc_tokens(&doc_signature, py_name, None, doc, None, Some("$module"))
}
})
.collect();
Expand All @@ -726,6 +737,7 @@ impl ModuleItem for FunctionItem {
py_names,
cfgs: args.cfgs.to_vec(),
docs,
binds_module,
});
Ok(())
}
Expand Down
Loading
Loading