API Documentation

Main module.

class minelog.MineLog(path=None, /)

Bases: object

Class for search in minecraft logs.

Parameters:

path (Path | None)

__init__(path=None, /)

Create a MineLog instance.

Parameters:

path (Path | None)

Return type:

None

compile(pattern, /)

Compile the regex.

Parameters:

pattern (bytes | Pattern[bytes])

Return type:

Pattern[bytes]

iter_open()

Iterate over all files and open them.

Return type:

Iterator[tuple[Path, IO[bytes]]]

iter_match(pattern, /)

Iterate over all match found inside logs.

Parameters:

pattern (bytes | Pattern[bytes])

Return type:

Iterator[LogEntry]

search_bytes(pattern, /, *, repl=None, unique=False, sort=False)

Search and return replacement with a regex.

Parameters:

• pattern (bytes | Pattern[bytes])

• repl (bytes | Callable[[Match[bytes]], bytes] | None)

• unique (bool | None)

• sort (bool | None)

Return type:

Iterator[bytes]

__repr__()

Represent a MineLog.

Return type:

str