pytracy 0.0.2rc5

python package for tracing the performance of python code

pytracy

PyTracy is a python package that allows you to profile your python code using the Tracy profiler. It is a wrapper around the Tracy profiler, which is a real-time, nanosecond resolution, remote telemetry, hybrid frame and sampling profiler for games and other applications. PyTracy allows you to profile your python code with minimal overhead and visualize the results in the Tracy profiler.

Features

• Real-time, nanosecond resolution, remote telemetry, hybrid frame and sampling profiler
• Minimal overhead
• Easy integration with python code
• Support for free threaded python

Installation

Download the pytracy package using the following command: pip install pytracy

To connect to a profiled application, you will need the Tracy profiler. Follow the steps below:

Download Tracy profiler from Tracy Github.

• For Windows, an executable is provided by the author.
• For Linux, you need to build it from the source (refer to Tracy documentation for build instructions).

Usage

1. Enable the profiler

import pytracy
pytracy.enable_tracing(True)

2. Start your script
3. Start Tracy profiler and click connect

Limitations:

• Relatively high overhead. Enabling PyTracy currently average ~380ns per function call, compared to ~80ns for an untraced function call. The theoretical limit is an overhead of ~250ns per function call. This has been measured by giving the python profiler an empty function as a profiler callback.
• set_tracing_mode doesn't work for already started threads. It has to be called before other threads are started.
• No visibility into functions run using multiprocessing.

Goals for 0.3.0 release

• Mac support
• Shutdown and startup during program execution
• Changing of the tracing mode during runtime
• Easy integration with python logging

Goals for 0.4.0 release

• Offline mode - save trace to file
• Preinitialize all of the code objects, using gc module

Performance measurements

py .\utils\perf.py

Test	Average	Std. Deviation
Base	80.00 ns	45.87 ns
python empty profile_function	246.06 ns	47.37 ns
PyTracy Debug(19587f466)	3390.63 ns	375.23 ns
PyTracy Release(19587f466)	1441.24 ns	66.48 ns
PyTracy Release(c6c8c803e)	950.58 ns	113.11 ns
PyTracy Release(a42aa86b5)	760.63 ns	49.53 ns