Struct TypeInfo 

pub struct TypeInfo {
    pub name: String,
    pub import: HashSet<ImportRef>,
}

Type information for creating Python stub files annotated by PyStubType trait.

Fields

name: String

The Python type name.

import: HashSet<ImportRef>

Python modules must be imported in the stub file.

For example, when name is typing.Sequence[int], import should contain typing. This makes it possible to use user-defined types in the stub file.

Implementations

impl TypeInfo

pub fn none() -> Self

A None type annotation.

pub fn any() -> Self

A typing.Any type annotation.

pub fn list_of<T: PyStubType>() -> Self

A list[Type] type annotation.

pub fn set_of<T: PyStubType>() -> Self

A set[Type] type annotation.

pub fn dict_of<K: PyStubType, V: PyStubType>() -> Self

A dict[Type] type annotation.

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

A type annotation of a built-in type provided from builtins module, such as int, str, or float. Generic builtin types are also possible, such as dict[str, str].

pub fn unqualified(name: &str) -> Self

Unqualified type.

pub fn with_module(name: &str, module: ModuleRef) -> Self

A type annotation of a type that must be imported. The type name must be qualified with the module name:

pyo3_stub_gen::TypeInfo::with_module("pathlib.Path", "pathlib".into());

pub fn locally_defined(type_name: &str, module: ModuleRef) -> Self

A type defined in the PyO3 module.

• Types defined in the same module can be referenced without import. But when it is used in another submodule, it must be imported.
• For example, if A is defined in submod1, it can be used as A in submod1. In submod2, it must be imported as from submod1 import A.

pyo3_stub_gen::TypeInfo::locally_defined("A", "submod1".into());

Trait Implementations

impl BitOr for TypeInfo

type Output = TypeInfo

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl Clone for TypeInfo

fn clone(&self) -> TypeInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeInfo

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

Formats the value using the given formatter.

impl Display for TypeInfo

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

Formats the value using the given formatter.

impl PartialEq for TypeInfo

fn eq(&self, other: &TypeInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TypeInfo

impl StructuralPartialEq for TypeInfo