Merge pull request #1440 from davidhewitt/fix-multiple-kw-only-arg

pyfunction: refactor argument extraction

CHANGELOG.md

@@ -33,6 +33,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `PYO3_CROSS_LIB_DIR` enviroment variable no long required when compiling for x86-64 Python from macOS arm64 and reverse. [#1428](/~https://github.com/PyO3/pyo3/pull/1428)
 - Fix FFI definition `_PyEval_RequestCodeExtraIndex` which took an argument of the wrong type. [#1429](/~https://github.com/PyO3/pyo3/pull/1429)
 - Fix FFI definition `PyIndex_Check` missing with the `abi3` feature. [#1436](/~https://github.com/PyO3/pyo3/pull/1436)
+- Fix incorrect `TypeError` raised when keyword-only argument passed along with a positional argument in `*args`. [#1440](/~https://github.com/PyO3/pyo3/pull/1440)
+- Fix inability to use a named lifetime for `&PyTuple` of `*args` in `#[pyfunction]`. [#1440](/~https://github.com/PyO3/pyo3/pull/1440)
 
 ## [0.13.2] - 2021-02-12
 ### Packaging

examples/pyo3_benchmarks/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+authors = ["PyO3 Authors"]
+name = "pyo3-benchmarks"
+version = "0.1.0"
+description = "Python-based benchmarks for various PyO3 functionality"
+edition = "2018"
+
+[dependencies]
+
+[dependencies.pyo3]
+path = "../../"
+features = ["extension-module"]
+
+[lib]
+name = "_pyo3_benchmarks"
+crate-type = ["cdylib"]

examples/pyo3_benchmarks/MANIFEST.in

@@ -0,0 +1,2 @@
+include pyproject.toml Cargo.toml
+recursive-include src *

examples/pyo3_benchmarks/README.md

@@ -0,0 +1,17 @@
+# rustapi_module
+
+A simple extension module built using PyO3.
+
+## Build
+
+```shell
+python setup.py install
+```
+
+## Testing
+
+To test install tox globally and run
+
+```shell
+tox -e py
+```

examples/pyo3_benchmarks/pyo3_benchmarks/__init__.py

@@ -0,0 +1 @@
+from ._pyo3_benchmarks import *

examples/pyo3_benchmarks/requirements-dev.txt

@@ -0,0 +1,6 @@
+pip>=19.1
+hypothesis>=3.55
+pytest>=3.5.0
+setuptools-rust>=0.10.2
+psutil>=5.6
+pytest-benchmark~=3.2

examples/pyo3_benchmarks/setup.py

@@ -0,0 +1,44 @@
+import sys
+import platform
+
+from setuptools import setup
+from setuptools_rust import RustExtension
+
+
+def get_py_version_cfgs():
+    # For now each Cfg Py_3_X flag is interpreted as "at least 3.X"
+    version = sys.version_info[0:2]
+    py3_min = 6
+    out_cfg = []
+    for minor in range(py3_min, version[1] + 1):
+        out_cfg.append("--cfg=Py_3_%d" % minor)
+
+    if platform.python_implementation() == "PyPy":
+        out_cfg.append("--cfg=PyPy")
+
+    return out_cfg
+
+
+setup(
+    name="pyo3-benchmarks",
+    version="0.1.0",
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python",
+        "Programming Language :: Rust",
+        "Operating System :: POSIX",
+        "Operating System :: MacOS :: MacOS X",
+    ],
+    packages=["pyo3_benchmarks"],
+    rust_extensions=[
+        RustExtension(
+            "pyo3_benchmarks._pyo3_benchmarks",
+            rustc_flags=get_py_version_cfgs(),
+            debug=False,
+        ),
+    ],
+    include_package_data=True,
+    zip_safe=False,
+)

examples/pyo3_benchmarks/src/lib.rs

@@ -0,0 +1,33 @@
+use pyo3::prelude::*;
+use pyo3::types::{PyDict, PyTuple};
+use pyo3::wrap_pyfunction;
+
+#[pyfunction(args = "*", kwargs = "**")]
+fn args_and_kwargs<'a>(
+    args: &'a PyTuple,
+    kwargs: Option<&'a PyDict>,
+) -> (&'a PyTuple, Option<&'a PyDict>) {
+    (args, kwargs)
+}
+
+#[pyfunction(a, b = 2, args = "*", c = 4, kwargs = "**")]
+fn mixed_args<'a>(
+    a: i32,
+    b: i32,
+    args: &'a PyTuple,
+    c: i32,
+    kwargs: Option<&'a PyDict>,
+) -> (i32, i32, &'a PyTuple, i32, Option<&'a PyDict>) {
+    (a, b, args, c, kwargs)
+}
+
+#[pyfunction]
+fn no_args() {}
+
+#[pymodule]
+fn _pyo3_benchmarks(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
+    m.add_function(wrap_pyfunction!(args_and_kwargs, m)?)?;
+    m.add_function(wrap_pyfunction!(mixed_args, m)?)?;
+    m.add_function(wrap_pyfunction!(no_args, m)?)?;
+    Ok(())
+}

examples/pyo3_benchmarks/tests/test_benchmarks.py

@@ -0,0 +1,46 @@
+import pyo3_benchmarks
+
+
+def test_args_and_kwargs(benchmark):
+    benchmark(pyo3_benchmarks.args_and_kwargs, 1, 2, 3, a=4, foo=10)
+
+
+def args_and_kwargs_py(*args, **kwargs):
+    return (args, kwargs)
+
+
+def test_args_and_kwargs_py(benchmark):
+    rust = pyo3_benchmarks.args_and_kwargs(1, 2, 3, bar=4, foo=10)
+    py = args_and_kwargs_py(1, 2, 3, bar=4, foo=10)
+    assert rust == py
+    benchmark(args_and_kwargs_py, 1, 2, 3, bar=4, foo=10)
+
+
+def test_mixed_args(benchmark):
+    benchmark(pyo3_benchmarks.mixed_args, 1, 2, 3, bar=4, foo=10)
+
+
+def mixed_args_py(a, b=2, *args, c=4, **kwargs):
+    return (a, b, args, c, kwargs)
+
+
+def test_mixed_args_py(benchmark):
+    rust = pyo3_benchmarks.mixed_args(1, 2, 3, bar=4, foo=10)
+    py = mixed_args_py(1, 2, 3, bar=4, foo=10)
+    assert rust == py
+    benchmark(mixed_args_py, 1, 2, 3, bar=4, foo=10)
+
+
+def test_no_args(benchmark):
+    benchmark(pyo3_benchmarks.no_args)
+
+
+def no_args_py():
+    return None
+
+
+def test_no_args_py(benchmark):
+    rust = pyo3_benchmarks.no_args()
+    py = no_args_py()
+    assert rust == py
+    benchmark(no_args_py)

examples/pyo3_benchmarks/tox.ini

@@ -0,0 +1,10 @@
+[tox]
+# can't install from sdist because local pyo3 repo can't be included in the sdist
+skipsdist = true
+
+[testenv]
+description = Run the unit tests under {basepython}
+deps = -rrequirements-dev.txt
+commands =
+    python setup.py install
+    pytest {posargs}

examples/rustapi_module/tests/test_datetime.py

@@ -143,12 +143,11 @@ def test_time_fold(fold):
     assert t.fold == fold
 
 
-@pytest.mark.xfail
 @pytest.mark.parametrize(
     "args", [(-1, 0, 0, 0), (0, -1, 0, 0), (0, 0, -1, 0), (0, 0, 0, -1)]
 )
-def test_invalid_time_fails_xfail(args):
-    with pytest.raises(ValueError):
+def test_invalid_time_fails_overflow(args):
+    with pytest.raises(OverflowError):
         rdt.make_time(*args)
 
 

pyo3-macros-backend/src/module.rs

@@ -8,7 +8,7 @@ use crate::pymethod::get_arg_names;
 use crate::utils;
 use proc_macro2::{Span, TokenStream};
 use quote::{format_ident, quote};
-use syn::{spanned::Spanned, Ident};
+use syn::{spanned::Spanned, Ident, Result};
 
 /// Generates the function that is called by the python interpreter to initialize the native
 /// module
@@ -197,7 +197,7 @@ pub fn add_fn_to_module(
 
     let name = &func.sig.ident;
     let wrapper_ident = format_ident!("__pyo3_raw_{}", name);
-    let wrapper = function_c_wrapper(name, &wrapper_ident, &spec, pyfn_attrs.pass_module);
+    let wrapper = function_c_wrapper(name, &wrapper_ident, &spec, pyfn_attrs.pass_module)?;
     Ok(quote! {
         #wrapper
         pub(crate) fn #function_wrapper_ident<'a>(
@@ -223,7 +223,7 @@ fn function_c_wrapper(
     wrapper_ident: &Ident,
     spec: &method::FnSpec<'_>,
     pass_module: bool,
-) -> TokenStream {
+) -> Result<TokenStream> {
     let names: Vec<Ident> = get_arg_names(&spec);
     let cb;
     let slf_module;
@@ -240,8 +240,8 @@ fn function_c_wrapper(
         };
         slf_module = None;
     };
-    let body = pymethod::impl_arg_params(spec, None, cb);
-    quote! {
+    let body = pymethod::impl_arg_params(spec, None, cb)?;
+    Ok(quote! {
         unsafe extern "C" fn #wrapper_ident(
             _slf: *mut pyo3::ffi::PyObject,
             _args: *mut pyo3::ffi::PyObject,
@@ -256,5 +256,5 @@ fn function_c_wrapper(
                 #body
             })
         }
-    }
+    })
 }