This is /home/pdm/install/Python-2.1/Doc/lib/python-lib.info, produced by makeinfo version 4.0 from lib.texi. April 15, 2001 2.1  File: python-lib.info, Node: Resource Limits, Next: Resource Usage, Prev: resource, Up: resource Resource Limits --------------- Resources usage can be limited using the `setrlimit()' function described below. Each resource is controlled by a pair of limits: a soft limit and a hard limit. The soft limit is the current limit, and may be lowered or raised by a process over time. The soft limit can never exceed the hard limit. The hard limit can be lowered to any value greater than the soft limit, but not raised. (Only processes with the effective UID of the super-user can raise a hard limit.) The specific resources that can be limited are system dependent. They are described in the `getrlimit(2)' man page. The resources listed below are supported when the underlying operating system supports them; resources which cannot be checked or controlled by the operating system are not defined in this module for those platforms. `getrlimit(resource)' Returns a tuple `(SOFT, HARD)' with the current soft and hard limits of RESOURCE. Raises `ValueError' if an invalid resource is specified, or `error' if the underyling system call fails unexpectedly. `setrlimit(resource, limits)' Sets new limits of consumption of RESOURCE. The LIMITS argument must be a tuple `(SOFT, HARD)' of two integers describing the new limits. A value of `-1' can be used to specify the maximum possible upper limit. Raises `ValueError' if an invalid resource is specified, if the new soft limit exceeds the hard limit, or if a process tries to raise its hard limit (unless the process has an effective UID of super-user). Can also raise `error' if the underyling system call fails. These symbols define resources whose consumption can be controlled using the `setrlimit()' and `getrlimit()' functions described below. The values of these symbols are exactly the constants used by C programs. The UNIX man page for `getrlimit(2)' lists the available resources. Note that not all systems use the same symbol or same value to denote the same resource. `RLIMIT_CORE' The maximum size (in bytes) of a core file that the current process can create. This may result in the creation of a partial core file if a larger core would be required to contain the entire process image. `RLIMIT_CPU' The maximum amount of CPU time (in seconds) that a process can use. If this limit is exceeded, a `SIGXCPU' signal is sent to the process. (See the `signal' module documentation for information about how to catch this signal and do something useful, e.g. flush open files to disk.) `RLIMIT_FSIZE' The maximum size of a file which the process may create. This only affects the stack of the main thread in a multi-threaded process. `RLIMIT_DATA' The maximum size (in bytes) of the process's heap. `RLIMIT_STACK' The maximum size (in bytes) of the call stack for the current process. `RLIMIT_RSS' The maximum resident set size that should be made available to the process. `RLIMIT_NPROC' The maximum number of processes the current process may create. `RLIMIT_NOFILE' The maximum number of open file descriptors for the current process. `RLIMIT_OFILE' The BSD name for `RLIMIT_NOFILE'. `RLIMIT_MEMLOC' The maximm address space which may be locked in memory. `RLIMIT_VMEM' The largest area of mapped memory which the process may occupy. `RLIMIT_AS' The maximum area (in bytes) of address space which may be taken by the process.  File: python-lib.info, Node: Resource Usage, Prev: Resource Limits, Up: resource Resource Usage -------------- These functiona are used to retrieve resource usage information: `getrusage(who)' This function returns a large tuple that describes the resources consumed by either the current process or its children, as specified by the WHO parameter. The WHO parameter should be specified using one of the `RUSAGE_*' constants described below. The elements of the return value each describe how a particular system resource has been used, e.g. amount of time spent running is user mode or number of times the process was swapped out of main memory. Some values are dependent on the clock tick internal, e.g. the amount of memory the process is using. The first two elements of the return value are floating point values representing the amount of time spent executing in user mode and the amount of time spent executing in system mode, respectively. The remaining values are integers. Consult the `getrusage(2)' man page for detailed information about these values. A brief summary is presented here: Offset Resource ------ ----- 0 time in user mode (float) 1 time in system mode (float) 2 maximum resident set size 3 shared memory size 4 unshared memory size 5 unshared stack size 6 page faults not requiring I/O 7 page faults requiring I/O 8 number of swap outs 9 block input operations 10 block output operations 11 messages sent 12 messages received 13 signals received 14 voluntary context switches 15 involuntary context switches This function will raise a `ValueError' if an invalid WHO parameter is specified. It may also raise `error' exception in unusual circumstances. `getpagesize()' Returns the number of bytes in a system page. (This need not be the same as the hardware page size.) This function is useful for determining the number of bytes of memory a process is using. The third element of the tuple returned by `getrusage()' describes memory usage in pages; multiplying by page size produces number of bytes. The following `RUSAGE_*' symbols are passed to the `getrusage()' function to specify which processes information should be provided for. `RUSAGE_SELF' `RUSAGE_SELF' should be used to request information pertaining only to the process itself. `RUSAGE_CHILDREN' Pass to `getrusage()' to request resource information for child processes of the calling process. `RUSAGE_BOTH' Pass to `getrusage()' to request resources consumed by both the current process and child processes. May not be available on all systems.  File: python-lib.info, Node: nis, Next: syslog, Prev: resource, Up: Unix Specific Services Interface to Sun's NIS (Yellow Pages) ===================================== This module was documented by Fred Gansevles . This section was written by Moshe Zadka . Interface to Sun's NIS (a.k.a. Yellow Pages) library. The `nis' module gives a thin wrapper around the NIS library, useful for central administration of several hosts. Because NIS exists only on UNIX systems, this module is only available for UNIX. The `nis' module defines the following functions: `match(key, mapname)' Return the match for KEY in map MAPNAME, or raise an error (`nis.error') if there is none. Both should be strings, KEY is 8-bit clean. Return value is an arbitrary array of bytes (i.e., may contain `NULL' and other joys). Note that MAPNAME is first checked if it is an alias to another name. `cat(mapname)' Return a dictionary mapping KEY to VALUE such that `match(KEY, MAPNAME)==VALUE'. Note that both keys and values of the dictionary are arbitrary arrays of bytes. Note that MAPNAME is first checked if it is an alias to another name. `maps()' Return a list of all valid maps. The `nis' module defines the following exception: `error' An error raised when a NIS function returns an error code.  File: python-lib.info, Node: syslog, Next: commands, Prev: nis, Up: Unix Specific Services UNIX syslog library routines ============================ An interface to the UNIX syslog library routines. This module provides an interface to the UNIX `syslog' library routines. Refer to the UNIX manual pages for a detailed description of the `syslog' facility. The module defines the following functions: `syslog([priority,] message)' Send the string MESSAGE to the system logger. A trailing newline is added if necessary. Each message is tagged with a priority composed of a FACILITY and a LEVEL. The optional PRIORITY argument, which defaults to `LOG_INFO', determines the message priority. If the facility is not encoded in PRIORITY using logical-or (`LOG_INFO | LOG_USER'), the value given in the `openlog()' call is used. `openlog(ident[, logopt[, facility]])' Logging options other than the defaults can be set by explicitly opening the log file with `openlog()' prior to calling `syslog()'. The defaults are (usually) IDENT = `'syslog'', LOGOPT = `0', FACILITY = `LOG_USER'. The IDENT argument is a string which is prepended to every message. The optional LOGOPT argument is a bit field - see below for possible values to combine. The optional FACILITY argument sets the default facility for messages which do not have a facility explicitly encoded. `closelog()' Close the log file. `setlogmask(maskpri)' Set the priority mask to MASKPRI and return the previous mask value. Calls to `syslog()' with a priority level not set in MASKPRI are ignored. The default is to log all priorities. The function `LOG_MASK(PRI)' calculates the mask for the individual priority PRI. The function `LOG_UPTO(PRI)' calculates the mask for all priorities up to and including PRI. The module defines the following constants: `Priority levels (high to low):' `LOG_EMERG', `LOG_ALERT', `LOG_CRIT', `LOG_ERR', `LOG_WARNING', `LOG_NOTICE', `LOG_INFO', `LOG_DEBUG'. `Facilities:' `LOG_KERN', `LOG_USER', `LOG_MAIL', `LOG_DAEMON', `LOG_AUTH', `LOG_LPR', `LOG_NEWS', `LOG_UUCP', `LOG_CRON' and `LOG_LOCAL0' to `LOG_LOCAL7'. `Log options:' `LOG_PID', `LOG_CONS', `LOG_NDELAY', `LOG_NOWAIT' and `LOG_PERROR' if defined in `'.  File: python-lib.info, Node: commands, Prev: syslog, Up: Unix Specific Services Utilities for running commands ============================== Utility functions for running external commands. This section was written by Sue Williams . The `commands' module contains wrapper functions for `os.popen()' which take a system command as a string and return any output generated by the command and, optionally, the exit status. The `commands' module defines the following functions: `getstatusoutput(cmd)' Execute the string CMD in a shell with `os.popen()' and return a 2-tuple `(STATUS, OUTPUT)'. CMD is actually run as `{ CMD ; } 2>&1', so that the returned output will contain output or error messages. A trailing newline is stripped from the output. The exit status for the command can be interpreted according to the rules for the C function `wait()'. `getoutput(cmd)' Like `getstatusoutput()', except the exit status is ignored and the return value is a string containing the command's output. `getstatus(file)' Return the output of `ls -ld FILE' as a string. This function uses the `getoutput()' function, and properly escapes backslashes and dollar signs in the argument. Example: >>> import commands >>> commands.getstatusoutput('ls /bin/ls') (0, '/bin/ls') >>> commands.getstatusoutput('cat /bin/junk') (256, 'cat: /bin/junk: No such file or directory') >>> commands.getstatusoutput('/bin/junk') (256, 'sh: /bin/junk: not found') >>> commands.getoutput('ls /bin/ls') '/bin/ls' >>> commands.getstatus('/bin/ls') '-rwxr-xr-x 1 root 13352 Oct 14 1994 /bin/ls'  File: python-lib.info, Node: Python Debugger, Next: Python Profiler, Prev: Unix Specific Services, Up: Top The Python Debugger ******************* The Python debugger for interactive interpreters. The module `pdb' defines an interactive source code debugger for Python programs. It supports setting (conditional) breakpoints and single stepping at the source line level, inspection of stack frames, source code listing, and evaluation of arbitrary Python code in the context of any stack frame. It also supports post-mortem debugging and can be called under program control. The debugger is extensible -- it is actually defined as the class `Pdb'. This is currently undocumented but easily understood by reading the source. The extension interface uses the modules `bdb' (undocumented) and `cmd'. The debugger's prompt is `(Pdb) '. Typical usage to run a program under control of the debugger is: >>> import pdb >>> import mymodule >>> pdb.run('mymodule.test()') > (0)?() (Pdb) continue > (1)?() (Pdb) continue NameError: 'spam' > (1)?() (Pdb) `pdb.py' can also be invoked as a script to debug other scripts. For example: python /usr/local/lib/python1.5/pdb.py myscript.py Typical usage to inspect a crashed program is: >>> import pdb >>> import mymodule >>> mymodule.test() Traceback (most recent call last): File "", line 1, in ? File "./mymodule.py", line 4, in test test2() File "./mymodule.py", line 3, in test2 print spam NameError: spam >>> pdb.pm() > ./mymodule.py(3)test2() -> print spam (Pdb) The module defines the following functions; each enters the debugger in a slightly different way: `run(statement[, globals[, locals]])' Execute the STATEMENT (given as a string) under debugger control. The debugger prompt appears before any code is executed; you can set breakpoints and type `continue', or you can step through the statement using `step' or `next' (all these commands are explained below). The optional GLOBALS and LOCALS arguments specify the environment in which the code is executed; by default the dictionary of the module `__main__' is used. (See the explanation of the `exec' statement or the `eval()' built-in function.) `runeval(expression[, globals[, locals]])' Evaluate the EXPRESSION (given as a a string) under debugger control. When `runeval()' returns, it returns the value of the expression. Otherwise this function is similar to `run()'. `runcall(function[, argument, ...])' Call the FUNCTION (a function or method object, not a string) with the given arguments. When `runcall()' returns, it returns whatever the function call returned. The debugger prompt appears as soon as the function is entered. `set_trace()' Enter the debugger at the calling stack frame. This is useful to hard-code a breakpoint at a given point in a program, even if the code is not otherwise being debugged (e.g. when an assertion fails). `post_mortem(traceback)' Enter post-mortem debugging of the given TRACEBACK object. `pm()' Enter post-mortem debugging of the traceback found in `sys.last_traceback'. * Menu: * Debugger Commands:: * How It Works::  File: python-lib.info, Node: Debugger Commands, Next: How It Works, Prev: Python Debugger, Up: Python Debugger Debugger Commands ================= The debugger recognizes the following commands. Most commands can be abbreviated to one or two letters; e.g. `h(elp)' means that either `h' or `help' can be used to enter the help command (but not `he' or `hel', nor `H' or `Help' or `HELP'). Arguments to commands must be separated by whitespace (spaces or tabs). Optional arguments are enclosed in square brackets (`[]') in the command syntax; the square brackets must not be typed. Alternatives in the command syntax are separated by a vertical bar (`|'). Entering a blank line repeats the last command entered. Exception: if the last command was a `list' command, the next 11 lines are listed. Commands that the debugger doesn't recognize are assumed to be Python statements and are executed in the context of the program being debugged. Python statements can also be prefixed with an exclamation point (`!'). This is a powerful way to inspect the program being debugged; it is even possible to change a variable or call a function. When an exception occurs in such a statement, the exception name is printed but the debugger's state is not changed. Multiple commands may be entered on a single line, separated by `;;'. (A single `;' is not used as it is the separator for multiple commands in a line that is passed to the Python parser.) No intelligence is applied to separating the commands; the input is split at the first `;;' pair, even if it is in the middle of a quoted string. The debugger supports aliases. Aliases can have parameters which allows one a certain level of adaptability to the context under examination. If a file `.pdbrc' exists in the user's home directory or in the current directory, it is read in and executed as if it had been typed at the debugger prompt. This is particularly useful for aliases. If both files exist, the one in the home directory is read first and aliases defined there can be overridden by the local file. `h(elp) [COMMAND]' Without argument, print the list of available commands. With a COMMAND as argument, print help about that command. `help pdb' displays the full documentation file; if the environment variable `PAGER' is defined, the file is piped through that command instead. Since the COMMAND argument must be an identifier, `help exec' must be entered to get help on the `!' command. `w(here)' Print a stack trace, with the most recent frame at the bottom. An arrow indicates the current frame, which determines the context of most commands. `d(own)' Move the current frame one level down in the stack trace (to an newer frame). `u(p)' Move the current frame one level up in the stack trace (to a older frame). `b(reak) [[FILENAME:]LINENO`{|}'FUNCTION[, CONDITION]]' With a LINENO argument, set a break there in the current file. With a FUNCTION argument, set a break at the first executable statement within that function. The line number may be prefixed with a filename and a colon, to specify a breakpoint in another file (probably one that hasn't been loaded yet). The file is searched on `sys.path'. Note that each breakpoint is assigned a number to which all the other breakpoint commands refer. If a second argument is present, it is an expression which must evaluate to true before the breakpoint is honored. Without argument, list all breaks, including for each breakpoint, the number of times that breakpoint has been hit, the current ignore count, and the associated condition if any. `tbreak [[FILENAME:]LINENO`{|}'FUNCTION[, CONDITION]]' Temporary breakpoint, which is removed automatically when it is first hit. The arguments are the same as break. `cl(ear) [BPNUMBER [BPNUMBER ...]]' With a space separated list of breakpoint numbers, clear those breakpoints. Without argument, clear all breaks (but first ask confirmation). `disable [BPNUMBER [BPNUMBER ...]]' Disables the breakpoints given as a space separated list of breakpoint numbers. Disabling a breakpoint means it cannot cause the program to stop execution, but unlike clearing a breakpoint, it remains in the list of breakpoints and can be (re-)enabled. `enable [BPNUMBER [BPNUMBER ...]]' Enables the breakpoints specified. `ignore BPNUMBER [COUNT]' Sets the ignore count for the given breakpoint number. If count is omitted, the ignore count is set to 0. A breakpoint becomes active when the ignore count is zero. When non-zero, the count is decremented each time the breakpoint is reached and the breakpoint is not disabled and any associated condition evaluates to true. `condition BPNUMBER [CONDITION]' Condition is an expression which must evaluate to true before the breakpoint is honored. If condition is absent, any existing condition is removed; i.e., the breakpoint is made unconditional. `s(tep)' Execute the current line, stop at the first possible occasion (either in a function that is called or on the next line in the current function). `n(ext)' Continue execution until the next line in the current function is reached or it returns. (The difference between `next' and `step' is that `step' stops inside a called function, while `next' executes called functions at (nearly) full speed, only stopping at the next line in the current function.) `r(eturn)' Continue execution until the current function returns. `c(ont(inue))' Continue execution, only stop when a breakpoint is encountered. `l(ist) [FIRST[, LAST]]' List source code for the current file. Without arguments, list 11 lines around the current line or continue the previous listing. With one argument, list 11 lines around at that line. With two arguments, list the given range; if the second argument is less than the first, it is interpreted as a count. `a(rgs)' Print the argument list of the current function. `p EXPRESSION' Evaluate the EXPRESSION in the current context and print its value. (Note: `print' can also be used, but is not a debugger command -- this executes the Python `print' statement.) `alias [NAME [command]]' Creates an alias called NAME that executes COMMAND. The command must _not_ be enclosed in quotes. Replaceable parameters can be indicated by `%1', `%2', and so on, while `%*' is replaced by all the parameters. If no command is given, the current alias for NAME is shown. If no arguments are given, all aliases are listed. Aliases may be nested and can contain anything that can be legally typed at the pdb prompt. Note that internal pdb commands _can_ be overridden by aliases. Such a command is then hidden until the alias is removed. Aliasing is recursively applied to the first word of the command line; all other words in the line are left alone. As an example, here are two useful aliases (especially when placed in the `.pdbrc' file): #Print instance variables (usage "pi classInst") alias pi for k in %1.__dict__.keys(): print "%1.",k,"=",%1.__dict__[k] #Print instance variables in self alias ps pi self `unalias NAME' Deletes the specified alias. `[!]STATEMENT' Execute the (one-line) STATEMENT in the context of the current stack frame. The exclamation point can be omitted unless the first word of the statement resembles a debugger command. To set a global variable, you can prefix the assignment command with a `global' command on the same line, e.g.: (Pdb) global list_options; list_options = ['-l'] (Pdb) `q(uit)' Quit from the debugger. The program being executed is aborted.  File: python-lib.info, Node: How It Works, Prev: Debugger Commands, Up: Python Debugger How It Works ============ Some changes were made to the interpreter: * `sys.settrace(FUNC)' sets the global trace function * there can also a local trace function (see later) Trace functions have three arguments: FRAME, EVENT, and ARG. FRAME is the current stack frame. EVENT is a string: `'call'', `'line'', `'return'' or `'exception''. ARG depends on the event type. The global trace function is invoked (with EVENT set to `'call'') whenever a new local scope is entered; it should return a reference to the local trace function to be used that scope, or `None' if the scope shouldn't be traced. The local trace function should return a reference to itself (or to another function for further tracing in that scope), or `None' to turn off tracing in that scope. Instance methods are accepted (and very useful!) as trace functions. The events have the following meaning: ``'call''' A function is called (or some other code block entered). The global trace function is called; arg is the argument list to the function; the return value specifies the local trace function. ``'line''' The interpreter is about to execute a new line of code (sometimes multiple line events on one line exist). The local trace function is called; arg in None; the return value specifies the new local trace function. ``'return''' A function (or other code block) is about to return. The local trace function is called; arg is the value that will be returned. The trace function's return value is ignored. ``'exception''' An exception has occurred. The local trace function is called; arg is a triple (exception, value, traceback); the return value specifies the new local trace function Note that as an exception is propagated down the chain of callers, an `'exception'' event is generated at each level. For more information on code and frame objects, refer to the .  File: python-lib.info, Node: Python Profiler, Next: Internet Protocols and Support, Prev: Python Debugger, Up: Top The Python Profiler ******************* This section was written by James Roskind <>. Copyright (C) 1994, by InfoSeek Corporation, all rights reserved. Written by James Roskind.(1) Permission to use, copy, modify, and distribute this Python software and its associated documentation for any purpose (subject to the restriction in the following sentence) without fee is hereby granted, provided that the above copyright notice appears in all copies, and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of InfoSeek not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. This permission is explicitly restricted to the copying and modification of the software to remain in Python, compiled Python, or other languages (such as C) wherein the modified or derived code is exclusively imported into a Python module. INFOSEEK CORPORATION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INFOSEEK CORPORATION BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. The profiler was written after only programming in Python for 3 weeks. As a result, it is probably clumsy code, but I don't know for sure yet 'cause I'm a beginner :-). I did work hard to make the code run fast, so that profiling would be a reasonable thing to do. I tried not to repeat code fragments, but I'm sure I did some stuff in really awkward ways at times. Please send suggestions for improvements to: . I won't promise _any_ support. ...but I'd appreciate the feedback. * Menu: * Profiler Introduction:: * Profiler Changes:: * Instant Users Manual:: * Deterministic Profiling:: * Reference Manual:: * Limitations:: * Calibration:: * Profiler Extensions:: ---------- Footnotes ---------- (1) Updated and converted to LaTeX by Guido van Rossum. The references to the old profiler are left in the text, although it no longer exists.  File: python-lib.info, Node: Profiler Introduction, Next: Profiler Changes, Prev: Python Profiler, Up: Python Profiler Introduction to the profiler ============================ A "profiler" is a program that describes the run time performance of a program, providing a variety of statistics. This documentation describes the profiler functionality provided in the modules `profile' and `pstats'. This profiler provides "deterministic profiling" of any Python programs. It also provides a series of report generation tools to allow users to rapidly examine the results of a profile operation.  File: python-lib.info, Node: Profiler Changes, Next: Instant Users Manual, Prev: Profiler Introduction, Up: Python Profiler How Is This Profiler Different From The Old Profiler? ===================================================== (This section is of historical importance only; the old profiler discussed here was last seen in Python 1.1.) The big changes from old profiling module are that you get more information, and you pay less CPU time. It's not a trade-off, it's a trade-up. To be specific: `Bugs removed:' Local stack frame is no longer molested, execution time is now charged to correct functions. `Accuracy increased:' Profiler execution time is no longer charged to user's code, calibration for platform is supported, file reads are not done _by_ profiler _during_ profiling (and charged to user's code!). `Speed increased:' Overhead CPU cost was reduced by more than a factor of two (perhaps a factor of five), lightweight profiler module is all that must be loaded, and the report generating module (`pstats') is not needed during profiling. `Recursive functions support:' Cumulative times in recursive functions are correctly calculated; recursive entries are counted. `Large growth in report generating UI:' Distinct profiles runs can be added together forming a comprehensive report; functions that import statistics take arbitrary lists of files; sorting criteria is now based on keywords (instead of 4 integer options); reports shows what functions were profiled as well as what profile file was referenced; output format has been improved.  File: python-lib.info, Node: Instant Users Manual, Next: Deterministic Profiling, Prev: Profiler Changes, Up: Python Profiler Instant Users Manual ==================== This section is provided for users that "don't want to read the manual." It provides a very brief overview, and allows a user to rapidly perform profiling on an existing application. To profile an application with a main entry point of `foo()', you would add the following to your module: import profile profile.run('foo()') The above action would cause `foo()' to be run, and a series of informative lines (the profile) to be printed. The above approach is most useful when working with the interpreter. If you would like to save the results of a profile into a file for later examination, you can supply a file name as the second argument to the `run()' function: import profile profile.run('foo()', 'fooprof') The file `profile.py' can also be invoked as a script to profile another script. For example: python /usr/local/lib/python1.5/profile.py myscript.py When you wish to review the profile, you should use the methods in the `pstats' module. Typically you would load the statistics data as follows: import pstats p = pstats.Stats('fooprof') The class `Stats' (the above code just created an instance of this class) has a variety of methods for manipulating and printing the data that was just read into `p'. When you ran `profile.run()' above, what was printed was the result of three method calls: p.strip_dirs().sort_stats(-1).print_stats() The first method removed the extraneous path from all the module names. The second method sorted all the entries according to the standard module/line/name string that is printed (this is to comply with the semantics of the old profiler). The third method printed out all the statistics. You might try the following sort calls: p.sort_stats('name') p.print_stats() The first call will actually sort the list by function name, and the second call will print out the statistics. The following are some interesting calls to experiment with: p.sort_stats('cumulative').print_stats(10) This sorts the profile by cumulative time in a function, and then only prints the ten most significant lines. If you want to understand what algorithms are taking time, the above line is what you would use. If you were looking to see what functions were looping a lot, and taking a lot of time, you would do: p.sort_stats('time').print_stats(10) to sort according to time spent within each function, and then print the statistics for the top ten functions. You might also try: p.sort_stats('file').print_stats('__init__') This will sort all the statistics by file name, and then print out statistics for only the class init methods ('cause they are spelled with `__init__' in them). As one final example, you could try: p.sort_stats('time', 'cum').print_stats(.5, 'init') This line sorts statistics with a primary key of time, and a secondary key of cumulative time, and then prints out some of the statistics. To be specific, the list is first culled down to 50% (re: `.5') of its original size, then only lines containing `init' are maintained, and that sub-sub-list is printed. If you wondered what functions called the above functions, you could now (`p' is still sorted according to the last criteria) do: p.print_callers(.5, 'init') and you would get a list of callers for each of the listed functions. If you want more functionality, you're going to have to read the manual, or guess what the following functions do: p.print_callees() p.add('fooprof') Invoked as a script, the `pstats' module is a statistics browser for reading and examining profile dumps. It has a simple line-oriented interface (implemented using `cmd') and interactive help.  File: python-lib.info, Node: Deterministic Profiling, Next: Reference Manual, Prev: Instant Users Manual, Up: Python Profiler What Is Deterministic Profiling? ================================ "Deterministic profiling" is meant to reflect the fact that all _function call_, _function return_, and _exception_ events are monitored, and precise timings are made for the intervals between these events (during which time the user's code is executing). In contrast, "statistical profiling" (which is not done by this module) randomly samples the effective instruction pointer, and deduces where time is being spent. The latter technique traditionally involves less overhead (as the code does not need to be instrumented), but provides only relative indications of where time is being spent. In Python, since there is an interpreter active during execution, the presence of instrumented code is not required to do deterministic profiling. Python automatically provides a "hook" (optional callback) for each event. In addition, the interpreted nature of Python tends to add so much overhead to execution, that deterministic profiling tends to only add small processing overhead in typical applications. The result is that deterministic profiling is not that expensive, yet provides extensive run time statistics about the execution of a Python program. Call count statistics can be used to identify bugs in code (surprising counts), and to identify possible inline-expansion points (high call counts). Internal time statistics can be used to identify "hot loops" that should be carefully optimized. Cumulative time statistics should be used to identify high level errors in the selection of algorithms. Note that the unusual handling of cumulative times in this profiler allows statistics for recursive implementations of algorithms to be directly compared to iterative implementations.  File: python-lib.info, Node: Reference Manual, Next: Limitations, Prev: Deterministic Profiling, Up: Python Profiler Reference Manual ================ Python profiler The primary entry point for the profiler is the global function `profile.run()'. It is typically used to create any profile information. The reports are formatted and printed using methods of the class `pstats.Stats'. The following is a description of all of these standard entry points and functions. For a more in-depth view of some of the code, consider reading the later section on Profiler Extensions, which includes discussion of how to derive "better" profilers from the classes presented, or reading the source code for these modules. `run(string[, filename[, ...]])' This function takes a single argument that has can be passed to the `exec' statement, and an optional file name. In all cases this routine attempts to `exec' its first argument, and gather profiling statistics from the execution. If no file name is present, then this function automatically prints a simple profiling report, sorted by the standard name string (file/line/function-name) that is presented in each line. The following is a typical output from such a call: main() 2706 function calls (2004 primitive calls) in 4.504 CPU seconds Ordered by: standard name ncalls tottime percall cumtime percall filename:lineno(function) 2 0.006 0.003 0.953 0.477 pobject.py:75(save_objects) 43/3 0.533 0.012 0.749 0.250 pobject.py:99(evaluate) ... The first line indicates that this profile was generated by the call:\ `profile.run('main()')', and hence the exec'ed string is `'main()''. The second line indicates that 2706 calls were monitored. Of those calls, 2004 were "primitive". We define "primitive" to mean that the call was not induced via recursion. The next line: `Ordered by: standard name', indicates that the text string in the far right column was used to sort the output. The column headings include: `ncalls' for the number of calls, `tottime' for the total time spent in the given function (and excluding time made in calls to sub-functions), `percall' is the quotient of `tottime' divided by `ncalls' `cumtime' is the total time spent in this and all subfunctions (i.e., from invocation till exit). This figure is accurate _even_ for recursive functions. `percall' is the quotient of `cumtime' divided by primitive calls `filename:lineno(function)' provides the respective data of each function When there are two numbers in the first column (e.g.: `43/3'), then the latter is the number of primitive calls, and the former is the actual number of calls. Note that when the function does not recurse, these two values are the same, and only the single figure is printed. Analysis of the profiler data is done using this class from the `pstats' module: `Stats(filename[, ...])' This class constructor creates an instance of a "statistics object" from a FILENAME (or set of filenames). `Stats' objects are manipulated by methods, in order to print useful reports. The file selected by the above constructor must have been created by the corresponding version of `profile'. To be specific, there is _no_ file compatibility guaranteed with future versions of this profiler, and there is no compatibility with files produced by other profilers (e.g., the old system profiler). If several files are provided, all the statistics for identical functions will be coalesced, so that an overall view of several processes can be considered in a single report. If additional files need to be combined with data in an existing `Stats' object, the `add()' method can be used. * Menu: * Stats Class::  File: python-lib.info, Node: Stats Class, Prev: Reference Manual, Up: Reference Manual The `Stats' Class ----------------- `Stats' objects have the following methods: `strip_dirs()' This method for the `Stats' class removes all leading path information from file names. It is very useful in reducing the size of the printout to fit within (close to) 80 columns. This method modifies the object, and the stripped information is lost. After performing a strip operation, the object is considered to have its entries in a "random" order, as it was just after object initialization and loading. If `strip_dirs()' causes two function names to be indistinguishable (i.e., they are on the same line of the same filename, and have the same function name), then the statistics for these two entries are accumulated into a single entry. `add(filename[, ...])' This method of the `Stats' class accumulates additional profiling information into the current profiling object. Its arguments should refer to filenames created by the corresponding version of `profile.run()'. Statistics for identically named (re: file, line, name) functions are automatically accumulated into single function statistics. `sort_stats(key[, ...])' This method modifies the `Stats' object by sorting it according to the supplied criteria. The argument is typically a string identifying the basis of a sort (example: `'time'' or `'name''). When more than one key is provided, then additional keys are used as secondary criteria when the there is equality in all keys selected before them. For example, `sort_stats('name', 'file')' will sort all the entries according to their function name, and resolve all ties (identical function names) by sorting by file name. Abbreviations can be used for any key names, as long as the abbreviation is unambiguous. The following are the keys currently defined: Valid Arg Meaning ------ ----- 'calls' call count 'cumulative' cumulative time 'file' file name 'module' file name 'pcalls' primitive call count 'line' line number 'name' function name 'nfl' name/file/line 'stdname' standard name 'time' internal time Note that all sorts on statistics are in descending order (placing most time consuming items first), where as name, file, and line number searches are in ascending order (i.e., alphabetical). The subtle distinction between `'nfl'' and `'stdname'' is that the standard name is a sort of the name as printed, which means that the embedded line numbers get compared in an odd way. For example, lines 3, 20, and 40 would (if the file names were the same) appear in the string order 20, 3 and 40. In contrast, `'nfl'' does a numeric compare of the line numbers. In fact, `sort_stats('nfl')' is the same as `sort_stats('name', 'file', 'line')'. For compatibility with the old profiler, the numeric arguments `-1', `0', `1', and `2' are permitted. They are interpreted as `'stdname'', `'calls'', `'time'', and `'cumulative'' respectively. If this old style format (numeric) is used, only one sort key (the numeric key) will be used, and additional arguments will be silently ignored. `reverse_order()' This method for the `Stats' class reverses the ordering of the basic list within the object. This method is provided primarily for compatibility with the old profiler. Its utility is questionable now that ascending vs descending order is properly selected based on the sort key of choice. `print_stats(restriction[, ...])' This method for the `Stats' class prints out a report as described in the `profile.run()' definition. The order of the printing is based on the last `sort_stats()' operation done on the object (subject to caveats in `add()' and `strip_dirs()'. The arguments provided (if any) can be used to limit the list down to the significant entries. Initially, the list is taken to be the complete set of profiled functions. Each restriction is either an integer (to select a count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to select a percentage of lines), or a regular expression (to pattern match the standard name that is printed; as of Python 1.5b1, this uses the Perl-style regular expression syntax defined by the `re' module). If several restrictions are provided, then they are applied sequentially. For example: print_stats(.1, 'foo:') would first limit the printing to first 10% of list, and then only print functions that were part of filename `.*foo:'. In contrast, the command: print_stats('foo:', .1) would limit the list to all functions having file names `.*foo:', and then proceed to only print the first 10% of them. `print_callers(restrictions[, ...])' This method for the `Stats' class prints a list of all functions that called each function in the profiled database. The ordering is identical to that provided by `print_stats()', and the definition of the restricting argument is also identical. For convenience, a number is shown in parentheses after each caller to show how many times this specific call was made. A second non-parenthesized number is the cumulative time spent in the function at the right. `print_callees(restrictions[, ...])' This method for the `Stats' class prints a list of all function that were called by the indicated function. Aside from this reversal of direction of calls (re: called vs was called by), the arguments and ordering are identical to the `print_callers()' method. `ignore()' _This is deprecated in Python 1.5.1. This is not needed in modern versions of Python.(1)_ ---------- Footnotes ---------- (1) This was once necessary, when Python would print any unused expression result that was not `None'. The method is still defined for backward compatibility.  File: python-lib.info, Node: Limitations, Next: Calibration, Prev: Reference Manual, Up: Python Profiler Limitations =========== There are two fundamental limitations on this profiler. The first is that it relies on the Python interpreter to dispatch "call", "return", and "exception" events. Compiled C code does not get interpreted, and hence is "invisible" to the profiler. All time spent in C code (including built-in functions) will be charged to the Python function that invoked the C code. If the C code calls out to some native Python code, then those calls will be profiled properly. The second limitation has to do with accuracy of timing information. There is a fundamental problem with deterministic profilers involving accuracy. The most obvious restriction is that the underlying "clock" is only ticking at a rate (typically) of about .001 seconds. Hence no measurements will be more accurate that that underlying clock. If enough measurements are taken, then the "error" will tend to average out. Unfortunately, removing this first error induces a second source of error... The second problem is that it "takes a while" from when an event is dispatched until the profiler's call to get the time actually _gets_ the state of the clock. Similarly, there is a certain lag when exiting the profiler event handler from the time that the clock's value was obtained (and then squirreled away), until the user's code is once again executing. As a result, functions that are called many times, or call many functions, will typically accumulate this error. The error that accumulates in this fashion is typically less than the accuracy of the clock (i.e., less than one clock tick), but it _can_ accumulate and become very significant. This profiler provides a means of calibrating itself for a given platform so that this error can be probabilistically (i.e., on the average) removed. After the profiler is calibrated, it will be more accurate (in a least square sense), but it will sometimes produce negative numbers (when call counts are exceptionally low, and the gods of probability work against you :-). ) Do _not_ be alarmed by negative numbers in the profile. They should _only_ appear if you have calibrated your profiler, and the results are actually better than without calibration.