Quickstart

Requirements

CPython 3.8/3.9/3.10/3.11
WSGI application

Installation

You can install wsgi_lineprof from PyPI.

$ pip install wsgi_lineprof

We provide wheel packages for some platforms. If your platform is supported, you don’t need to build C extension. Otherwise, you need environment for building Python C extensions.

Enabling wsgi_lineprof

Apply wsgi_lineprof to the existing WSGI web application called app:

from wsgi_lineprof.middleware import LineProfilerMiddleware

app = LineProfilerMiddleware(app)

Running wsgi_lineprof

Start the web application and access the application. wsgi_lineprof writes results to stdout every time an HTTP request is processed by default. You can see the output like this in your console:

... (snip) ...

File: ./app.py
Name: index
Total time: 1.00518 [sec]
  Line      Hits         Time  Code
===================================
     9                         @app.route('/')
    10                         def index():
    11         1      1005175      time.sleep(1)
    12         1            4      return "Hello world!!"

... (snip) ...

Also, you can check the result on your web browser by accessing the special endpoint /wsgi_lineprof/.

Next Steps

See Examples for more examples of integrating wsgi_lineprof with your applications.
See Configuration for advanced usage such as filtering results, writing results to the file, accumulating results, and so on.