flexprofiler 0.1.0

A flexible profiling utility for Python.

flexprofiler

A flexible profiling utility for Python.

Installation

pip install flexprofiler

Usage Examples

1. Tracking a Simple Function

import time
from flexprofiler import FlexProfiler

profiler = FlexProfiler(max_depth=5, detailed=True, record_each_call=True)

@profiler.track
def simple_func():
    for i in range(3):
        time.sleep(0.1)

simple_func()
simple_func()

profiler.stats()

Output

<title>stdin</title>

Detailed Function Call Statistics:
simple_func: 2 calls, Total: 0.6008s, Avg: 0.3004s, Std: 0.0000s, Median: 0.3004s

2. Tracking All Methods in a Class

import time
from flexprofiler import FlexProfiler

profiler = FlexProfiler(max_depth=5, detailed=True, record_each_call=True)

@profiler.track_all_recursive()
class Foo:
    def example_method(self):
        self.another_method()
        time.sleep(0.1)
    def another_method(self):
        time.sleep(0.2)

Foo().example_method()
Foo().another_method()

profiler.stats()

output:

<title>stdin</title>

Detailed Function Call Statistics:
Foo.example_method: 1 calls, Total: 0.3003s, Avg: 0.3003s
  └──Foo.another_method:      1 calls, Total: 0.2002s, Avg: 0.2002s
Foo.another_method: 1 calls, Total: 0.2001s, Avg: 0.2001s

3. Tracking All Methods in a Class Recursively

import time
from flexprofiler import FlexProfiler

profiler = FlexProfiler(max_depth=5, detailed=True, record_each_call=True)

@profiler.track_all_recursive()
class Foo:
    def __init__(self):
        self.sub_class = Bar()
    def example_method(self):
        self.another_method()
        time.sleep(0.1)
    def another_method(self):
        time.sleep(0.2)
    def calling_subclass_method(self):
        for i in range(3):
            self.sub_class.subclass_method_1()
            self.sub_class.subclass_method_2()
            self.sub_class.subclass_method_3()

class Bar:
    def subclass_method_1(self):
        time.sleep(0.05)
    def subclass_method_2(self):
        self.a()
        self.b()
    def subclass_method_3(self):
        self.a()
        self.b()
    def a(self):
        time.sleep(0.02)
    def b(self):
        time.sleep(0.01)

obj = Foo()
obj.example_method()
obj.calling_subclass_method()

profiler.stats()

output:

<title>stdin</title>

Detailed Function Call Statistics:
Foo.__init__: 2 calls, Total: 0.0001s, Avg: 0.0000s, Std: 0.0001s, Median: 0.0000s
Foo.example_method: 1 calls, Total: 0.3003s, Avg: 0.3003s
  └──Foo.another_method:      1 calls, Total: 0.2001s, Avg: 0.2001s
Foo.calling_subclass_method: 1 calls, Total: 0.3326s, Avg: 0.3326s
  ├──Bar.subclass_method_1:  │   3 calls, Total: 0.1504s, Avg: 0.0501s, Std: 0.0001s, Median: 0.0501s
  ├──Bar.subclass_method_2:  │   3 calls, Total: 0.0910s, Avg: 0.0303s, Std: 0.0001s, Median: 0.0303s
  │    ├──Bar.a:       │   3 calls, Total: 0.0604s, Avg: 0.0201s, Std: 0.0001s, Median: 0.0201s
  │    └──Bar.b:           3 calls, Total: 0.0303s, Avg: 0.0101s, Std: 0.0000s, Median: 0.0101s
  └──Bar.subclass_method_3:      3 calls, Total: 0.0910s, Avg: 0.0303s, Std: 0.0002s, Median: 0.0303s
       ├──Bar.a:       │   3 calls, Total: 0.0604s, Avg: 0.0201s, Std: 0.0001s, Median: 0.0201s
       └──Bar.b:           3 calls, Total: 0.0304s, Avg: 0.0101s, Std: 0.0001s, Median: 0.0102s

Author

Arthur Bucker ([e-mail])