third_party/psutil/docs/documentation.html - Issue 8159001: Update third_party/psutil and fix the licence issue with it.

Unified Diff: third_party/psutil/docs/documentation.html

Issue 8159001: Update third_party/psutil and fix the licence issue with it. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: remove the suppression and unnecessary files. Created 9 years, 2 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: third_party/psutil/docs/documentation.html

diff --git a/third_party/psutil/docs/documentation.html b/third_party/psutil/docs/documentation.html

index 990913e6fbaa5eb63d60c5252c0ff400ad925dd3..35adcb957a6b6706040ecc4bdb99b6204a8284e7 100644

--- a/third_party/psutil/docs/documentation.html

+++ b/third_party/psutil/docs/documentation.html

@@ -1,77 +1,167 @@

-<html>

- <head>

- <title>Documentation</title>

- </head>

- <body>

-<style>

-</style>

+

+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

+ <title>DocumentationDev</title>

+ <script src="./documentation_files/googleapis.client__plusone.js"></script></head>

+ <body>

- <div id="wikicontent">

- <table width="100%" border="0" cellspacing="0" cellpadding="0">

- <tr>

- <td class="vt" id="wikimaincol" width="100%">

- <div id="wikiheader" style="margin-bottom:1em">

- </div>

- <h1><a name="API_Reference"></a>API Reference<a href="#API_Reference" class="section_anchor"></a></h1><h2><a name="Exceptions"></a>Exceptions<a href="#Exceptions" class="section_anchor"></a></h2>psutil.NoSuchProcess<tt>(</tt>pid, name=None, msg=None<tt>)</tt> <blockquote>Raised when no process with the given PID was found in the current process list or when a process no longer exists (zombie).

-</blockquote><blockquote>Changed in 0.2.0: <tt>pid</tt>, <tt>name</tt> and <tt>msg</tt> arguments were added

-</blockquote>psutil.AccessDenied</a><tt>(</tt>pid=None, name=None, msg=None<tt>)</tt> <blockquote>Raised when permission to perform an action is denied.

-</blockquote><blockquote>Changed in 0.2.0: <tt>pid</tt>, <tt>name</tt> and <tt>msg</tt> arguments were added

-</blockquote><hr/><h2><a name="Classes"></a>Classes<a href="#Classes" class="section_anchor"></a></h2>psutil.Process<tt>(</tt>pid<tt>)</tt> <blockquote>A class which represents an OS process.

-</blockquote><ul><li>pid The process pid. </li></ul><ul><li>ppid The process parent pid. </li></ul><ul><li>parent Return the parent process as a <tt>Process</tt> object. If no ppid is known then return <tt>None</tt>. </li></ul><ul><li>name The process name. </li></ul><ul><li>exe The process executable as an absolute path name. </li></ul><blockquote>New in 0.2.0

-</blockquote><ul><li>cmdline The command line process has been called with. </li></ul><ul><li>path The process path. </li></ul><blockquote>Deprecated in 0.2.0

-</blockquote><ul><li>create_time The process creation time as a floating point number expressed in seconds since the epoch, in <a href="http://en.wikipedia.org/wiki/Coordinated_Universal_Time" rel="nofollow">UTC</a>. </li></ul><ul><li>uid The real user id of the current process. Where uid doesn't make sense (Windows) always return <tt>-1</tt>. </li></ul><ul><li>gid The real group id of the current process. Where gid doesn't make sense (Windows) always return <tt>-1</tt>. </li></ul><ul><li>username The name of the user that owns the process. </li></ul><blockquote>Changed in 2.0: Windows implementation has been rewritten in C for performace and <a href="http://sourceforge.net/projects/pywin32/" rel="nofollow">pywin32</a> extension is no longer required.

-</blockquote><ul><li>getcwd<tt>()</tt> Return a string representing the process current working directory. </li></ul><ul><li>get_num_threads<tt>()</tt> Return the number of threads used by this process. </li></ul><blockquote>New in 0.2.0

-</blockquote><ul><li>get_cpu_times<tt>()</tt> Return a tuple whose values are process CPU user and system times which means the amount of time expressed in seconds that a process has spent in <a href="http://stackoverflow.com/questions/556405/what-do-real-user-and-sys-mean-in-the-output-of-time1" rel="nofollow">user/system mode</a>. </li></ul><ul><li>cpu_percent<tt>(</tt>interval=0.1<tt>)</tt> Return a float representing the process CPU utilization as a percentage. When interval is > 0.0 compares process times to system CPU times elapsed before and after the interval (blocking). When interval is 0.0 or None compares process times to system CPU times elapsed since last call, returning immediately. In this case is recommended for accuracy that this function be called with at least 0.1 seconds between calls. </li></ul><blockquote>Changed in 0.2.0: interval parameter was added

-</blockquote><ul><li>get_memory_info<tt>()</tt> Return a tuple representing <a href="http://en.wikipedia.org/wiki/Resident_Set_Size" rel="nofollow">RSS</a> (Resident Set Size) and VMS (Virtual Memory Size) in bytes. On UNIX RSS and VMS are the same values shown by ps. On Windows RSS and VMS refer to "Mem Usage" and "VM Size" columns of taskmgr.exe. </li></ul><ul><li>get_memory_percent<tt>()</tt> Compare physical system memory to process resident memory and calculate process memory utilization as a percentage. </li></ul><ul><li>get_children<tt>()</tt> Return the children of this process as a list of <tt>Process</tt> objects. </li></ul><blockquote>New in 0.2.0

-</blockquote><ul><li>get_open_files<tt>()</tt> Return files opened by process as a list of <a href="http://docs.python.org/library/collections.html?highlight=namedtuple#collections.namedtuple" rel="nofollow">namedtuples</a> including file absolute path name and file descriptor. On OSX and FreeBSD this is done by parsing <a href="http://en.wikipedia.org/wiki/Lsof" rel="nofollow">lsof</a> command output. If lsof is not installed on the system <a href="http://docs.python.org/library/exceptions.html?highlight=notimplementederror#exceptions.NotImplementedError" rel="nofollow">NotImplementedError</a> exception is raised. Example: </li><pre class="prettyprint">>>> import psutil, os

->>> f = open('file.ext', 'w')

->>> psutil.Process(os.getpid()).get_open_files()

-[openfile(path='/home/giampaolo/svn/psutil/file.ext', fd=3)]</pre></ul><blockquote>New in 0.2.0

-</blockquote><ul><li>get_connections<tt>()</tt> Return all TCP and UPD connections opened by process as a list of <a href="http://docs.python.org/library/collections.html?highlight=namedtuple#collections.namedtuple" rel="nofollow">namedtuples</a>. Every namedtuple provides 6 attributes: </li><ul><li>fd: the socket file descriptor. This can be passed to <a href="http://docs.python.org/library/socket.html#socket.fromfd" rel="nofollow">socket.fromfd</a> to obtain a usable socket object. This is only available on UNIX; on Windows <tt>-1</tt> is always returned. </li><li>family: the address family, either <a href="http://docs.python.org/library/socket.html#socket.AF_INET" rel="nofollow">AF_INET</a> or <a href="http://docs.python.org/library/socket.html#socket.AF_INET6" rel="nofollow">AF_INET6</a> </li><li>type: the address type, either <a href="http://docs.python.org/library/socket.html#socket.SOCK_STREAM" rel="nofollow">SOCK_STREAM</a> or <a href="http://docs.python.org/library/socket.html#socket.SOCK_DGRAM" rel="nofollow">SOCK_DGRAM</a> </li><li>local_address: the local address as a <tt>(ip, port)</tt> tuple. </li><li>remote_address: the remote address as a <tt>(ip, port)</tt> tuple. When the remote endpoint is not connected the tuple is empty. </li><li>status: a string representing the TCP connections status. String values are supposed to match Linux's <a href="http://students.mimuw.edu.pl/lxr/source/include/net/tcp_states.h" rel="nofollow">tcp_states.h</a> header file across all platforms. For UDP sockets this is always going to be an empty string. </li></ul></ul><blockquote>Example:

+<div>

+<table>

+ <tbody><tr>

+ <td style="vertical-align:top; padding-left:5px">

+ <div id="wikicontent">

+ <div class="vt" id="wikimaincol">

+ <h1><a name="API_Reference"></a>API Reference<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#API_Reference" class="section_anchor"></a></h1><h2><a name="Exceptions"></a>Exceptions<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Exceptions" class="section_anchor"></a></h2>psutil.NoSuchProcess<tt>(</tt>pid, name=None, msg=None<tt>)</tt> <blockquote>Raised when no process with the given PID is found in the current process list or when a process no longer exists (zombie).

+</blockquote>psutil.AccessDenied<tt>(</tt>pid=None, name=None, msg=None<tt>)</tt> <blockquote>Raised when permission to perform an action is denied.

+</blockquote>psutil.TimeoutExpired<tt>(</tt>pid=None, name=None<tt>)</tt> <blockquote>Raised on <tt>Process.wait(timeout)</tt> if timeout expires and process is still alive.

+</blockquote><blockquote>New in 0.2.1

+</blockquote><hr><h2><a name="Classes"></a>Classes<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Classes" class="section_anchor"></a></h2>psutil.Process<tt>(</tt>pid<tt>)</tt> <blockquote>A class which represents an OS process.

+</blockquote><ul><li>pid The process pid. </li></ul><ul><li>ppid The process parent pid. </li></ul><ul><li>parent Return the parent process as a <tt>Process</tt> object. If no ppid is known then return <tt>None</tt>. </li></ul><ul><li>name The process name. </li></ul><ul><li>exe The process executable as an absolute path name. </li></ul><ul><li>cmdline The command line process has been called with. </li></ul><ul><li>create_time The process creation time as a floating point number expressed in seconds since the epoch, in <a href="http://en.wikipedia.org/wiki/Coordinated_Universal_Time" rel="nofollow">UTC</a>. </li><pre class="prettyprint">>>> import os, psutil, datetime

+>>> p = psutil.Process(os.getpid())

+>>> p.create_time

+1307289803.47

+>>> datetime.datetime.fromtimestamp(p.create_time).strftime("%Y-%M-%d %H:%M")

+'2011-03-05 18:03'</pre></ul><ul><li>uids The real, effective and saved user ids of the current process as a nameduple. This is the same as <a href="http://docs.python.org/library/os.html#os.getresuid" rel="nofollow">os.getresuid()</a> but per-process. </li></ul><blockquote>New in 0.2.1 Availability: UNIX

+</blockquote><ul><li>gids The real, effective and saved group ids of the current process as a nameduple. This is the same as <a href="http://docs.python.org/library/os.html#os.getresgid" rel="nofollow">os.getresgid()</a> but per-process. </li></ul><blockquote>New in 0.2.1 Availability: UNIX

+</blockquote><ul><li>username The name of the user that owns the process. On UNIX this is calculated by using real process uid. </li></ul><blockquote>Changed in 2.0: Windows implementation has been rewritten in C for performace and <a href="http://sourceforge.net/projects/pywin32/" rel="nofollow">pywin32</a> extension is no longer required.

+</blockquote><ul><li>terminal The terminal associated with this process, if any, else None. This is similar to "tty" command but per-process. </li></ul><blockquote>New in 0.3.0 Availability: UNIX

+</blockquote><ul><li>status The current process status. The return value is one of the <tt>STATUS_*</tt> constants, which is an integer that can be used in conjunction with str() to obtain a human-readable form of the current process status. Example: </li><pre class="prettyprint">>>> import psutil, os

+>>> p = psutil.Process(os.getpid())

+>>> p.status

+>>> p.status == psutil.STATUS_RUNNING

+True

+>>> str(p.status)

+'running'

+>>></pre></ul><blockquote>New in 2.1

+</blockquote><ul><li>nice Get or set process <a href="http://blogs.techrepublic.com.com/opensource/?p=140" rel="nofollow">niceness</a> (priority). On UNIX this is a number which usually goes from -20 to 20. The higher the nice value, the lower the priority of the process. </li><pre class="prettyprint">>>> p = psutil.Process(os.getpid())

+>>> p.nice

+>>> p.nice = 10 # set/change process priority

+>>> p.nice

+10</pre></ul><blockquote>On Windows this is available as well by using <a href="http://msdn.microsoft.com/en-us/library/ms683211(v=vs.85).aspx" rel="nofollow">GetPriorityClass</a> and <a href="http://msdn.microsoft.com/en-us/library/ms686219(v=vs.85).aspx" rel="nofollow">SetPriorityClass</a>. <tt>psutil.*_PRIORITY_CLASS</tt> constants (explained <a href="http://msdn.microsoft.com/en-us/library/ms686219(v=vs.85).aspx" rel="nofollow">here</a>) can be used in conjunction. Example which increases process priority:

+</blockquote><blockquote><pre class="prettyprint">>> p.nice = psutil.HIGH_PRIORITY_CLASS</pre>

+</blockquote><blockquote>New in 2.1

+</blockquote><ul><li>getcwd<tt>()</tt> Return a string representing the process current working directory. </li></ul><blockquote>Availability: Windows, Linux

+</blockquote><ul><li>get_io_counters<tt>()</tt> Return process I/O statistics as a namedtuple including the number of read and write operations performed by the process and the amount of bytes read and written. For linux refer to <a href="http://www.mjmwired.net/kernel/Documentation/filesystems/proc.txt#1304" rel="nofollow">/proc filesysem documentation</a>. On BSD there's apparently no way to retrieve bytes counters, hence <tt>-1</tt> is returned for <tt>read_bytes</tt> and <tt>write_bytes</tt> fields. OSX is not supported. </li><pre class="prettyprint">>>> p.get_io_counters()

+io(read_count=454556, write_count=3456, read_bytes=110592, write_bytes=0)</pre></ul><blockquote>New in 2.1 Availability: Linux, Windows, FreeBSD

+</blockquote><ul><li>get_ionice<tt>()</tt> Return <a href="http://friedcpu.wordpress.com/2007/07/17/why-arent-you-using-ionice-yet/" rel="nofollow">process I/O niceness</a> (priority) as a namedtuple including priority class and priority data. See <tt>set_ionice</tt> below for more information. </li></ul><blockquote>New in 2.1 Availability: Linux

+</blockquote><ul><li>set_ionice<tt>(</tt>ioclass, value=None<tt>)</tt> Change <a href="http://friedcpu.wordpress.com/2007/07/17/why-arent-you-using-ionice-yet/" rel="nofollow">process I/O niceness</a> (priority). ioclass is one of the <tt>IOPRIO_CLASS_*</tt> constants. value is a number which goes from 0 to 7. The higher value value, the lower the I/O priority of the process. For further information refer to <a href="http://linux.die.net/man/1/ionice" rel="nofollow">ionice</a> command line utility or <a href="http://linux.die.net/man/2/ioprio_set" rel="nofollow">ioprio_set</a> system call. The example below sets IDLE priority class for the current process, meaning it will only get I/O time when no other process needs the disk: </li><pre class="prettyprint">>>> import psutil, os

+>>> p = psutil.Process(os.getpid())

+>>> p.set_ionice(psutil.IOPRIO_CLASS_IDLE)

+>>></pre></ul><blockquote>New in 2.1 Availability: Linux

+</blockquote><ul><li>get_num_threads<tt>()</tt> Return the number of threads used by this process. </li></ul><ul><li>get_threads<tt>()</tt> Return threads opened by process as a list of namedtuples including thread id and thread CPU times (user/system). </li></ul><blockquote>New in 0.2.1

+</blockquote><ul><li>get_cpu_times<tt>()</tt> Return a tuple whose values are process CPU user and system times which means the amount of time expressed in seconds that a process has spent in <a href="http://stackoverflow.com/questions/556405/what-do-real-user-and-sys-mean-in-the-output-of-time1" rel="nofollow">user/system mode</a>. </li></ul><ul><li>get_cpu_percent<tt>(</tt>interval=0.1<tt>)</tt> Return a float representing the process CPU utilization as a percentage. When interval is > 0.0 compares process times to system CPU times elapsed before and after the interval (blocking). When interval is 0.0 or None compares process times to system CPU times elapsed since last call, returning immediately. In this case is recommended for accuracy that this function be called with at least 0.1 seconds between calls. </li></ul><blockquote>Changed in 0.2.0: interval parameter was added

+</blockquote><ul><li>get_memory_info<tt>()</tt> Return a tuple representing <a href="http://en.wikipedia.org/wiki/Resident_Set_Size" rel="nofollow">RSS</a> (Resident Set Size) and VMS (Virtual Memory Size) in bytes. On UNIX RSS and VMS are the same values shown by ps. On Windows RSS and VMS refer to "Mem Usage" and "VM Size" columns of taskmgr.exe. </li></ul><ul><li>get_memory_percent<tt>()</tt> Compare physical system memory to process resident memory and calculate process memory utilization as a percentage. </li></ul><ul><li>get_children<tt>()</tt> Return the children of this process as a list of <tt>Process</tt> objects. </li></ul><ul><li>get_open_files<tt>()</tt> Return files opened by process as a list of <a href="http://docs.python.org/library/collections.html?highlight=namedtuple#collections.namedtuple" rel="nofollow">namedtuples</a> including file absolute path name and file descriptor. On FreeBSD this is done by parsing <a href="http://en.wikipedia.org/wiki/Lsof" rel="nofollow">lsof</a> command output. If lsof is not installed on the system <a href="http://docs.python.org/library/exceptions.html?highlight=notimplementederror#exceptions.NotImplementedError" rel="nofollow">NotImplementedError</a> exception is raised. Example: </li><pre class="prettyprint">>>> import psutil, os

+>>> f = open('file.ext', 'w')

+>>> p = psutil.Process(os.getpid())

+>>> p.get_open_files()

+[openfile(path='/home/giampaolo/svn/psutil/file.ext', fd=3)]</pre></ul><blockquote>Changed in 0.2.1: OSX implementation rewritten in C; no longer requiring lsof.

+</blockquote><ul><li>get_connections<tt>()</tt> Return all TCP and UPD connections opened by process as a list of <a href="http://docs.python.org/library/collections.html?highlight=namedtuple#collections.namedtuple" rel="nofollow">namedtuples</a>. Every namedtuple provides 6 attributes: </li><ul><li>fd: the socket file descriptor. This can be passed to <a href="http://docs.python.org/library/socket.html#socket.fromfd" rel="nofollow">socket.fromfd</a> to obtain a usable socket object. This is only available on UNIX; on Windows <tt>-1</tt> is always returned. </li><li>family: the address family, either <a href="http://docs.python.org/library/socket.html#socket.AF_INET" rel="nofollow">AF_INET</a> or <a href="http://docs.python.org/library/socket.html#socket.AF_INET6" rel="nofollow">AF_INET6</a> </li><li>type: the address type, either <a href="http://docs.python.org/library/socket.html#socket.SOCK_STREAM" rel="nofollow">SOCK_STREAM</a> or <a href="http://docs.python.org/library/socket.html#socket.SOCK_DGRAM" rel="nofollow">SOCK_DGRAM</a> </li><li>local_address: the local address as a <tt>(ip, port)</tt> tuple. </li><li>remote_address: the remote address as a <tt>(ip, port)</tt> tuple. When the remote endpoint is not connected the tuple is empty. </li><li>status: a string representing the TCP connections status. String values are supposed to match Linux's <a href="http://students.mimuw.edu.pl/lxr/source/include/net/tcp_states.h" rel="nofollow">tcp_states.h</a> header file across all platforms. For UDP sockets this is always going to be an empty string. </li></ul></ul><blockquote>Example:

<pre class="prettyprint">>>> p = psutil.Process(1694)

>>> p.name

-'firefox'

+'firefox'

>>> p.get_connections()

-[connection(fd=115, family=2, type=1, local_address=('10.0.0.1', 48776), remote_address=('93.186.135.91', 80), status='ESTABLISHED'),

- connection(fd=117, family=2, type=1, local_address=('10.0.0.1', 43761), remote_address=('72.14.234.100', 80), status='CLOSING'),

- connection(fd=119, family=2, type=1, local_address=('10.0.0.1', 60759), remote_address=('72.14.234.104', 80), status='ESTABLISHED'),

- connection(fd=123, family=2, type=1, local_address=('10.0.0.1', 51314), remote_address=('72.14.234.83', 443), status='SYN_SENT')]</pre>On OSX and FreeBSD this is implemented by parsing <a href="http://en.wikipedia.org/wiki/Lsof" rel="nofollow">lsof</a> command output. If lsof is not installed on the system <a href="http://docs.python.org/library/exceptions.html?highlight=notimplementederror#exceptions.NotImplementedError" rel="nofollow">NotImplementedError</a> exception is raised. For third party processes (different than <tt>os.getpid()</tt>) results can differ depending on user privileges.

-</blockquote><blockquote>New in 0.2.0

-</blockquote><ul><li>is_running<tt>()</tt> Return whether the current process is running in the current process list. </li></ul><ul><li>suspend<tt>()</tt> Suspend process execution. </li></ul><ul><li>resume<tt>()</tt> Resume process execution. </li></ul><ul><li>terminate<tt>()</tt> Terminate the process with <tt>SIGTERM</tt> signal. On Windows this is an alias for <tt>kill()</tt>. </li></ul><blockquote>New in 0.2.0

-</blockquote><ul><li>send_signal<tt>(</tt>signal<tt>)</tt> Send a signal to process (see <a href="http://docs.python.org/library/signal.html" rel="nofollow">signal module</a> constants). On Windows only <tt>SIGTERM</tt> is valid and is treated as an alias for <tt>kill()</tt>. </li></ul><blockquote>New in 0.2.0

-</blockquote><ul><li>kill<tt>()</tt> Kill the current process by using <tt>SIGKILL</tt> signal. </li></ul><blockquote>Changed in 0.2.0: no longer accepts <tt>sig</tt> keyword argument - use <tt>send_signal()</tt> instead.

-</blockquote><hr/><h2><a name="Functions"></a>Functions<a href="#Functions" class="section_anchor"></a></h2>psutil.get_pid_list<tt>()</tt> <blockquote>Return a list of current running PIDs.

-</blockquote>psutil.pid_exists<tt>(</tt>pid<tt>)</tt> <blockquote>Check whether the given PID exists in the current process list.

-</blockquote>psutil.process_iter<tt>()</tt> <blockquote>Return an iterator yielding a Process class instances for all running processes on the local machine.

-</blockquote><hr/><h2><a name="System_related_objects"></a>System related objects<a href="#System_related_objects" class="section_anchor"></a></h2>psutil.cpu_percent<tt>(</tt>interval=0.1<tt>)</tt> <blockquote>Return a float representing the current system-wide CPU utilization as a percentage. When interval is > 0.0 compares system CPU times elapsed before and after the interval (blocking). When interval is 0.0 or None compares system CPU times elapsed since last call or module import, returning immediately. In this case is recommended for accuracy that this function be called with at least 0.1 seconds between calls.

-</blockquote><blockquote>Changed in 0.2.0: interval parameter was added

-</blockquote>psutil.cpu_times<tt>()</tt> <blockquote>Return system CPU times as a <tt>CPUTimes</tt> class object. Every CPU time is accessible in form of a <tt>CPUTimes</tt> attribute and represents the time CPU has spent in the given mode. The attributes availability varies depending on the platform. Here follows a list of all available attributes:

-</blockquote><blockquote>- user

-- system

-- idle

-- nice (UNIX)

-- iowait (Linux)

-- irq (Linux, FreeBSD)

-- softirq (Linux)

-</blockquote>psutil.TOTAL_PHYMEM psutil.avail_phymem<tt>()</tt> psutil.used_phymem<tt>()</tt> <blockquote>Return the amount of total, available and used physical memory on the system, in bytes.

-</blockquote>psutil.cached_phymem<tt>()</tt> <blockquote>Return the amount of cached memory on the system, in bytes. This reflects the "cached" column of free command line utility on Linux.

-</blockquote><blockquote>New in 0.2.0 Availability: Linux

-</blockquote>psutil.phymem_buffers<tt>()</tt> <blockquote>Return the amount of physical memory buffers used by the kernel in bytes. This reflects the "buffers" column of free command line utility on Linux.

-</blockquote><blockquote>New in 0.2.0 Availability: Linux

-</blockquote>psutil.total_virtmem<tt>()</tt> psutil.avail_virtmem<tt>()</tt> psutil.used_virtmem<tt>()</tt> <blockquote>Return the amount of total, available and used virtual memory on the system, in bytes. On Linux they match the values returned by <tt>free</tt> command line utility. On OS X and FreeBSD they represent the same values as returned by <tt>sysctl vm.vmtotal</tt>. On Windows they are determined by reading the <tt>*PageFile</tt> values of <a href="http://msdn.microsoft.com/en-us/library/aa366770(VS.85).aspx" rel="nofollow">MEMORYSTATUSEX</a> structure.

-</blockquote>

- </td>

- </tr>

- </table>

+[connection(fd=115, family=2, type=1, local_address=('10.0.0.1', 48776), remote_address=('93.186.135.91', 80), status='ESTABLISHED'),

+ connection(fd=117, family=2, type=1, local_address=('10.0.0.1', 43761), remote_address=('72.14.234.100', 80), status='CLOSING'),

+ connection(fd=119, family=2, type=1, local_address=('10.0.0.1', 60759), remote_address=('72.14.234.104', 80), status='ESTABLISHED'),

+ connection(fd=123, family=2, type=1, local_address=('10.0.0.1', 51314), remote_address=('72.14.234.83', 443), status='SYN_SENT')]</pre>On FreeBSD this is implemented by parsing <a href="http://en.wikipedia.org/wiki/Lsof" rel="nofollow">lsof</a> command output. If lsof is not installed on the system <a href="http://docs.python.org/library/exceptions.html?highlight=notimplementederror#exceptions.NotImplementedError" rel="nofollow">NotImplementedError</a> exception is raised and for third party processes (different than <tt>os.getpid()</tt>) results can differ depending on user privileges.

+</blockquote><blockquote>Changed in 0.2.1: OSX implementation rewritten in C; no longer requiring lsof.

+</blockquote><ul><li>is_running<tt>()</tt> Return whether the current process is running in the current process list. </li></ul><ul><li>send_signal<tt>(</tt>signal<tt>)</tt> Send a signal to process (see <a href="http://docs.python.org/library/signal.html" rel="nofollow">signal module</a> constants). On Windows only <tt>SIGTERM</tt> is valid and is treated as an alias for <tt>kill()</tt>. </li></ul><ul><li>suspend<tt>()</tt> Suspend process execution with <tt>SIGSTOP</tt> signal. On Windows this is done by suspending all process threads execution. </li></ul><ul><li>resume<tt>()</tt> Resume process execution with <tt>SIGCONT</tt> signal. On Windows this is done by resuming all process threads execution. </li></ul><ul><li>terminate<tt>()</tt> Terminate the process with <tt>SIGTERM</tt> signal. On Windows this is an alias for <tt>kill()</tt>. </li></ul><ul><li>kill<tt>()</tt> Kill the current process by using <tt>SIGKILL</tt> signal. </li></ul><blockquote>Changed in 0.2.0: no longer accepts <tt>sig</tt> keyword argument - use <tt>send_signal()</tt> instead.

+</blockquote><ul><li>wait<tt>(</tt>timeout=None<tt>)</tt> Wait for process termination and if the process is a children of the current one also return the exit code, else <tt>None</tt>. On Windows there's no such limitation (exit code is always returned). If the process is already terminated does not raise <tt>NoSuchProcess</tt> exception but just return <tt>None</tt> immediately. If timeout is specified and process is still alive raises <tt>TimeoutExpired</tt> exception. </li></ul><blockquote>New in 0.2.1

+</blockquote> psutil.Popen<tt>(</tt><tt>*args, **kwargs</tt><tt>)</tt> <blockquote>A more convenient interface to stdlib <a href="http://docs.python.org/library/subprocess.html#subprocess.Popen" rel="nofollow">subprocess.Popen</a>. It starts a sub process and deals with it exactly as when using subprocess.Popen class but in addition also provides all the properties and methods of psutil.Process class in a unique interface. For method names common to both classes such as kill() and terminate(), psutil.Process implementation takes precedence. For a complete documentation refers to <a href="http://docs.python.org/library/subprocess.html" rel="nofollow">subprocess module documentation</a>.

+<pre class="prettyprint">>>> import psutil

+>>> from subprocess import PIPE

+>>> p = psutil.Popen(["/usr/bin/python", "-c", "print 'hi'"], stdout=PIPE)

+>>> p.name

+'python'

+>>> p.uids

+user(real=1000, effective=1000, saved=1000)

+>>> p.username

+'giampaolo'

+>>> p.communicate()

+('hi\n', None)

+>>> p.wait(timeout=2)

+>>></pre></blockquote><blockquote>New in 0.2.1

+</blockquote><hr><h2><a name="Functions"></a>Functions<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Functions" class="section_anchor"></a></h2>psutil.get_pid_list<tt>()</tt> <blockquote>Return a list of current running PIDs.

+</blockquote>psutil.pid_exists<tt>(</tt>pid<tt>)</tt> <blockquote>Check whether the given PID exists in the current process list. This is faster than doing <tt>pid in psutil.get_pid_list()</tt> and should be preferred.

+</blockquote>psutil.process_iter<tt>()</tt> <blockquote>Return an iterator yielding a Process class instances for all running processes on the local machine. This should be preferred over doing <tt>for pid in psutil.get_pid_list(): psutil.Process(pid)</tt> as it safe from race conditions.

+</blockquote><hr><h2><a name="System_related_functions"></a>System related functions<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#System_related_functions" class="section_anchor"></a></h2><h3><a name="CPU"></a>CPU<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#CPU" class="section_anchor"></a></h3>psutil.cpu_percent<tt>(</tt>interval=0.1, percpu=False<tt>)</tt> <blockquote>Return a float representing the current system-wide CPU utilization as a percentage. When interval is > 0.0 compares system CPU times elapsed before and after the interval (blocking). When interval is 0.0 or None compares system CPU times elapsed since last call or module import, returning immediately. In this case is recommended for accuracy that this function be called with at least 0.1 seconds between calls. When percpu is True returns a list of floats representing the utilization as a percentage for each CPU. First element of the list refers to first CPU, second element to second CPU and so on. The order of the list is consistent across calls.

+</blockquote><pre class="prettyprint">>>> # blocking, system-wide

+>>> psutil.cpu_percent(interval=1)

+2.0

+>>>

+>>> # blocking, per-cpu

+>>> psutil.cpu_percent(interval=1, percpu=True)

+[2.0, 1.0]

+>>>

+>>> # non-blocking (percentage since last call)

+>>> psutil.cpu_percent(interval=0)

+2.9

+>>></pre><blockquote>Changed in 0.2.0: interval parameter was added Changed in 0.3.0: percpu parameter was added

+</blockquote>psutil.cpu_times<tt>(</tt>percpu=False<tt>)</tt> <blockquote>Return system CPU times as a namedtuple. Every attribute represents the time CPU has spent in the given mode. The attributes availability varies depending on the platform. Here follows a list of all available attributes:

+</blockquote><blockquote>- user

+- system

+- idle

+- nice (UNIX)

+- iowait (Linux)

+- irq (Linux, FreeBSD)

+- softirq (Linux)

+</blockquote><blockquote>When percpu is True return a list of nameduples for each CPU. First element of the list refers to first CPU, second element to second CPU and so on. The order of the list is consistent across calls.

+</blockquote><blockquote>Changed in 0.3.0: percpu parameter was added

+</blockquote><hr><h3><a name="Memory"></a>Memory<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Memory" class="section_anchor"></a></h3>psutil.phymem_usage<tt>()</tt> <blockquote>Return the amount of total, used and free physical memory on the system in bytes plus the percentage usage.

+<pre class="prettyprint">>>> psutil.phymem_usage()

+usage(total=4153868288, used=2854199296, free=1299668992, percent=34.6)</pre>New in 0.3.0

+</blockquote>psutil.virtmem_usage<tt>()</tt> <blockquote>Return the amount of total, used and free virtual memory on the system in bytes plus the percentage usage. On Linux they match the values returned by <tt>free</tt> command line utility. On OS X and FreeBSD they represent the same values as returned by <tt>sysctl vm.vmtotal</tt>. On Windows they are determined by reading the <tt>*PageFile</tt> values of <a href="http://msdn.microsoft.com/en-us/library/aa366770(VS.85).aspx" rel="nofollow">MEMORYSTATUSEX</a> structure.

+<pre class="prettyprint">>>> psutil.virtmem_usage()

+usage(total=2097147904, used=4096, free=2097143808, percent=0.0)</pre>New in 0.3.0

+</blockquote>psutil.cached_phymem<tt>()</tt> psutil.phymem_buffers<tt>()</tt> <blockquote>Return the amount of cached memory and physical memory buffers on the system, in bytes. Thet reflects the "cached" and "buffers" columns of free command line utility on Linux.

+</blockquote><blockquote>Availability: Linux

+</blockquote>psutil.avail_phymem<tt>()</tt> psutil.used_phymem<tt>()</tt> psutil.total_virtmem<tt>()</tt> psutil.avail_virtmem<tt>()</tt> psutil.used_virtmem<tt>()</tt> <blockquote>These functions are deprecated by psutil.phymem_usage() and psutil.virtmem_usage(). Use them instead.

+</blockquote><blockquote>Deprecated in 0.3.0

+</blockquote><hr><h3><a name="Disk"></a>Disk<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Disk" class="section_anchor"></a></h3>psutil.disk_partitions<tt>(</tt>all=False<tt>)</tt> <blockquote>Return all mounted disk partitions as a list of namedtuples including device, mount point and filesystem type, similarly to "df" command on posix. If all parameter is False return physical devices only (e.g. hard disks, cd-rom drives, USB keys) and ignore all others (e.g. memory partitions such as <a href="http://www.cyberciti.biz/tips/what-is-devshm-and-its-practical-usage.html" rel="nofollow">/dev/shm</a>). Namedtuple's 'fstype' field is a string which varies depending on the platform. On Linux it can be one of the values found in /proc/filesystems (e.g. 'ext3' for an ext3 hard drive o 'iso9660' for the CD-ROM drive). On Windows it is determined via <a href="http://msdn.microsoft.com/en-us/library/aa364939(v=vs.85).aspx" rel="nofollow">GetDriveType</a> and can be either "removable", "fixed", "remote", "cdrom", "unmounted" or "ramdisk". On OSX and FreeBSD it is retrieved via <a href="http://www.manpagez.com/man/2/getfsstat/" rel="nofollow">getfsstat(2)</a>. See <a href="http://psutil.googlecode.com/svn/trunk/examples/disk_usage.py" rel="nofollow">examples/disk_usage.py</a> script providing an example usage.

+<pre class="prettyprint">>>> psutil.get_partitions()

+[partition(device='/dev/sda3', mountpoint='/', fstype='ext4'),

+ partition(device='/dev/sda7', mountpoint='/home', fstype='ext4')]

+>>></pre></blockquote><blockquote>New in 0.3.0

+</blockquote>psutil.disk_usage<tt>(</tt>path<tt>)</tt> <blockquote>Return disk usage statistics about the given path as a namedtuple including total, used and free space expressed in bytes plus the percentage usage. OSError is raised if path does not exist. See <a href="http://psutil.googlecode.com/svn/trunk/examples/disk_usage.py" rel="nofollow">examples/disk_usage.py</a> script providing an example usage.

+<pre class="prettyprint">>>> psutil.disk_usage('/')

+usage(total=21378641920, used=4809781248, free=15482871808, percent=22.5)</pre></blockquote><blockquote>New in 0.3.0

+</blockquote><hr><h2><a name="Constants"></a>Constants<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Constants" class="section_anchor"></a></h2>psutil.TOTAL_PHYMEM <blockquote>The amount of total physical memory on the system, in bytes.

+</blockquote>psutil.NUM_CPUS <blockquote>The number of CPUs on the system. This is preferable than using <tt>os.environ['NUMBER_OF_PROCESSORS']</tt> as it is more accurate and always available.

+</blockquote>psutil.BOOT_TIME <blockquote>A number indicating the system boot time expressed in seconds since the epoch.

+</blockquote><blockquote>New in 0.2.1

+</blockquote>psutil.ABOVE_NORMAL_PRIORITY_CLASS psutil.BELOW_NORMAL_PRIORITY_CLASS psutil.HIGH_PRIORITY_CLASS psutil.IDLE_PRIORITY_CLASS psutil.NORMAL_PRIORITY_CLASS psutil.REALTIME_PRIORITY_CLASS <blockquote>A set of integers representing the priority of a process on Windows (see <a href="http://msdn.microsoft.com/en-us/library/ms686219(v=vs.85).aspx" rel="nofollow">MSDN documentation</a>). They can be used in conjunction with <tt>psutil.Process.nice</tt> to get or set process priority.

+</blockquote><blockquote>New in 0.2.1 Availability: Windows

+</blockquote>psutil.IOPRIO_CLASS_NONE psutil.IOPRIO_CLASS_RT psutil.IOPRIO_CLASS_BE psutil.IOPRIO_CLASS_IDLE <blockquote>A set of integers representing the I/O priority of a process on Linux. They can be used in conjunction with <tt>psutil.Process.get_ionice()</tt> and <tt>psutil.Process.set_ionice()</tt> to get or set process I/O priority. For further information refer to <a href="http://linux.die.net/man/1/ionice" rel="nofollow">ionice</a> command line utility or <a href="http://linux.die.net/man/2/ioprio_get" rel="nofollow">ioprio_get</a> system call.

+</blockquote><blockquote>New in 0.2.1 Availability: Linux

+</blockquote>psutil.STATUS_RUNNING psutil.STATUS_SLEEPING psutil.STATUS_DISK_SLEEP psutil.STATUS_STOPPED psutil.STATUS_TRACING_STOP psutil.STATUS_ZOMBIE psutil.STATUS_DEAD psutil.STATUS_WAKE_KILL psutil.STATUS_WAKING psutil.STATUS_IDLE psutil.STATUS_LOCKED psutil.STATUS_WAITING <blockquote>A set of integers representing the status of a process. To be used in conjunction with <tt>psutil.Process.status</tt> property. If used with str() return a human-readable status string.

+</blockquote><blockquote>New in 0.2.1

+</blockquote>

+ </div>

</div>

+ </td></tr><tr>

+</tr></tbody></table>

+ </div>

+<script type="text/javascript" src="./documentation_files/dit_scripts.js"></script>

+<script type="text/javascript" src="./documentation_files/plusone.js">

+</script>

- </body>

-</html>

+</body></html>

« no previous file with comments | « third_party/psutil/docs/class_diagram.png ('k') | third_party/psutil/docs/index.html » ('j') | no next file with comments »