PyStubType

pyo3_stub_gen

Trait PyStubType 

Source 
pub trait PyStubType {
    // Required method
    fn type_output() -> TypeInfo;

    // Provided method
    fn type_input() -> TypeInfo { ... }
}
Expand description

Annotate Rust types with Python type information for stub file generation.

This trait is used to generate Python stub files (.pyi) from Rust types. For runtime type alias support, see runtime::PyRuntimeType.

Required Methods§

Source

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

Provided Methods§

Source

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

This defaults to the output type, but can be overridden for types that are not valid input types. For example, Vec::<T>::type_output returns list[T] while Vec::<T>::type_input returns typing.Sequence[T].

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

Source§

impl PyStubType for &str

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Cow<'_, str>

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Cow<'_, OsStr>

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Cow<'_, [u8]>

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for IpAddr

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for bool

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for char

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for f32

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for f64

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for i8

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for i16

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for i32

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for i64

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for i128

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for isize

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for u8

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for u16

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for u32

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for u64

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for u128

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for ()

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for usize

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for String

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Ipv4Addr

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Ipv6Addr

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Duration

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for OsStr

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for OsString

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PathBuf

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl PyStubType for SystemTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for NaiveDate

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for NaiveDateTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for NaiveTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for FixedOffset

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Utc

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Uuid

Available on crate feature uuid only.
Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Duration

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Complex32

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Complex64

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for CompareOp

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Date

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Date

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for DateTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Decimal

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Duration

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for ISOWeekDate

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for NotNan<f32>

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for NotNan<f64>

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Offset

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for OffsetDateTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for OrderedFloat<f32>

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for OrderedFloat<f64>

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PrimitiveDateTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyAny

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyArithmeticError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyArrayDescr

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyAssertionError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyAttributeError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBackedBytes

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBackedStr

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBaseException

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBlockingIOError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBool

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBrokenPipeError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBufferError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyByteArray

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBytes

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyBytesWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyChildProcessError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyComplex

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyConnectionAbortedError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyConnectionError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyConnectionRefusedError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyConnectionResetError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyDate

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyDateTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyDelta

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyDeprecationWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyDict

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyEOFError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyEncodingWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyException

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyFileExistsError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyFileNotFoundError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyFloat

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyFloatingPointError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyFutureWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyGeneratorExit

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyImportError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyImportWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyIndexError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyInt

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyInterruptedError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyIsADirectoryError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyKeyError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyKeyboardInterrupt

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyList

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyLookupError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyMemoryError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyModuleNotFoundError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyNameError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyNotADirectoryError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyNotImplementedError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyOSError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyOverflowError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyPendingDeprecationWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyPermissionError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyProcessLookupError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyRecursionError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyReferenceError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyResourceWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyRuntimeError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyRuntimeWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PySet

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PySlice

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyStopAsyncIteration

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyStopIteration

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyString

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PySyntaxError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PySyntaxWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PySystemError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PySystemExit

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyTimeoutError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyTuple

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyType

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyTypeError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyTzInfo

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUnboundLocalError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUnicodeDecodeError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUnicodeEncodeError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUnicodeError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUnicodeTranslateError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUnicodeWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUntypedArray

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyUserWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyValueError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyWarning

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for PyZeroDivisionError

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for SignedDuration

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Span

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Time

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Time

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for TimeZone

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Timestamp

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for UtcDateTime

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for UtcOffset

Source§

fn type_output() -> TypeInfo

Source§

impl PyStubType for Zoned

Source§

fn type_output() -> TypeInfo

Source§

impl<Key: PyStubType, Value: PyStubType> PyStubType for BTreeMap<Key, Value>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<Key: PyStubType, Value: PyStubType, State> PyStubType for HashMap<Key, Value, State>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<Key: PyStubType, Value: PyStubType, State> PyStubType for IndexMap<Key, Value, State>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<L: PyStubType, R: PyStubType> PyStubType for Either<L, R>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T1: PyStubType> PyStubType for (T1,)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType> PyStubType for (T1, T2)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType, T3: PyStubType> PyStubType for (T1, T2, T3)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType, T3: PyStubType, T4: PyStubType> PyStubType for (T1, T2, T3, T4)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType, T3: PyStubType, T4: PyStubType, T5: PyStubType> PyStubType for (T1, T2, T3, T4, T5)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType, T3: PyStubType, T4: PyStubType, T5: PyStubType, T6: PyStubType> PyStubType for (T1, T2, T3, T4, T5, T6)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType, T3: PyStubType, T4: PyStubType, T5: PyStubType, T6: PyStubType, T7: PyStubType> PyStubType for (T1, T2, T3, T4, T5, T6, T7)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType, T3: PyStubType, T4: PyStubType, T5: PyStubType, T6: PyStubType, T7: PyStubType, T8: PyStubType> PyStubType for (T1, T2, T3, T4, T5, T6, T7, T8)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T1: PyStubType, T2: PyStubType, T3: PyStubType, T4: PyStubType, T5: PyStubType, T6: PyStubType, T7: PyStubType, T8: PyStubType, T9: PyStubType> PyStubType for (T1, T2, T3, T4, T5, T6, T7, T8, T9)

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<T, D> PyStubType for PyReadonlyArray<'_, T, D>
where T: NumPyScalar + Element, D: Dimension,

Source§

fn type_output() -> TypeInfo

Source§

impl<T, D> PyStubType for PyReadwriteArray<'_, T, D>
where T: NumPyScalar + Element, D: Dimension,

Source§

fn type_output() -> TypeInfo

Source§

impl<T: NumPyScalar, D> PyStubType for PyArray<T, D>

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType + PyClass> PyStubType for PyRef<'_, T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType + PyClass<Frozen = False>> PyStubType for PyRefMut<'_, T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for Option<T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for &T

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for Box<T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for BTreeSet<T>

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for Rc<T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for Arc<T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for Vec<T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for Bound<'_, T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for IndexSet<T>

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType> PyStubType for Py<T>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType, E> PyStubType for Result<T, E>

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType, State> PyStubType for HashSet<T, State>

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyStubType, const N: usize> PyStubType for [T; N]

Source§

fn type_input() -> TypeInfo

Source§

fn type_output() -> TypeInfo

Source§

impl<T: PyClass + PyStubType> PyStubType for PyClassInitializer<T>

Source§

fn type_output() -> TypeInfo

Source§

fn type_input() -> TypeInfo

Source§

impl<Tz: TimeZone> PyStubType for DateTime<Tz>

Source§

fn type_output() -> TypeInfo

Implementors§