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

class mpi4py.typing.SupportsBuffer

Python buffer protocol.

See also

Buffer Protocol

__buffer__(flags, /)

Create a buffer from a Python object.

Parameters:

flags (int)

Return type:

memoryview

class mpi4py.typing.SupportsDLPack

DLPack data interchange protocol.

See also

Python Specification for DLPack

__dlpack__(*, stream=None)

Export data for consumption as a DLPack capsule.

Parameters:

stream (int | Any | None)

Return type:

object

__dlpack_device__()

Get device type and device ID in DLPack format.

Return type:

tuple[int, int]

class mpi4py.typing.SupportsCAI

CUDA Array Interface (CAI) protocol.

See also

CUDA Array Interface (Version 3)

property __cuda_array_interface__: dict[str, Any]

CAI protocol data.

type mpi4py.typing.Buffer = SupportsBuffer | SupportsDLPack | SupportsCAI

Buffer-like object.

type mpi4py.typing.Bottom = BottomType | None

Start of the address range.

type mpi4py.typing.InPlace = InPlaceType | None

In-place buffer argument.

type mpi4py.typing.Aint = SupportsIndex

Address-sized integral type.

type mpi4py.typing.Count = SupportsIndex

Integral type for counts.

type mpi4py.typing.Displ = SupportsIndex

Integral type for displacements.

type mpi4py.typing.Offset = SupportsIndex

Integral type for offsets.

type mpi4py.typing.TypeSpec = Datatype | str

Datatype specification.

type mpi4py.typing.BufSpec = 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]

Buffer specification.

• Buffer

• tuple[Buffer, Count]

• tuple[Buffer, TypeSpec]

• tuple[Buffer, Count, TypeSpec]

• tuple[Bottom, Count, Datatype]

type mpi4py.typing.BufSpecB = SupportsBuffer | SupportsDLPack | SupportsCAI | tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, SupportsIndex] | tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, Datatype | str] | tuple[SupportsBuffer | SupportsDLPack | SupportsCAI, SupportsIndex, Datatype | str] | list[Any]

Buffer specification (block).

• Buffer

• tuple[Buffer, Count]

• tuple[Buffer, TypeSpec]

• tuple[Buffer, Count, TypeSpec]

type mpi4py.typing.BufSpecV = 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]

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]

type mpi4py.typing.BufSpecW = 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]

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]]

type mpi4py.typing.TargetSpec = SupportsIndex | tuple[()] | tuple[SupportsIndex] | tuple[SupportsIndex, SupportsIndex] | tuple[SupportsIndex, SupportsIndex, Datatype | str] | list[Any]

Target specification.

• Displ

• tuple[()]

• tuple[Displ]

• tuple[Displ, Count]

• tuple[Displ, Count, TypeSpec]

mpi4py.typing.S = ~S

Type variable.

mpi4py.typing.T = ~T

Type variable.

mpi4py.typing.U = ~U

Type variable.

mpi4py.typing.V = ~V

Type variable.