Skip to content

Commit d0381c2

Browse files
birkenfeldbirkenfeld
committed
pyo3_path: rename internal types/variables to Crate/krate
1 parent 2d49dc3 commit d0381c2

File tree

9 files changed

+101
-102
lines changed

9 files changed

+101
-102
lines changed

‎pyo3-macros-backend/src/attributes.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ impl Parse for NameAttribute {
4545

4646
/// For specifying the path to the pyo3 crate.
4747
#[derive(Clone, Debug, PartialEq)]
48-
pub struct PyO3PathAttribute(pub Path);
48+
pub struct CrateAttribute(pub Path);
4949

50-
impl Parse for PyO3PathAttribute {
50+
impl Parse for CrateAttribute {
5151
fn parse(input: ParseStream) -> Result<Self> {
5252
let _: Token![crate] = input.parse()?;
5353
let _: Token![=] = input.parse()?;
5454
let string_literal: LitStr = input.parse()?;
55-
string_literal.parse().map(PyO3PathAttribute)
55+
string_literal.parse().map(CrateAttribute)
5656
}
5757
}
5858

‎pyo3-macros-backend/src/from_pyobject.rs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use crate::{
2-
attributes::{self, get_pyo3_options, FromPyWithAttribute, PyO3PathAttribute},
3-
utils::get_pyo3_path,
2+
attributes::{self, get_pyo3_options, CrateAttribute, FromPyWithAttribute},
3+
utils::get_pyo3_crate,
44
};
55
use proc_macro2::TokenStream;
66
use quote::quote;
@@ -310,7 +310,7 @@ struct ContainerOptions {
310310
/// Change the name of an enum variant in the generated error message.
311311
annotation: Option<syn::LitStr>,
312312
/// Change the path for the pyo3 crate
313-
pyo3_path: Option<PyO3PathAttribute>,
313+
krate: Option<CrateAttribute>,
314314
}
315315

316316
/// Attributes for deriving FromPyObject scoped on containers.
@@ -321,7 +321,7 @@ enum ContainerPyO3Attribute {
321321
/// Change the name of an enum variant in the generated error message.
322322
ErrorAnnotation(LitStr),
323323
/// Change the path for the pyo3 crate
324-
PyO3Path(PyO3PathAttribute),
324+
Crate(CrateAttribute),
325325
}
326326

327327
impl Parse for ContainerPyO3Attribute {
@@ -335,7 +335,7 @@ impl Parse for ContainerPyO3Attribute {
335335
let _: Token![=] = input.parse()?;
336336
input.parse().map(ContainerPyO3Attribute::ErrorAnnotation)
337337
} else if lookahead.peek(Token![crate]) {
338-
input.parse().map(ContainerPyO3Attribute::PyO3Path)
338+
input.parse().map(ContainerPyO3Attribute::Crate)
339339
} else {
340340
Err(lookahead.error())
341341
}
@@ -364,12 +364,12 @@ impl ContainerOptions {
364364
);
365365
options.annotation = Some(lit_str);
366366
}
367-
ContainerPyO3Attribute::PyO3Path(path) => {
367+
ContainerPyO3Attribute::Crate(path) => {
368368
ensure_spanned!(
369-
options.pyo3_path.is_none(),
370-
path.0.span() => "`pyo3_path` may only be provided once"
369+
options.krate.is_none(),
370+
path.0.span() => "`crate` may only be provided once"
371371
);
372-
options.pyo3_path = Some(path);
372+
options.krate = Some(path);
373373
}
374374
}
375375
}
@@ -515,7 +515,7 @@ pub fn build_derive_from_pyobject(tokens: &DeriveInput) -> Result<TokenStream> {
515515
.push(parse_quote!(#gen_ident: FromPyObject<#lt_param>))
516516
}
517517
let options = ContainerOptions::from_attrs(&tokens.attrs)?;
518-
let pyo3_path = get_pyo3_path(&options.pyo3_path);
518+
let krate = get_pyo3_crate(&options.krate);
519519
let derives = match &tokens.data {
520520
syn::Data::Enum(en) => {
521521
if options.transparent || options.annotation.is_some() {
@@ -541,7 +541,7 @@ pub fn build_derive_from_pyobject(tokens: &DeriveInput) -> Result<TokenStream> {
541541
let ident = &tokens.ident;
542542
Ok(quote!(
543543
const _: () = {
544-
use #pyo3_path as _pyo3;
544+
use #krate as _pyo3;
545545

546546
#[automatically_derived]
547547
impl#trait_generics _pyo3::FromPyObject<#lt_param> for #ident#generics #where_clause {

‎pyo3-macros-backend/src/method.rs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::deprecations::Deprecation;
55
use crate::params::{accept_args_kwargs, impl_arg_params};
66
use crate::pyfunction::PyFunctionOptions;
77
use crate::pyfunction::{PyFunctionArgPyO3Attributes, PyFunctionSignature};
8-
use crate::utils::{self, get_pyo3_path, PythonDoc};
8+
use crate::utils::{self, get_pyo3_crate, PythonDoc};
99
use crate::{deprecations::Deprecations, pyfunction::Argument};
1010
use proc_macro2::{Span, TokenStream};
1111
use quote::ToTokens;
@@ -228,7 +228,7 @@ pub struct FnSpec<'a> {
228228
pub deprecations: Deprecations,
229229
pub convention: CallingConvention,
230230
pub text_signature: Option<TextSignatureAttribute>,
231-
pub pyo3_path: syn::Path,
231+
pub krate: syn::Path,
232232
}
233233

234234
pub fn get_return_info(output: &syn::ReturnType) -> syn::Type {
@@ -262,7 +262,7 @@ impl<'a> FnSpec<'a> {
262262
) -> Result<FnSpec<'a>> {
263263
let PyFunctionOptions {
264264
text_signature,
265-
pyo3_path,
265+
krate,
266266
name,
267267
mut deprecations,
268268
..
@@ -281,7 +281,7 @@ impl<'a> FnSpec<'a> {
281281
let name = &sig.ident;
282282
let ty = get_return_info(&sig.output);
283283
let python_name = python_name.as_ref().unwrap_or(name).unraw();
284-
let pyo3_path = get_pyo3_path(&pyo3_path);
284+
let krate = get_pyo3_crate(&krate);
285285

286286
let doc = utils::get_doc(
287287
meth_attrs,
@@ -315,7 +315,7 @@ impl<'a> FnSpec<'a> {
315315
doc,
316316
deprecations,
317317
text_signature,
318-
pyo3_path,
318+
krate,
319319
})
320320
}
321321

@@ -477,16 +477,16 @@ impl<'a> FnSpec<'a> {
477477
};
478478
let rust_call =
479479
quote! { _pyo3::callback::convert(#py, #rust_name(#self_arg #(#arg_names),*)) };
480-
let pyo3_path = &self.pyo3_path;
480+
let krate = &self.krate;
481481
Ok(match self.convention {
482482
CallingConvention::Noargs => {
483483
quote! {
484484
unsafe extern "C" fn #ident (
485-
_slf: *mut #pyo3_path::ffi::PyObject,
486-
_args: *mut #pyo3_path::ffi::PyObject,
487-
) -> *mut #pyo3_path::ffi::PyObject
485+
_slf: *mut #krate::ffi::PyObject,
486+
_args: *mut #krate::ffi::PyObject,
487+
) -> *mut #krate::ffi::PyObject
488488
{
489-
use #pyo3_path as _pyo3;
489+
use #krate as _pyo3;
490490
#deprecations
491491
_pyo3::callback::handle_panic(|#py| {
492492
#self_conversion
@@ -499,12 +499,12 @@ impl<'a> FnSpec<'a> {
499499
let arg_convert_and_rust_call = impl_arg_params(self, cls, rust_call, &py, true)?;
500500
quote! {
501501
unsafe extern "C" fn #ident (
502-
_slf: *mut #pyo3_path::ffi::PyObject,
503-
_args: *const *mut #pyo3_path::ffi::PyObject,
504-
_nargs: #pyo3_path::ffi::Py_ssize_t,
505-
_kwnames: *mut #pyo3_path::ffi::PyObject) -> *mut #pyo3_path::ffi::PyObject
502+
_slf: *mut #krate::ffi::PyObject,
503+
_args: *const *mut #krate::ffi::PyObject,
504+
_nargs: #krate::ffi::Py_ssize_t,
505+
_kwnames: *mut #krate::ffi::PyObject) -> *mut #krate::ffi::PyObject
506506
{
507-
use #pyo3_path as _pyo3;
507+
use #krate as _pyo3;
508508
#deprecations
509509
_pyo3::callback::handle_panic(|#py| {
510510
#self_conversion
@@ -527,11 +527,11 @@ impl<'a> FnSpec<'a> {
527527
let arg_convert_and_rust_call = impl_arg_params(self, cls, rust_call, &py, false)?;
528528
quote! {
529529
unsafe extern "C" fn #ident (
530-
_slf: *mut #pyo3_path::ffi::PyObject,
531-
_args: *mut #pyo3_path::ffi::PyObject,
532-
_kwargs: *mut #pyo3_path::ffi::PyObject) -> *mut #pyo3_path::ffi::PyObject
530+
_slf: *mut #krate::ffi::PyObject,
531+
_args: *mut #krate::ffi::PyObject,
532+
_kwargs: *mut #krate::ffi::PyObject) -> *mut #krate::ffi::PyObject
533533
{
534-
use #pyo3_path as _pyo3;
534+
use #krate as _pyo3;
535535
#deprecations
536536
_pyo3::callback::handle_panic(|#py| {
537537
#self_conversion
@@ -548,11 +548,11 @@ impl<'a> FnSpec<'a> {
548548
let arg_convert_and_rust_call = impl_arg_params(self, cls, rust_call, &py, false)?;
549549
quote! {
550550
unsafe extern "C" fn #ident (
551-
subtype: *mut #pyo3_path::ffi::PyTypeObject,
552-
_args: *mut #pyo3_path::ffi::PyObject,
553-
_kwargs: *mut #pyo3_path::ffi::PyObject) -> *mut #pyo3_path::ffi::PyObject
551+
subtype: *mut #krate::ffi::PyTypeObject,
552+
_args: *mut #krate::ffi::PyObject,
553+
_kwargs: *mut #krate::ffi::PyObject) -> *mut #krate::ffi::PyObject
554554
{
555-
use #pyo3_path as _pyo3;
555+
use #krate as _pyo3;
556556
#deprecations
557557
use _pyo3::callback::IntoPyCallbackOutput;
558558
_pyo3::callback::handle_panic(|#py| {

‎pyo3-macros-backend/src/module.rs

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,10 @@
33
44
use crate::{
55
attributes::{
6-
self, is_attribute_ident, take_attributes, take_pyo3_options, NameAttribute,
7-
PyO3PathAttribute,
6+
self, is_attribute_ident, take_attributes, take_pyo3_options, CrateAttribute, NameAttribute,
87
},
98
pyfunction::{impl_wrap_pyfunction, PyFunctionOptions},
10-
utils::{get_pyo3_path, PythonDoc},
9+
utils::{get_pyo3_crate, PythonDoc},
1110
};
1211
use proc_macro2::{Span, TokenStream};
1312
use quote::quote;
@@ -21,7 +20,7 @@ use syn::{
2120

2221
#[derive(Default)]
2322
pub struct PyModuleOptions {
24-
pyo3_path: Option<PyO3PathAttribute>,
23+
krate: Option<CrateAttribute>,
2524
name: Option<syn::Ident>,
2625
}
2726

@@ -32,7 +31,7 @@ impl PyModuleOptions {
3231
for option in take_pyo3_options(attrs)? {
3332
match option {
3433
PyModulePyO3Option::Name(name) => options.set_name(name.0)?,
35-
PyModulePyO3Option::PyO3Path(path) => options.set_pyo3_path(path)?,
34+
PyModulePyO3Option::Crate(path) => options.set_crate(path)?,
3635
}
3736
}
3837

@@ -49,13 +48,13 @@ impl PyModuleOptions {
4948
Ok(())
5049
}
5150

52-
fn set_pyo3_path(&mut self, path: PyO3PathAttribute) -> Result<()> {
51+
fn set_crate(&mut self, path: CrateAttribute) -> Result<()> {
5352
ensure_spanned!(
54-
self.pyo3_path.is_none(),
55-
path.0.span() => "`pyo3_path` may only be specified once"
53+
self.krate.is_none(),
54+
path.0.span() => "`crate` may only be specified once"
5655
);
5756

58-
self.pyo3_path = Some(path);
57+
self.krate = Some(path);
5958
Ok(())
6059
}
6160
}
@@ -64,16 +63,16 @@ impl PyModuleOptions {
6463
/// module
6564
pub fn py_init(fnname: &Ident, options: PyModuleOptions, doc: PythonDoc) -> TokenStream {
6665
let name = options.name.unwrap_or_else(|| fnname.unraw());
67-
let pyo3_path = get_pyo3_path(&options.pyo3_path);
66+
let krate = get_pyo3_crate(&options.krate);
6867
let cb_name = Ident::new(&format!("PyInit_{}", name), Span::call_site());
6968

7069
quote! {
7170
#[no_mangle]
7271
#[allow(non_snake_case)]
7372
/// This autogenerated function is called by the python interpreter when importing
7473
/// the module.
75-
pub unsafe extern "C" fn #cb_name() -> *mut #pyo3_path::ffi::PyObject {
76-
use #pyo3_path as _pyo3;
74+
pub unsafe extern "C" fn #cb_name() -> *mut #krate::ffi::PyObject {
75+
use #krate as _pyo3;
7776
use _pyo3::derive_utils::ModuleDef;
7877
static NAME: &str = concat!(stringify!(#name), "\0");
7978
static DOC: &str = #doc;
@@ -161,7 +160,7 @@ fn get_pyfn_attr(attrs: &mut Vec<syn::Attribute>) -> syn::Result<Option<PyFnArgs
161160
}
162161

163162
enum PyModulePyO3Option {
164-
PyO3Path(PyO3PathAttribute),
163+
Crate(CrateAttribute),
165164
Name(NameAttribute),
166165
}
167166

@@ -171,7 +170,7 @@ impl Parse for PyModulePyO3Option {
171170
if lookahead.peek(attributes::kw::name) {
172171
input.parse().map(PyModulePyO3Option::Name)
173172
} else if lookahead.peek(syn::Token![crate]) {
174-
input.parse().map(PyModulePyO3Option::PyO3Path)
173+
input.parse().map(PyModulePyO3Option::Crate)
175174
} else {
176175
Err(lookahead.error())
177176
}

0 commit comments

Comments
 (0)