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.

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

CUDA Array Interface (CAI) protocol.

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 'numbers.Integral'>

Address-sized integral type.

alias of numbers.Integral

mpi4py.typing.Count = <class 'numbers.Integral'>

Integral type for counts.

alias of numbers.Integral

mpi4py.typing.Displ = <class 'numbers.Integral'>

Integral type for displacements.

alias of numbers.Integral

mpi4py.typing.Offset = <class 'numbers.Integral'>

Integral type for offsets.

alias of numbers.Integral

mpi4py.typing.TypeSpec

Datatype specification.

alias of Datatype | str

mpi4py.typing.BufSpec

Buffer specification.

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

mpi4py.typing.BufSpecB

Buffer specification (block).

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

mpi4py.typing.BufSpecV

Buffer specification (vector).

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

mpi4py.typing.BufSpecW

Buffer specification (generalized).

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

mpi4py.typing.TargetSpec

Target specification.

alias of Integral | Tuple | Tuple[Integral] | Tuple[Integral, Integral] | Tuple[Integral, Integral, 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.