pyo3cls 0.6.0-alpha.2

Proc macros for PyO3 package
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

// Copyright (c) 2017-present PyO3 Project and Contributors
//! This crate declares only the proc macro attributes, as a crate defining proc macro attributes
//! must not contain any other public items.

extern crate proc_macro;
use proc_macro::TokenStream;
use proc_macro2::Span;
use pyo3_derive_backend::{module, py_class, py_impl, py_proto, utils};
use quote::quote;
use syn;
use syn::parse::Parser;
use syn::punctuated::Punctuated;
use syn::Token;

#[proc_macro_attribute]
pub fn pymodule2(attr: TokenStream, input: TokenStream) -> TokenStream {
    // Parse the token stream into a syntax tree
    let mut ast: syn::ItemFn = syn::parse(input).expect("#[pymodule] must be used on a function");

    let modname: syn::Ident;
    if attr.is_empty() {
        modname = ast.ident.clone();
    } else {
        modname = syn::parse(attr).expect("could not parse module name");
    }

    // Process the functions within the module
    module::process_functions_in_module(&mut ast);

    // Create the module initialisation function
    let expanded = module::py2_init(&ast.ident, &modname, utils::get_doc(&ast.attrs, false));

    quote!(
        #ast
        #expanded
    )
    .into()
}

#[proc_macro_attribute]
pub fn pymodule3(attr: TokenStream, input: TokenStream) -> TokenStream {
    // Parse the token stream into a syntax tree
    let mut ast: syn::ItemFn = syn::parse(input).expect("#[pymodule] must be used on a `fn` block");

    let modname: syn::Ident;
    if attr.is_empty() {
        modname = ast.ident.clone();
    } else {
        modname = syn::parse(attr).expect("could not parse module name");
    }

    // Process the functions within the module
    module::process_functions_in_module(&mut ast);

    // Create the module initialisation function
    let expanded = module::py3_init(&ast.ident, &modname, utils::get_doc(&ast.attrs, false));

    quote!(
        #ast
        #expanded
    )
    .into()
}

#[proc_macro_attribute]
pub fn pyproto(_: TokenStream, input: TokenStream) -> TokenStream {
    // Parse the token stream into a syntax tree
    let mut ast: syn::ItemImpl =
        syn::parse(input).expect("#[pyproto] must be used on an `impl` block");

    // Build the output
    let expanded = py_proto::build_py_proto(&mut ast);

    quote!(
        #ast
        #expanded
    )
    .into()
}

#[proc_macro_attribute]
pub fn pyclass(attr: TokenStream, input: TokenStream) -> TokenStream {
    // Parse the token stream into a syntax tree
    let mut ast: syn::ItemStruct =
        syn::parse(input).expect("#[pyclass] must be used on a `struct`");

    // Parse the macro arguments into a list of expressions
    let parser = Punctuated::<syn::Expr, Token![,]>::parse_terminated;
    let error_message = "The macro attributes should be a list of comma separated expressions";
    let args = parser
        .parse(attr)
        .expect(error_message)
        .into_iter()
        .collect();

    // Build the output
    let expanded = py_class::build_py_class(&mut ast, &args);

    quote!(
        #ast
        #expanded
    )
    .into()
}

#[proc_macro_attribute]
pub fn pymethods(_: TokenStream, input: TokenStream) -> TokenStream {
    // Parse the token stream into a syntax tree
    let mut ast: syn::ItemImpl =
        syn::parse(input.clone()).expect("#[pymethods] must be used on an `impl` block");

    // Build the output
    let expanded = py_impl::build_py_methods(&mut ast);

    quote!(
        #ast
        #expanded
    )
    .into()
}

#[proc_macro_attribute]
pub fn pyfunction(_: TokenStream, input: TokenStream) -> TokenStream {
    let mut ast: syn::ItemFn = syn::parse(input).expect("#[function] must be used on a `fn` block");

    // Workaround for https://github.com/dtolnay/syn/issues/478
    let python_name = syn::Ident::new(
        &ast.ident.to_string().trim_start_matches("r#"),
        Span::call_site(),
    );
    let expanded = module::add_fn_to_module(&mut ast, &python_name, Vec::new());

    quote!(
        #ast
        #expanded
    )
    .into()
}