Struct TypeHint 

pub struct TypeHint { /* private fields */ }

A type hint.

This struct aims at being used in const contexts like in FromPyObject::INPUT_TYPE and IntoPyObject::OUTPUT_TYPE.

use pyo3::inspect::TypeHint;

const T: TypeHint = TypeHint::union(&[TypeHint::builtin("int"), TypeHint::module_attr("b", "B")]);
assert_eq!(T.to_string(), "int | b.B");

Implementations

impl TypeHint

pub const fn builtin(name: &'static str) -> Self

A builtin like int or list

use pyo3::inspect::TypeHint;

const T: TypeHint = TypeHint::builtin("int");
assert_eq!(T.to_string(), "int");

pub const fn module_attr(module: &'static str, attr: &'static str) -> Self

A type contained in a module like datetime.time

use pyo3::inspect::TypeHint;

const T: TypeHint = TypeHint::module_attr("datetime", "time");
assert_eq!(T.to_string(), "datetime.time");

pub const fn union(elts: &'static [TypeHint]) -> Self

The union of multiple types

use pyo3::inspect::TypeHint;

const T: TypeHint = TypeHint::union(&[TypeHint::builtin("int"), TypeHint::builtin("float")]);
assert_eq!(T.to_string(), "int | float");

pub const fn subscript(value: &'static Self, slice: &'static [Self]) -> Self

A subscribed type, often a container

use pyo3::inspect::TypeHint;

const T: TypeHint = TypeHint::subscript(&TypeHint::builtin("dict"), &[TypeHint::builtin("int"), TypeHint::builtin("str")]);
assert_eq!(T.to_string(), "dict[int, str]");

Trait Implementations

impl Clone for TypeHint

fn clone(&self) -> TypeHint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for TypeHint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for TypeHint