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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
pub mod collection;
pub mod error;
use pyo3::{PyAny, PyObject, PyResult, PyTypeInfo, Python};
#[derive(Debug, PartialEq)]
pub struct FuncMetadata {
pub name: String,
pub is_coroutine: bool,
pub num_args: usize,
}
pub fn func_metadata(py: Python, func: &PyObject) -> PyResult<FuncMetadata> {
let name = func.getattr(py, "__name__")?.extract::<String>(py)?;
let is_coroutine = is_coroutine(py, func)?;
let inspect = py.import("inspect")?;
let args = inspect
.call_method1("getargs", (func.getattr(py, "__code__")?,))?
.getattr("args")?
.extract::<Vec<String>>()?;
Ok(FuncMetadata {
name,
is_coroutine,
num_args: args.len(),
})
}
fn is_coroutine(py: Python, func: &PyObject) -> PyResult<bool> {
let inspect = py.import("inspect")?;
inspect
.call_method1("iscoroutinefunction", (func,))?
.extract::<bool>()
}
#[allow(unused)]
pub fn is_optional_of<T: PyTypeInfo>(py: Python, ty: &PyAny) -> PyResult<bool> {
let union_ty = py.import("typing")?.getattr("Union")?;
match ty.getattr("__origin__").map(|origin| origin.is(union_ty)) {
Ok(true) => {}
_ => return Ok(false),
};
let none = py.None();
let none_ty = none.as_ref(py).get_type();
let target_ty = py.get_type::<T>();
match ty
.getattr("__args__")
.and_then(|args| args.extract::<(&PyAny, &PyAny)>())
{
Ok((first_ty, second_ty)) => Ok(
(first_ty.is(target_ty) && second_ty.is(none_ty)) ||
(first_ty.is(none_ty) && second_ty.is(target_ty)),
),
_ => Ok(false),
}
}
#[cfg(test)]
mod tests {
use pyo3::{
types::{PyBool, PyDict, PyModule, PyString},
IntoPy,
};
use super::*;
#[test]
fn function_metadata() -> PyResult<()> {
pyo3::prepare_freethreaded_python();
Python::with_gil(|py| {
let module = PyModule::from_code(
py,
r#"
def regular_func(first_arg, second_arg):
pass
async def async_func():
pass
"#,
"",
"",
)?;
let regular_func = module.getattr("regular_func")?.into_py(py);
assert_eq!(
FuncMetadata {
name: "regular_func".to_string(),
is_coroutine: false,
num_args: 2,
},
func_metadata(py, ®ular_func)?
);
let async_func = module.getattr("async_func")?.into_py(py);
assert_eq!(
FuncMetadata {
name: "async_func".to_string(),
is_coroutine: true,
num_args: 0,
},
func_metadata(py, &async_func)?
);
Ok(())
})
}
#[test]
fn check_if_is_optional_of() -> PyResult<()> {
pyo3::prepare_freethreaded_python();
Python::with_gil(|py| {
let typing = py.import("typing")?;
let module = PyModule::from_code(
py,
r#"
import typing
class Types:
opt_of_str: typing.Optional[str] = "hello"
opt_of_bool: typing.Optional[bool] = None
regular_str: str = "world"
"#,
"",
"",
)?;
let types = module.getattr("Types")?.into_py(py);
let type_hints = typing
.call_method1("get_type_hints", (types,))
.and_then(|res| res.extract::<&PyDict>())?;
assert_eq!(
true,
is_optional_of::<PyString>(py, type_hints.get_item("opt_of_str").unwrap())?
);
assert_eq!(
false,
is_optional_of::<PyString>(py, type_hints.get_item("regular_str").unwrap())?
);
assert_eq!(
true,
is_optional_of::<PyBool>(py, type_hints.get_item("opt_of_bool").unwrap())?
);
assert_eq!(
false,
is_optional_of::<PyString>(py, type_hints.get_item("opt_of_bool").unwrap())?
);
Ok(())
})
}
}