Skip to content

Refactoring of FnArg #4033

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
merged 7 commits into from
Apr 14, 2024
Merged

Refactoring of FnArg #4033

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
deec739
refactor `FnArg`
Icxolu Mar 31, 2024
3087e6d
add UI tests
Icxolu Apr 1, 2024
b97d2c4
use enum variant types
Icxolu Apr 2, 2024
f578da1
add comment
Icxolu Apr 2, 2024
7c924e9
remove dead code
Icxolu Apr 2, 2024
e764067
remove last FIXME
Icxolu Apr 3, 2024
68bff0f
review feedback davidhewitt
Icxolu Apr 14, 2024
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
91 changes: 57 additions & 34 deletions pyo3-macros-backend/src/method.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,20 @@ use crate::{
pub struct FnArg<'a> {
pub name: &'a syn::Ident,
pub ty: &'a syn::Type,
pub optional: Option<&'a syn::Type>,
pub default: Option<syn::Expr>,
pub py: bool,
pub attrs: PyFunctionArgPyO3Attributes,
pub is_varargs: bool,
pub is_kwargs: bool,
pub is_cancel_handle: bool,
pub kind: FnArgKind<'a>,
}

#[derive(Clone, Debug)]
pub enum FnArgKind<'a> {
Regular {
default: Option<syn::Expr>,
ty_opt: Option<&'a syn::Type>,
},
VarArgs,
KwArgs,
Py,
CancelHandle,
}

impl<'a> FnArg<'a> {
Expand All @@ -47,26 +54,36 @@ impl<'a> FnArg<'a> {
other => return Err(handle_argument_error(other)),
};

let is_cancel_handle = arg_attrs.cancel_handle.is_some();
if utils::is_python(&cap.ty) {
return Ok(Self {
name: ident,
ty: &cap.ty,
attrs: arg_attrs,
kind: FnArgKind::Py,
});
}

if arg_attrs.cancel_handle.is_some() {
return Ok(Self {
name: ident,
ty: &cap.ty,
attrs: arg_attrs,
kind: FnArgKind::CancelHandle,
});
}

Ok(FnArg {
Ok(Self {
name: ident,
ty: &cap.ty,
optional: utils::option_type_argument(&cap.ty),
default: None,
py: utils::is_python(&cap.ty),
attrs: arg_attrs,
is_varargs: false,
is_kwargs: false,
is_cancel_handle,
kind: FnArgKind::Regular {
default: None,
ty_opt: utils::option_type_argument(&cap.ty),
},
})
}
}
}

pub fn is_regular(&self) -> bool {
!self.py && !self.is_cancel_handle && !self.is_kwargs && !self.is_varargs
}
}

fn handle_argument_error(pat: &syn::Pat) -> syn::Error {
Expand Down Expand Up @@ -492,12 +509,22 @@ impl<'a> FnSpec<'a> {
.signature
.arguments
.iter()
.filter(|arg| arg.is_cancel_handle);
.filter(|arg| matches!(arg.kind, FnArgKind::CancelHandle));
let cancel_handle = cancel_handle_iter.next();
if let Some(arg) = cancel_handle {
ensure_spanned!(self.asyncness.is_some(), arg.name.span() => "`cancel_handle` attribute can only be used with `async fn`");
if let Some(arg2) = cancel_handle_iter.next() {
bail_spanned!(arg2.name.span() => "`cancel_handle` may only be specified once");
if let Some(FnArg {
name,
kind: FnArgKind::CancelHandle,
..
}) = cancel_handle
{
ensure_spanned!(self.asyncness.is_some(), name.span() => "`cancel_handle` attribute can only be used with `async fn`");
if let Some(FnArg {
name,
kind: FnArgKind::CancelHandle,
..
}) = cancel_handle_iter.next()
{
bail_spanned!(name.span() => "`cancel_handle` may only be specified once");
}
}

Expand Down Expand Up @@ -616,14 +643,10 @@ impl<'a> FnSpec<'a> {
.signature
.arguments
.iter()
.map(|arg| {
if arg.py {
quote!(py)
} else if arg.is_cancel_handle {
quote!(__cancel_handle)
} else {
unreachable!()
}
.map(|arg| match arg.kind {
FnArgKind::Py => quote!(py),
FnArgKind::CancelHandle { .. } => quote!(__cancel_handle),
_ => unreachable!(),
Copy link
Member

@mejrs mejrs Apr 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe some kind of

enum PyOrCancelHandle{
    Py,
    CancelHandle,
}

could get rid of this unreachable 🤔 Just some food for thoughts

Copy link
Contributor Author

@Icxolu Icxolu Apr 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, since this from the general parsed types, I don't think we can do a lot to avoid it. But since this is under CallingConvention::Noargs there really shouldn't be any "real" argument's (reaching Python), except for self which is handled separately. So I think unreachable!() is appropriate here, but an explanation comment might be good, I'll add that.

})
.collect();
let call = rust_call(args, &mut holders);
Expand All @@ -646,7 +669,7 @@ impl<'a> FnSpec<'a> {
}
CallingConvention::Fastcall => {
let mut holders = Holders::new();
let (arg_convert, args) = impl_arg_params(self, cls, true, &mut holders, ctx)?;
let (arg_convert, args) = impl_arg_params(self, cls, true, &mut holders, ctx);
let call = rust_call(args, &mut holders);
let init_holders = holders.init_holders(ctx);
let check_gil_refs = holders.check_gil_refs();
Expand All @@ -671,7 +694,7 @@ impl<'a> FnSpec<'a> {
}
CallingConvention::Varargs => {
let mut holders = Holders::new();
let (arg_convert, args) = impl_arg_params(self, cls, false, &mut holders, ctx)?;
let (arg_convert, args) = impl_arg_params(self, cls, false, &mut holders, ctx);
let call = rust_call(args, &mut holders);
let init_holders = holders.init_holders(ctx);
let check_gil_refs = holders.check_gil_refs();
Expand All @@ -695,7 +718,7 @@ impl<'a> FnSpec<'a> {
}
CallingConvention::TpNew => {
let mut holders = Holders::new();
let (arg_convert, args) = impl_arg_params(self, cls, false, &mut holders, ctx)?;
let (arg_convert, args) = impl_arg_params(self, cls, false, &mut holders, ctx);
let self_arg = self
.tp
.self_arg(cls, ExtractErrorMode::Raise, &mut holders, ctx);
Expand Down
Loading