mpi4py.typing

New 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

alias of mpi4py.typing.SupportsBuffer

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

DLPack data interchange protocol.

alias of mpi4py.typing.SupportsDLPack

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

CUDA Array Interface (CAI) protocol.

alias of mpi4py.typing.SupportsCAI

mpi4py.typing.Buffer

Buffer-like object.

alias of Union[SupportsBuffer, SupportsDLPack, SupportsCAI]

mpi4py.typing.Bottom

Start of the address range.

alias of Optional[BottomType]

mpi4py.typing.InPlace

In-place buffer argument.

alias of Optional[InPlaceType]

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 Union[Datatype, str]

mpi4py.typing.BufSpec

Buffer specification.

alias of Union[SupportsBuffer, SupportsDLPack, SupportsCAI, Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Integral], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Union[Datatype, str]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Integral, Union[Datatype, str]], Tuple[Optional[BottomType], Integral, Datatype], List]

mpi4py.typing.BufSpecB

Buffer specification (block).

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

mpi4py.typing.BufSpecV

Buffer specification (vector).

alias of Union[SupportsBuffer, SupportsDLPack, SupportsCAI, Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Sequence[Integral]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Tuple[Sequence[Integral], Sequence[Integral]]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Union[Datatype, str]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Sequence[Integral], Union[Datatype, str]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Tuple[Sequence[Integral], Sequence[Integral]], Union[Datatype, str]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Sequence[Integral], Sequence[Integral], Union[Datatype, str]], Tuple[Optional[BottomType], Tuple[Sequence[Integral], Sequence[Integral]], Datatype], Tuple[Optional[BottomType], Sequence[Integral], Sequence[Integral], Datatype], List]

mpi4py.typing.BufSpecW

Buffer specification (generalized).

alias of Union[Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Sequence[Datatype]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Tuple[Sequence[Integral], Sequence[Integral]], Sequence[Datatype]], Tuple[Union[SupportsBuffer, SupportsDLPack, SupportsCAI], Sequence[Integral], Sequence[Integral], Sequence[Datatype]], Tuple[Optional[BottomType], Tuple[Sequence[Integral], Sequence[Integral]], Sequence[Datatype]], Tuple[Optional[BottomType], Sequence[Integral], Sequence[Integral], Sequence[Datatype]], List]

mpi4py.typing.TargetSpec

Target specification.

alias of Union[Integral, Tuple[()], Tuple[Integral], Tuple[Integral, Integral], Tuple[Integral, Integral, Union[Datatype, str]], List]