pyo3_path, part 4: rename to crate to keep consistent with serde

Author: birkenfeld

CHANGELOG.md

@@ -21,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add `Py::setattr` method. [#2009](https://github.com/PyO3/pyo3/pull/2009)
 - Add `PyCapsule`, exposing the [Capsule API](https://docs.python.org/3/c-api/capsule.html#capsules). [#1980](https://github.com/PyO3/pyo3/pull/1980)
-- All PyO3 proc-macros except the deprecated `#[pyproto]` now accept a supplemental attribute `#[pyo3(pyo3_path = "some::path")]` that specifies
+- All PyO3 proc-macros except the deprecated `#[pyproto]` now accept a supplemental attribute `#[pyo3(crate = "some::path")]` that specifies
   where to find the `pyo3` crate, in case it has been renamed or is re-exported and not found at the crate root. [#2022](https://github.com/PyO3/pyo3/pull/2022)
 
 ### Changed

guide/src/faq.md

@@ -149,13 +149,13 @@ crate.
 
 However, when the dependency is renamed, or your crate only indirectly depends
 on `pyo3`, you need to let the macro code know where to find the crate.  This is
-done with the `pyo3_path` attribute:
+done with the `crate` attribute:
 
 ```rust
 # use pyo3::prelude::*;
 # pub extern crate pyo3;
 # mod reexported { pub use ::pyo3; }
 #[pyclass]
-#[pyo3(pyo3_path = "reexported::pyo3")]
+#[pyo3(crate = "reexported::pyo3")]
 struct MyClass;
 ```

pyo3-macros-backend/src/attributes.rs

@@ -17,7 +17,6 @@ pub mod kw {
     syn::custom_keyword!(signature);
     syn::custom_keyword!(text_signature);
     syn::custom_keyword!(transparent);
-    syn::custom_keyword!(pyo3_path);
 }
 
 #[derive(Clone, Debug, PartialEq)]
@@ -50,7 +49,7 @@ pub struct PyO3PathAttribute(pub Path);
 
 impl Parse for PyO3PathAttribute {
     fn parse(input: ParseStream) -> Result<Self> {
-        let _: kw::pyo3_path = input.parse()?;
+        let _: Token![crate] = input.parse()?;
         let _: Token![=] = input.parse()?;
         let string_literal: LitStr = input.parse()?;
         string_literal.parse().map(PyO3PathAttribute)

pyo3-macros-backend/src/from_pyobject.rs

@@ -334,7 +334,7 @@ impl Parse for ContainerPyO3Attribute {
             let _: attributes::kw::annotation = input.parse()?;
             let _: Token![=] = input.parse()?;
             input.parse().map(ContainerPyO3Attribute::ErrorAnnotation)
-        } else if lookahead.peek(attributes::kw::pyo3_path) {
+        } else if lookahead.peek(Token![crate]) {
             input.parse().map(ContainerPyO3Attribute::PyO3Path)
         } else {
             Err(lookahead.error())

pyo3-macros-backend/src/module.rs

@@ -170,7 +170,7 @@ impl Parse for PyModulePyO3Option {
         let lookahead = input.lookahead1();
         if lookahead.peek(attributes::kw::name) {
             input.parse().map(PyModulePyO3Option::Name)
-        } else if lookahead.peek(attributes::kw::pyo3_path) {
+        } else if lookahead.peek(syn::Token![crate]) {
             input.parse().map(PyModulePyO3Option::PyO3Path)
         } else {
             Err(lookahead.error())

pyo3-macros-backend/src/pyclass.rs

@@ -201,7 +201,7 @@ impl Parse for PyClassPyO3Option {
         let lookahead = input.lookahead1();
         if lookahead.peek(attributes::kw::text_signature) {
             input.parse().map(PyClassPyO3Option::TextSignature)
-        } else if lookahead.peek(attributes::kw::pyo3_path) {
+        } else if lookahead.peek(Token![crate]) {
             input.parse().map(PyClassPyO3Option::PyO3Path)
         } else {
             Err(lookahead.error())

pyo3-macros-backend/src/pyfunction.rs

@@ -257,7 +257,7 @@ impl Parse for PyFunctionOptions {
                 if !input.is_empty() {
                     let _: Comma = input.parse()?;
                 }
-            } else if lookahead.peek(attributes::kw::pyo3_path) {
+            } else if lookahead.peek(syn::Token![crate]) {
                 // TODO needs duplicate check?
                 options.pyo3_path = Some(input.parse()?);
             } else {
@@ -292,7 +292,7 @@ impl Parse for PyFunctionOption {
             input.parse().map(PyFunctionOption::Signature)
         } else if lookahead.peek(attributes::kw::text_signature) {
             input.parse().map(PyFunctionOption::TextSignature)
-        } else if lookahead.peek(attributes::kw::pyo3_path) {
+        } else if lookahead.peek(syn::Token![crate]) {
             input.parse().map(PyFunctionOption::PyO3Path)
         } else {
             Err(lookahead.error())

pyo3-macros-backend/src/pyimpl.rs

@@ -3,7 +3,7 @@
 use std::collections::HashSet;
 
 use crate::{
-    attributes::{self, take_pyo3_options, PyO3PathAttribute},
+    attributes::{take_pyo3_options, PyO3PathAttribute},
     konst::{ConstAttributes, ConstSpec},
     pyfunction::PyFunctionOptions,
     pymethod::{self, is_proto_method},
@@ -32,7 +32,7 @@ enum PyImplPyO3Option {
 impl Parse for PyImplPyO3Option {
     fn parse(input: ParseStream) -> Result<Self> {
         let lookahead = input.lookahead1();
-        if lookahead.peek(attributes::kw::pyo3_path) {
+        if lookahead.peek(syn::Token![crate]) {
             input.parse().map(PyImplPyO3Option::PyO3Path)
         } else {
             Err(lookahead.error())

src/test_hygiene/misc.rs

@@ -1,24 +1,24 @@
 #![no_implicit_prelude]
 
 #[derive(crate::FromPyObject)]
-#[pyo3(pyo3_path = "crate")]
+#[pyo3(crate = "crate")]
 struct Derive1(i32); // newtype case
 
 #[derive(crate::FromPyObject)]
-#[pyo3(pyo3_path = "crate")]
+#[pyo3(crate = "crate")]
 #[allow(dead_code)]
 struct Derive2(i32, i32); // tuple case
 
 #[derive(crate::FromPyObject)]
-#[pyo3(pyo3_path = "crate")]
+#[pyo3(crate = "crate")]
 #[allow(dead_code)]
 struct Derive3 {
     f: i32,
     g: i32,
 } // struct case
 
 #[derive(crate::FromPyObject)]
-#[pyo3(pyo3_path = "crate")]
+#[pyo3(crate = "crate")]
 #[allow(dead_code)]
 enum Derive4 {
     A(i32),

src/test_hygiene/pyclass.rs

@@ -2,12 +2,12 @@
 #![allow(unused_variables)]
 
 #[crate::pyclass]
-#[pyo3(pyo3_path = "crate")]
+#[pyo3(crate = "crate")]
 #[derive(::std::clone::Clone)]
 pub struct Foo;
 
 #[crate::pyclass]
-#[pyo3(pyo3_path = "crate")]
+#[pyo3(crate = "crate")]
 pub struct Foo2;
 
 #[crate::pyclass(
@@ -19,7 +19,7 @@ pub struct Foo2;
     extends = crate::types::PyAny,
     module = "Spam"
 )]
-#[pyo3(pyo3_path = "crate")]
+#[pyo3(crate = "crate")]
 pub struct Bar {
     #[pyo3(get, set)]
     a: u8,