test: Adds test-cases for kwargs / args (#260)

Eventually fixes #259, but this contains only a reproducer for `*args`
and `**kwargs`.

---------

Co-authored-by: Toshiki Teramura <toshiki.teramura@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

examples/pure/pure.pyi

@@ -241,6 +241,16 @@ def echo_path(path:builtins.str | os.PathLike | pathlib.Path) -> pathlib.Path: .
 
 def fn_override_type(cb:collections.abc.Callable[[str]]) -> collections.abc.Callable[[str]]: ...
 
+def func_with_kwargs(**kwargs) -> builtins.bool:
+    r"""
+    Takes a variable number of keyword arguments and does nothing
+    """
+
+def func_with_star_arg(*args) -> builtins.str:
+    r"""
+    Takes a variable number of arguments and returns their string representation.
+    """
+
 @typing.overload
 def overload_example_1(x:builtins.int) -> builtins.int: ...
 

examples/pure/src/lib.rs

@@ -539,6 +539,24 @@ submit! {
     }
 }
 
+// These are the tests to test the treatment of `*args` and `**kwargs` in functions
+
+/// Takes a variable number of arguments and returns their string representation.
+#[gen_stub_pyfunction]
+#[pyfunction]
+#[pyo3(signature = (*args))]
+fn func_with_star_arg(args: &Bound<PyTuple>) -> String {
+    args.to_string()
+}
+
+/// Takes a variable number of keyword arguments and does nothing
+#[gen_stub_pyfunction]
+#[pyfunction]
+#[pyo3(signature = (**kwargs))]
+fn func_with_kwargs(kwargs: Option<&Bound<PyDict>>) -> bool {
+    kwargs.is_some()
+}
+
 /// Initializes the Python module
 #[pymodule]
 fn pure(m: &Bound<PyModule>) -> PyResult<()> {
@@ -569,6 +587,9 @@ fn pure(m: &Bound<PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(fn_override_type, m)?)?;
     m.add_function(wrap_pyfunction!(overload_example_1, m)?)?;
     m.add_function(wrap_pyfunction!(overload_example_2, m)?)?;
+    // Test-cases for `*args` and `**kwargs`
+    m.add_function(wrap_pyfunction!(func_with_star_arg, m)?)?;
+    m.add_function(wrap_pyfunction!(func_with_kwargs, m)?)?;
     Ok(())
 }
 

pyo3-stub-gen-derive/src/gen_stub/signature.rs

@@ -191,15 +191,15 @@ impl ToTokens for ArgsWithSignature<'_> {
                         ::pyo3_stub_gen::type_info::ArgInfo {
                             name: #name,
                             r#type: <#r#type as ::pyo3_stub_gen::PyStubType>::type_input,
-                            signature: Some(pyo3_stub_gen::type_info::SignatureArg::Ident),
+                            signature: Some(pyo3_stub_gen::type_info::SignatureArg::Args),
                         }}),
                         Some(ArgInfo { name, r#type: TypeOrOverride::OverrideType{ type_repr, imports, .. }}) => {
                             let imports = imports.iter().collect::<Vec<&String>>();
                             Ok(quote! {
                             ::pyo3_stub_gen::type_info::ArgInfo {
                                 name: #name,
                                 r#type: || ::pyo3_stub_gen::TypeInfo { name: #type_repr.to_string(), import: ::std::collections::HashSet::from([#(#imports.into(),)*]) },
-                                signature: Some(pyo3_stub_gen::type_info::SignatureArg::Ident),
+                                signature: Some(pyo3_stub_gen::type_info::SignatureArg::Args),
                             }})
                         },
                         None => Err(syn::Error::new(ident.span(), format!("can not find argument: {ident}")))
@@ -212,15 +212,15 @@ impl ToTokens for ArgsWithSignature<'_> {
                         ::pyo3_stub_gen::type_info::ArgInfo {
                             name: #name,
                             r#type: <#r#type as ::pyo3_stub_gen::PyStubType>::type_input,
-                            signature: Some(pyo3_stub_gen::type_info::SignatureArg::Ident),
+                            signature: Some(pyo3_stub_gen::type_info::SignatureArg::Keywords),
                         }}),
                         Some(ArgInfo { name, r#type: TypeOrOverride::OverrideType{ type_repr, imports, .. }}) => {
                             let imports = imports.iter().collect::<Vec<&String>>();
                             Ok(quote! {
                             ::pyo3_stub_gen::type_info::ArgInfo {
                                 name: #name,
                                 r#type: || ::pyo3_stub_gen::TypeInfo { name: #type_repr.to_string(), import: ::std::collections::HashSet::from([#(#imports.into(),)*]) },
-                                signature: Some(pyo3_stub_gen::type_info::SignatureArg::Ident),
+                                signature: Some(pyo3_stub_gen::type_info::SignatureArg::Keywords),
                             }})
                         },
                         None => Err(syn::Error::new(ident.span(), format!("can not find argument: {ident}")))