remove deprecated from_py_with string variant (PyO3#5097)

Icxolu · web-flow · commit 28dc14354ce3 · 2025-04-26T10:48:36.000Z
diff --git a/newsfragments/5097.removed.md b/newsfragments/5097.removed.md
@@ -0,0 +1 @@
+removed support for the deprecated string from of `from_py_with`
diff --git a/pyo3-macros-backend/src/attributes.rs b/pyo3-macros-backend/src/attributes.rs
@@ -350,37 +350,7 @@ impl<K: ToTokens, V: ToTokens> ToTokens for OptionalKeywordAttribute<K, V> {
     }
 }
 
-#[derive(Debug, Clone)]
-pub struct ExprPathWrap {
-    pub from_lit_str: bool,
-    pub expr_path: ExprPath,
-}
-
-impl Parse for ExprPathWrap {
-    fn parse(input: ParseStream<'_>) -> Result<Self> {
-        match input.parse::<ExprPath>() {
-            Ok(expr_path) => Ok(ExprPathWrap {
-                from_lit_str: false,
-                expr_path,
-            }),
-            Err(e) => match input.parse::<LitStrValue<ExprPath>>() {
-                Ok(LitStrValue(expr_path)) => Ok(ExprPathWrap {
-                    from_lit_str: true,
-                    expr_path,
-                }),
-                Err(_) => Err(e),
-            },
-        }
-    }
-}
-
-impl ToTokens for ExprPathWrap {
-    fn to_tokens(&self, tokens: &mut TokenStream) {
-        self.expr_path.to_tokens(tokens)
-    }
-}
-
-pub type FromPyWithAttribute = KeywordAttribute<kw::from_py_with, ExprPathWrap>;
+pub type FromPyWithAttribute = KeywordAttribute<kw::from_py_with, ExprPath>;
 pub type IntoPyWithAttribute = KeywordAttribute<kw::into_py_with, ExprPath>;
 
 pub type DefaultAttribute = OptionalKeywordAttribute<Token![default], Expr>;
diff --git a/pyo3-macros-backend/src/frompyobject.rs b/pyo3-macros-backend/src/frompyobject.rs
@@ -2,7 +2,7 @@ use crate::attributes::{
     self, get_pyo3_options, CrateAttribute, DefaultAttribute, FromPyWithAttribute,
     RenameAllAttribute, RenamingRule,
 };
-use crate::utils::{self, deprecated_from_py_with, Ctx};
+use crate::utils::{self, Ctx};
 use proc_macro2::TokenStream;
 use quote::{format_ident, quote, quote_spanned, ToTokens};
 use syn::{
@@ -304,13 +304,10 @@ impl<'a> Container<'a> {
                 value: expr_path,
             }) = from_py_with
             {
-                let deprecation = deprecated_from_py_with(expr_path).unwrap_or_default();
-
                 let extractor = quote_spanned! { kw.span =>
                     { let from_py_with: fn(_) -> _ = #expr_path; from_py_with }
                 };
                 quote! {
-                    #deprecation
                     Ok(#self_ty {
                         #ident: #pyo3_path::impl_::frompyobject::extract_struct_field_with(#extractor, obj, #struct_name, #field_name)?
                     })
@@ -327,13 +324,10 @@ impl<'a> Container<'a> {
             value: expr_path,
         }) = from_py_with
         {
-            let deprecation = deprecated_from_py_with(expr_path).unwrap_or_default();
-
             let extractor = quote_spanned! { kw.span =>
                 { let from_py_with: fn(_) -> _ = #expr_path; from_py_with }
             };
             quote! {
-                #deprecation
                 #pyo3_path::impl_::frompyobject::extract_tuple_struct_field_with(#extractor, obj, #struct_name, 0).map(#self_ty)
             }
         } else {
@@ -367,14 +361,7 @@ impl<'a> Container<'a> {
             }}
         });
 
-        let deprecations = struct_fields
-            .iter()
-            .filter_map(|fields| fields.from_py_with.as_ref())
-            .filter_map(|kw| deprecated_from_py_with(&kw.value))
-            .collect::<TokenStream>();
-
         quote!(
-            #deprecations
             match #pyo3_path::types::PyAnyMethods::extract(obj) {
                 ::std::result::Result::Ok((#(#field_idents),*)) => ::std::result::Result::Ok(#self_ty(#(#fields),*)),
                 ::std::result::Result::Err(err) => ::std::result::Result::Err(err),
@@ -448,13 +435,7 @@ impl<'a> Container<'a> {
             fields.push(quote!(#ident: #extracted));
         }
 
-        let d = struct_fields
-            .iter()
-            .filter_map(|field| field.from_py_with.as_ref())
-            .filter_map(|kw| deprecated_from_py_with(&kw.value))
-            .collect::<TokenStream>();
-
-        quote!(#d ::std::result::Result::Ok(#self_ty{#fields}))
+        quote!(::std::result::Result::Ok(#self_ty{#fields}))
     }
 }
 
diff --git a/pyo3-macros-backend/src/params.rs b/pyo3-macros-backend/src/params.rs
@@ -1,4 +1,4 @@
-use crate::utils::{deprecated_from_py_with, Ctx, TypeExt as _};
+use crate::utils::{Ctx, TypeExt as _};
 use crate::{
     attributes::FromPyWithAttribute,
     method::{FnArg, FnSpec, RegularArg},
@@ -62,9 +62,7 @@ pub fn impl_arg_params(
         .filter_map(|(i, arg)| {
             let from_py_with = &arg.from_py_with()?.value;
             let from_py_with_holder = format_ident!("from_py_with_{}", i);
-            let d = deprecated_from_py_with(from_py_with).unwrap_or_default();
             Some(quote_spanned! { from_py_with.span() =>
-                #d
                 let #from_py_with_holder = #from_py_with;
             })
         })
diff --git a/pyo3-macros-backend/src/pymethod.rs b/pyo3-macros-backend/src/pymethod.rs
@@ -4,8 +4,8 @@ use std::ffi::CString;
 use crate::attributes::{FromPyWithAttribute, NameAttribute, RenamingRule};
 use crate::method::{CallingConvention, ExtractErrorMode, PyArg};
 use crate::params::{impl_regular_arg_param, Holders};
-use crate::utils::{deprecated_from_py_with, PythonDoc, TypeExt as _};
 use crate::utils::{Ctx, LitCStr};
+use crate::utils::{PythonDoc, TypeExt as _};
 use crate::{
     method::{FnArg, FnSpec, FnType, SelfType},
     pyfunction::PyFunctionOptions,
@@ -659,10 +659,8 @@ pub fn impl_py_setter_def(
             let (from_py_with, ident) =
                 if let Some(from_py_with) = &value_arg.from_py_with().as_ref().map(|f| &f.value) {
                     let ident = syn::Ident::new("from_py_with", from_py_with.span());
-                    let d = deprecated_from_py_with(from_py_with).unwrap_or_default();
                     (
                         quote_spanned! { from_py_with.span() =>
-                            #d
                             let #ident = #from_py_with;
                         },
                         ident,
diff --git a/pyo3-macros-backend/src/utils.rs b/pyo3-macros-backend/src/utils.rs
@@ -1,6 +1,6 @@
-use crate::attributes::{CrateAttribute, ExprPathWrap, RenamingRule};
+use crate::attributes::{CrateAttribute, RenamingRule};
 use proc_macro2::{Span, TokenStream};
-use quote::{quote, quote_spanned, ToTokens};
+use quote::{quote, ToTokens};
 use std::ffi::CString;
 use syn::spanned::Spanned;
 use syn::{punctuated::Punctuated, Token};
@@ -324,20 +324,6 @@ pub(crate) fn has_attribute_with_namespace(
     })
 }
 
-pub(crate) fn deprecated_from_py_with(expr_path: &ExprPathWrap) -> Option<TokenStream> {
-    let path = quote!(#expr_path).to_string();
-    let msg =
-        format!("remove the quotes from the literal\n= help: use `{path}` instead of `\"{path}\"`");
-    expr_path.from_lit_str.then(|| {
-        quote_spanned! { expr_path.span() =>
-            #[deprecated(since = "0.24.0", note = #msg)]
-            #[allow(dead_code)]
-            const LIT_STR_DEPRECATION: () = ();
-            let _: () = LIT_STR_DEPRECATION;
-        }
-    })
-}
-
 pub(crate) trait TypeExt {
     /// Replaces all explicit lifetimes in `self` with elided (`'_`) lifetimes
     ///
diff --git a/tests/test_compile_error.rs b/tests/test_compile_error.rs
@@ -73,5 +73,4 @@ fn test_compile_errors() {
     t.compile_fail("tests/ui/invalid_base_class.rs");
     t.pass("tests/ui/ambiguous_associated_items.rs");
     t.pass("tests/ui/pyclass_probe.rs");
-    t.compile_fail("tests/ui/deprecated.rs");
 }
diff --git a/tests/ui/deprecated.rs b/tests/ui/deprecated.rs
diff --git a/tests/ui/deprecated.stderr b/tests/ui/deprecated.stderr
diff --git a/tests/ui/invalid_argument_attributes.rs b/tests/ui/invalid_argument_attributes.rs
@@ -13,7 +13,7 @@ fn from_py_with_string(#[pyo3("from_py_with")] _param: String) {}
 fn from_py_with_value_not_found(#[pyo3(from_py_with = func)] _param: String) {}
 
 #[pyfunction]
-fn from_py_with_repeated(#[pyo3(from_py_with = "func", from_py_with = "func")] _param: String) {}
+fn from_py_with_repeated(#[pyo3(from_py_with = func, from_py_with = func)] _param: String) {}
 
 fn bytes_from_py(bytes: &Bound<'_, pyo3::types::PyBytes>) -> Vec<u8> {
     bytes.as_bytes().to_vec()
diff --git a/tests/ui/invalid_argument_attributes.stderr b/tests/ui/invalid_argument_attributes.stderr
@@ -17,33 +17,19 @@ error: expected `cancel_handle` or `from_py_with`
    |                               ^^^^^^^^^^^^^^
 
 error: `from_py_with` may only be specified once per argument
-  --> tests/ui/invalid_argument_attributes.rs:16:56
+  --> tests/ui/invalid_argument_attributes.rs:16:54
    |
-16 | fn from_py_with_repeated(#[pyo3(from_py_with = "func", from_py_with = "func")] _param: String) {}
-   |                                                        ^^^^^^^^^^^^
+16 | fn from_py_with_repeated(#[pyo3(from_py_with = func, from_py_with = func)] _param: String) {}
+   |                                                      ^^^^^^^^^^^^
 
-error[E0425]: cannot find value `func` in this scope
-  --> tests/ui/invalid_argument_attributes.rs:13:55
-   |
-13 | fn from_py_with_value_not_found(#[pyo3(from_py_with = func)] _param: String) {}
-   |                                                       ^^^^ not found in this scope
-
-warning: use of deprecated constant `__pyfunction_f::LIT_STR_DEPRECATION`: remove the quotes from the literal
-         = help: use `bytes_from_py` instead of `"bytes_from_py"`
+error: expected identifier
   --> tests/ui/invalid_argument_attributes.rs:23:28
    |
 23 | fn f(#[pyo3(from_py_with = "bytes_from_py")] _bytes: Vec<u8>) {}
    |                            ^^^^^^^^^^^^^^^
-   |
-   = note: `#[warn(deprecated)]` on by default
 
-error[E0308]: mismatched types
-  --> tests/ui/invalid_argument_attributes.rs:23:13
-   |
-22 | #[pyfunction]
-   | ------------- here the type of `from_py_with` is inferred to be `fn(&pyo3::Bound<'_, PyBytes>) -> Vec<u8>`
-23 | fn f(#[pyo3(from_py_with = "bytes_from_py")] _bytes: Vec<u8>) {}
-   |             ^^^^^^^^^^^^ expected `PyAny`, found `PyBytes`
+error[E0425]: cannot find value `func` in this scope
+  --> tests/ui/invalid_argument_attributes.rs:13:55
    |
-   = note: expected fn pointer `fn(&pyo3::Bound<'_, PyAny>) -> Result<_, PyErr>`
-              found fn pointer `fn(&pyo3::Bound<'_, PyBytes>) -> Vec<u8>`
+13 | fn from_py_with_value_not_found(#[pyo3(from_py_with = func)] _param: String) {}
+   |                                                       ^^^^ not found in this scope
diff --git a/tests/ui/invalid_cancel_handle.rs b/tests/ui/invalid_cancel_handle.rs
@@ -21,7 +21,7 @@ async fn missing_cancel_handle_attribute(_param: pyo3::coroutine::CancelHandle)
 
 #[pyfunction]
 async fn cancel_handle_and_from_py_with(
-    #[pyo3(cancel_handle, from_py_with = "cancel_handle")] _param: pyo3::coroutine::CancelHandle,
+    #[pyo3(cancel_handle, from_py_with = cancel_handle)] _param: pyo3::coroutine::CancelHandle,
 ) {
 }
 
diff --git a/tests/ui/invalid_cancel_handle.stderr b/tests/ui/invalid_cancel_handle.stderr
@@ -19,7 +19,7 @@ error: `cancel_handle` attribute can only be used with `async fn`
 error: `from_py_with` and `cancel_handle` cannot be specified together
   --> tests/ui/invalid_cancel_handle.rs:24:12
    |
-24 |     #[pyo3(cancel_handle, from_py_with = "cancel_handle")] _param: pyo3::coroutine::CancelHandle,
+24 |     #[pyo3(cancel_handle, from_py_with = cancel_handle)] _param: pyo3::coroutine::CancelHandle,
    |            ^^^^^^^^^^^^^
 
 error[E0308]: mismatched types

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+removed support for the deprecated string from of `from_py_with`
Original file line number	Diff line number	Diff line change
`@@ -73,5 +73,4 @@ fn test_compile_errors() {`
`73`	`73`	`t.compile_fail("tests/ui/invalid_base_class.rs");`
`74`	`74`	`t.pass("tests/ui/ambiguous_associated_items.rs");`
`75`	`75`	`t.pass("tests/ui/pyclass_probe.rs");`
`76`		`- t.compile_fail("tests/ui/deprecated.rs");`
`77`	`76`	`}`