`asv_runner.benchmarks.mem`#

Module Contents#

Represents a single benchmark for tracking the memory consumption of an object.

class asv_runner.benchmarks.mem.MemBenchmark(name, func, attr_sources)#

Represents a single benchmark for tracking the memory consumption of an object.

The MemBenchmark class provides a benchmark type for tracking the memory consumption of the object returned by the benchmark function.

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

*run(param): Runs the benchmark function and returns the memory consumption of the object returned by the function.

Initialization

Initializes a new instance of the MemBenchmark 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 the memory consumption of the object returned by the function.

result (int): The memory consumption in bytes of the object returned by the benchmark function.