module documentation

Mailmap file reader.

Class Mailmap Class for accessing a mailmap file.
Function parse_identity Parse an identity string into name and email.
Function read_mailmap Read a mailmap.
def parse_identity(text: bytes) -> tuple[bytes | None, bytes | None]:

Parse an identity string into name and email.

Parameters
text:bytesIdentity string in format "Name <email>"
Returns
tuple[bytes | None, bytes | None]Tuple of (name, email) where either can be None
def read_mailmap(f: IO[bytes]) -> Iterator[tuple[tuple[bytes | None, bytes | None], tuple[bytes | None, bytes | None] | None]]:

Read a mailmap.

Returns: Iterator over
((canonical_name, canonical_email), (from_name, from_email)) tuples
Parameters
f:IO[bytes]File-like object to read from
Returns
Iterator[tuple[tuple[bytes | None, bytes | None], tuple[bytes | None, bytes | None] | None]]Undocumented