`asv_runner.benchmarks.peakmem`#

Module Contents#

Represents a single benchmark for tracking the peak memory consumption of the whole program.

class asv_runner.benchmarks.peakmem.PeakMemBenchmark(name, func, attr_sources)#

Represents a single benchmark for tracking the peak memory consumption of the whole program.

The PeakMemBenchmark class provides a benchmark type for tracking the peak memory consumption of the program while the benchmark function is running.

name_regex (re.Pattern): The regular expression used to match the names of functions that should be considered as peak memory benchmarks.
type (str): The type of the benchmark. The default type is “peakmemory”.
unit (str): The unit of the value that’s being tracked. By default, this is “bytes”.

Initialization

Initializes a new instance of the PeakMemBenchmark class.

name (str): The name of the benchmark.
func (callable): The function to benchmark.
attr_sources (list): A list of objects to search for attributes that might be used by the benchmark.

run(*param)#

Runs the benchmark function and measures its peak memory consumption.

result (int): The peak memory consumption in bytes of the program while the benchmark function was running.