pycallgraph is a Python module that creates call graphs for Python programs.

fix #120 port from https://github.com/ivannotes/pycallgraph/commit/0b2fb090a6dd2664235600af149f390cdabc3b00 by @ivannotes

rename decorator to trace

usage example:

import pycallgraph
from pycallgraph.output import GraphvizOutput

@pycallgraph.decorators.trace(output=GraphvizOutput())
def yours_very_slow_function():
    ....

TODO: docs

It would be good to be able to see the order in which functions were called. This could get out of hand quite quickly, so maybe track only the first calls.

It would be good to be able to see the order in which functions were called. This could get out of hand quite quickly, so maybe track only the first calls.

It would be good to be able to see the order in which functions were called. This could get out of hand quite quickly, so maybe track only the first calls.

It would be good to be able to see the order in which functions were called. This could get out of hand quite quickly, so maybe track only the first calls.

It looks like pycallgraph/output/gephi.py is using python 2.x style syntax:

Downloading/unpacking pycallgraph (from -r requirements/dev.txt (line 9))
  Downloading pycallgraph-1.0.1.tar.gz
  Running setup.py egg_info for package pycallgraph
    Traceback (most recent call last):
      File "<string>", line 16, in <module>
      File "/projects/acme_project/virtualenv/acme/build/pycallgraph/setup.py", line 9, in <module>
        import pycallgraph
      File "pycallgraph/__init__.py", line 15, in <module>
        from .pycallgraph import PyCallGraph
      File "pycallgraph/pycallgraph.py", line 3, in <module>
        from .output import Output
      File "pycallgraph/output/__init__.py", line 5, in <module>
        from .gephi import GephiOutput
      File "pycallgraph/output/gephi.py", line 28
        return u'\n'.join([
                   ^
    SyntaxError: invalid syntax
    Complete output from command python setup.py egg_info:
    Traceback (most recent call last):

  File "<string>", line 16, in <module>

  File "/projects/acme_project/virtualenv/acme/build/pycallgraph/setup.py", line 9, in <module>

    import pycallgraph

  File "pycallgraph/__init__.py", line 15, in <module>

    from .pycallgraph import PyCallGraph

  File "pycallgraph/pycallgraph.py", line 3, in <module>

    from .output import Output

  File "pycallgraph/output/__init__.py", line 5, in <module>

    from .gephi import GephiOutput

  File "pycallgraph/output/gephi.py", line 28

    return u'\n'.join([

               ^

SyntaxError: invalid syntax

I was amazed at how simple it was to install and use pycallgraph. Just one suggestion.

It would be very helpful if you could specify sys.argv to the called script on the command line. That way I wouldn't have to make a new script file for every set of options. If you put the output filename before the scriptfile you could feed the rest of the command line to the called script. For example:

{{{ pycallgraph-dot.py test1.png myscript.py --spam=42 ham.txt eggs.txt }}}

I was amazed at how simple it was to install and use pycallgraph. Just one suggestion.

It would be very helpful if you could specify sys.argv to the called script on the command line. That way I wouldn't have to make a new script file for every set of options. If you put the output filename before the scriptfile you could feed the rest of the command line to the called script. For example:

{{{ pycallgraph-dot.py test1.png myscript.py --spam=42 ham.txt eggs.txt }}}

I was amazed at how simple it was to install and use pycallgraph. Just one suggestion.

It would be very helpful if you could specify sys.argv to the called script on the command line. That way I wouldn't have to make a new script file for every set of options. If you put the output filename before the scriptfile you could feed the rest of the command line to the called script. For example:

{{{ pycallgraph-dot.py test1.png myscript.py --spam=42 ham.txt eggs.txt }}}

I was amazed at how simple it was to install and use pycallgraph. Just one suggestion.

It would be very helpful if you could specify sys.argv to the called script on the command line. That way I wouldn't have to make a new script file for every set of options. If you put the output filename before the scriptfile you could feed the rest of the command line to the called script. For example:

{{{ pycallgraph-dot.py test1.png myscript.py --spam=42 ham.txt eggs.txt }}}

I'm using pycallgraph 0.5.1, Django 1.3.1, Python 2.7.2 32bit.

Line 235 of pycallgraph.py, which gets the "class" of "self" in the current call being traced, causes an infinite loop. The method being traced is SimpleLazyObject's "init", which among other things sets "self._wrapped". ".class" triggers the "__get_class" method on the object, which checks if "_wrapped" is None, but since the constructor hasn't run yet (it was intercepted by the tracer), this gets translated into a "getattr" call on the object, which again checks if "_wrapped" is None... etc.

Here is the relevant part the stack trace. I used custom middleware to integrate pycallgraph in Django.

C:\Python27\lib\site-packages\django\contrib\auth\context_processors.py in auth   57. 'user': SimpleLazyObject(get_user), C:\Python27\lib\site-packages\django\utils\functional.py in init   316. def init(self, func): C:\Python27\lib\site-packages\pycallgraph.py in tracer   235. class_name = frame.f_locals['self'].class.name C:\Python27\lib\site-packages\django\utils\functional.py in __get_class   354. if self._wrapped is None: self._setup() C:\Python27\lib\site-packages\django\utils\functional.py in getattr   275. if self._wrapped is None: ... (this is the infinite loop) ... C:\Python27\lib\site-packages\django\utils\functional.py in getattr   275. if self._wrapped is None:

Config.init_libpath only looks at sysconfig.get_python_lib() (usually /usr/lib/), and doesnt include sysconfig.get_python_lib(plat_specific=True) , which is usually /usr/lib64. The later is where re.match will come from for most distro users. Both directories need to be used to determine if a module is part of the stdlib.

I have repeatedly tried PyCallGraphException with different results. I have gotten it to work with max_depth=4, but not max_depth=5. I do not appear to have a file named "tmpxw3sbjz1" (or similar file with a recent timestamp). Dot is in my path and I can execute the command manually from within Jupyter, but this command ("dot -Tpng -oML4AR2 pycallgraph.png C:\Users\XXXX\AppData\Local\Temp\tmpxw3sbjz1" ) does not work.

Here is the code

    from pycallgraph import PyCallGraph
    from pycallgraph import Config
    from pycallgraph import GlobbingFilter
    from pycallgraph.output import GraphvizOutput

    pycall_exclude = ['time.*', 'datetime.*', 'dateutil.*', 'argparse.*',
                    'numpy.*', 'pandas.*', 'yaml.*', 'pickle.*',
                    'psutil.*', 'sys.*', 'warnings.*', 'sklearn.*', 
                    'collections.*', 'scipy.*', 'tqdm.*', 'os.*',
                    'logging.*', 'pycallgraph.*']

    config = Config(max_depth=5)

    config.trace_filter = GlobbingFilter(exclude=pycall_exclude)
    graphviz = GraphvizOutput(output_file='ML4AR2 pycallgraph.png')

    if __name__ == '__main__':
        with PyCallGraph(output=graphviz, config=config):
               main()

Here is a description of my environment

INSTALLED VERSIONS
------------------
commit: None
python: 3.6.8.final.0
python-bits: 64
OS: Windows
OS-release: 10
machine: AMD64
processor: Intel64 Family 6 Model 78 Stepping 3, GenuineIntel
byteorder: little
LC_ALL: en_US_UTF-8
LANG: en_US.UTF-8
LOCALE: English_United States.1252

pandas: 0.24.1
pytest: 4.2.0
pip: 19.0.1
setuptools: 40.7.3
Cython: 0.29.4
numpy: 1.15.4
scipy: 1.2.0
pyarrow: None
xarray: None
IPython: 7.2.0
sphinx: 1.8.4
patsy: 0.5.1
dateutil: 2.7.5
pytz: 2018.9
blosc: None
bottleneck: 1.2.1
tables: 3.4.4
numexpr: 2.6.9
feather: None
matplotlib: 3.0.2
openpyxl: 2.5.14
xlrd: 1.2.0
xlwt: 1.3.0
xlsxwriter: 1.1.2
lxml.etree: 4.3.0
bs4: 4.7.1
html5lib: 1.0.1
sqlalchemy: 1.2.17
pymysql: None
psycopg2: None
jinja2: 2.10
s3fs: None
fastparquet: None
pandas_gbq: None
pandas_datareader: None
gcsfs: None

Please advise

Dears,

I would like to know if using pycallgraph I can show the chronology of the call graph. I'm thinking that at current time there is no special ordering about the "boxes" positioning .

pycallgraph has been a useful resource for performance testing my projects, but the PyPi release is far behind. I forked pycallgraph, merged the develop branch, and released pycallgraph2 on PyPi today.

I'll be actively maintaining and updating pycallgraph2 at on my fork if anyone would like to contribute. Namely, it needs stability updates + a wiki.

Using pycallgraph==1.0.1 with python 3.5.3 and locale ('fr_FR', 'UTF-8'), I got a tons of UTF-8 random errors that were somehow fixed by just changing the format from n to d.