Useful frames hidden

[asmeurer]

I am trying to profile some SymPy code. However, the output hides all the useful information in "hidden frames".

# test.py
from sympy import symbols, Min
x = symbols('x:50')
Min(*x)

  _     ._   __/__   _ _  _  _ _/_   Recorded: 23:10:12  Samples:  2312
 /_//_/// /_\ / //_// / //_'/ //     Duration: 3.560     CPU time: 3.540
/   _/                      v3.0.1

Program: test.py

3.559 <module>  test.py:1
├─ 3.062 __new__  sympy/functions/elementary/miscellaneous.py:341
│     [1798 frames hidden]  sympy, random
└─ 0.497 <module>  sympy/__init__.py:12
      [751 frames hidden]  sympy, inspect, enum, re, collections...

To view this report with different options, run:
    pyinstrument --load-prev 2019-03-14T23-10-12 [options]

[mikedh]

Hey, great package thanks for releasing it!

I'd also like to expand the hidden frames through the Python API. In the changelog:
Hidden code is controlled by the --hide or --hide-regex options - matching on the path of the code files.

How would one do that through the Python API? I checked the args for Profiler, profiler.start, and profiler.output_text, and none of them seemed to have an option for "show me all the things."

[joerick]

@asmeurer if you're interested in profiling a library that's installed into your environment, try using --show-all on the command line.

@mikedh it's true that the python API could use some love (specifically documentation)! But in your case, it would be something like:

from pyinstrument import Profiler
from pyinstrument.renderers import ConsoleRenderer

profiler = Profiler()
profiler.start()

# code you want to profile

session = profiler.stop()
profile_renderer = ConsoleRenderer(unicode=True, color=True, show_all=True)

print(profile_renderer.render(session))

[joerick]

Hi @asmeurer - FYI I just released an update to make this a little easier.

You can now do pyinstrument --show '*/sympy/*' test.py and Pyinstrument will show that library's frames while still hiding others.

[asmeurer]

How does pyinstrument determine which frames are useful or not?

[joerick]

Normally, using the default --hide param */lib/*. if those files are in a path that contains /lib/, they are considered to be third party libraries. This catches anything that has been installed by pip and hides it.

Does that make sense for how you're using it? Let me know if it doesn't fit your use case.