-
-
Notifications
You must be signed in to change notification settings - Fork 14
/
_py-spy
194 lines (181 loc) · 8.2 KB
/
_py-spy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
#compdef py-spy
# -----------------------------------------------------------------------------
#
# Copyright 2020, The zsh-completions Authors.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of que nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# -----------------------------------------------------------------------------
#
# github.com/benfred/py-spy@d95f8d1235a8
#
# -----------------------------------------------------------------------------
function _py-spy() {
local context curcontext=$curcontext state line expl ret=1
declare -A opt_args
local -a commands
commands=(
'record:Records stack trace information to a flamegraph, speedscope or raw file'
'top:Displays a top like view of functions consuming CPU'
'dump:Dumps stack traces for a target program to stdout'
'help:Prints this message or the help of the given subcommand(s)'
)
function _processes() {
_alternative 'processes:: _pids' 'jobs:: _jobs -t'
}
_arguments -C \
{-h,--help}'[Prints help information]' \
{-V,--version}'[Prints version information]' \
"1: :{_describe 'py-spy commands' commands}" \
'*:: :->args' \
&& ret=0
case $words[1] in
record)
_arguments \
{-p,--pid}'[PID of a running python program to spy on]:pid:_processes' \
{-o,--output}'[Output filename]:filename:_filename' \
{-f,--format}'[Output file format]:format:(flamegraph raw speedscope)' \
{-d,--duration}'[The number of seconds to sample for \(default: unlimited\)]:duration' \
{-r,--rate}'[The number of samples to collect per second \(default: 100\)]:rate' \
{-s,--subprocesses}'[Profile subprocesses of the original process]' \
{-F,--function}'[Aggregate samples by function name instead of by line number]' \
{-g,--gil}'[Only include traces that are holding on to the GIL]' \
{-t,--threads}'[Show thread ids in the output]' \
{-i,--idle}'[Include stack traces for idle threads]' \
"--nonblocking[Don't pause the python process when collecting samples.]" \
{-h,--help}'[Prints help information]' \
{-V,--version}'[Prints version information]' \
'*:python program args:_files'
;;
top)
_arguments \
{-p,--pid}'[PID of a running python program to spy on]:pid:_processes' \
{-r,--rate}'[The number of samples to collect per second \(default: 100\)]:rate' \
{-s,--subprocesses}'[Profile subprocesses of the original process]' \
"--nonblocking[Don't pause the python process when collecting samples.]" \
{-h,--help}'[Prints help information]' \
{-V,--version}'[Prints version information]' \
'*:python program args:_files'
;;
dump)
_arguments \
{-p,--pid}'[PID of a running python program to spy on]:pid:_processes' \
{-l,--locals}'[Show local variables for each frame]' \
{-j,--json}'[Format output as JSON]' \
"--nonblocking[Don't pause the python process when collecting samples.]" \
{-h,--help}'[Prints help information]' \
{-V,--version}'[Prints version information]'
;;
help)
_arguments "1: :{_describe 'command' commands}"
;;
esac
return ret
}
_py-spy "$*"
# -----------------------------------------------------------------------------
#
# py-spy 0.3.3
# Sampling profiler for Python programs
#
# USAGE:
# py-spy <SUBCOMMAND>
#
# OPTIONS:
# -h, --help Prints help information
# -V, --version Prints version information
#
# SUBCOMMANDS:
# record Records stack trace information to a flamegraph, speedscope or raw file
# top Displays a top like view of functions consuming CPU
# dump Dumps stack traces for a target program to stdout
# help Prints this message or the help of the given subcommand(s)
#
# -----------------------------------------------------------------------------
#
# py-spy-record
# Records stack trace information to a flamegraph, speedscope or raw file
#
# USAGE:
# py-spy record [OPTIONS] --output <filename> --pid <pid> [python_program]...
#
# OPTIONS:
# -p, --pid <pid> PID of a running python program to spy on
# -o, --output <filename> Output filename
# -f, --format <format> Output file format [default: flamegraph] [possible values: flamegraph, raw, speedscope]
# -d, --duration <duration> The number of seconds to sample for [default: unlimited]
# -r, --rate <rate> The number of samples to collect per second [default: 100]
# -s, --subprocesses Profile subprocesses of the original process
# -F, --function Aggregate samples by function name instead of by line number
# -g, --gil Only include traces that are holding on to the GIL
# -t, --threads Show thread ids in the output
# -i, --idle Include stack traces for idle threads
# --nonblocking Don't pause the python process when collecting samples. Setting this option will reduce the perfomance impact of sampling, but may lead to inaccurate results
# -h, --help Prints help information
# -V, --version Prints version information
#
# ARGS:
# <python_program>... commandline of a python program to run#
#
# -----------------------------------------------------------------------------
#
# py-spy-top
# Displays a top like view of functions consuming CPU
#
# USAGE:
# py-spy top [OPTIONS] --pid <pid> [python_program]...
#
# OPTIONS:
# -p, --pid <pid> PID of a running python program to spy on
# -r, --rate <rate> The number of samples to collect per second [default: 100]
# -s, --subprocesses Profile subprocesses of the original process
# --nonblocking Don't pause the python process when collecting samples. Setting this option will reduce the perfomance impact of sampling, but may lead to inaccurate results
# -h, --help Prints help information
# -V, --version Prints version information
#
# ARGS:
# <python_program>... commandline of a python program to run#
#
# -----------------------------------------------------------------------------
#
# py-spy-dump
# Dumps stack traces for a target program to stdout
#
# USAGE:
# py-spy dump [OPTIONS] --pid <pid>
#
# OPTIONS:
# -p, --pid <pid> PID of a running python program to spy on
# -l, --locals Show local variables for each frame
# -j, --json Format output as JSON
# --nonblocking Don't pause the python process when collecting samples. Setting this option will reduce the perfomance impact of sampling, but may lead to inaccurate results
# -h, --help Prints help information
# -V, --version Prints version information#
#
# -----------------------------------------------------------------------------
# vim:ft=zsh:et:sts=2:sw=2