scope_profiler.mpi_wrappers

Opt-in profiling wrappers for mpi4py communicators and requests.

Importing this module never imports mpi4py. Pass an existing communicator to profile_mpi_comm, or explicitly call profile_mpi4py to patch predefined communicators for the duration of a run. Importing scope-profiler therefore cannot initialize MPI in a serial process.

Classes

Name	Description
MPIRegionMetadata	Structured metadata decoded from a Python or native MPI region name.
ProfiledMPIComm	A transparent communicator proxy for common mpi4py operations.
ProfiledMPIRequest	A request proxy that attributes blocking completion time to MPI wait.

Functions

Name	Description
format_mpi_region	Return the canonical region name shared by Python and C++ wrappers.
message_nbytes	Estimate payload bytes for an mpi4py object or buffer specification.
parse_mpi_region	Decode a canonical MPI region name, or return None for another region.
profile_mpi4py	Temporarily profile mpi4py's predefined communicators.
profile_mpi_comm	Wrap a communicator without importing mpi4py.

MPIRegionMetadataclassdataclass#

View source

class MPIRegionMetadata(operation: str, kind: str, bytes: int, peer: int, root: int, tag: int, communicator: int, request: str | None = None)

Structured metadata decoded from a Python or native MPI region name.

bytesattributeinstance attribute#

View source

bytes: int

communicatorattributeinstance attribute#

View source

communicator: int

kindattributeinstance attribute#

View source

kind: str

operationattributeinstance attribute#

View source

operation: str

peerattributeinstance attribute#

View source

peer: int

requestattributeclass attributeinstance attribute#

View source

request: str | None = None

rootattributeinstance attribute#

View source

root: int

tagattributeinstance attribute#

View source

tag: int

ProfiledMPICommclass#

View source

class ProfiledMPIComm(communicator: Any, *, pickle_object_sizes: bool = False)

A transparent communicator proxy for common mpi4py operations.

communicatorproperty#

View source

communicator: Any

The unwrapped mpi4py communicator.

Allreducemethod#

View source

def Allreduce(sendbuf, recvbuf, op=None)

Barriermethod#

View source

def Barrier()

Bcastmethod#

View source

def Bcast(buf, root: int = 0)

Irecvmethod#

View source

def Irecv(buf, source: int = -1, tag: int = -1) -> ProfiledMPIRequest

Isendmethod#

View source

def Isend(buf, dest: int, tag: int = 0) -> ProfiledMPIRequest

Recvmethod#

View source

def Recv(buf, source: int = -1, tag: int = -1, status=None)

Reducemethod#

View source

def Reduce(sendbuf, recvbuf, op=None, root: int = 0)

Sendmethod#

View source

def Send(buf, dest: int, tag: int = 0)

allreducemethod#

View source

def allreduce(sendobj, op=None)

barriermethod#

View source

def barrier()

bcastmethod#

View source

def bcast(obj, root: int = 0)

irecvmethod#

View source

def irecv(buf=None, source: int = -1, tag: int = -1) -> ProfiledMPIRequest

isendmethod#

View source

def isend(obj, dest: int, tag: int = 0) -> ProfiledMPIRequest

recvmethod#

View source

def recv(buf=None, source: int = -1, tag: int = -1, status=None)

reducemethod#

View source

def reduce(sendobj, op=None, root: int = 0)

sendmethod#

View source

def send(obj, dest: int, tag: int = 0)

ProfiledMPIRequestclass#

View source

class ProfiledMPIRequest(request: Any, *, operation: str, bytes: int, peer: int, tag: int, communicator: int)

A request proxy that attributes blocking completion time to MPI wait.

Waitmethod#

View source

def Wait(status=None)

waitmethod#

View source

def wait(status=None)

format_mpi_regionfunction#

View source

def format_mpi_region(operation: str, *, bytes: int = -1, peer: int = -1, root: int = -1, tag: int = -1, communicator: int = -1, request: str | None = None) -> str

Return the canonical region name shared by Python and C++ wrappers.

message_nbytesfunction#

View source

def message_nbytes(value: Any, *, pickle_objects: bool = True) -> int

Estimate payload bytes for an mpi4py object or buffer specification.

Buffer-mode calls are exact when their datatype exposes Get_size. Object-mode values use their buffer size when possible. With pickle_objects=True (the default for this explicit helper), other objects use the size of their protocol-5 pickle. -1 means unknown.

parse_mpi_regionfunction#

View source

def parse_mpi_region(name: str) -> MPIRegionMetadata | None

Decode a canonical MPI region name, or return None for another region.

profile_mpi4pyfunction#

View source

def profile_mpi4py(mpi_module: Any = None, *, pickle_object_sizes: bool = False, lazy: bool = False) -> Iterator[None]

Temporarily profile mpi4py’s predefined communicators.

When lazy is true, mpi4py is wrapped only if the target imports it. This lets scope-profiler run --mpi-calls enable MPI-call profiling without importing or initializing MPI for an ordinary serial program. Both globals and Python’s import function are restored even when the program raises.

profile_mpi_commfunction#

View source

def profile_mpi_comm(communicator: Any, *, pickle_object_sizes: bool = False) -> ProfiledMPIComm

Wrap a communicator without importing mpi4py.

Set pickle_object_sizes=True to measure serialized object-mode payloads at the cost of one extra serialization per call. It is off by default to avoid overhead and repeated __reduce__ side effects.