mpi4py.typing

Added in version 4.0.0.

This module provides type aliases used to add type hints to the various functions and methods within the MPI module.

See also

Module typing

Documentation of the typing standard module.

Types Summary

SupportsBuffer	Python buffer protocol.
SupportsDLPack	DLPack data interchange protocol.
SupportsCAI	CUDA Array Interface (CAI) protocol.
Buffer	Buffer-like object.
Bottom	Start of the address range.
InPlace	In-place buffer argument.
Aint	Address-sized integral type.
Count	Integral type for counts.
Displ	Integral type for displacements.
Offset	Integral type for offsets.
TypeSpec	Datatype specification.
BufSpec	Buffer specification.
BufSpecB	Buffer specification (block).
BufSpecV	Buffer specification (vector).
BufSpecW	Buffer specification (generalized).
TargetSpec	Target specification.

Types Documentation

mpi4py.typing.SupportsBuffer = <class 'mpi4py.typing.SupportsBuffer'>

Python buffer protocol.

See also

Buffer Protocol

mpi4py.typing.SupportsDLPack = <class 'mpi4py.typing.SupportsDLPack'>

DLPack data interchange protocol.

See also

Python Specification for DLPack

mpi4py.typing.SupportsCAI = <class 'mpi4py.typing.SupportsCAI'>

CUDA Array Interface (CAI) protocol.

See also

CUDA Array Interface (Version 3)

mpi4py.typing.Buffer

Buffer-like object.

alias of SupportsBuffer | SupportsDLPack | SupportsCAI

mpi4py.typing.Bottom

Start of the address range.

alias of BottomType | None

mpi4py.typing.InPlace

In-place buffer argument.

alias of InPlaceType | None

mpi4py.typing.Aint = <class 'typing.SupportsIndex'>

Address-sized integral type.

alias of SupportsIndex

mpi4py.typing.Count = <class 'typing.SupportsIndex'>

Integral type for counts.

alias of SupportsIndex

mpi4py.typing.Displ = <class 'typing.SupportsIndex'>

Integral type for displacements.

alias of SupportsIndex

mpi4py.typing.Offset = <class 'typing.SupportsIndex'>

Integral type for offsets.

alias of SupportsIndex

mpi4py.typing.TypeSpec

Datatype specification.

alias of Datatype | str

mpi4py.typing.BufSpec

Buffer specification.

• Buffer

• Tuple[Buffer, Count]

• Tuple[Buffer, TypeSpec]

• Tuple[Buffer, Count, TypeSpec]

• Tuple[Bottom, Count, Datatype]

alias of SupportsBuffer | SupportsDLPack | SupportsCAI | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, SupportsIndex] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Datatype | str] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, SupportsIndex, Datatype | str] | Tuple[BottomType | None, SupportsIndex, Datatype] | List[Any]

mpi4py.typing.BufSpecB

Buffer specification (block).

• Buffer

• Tuple[Buffer, Count]

• Tuple[Buffer, TypeSpec]

• Tuple[Buffer, Count, TypeSpec]

alias of SupportsBuffer | SupportsDLPack | SupportsCAI | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, SupportsIndex] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Datatype | str] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, SupportsIndex, Datatype | str] | List[Any]

mpi4py.typing.BufSpecV

Buffer specification (vector).

• Buffer

• Tuple[Buffer, Sequence[Count]]

• Tuple[Buffer, Tuple[Sequence[Count], Sequence[Displ]]]

• Tuple[Buffer, TypeSpec]

• Tuple[Buffer, Sequence[Count], TypeSpec]

• Tuple[Buffer, Tuple[Sequence[Count], Sequence[Displ]], TypeSpec]

• Tuple[Buffer, Sequence[Count], Sequence[Displ], TypeSpec]

• Tuple[Bottom, Tuple[Sequence[Count], Sequence[Displ]], Datatype]

• Tuple[Bottom, Sequence[Count], Sequence[Displ], Datatype]

alias of SupportsBuffer | SupportsDLPack | SupportsCAI | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Sequence[SupportsIndex]] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Tuple[Sequence[SupportsIndex], Sequence[SupportsIndex]]] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Datatype | str] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Sequence[SupportsIndex], Datatype | str] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Tuple[Sequence[SupportsIndex], Sequence[SupportsIndex]], Datatype | str] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Sequence[SupportsIndex], Sequence[SupportsIndex], Datatype | str] | Tuple[BottomType | None, Tuple[Sequence[SupportsIndex], Sequence[SupportsIndex]], Datatype] | Tuple[BottomType | None, Sequence[SupportsIndex], Sequence[SupportsIndex], Datatype] | List[Any]

mpi4py.typing.BufSpecW

Buffer specification (generalized).

• Tuple[Buffer, Sequence[Datatype]]

• Tuple[Buffer, Tuple[Sequence[Count], Sequence[Displ]], Sequence[Datatype]]

• Tuple[Buffer, Sequence[Count], Sequence[Displ], Sequence[Datatype]]

• Tuple[Bottom, Tuple[Sequence[Count], Sequence[Displ]], Sequence[Datatype]]

• Tuple[Bottom, Sequence[Count], Sequence[Displ], Sequence[Datatype]]

alias of Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Sequence[Datatype]] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Tuple[Sequence[SupportsIndex], Sequence[SupportsIndex]], Sequence[Datatype]] | Tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Sequence[SupportsIndex], Sequence[SupportsIndex], Sequence[Datatype]] | Tuple[BottomType | None, Tuple[Sequence[SupportsIndex], Sequence[SupportsIndex]], Sequence[Datatype]] | Tuple[BottomType | None, Sequence[SupportsIndex], Sequence[SupportsIndex], Sequence[Datatype]] | List[Any]

mpi4py.typing.TargetSpec

Target specification.

• Displ

• Tuple[()]

• Tuple[Displ]

• Tuple[Displ, Count]

• Tuple[Displ, Count, TypeSpec]

alias of SupportsIndex | Tuple | Tuple[SupportsIndex] | Tuple[SupportsIndex, SupportsIndex] | Tuple[SupportsIndex, SupportsIndex, Datatype | str] | List[Any]

mpi4py.typing.S = TypeVar("S")

Invariant TypeVar.

mpi4py.typing.T = TypeVar("T")

Invariant TypeVar.

mpi4py.typing.U = TypeVar("U")

Invariant TypeVar.

mpi4py.typing.V = TypeVar("V")

Invariant TypeVar.