third_party/psutil/docs/documentation.html - Issue 8774018: Add psutil build step to fix pyauto media issues. Upgrade psutil to 0.4.0.

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

Issue 8774018: Add psutil build step to fix pyauto media issues. Upgrade psutil to 0.4.0. (Closed) Base URL: http://git.chromium.org/chromium/src.git@master

Patch Set: Replace 'python' w/ sys.executable. Created 9 years 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 35adcb957a6b6706040ecc4bdb99b6204a8284e7..77c88378dfe4adfe4b811e3d98b05765c054fb2b 100644

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

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

@@ -2,7 +2,7 @@

<title>DocumentationDev</title>

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

+ </head>

<body>

@@ -18,9 +18,9 @@

- <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.

+<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<a href="http://code.google.com/p/psutil/w/edit/NoSuchProcess">?</a><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<a href="http://code.google.com/p/psutil/w/edit/AccessDenied">?</a><tt>(</tt>pid=None, name=None, msg=None<tt>)</tt> <blockquote>Raised when permission to perform an action is denied.

+</blockquote>psutil.TimeoutExpired<a href="http://code.google.com/p/psutil/w/edit/TimeoutExpired">?</a><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

@@ -49,7 +49,8 @@ True

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>getcwd<tt>()</tt> Return a string representing the process current working directory. </li></ul><blockquote>Availability: Windows, Linux, FreeBSD

+Changed in 0.4.0: added FreeBSD support

</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

@@ -58,13 +59,23 @@ io(read_count=454556, write_count=3456, read_bytes=110592, write_bytes=0)</pre><

>>> 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

+</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. Example: </li><pre class="prettyprint">>>> import psutil, os

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

+>>> # blocking

+>>> p.get_cpu_percent(interval=1)

+2.0

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

+>>> p.get_cpu_percent(interval=0)

+2.9

+>>></pre></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. 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:

+[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.

+Changed in 0.4.1: FreeBSD implementation rewritten in C; no longer requiring lsof.

+</blockquote><ul><li>get_connections<tt>(</tt>kind='inet'<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>The kind parameter is a string which filters for connections that fit the following criteria:

+</blockquote><table class="wikitable"><tbody><tr><td style="border: 1px solid #ccc; padding: 5px;"> Kind value </td><td style="border: 1px solid #ccc; padding: 5px;"> Connections using </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> inet </td><td style="border: 1px solid #ccc; padding: 5px;"> IPv4 and IPv6 </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> inet4 </td><td style="border: 1px solid #ccc; padding: 5px;"> IPv4 </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> inet6 </td><td style="border: 1px solid #ccc; padding: 5px;"> IPv6 </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> tcp </td><td style="border: 1px solid #ccc; padding: 5px;"> TCP </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> tcp4 </td><td style="border: 1px solid #ccc; padding: 5px;"> TCP over IPv4 </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> tcp6 </td><td style="border: 1px solid #ccc; padding: 5px;"> TCP over IPv6 </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> udp </td><td style="border: 1px solid #ccc; padding: 5px;"> UDP </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> udp4 </td><td style="border: 1px solid #ccc; padding: 5px;"> UDP over IPv4 </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> udp6 </td><td style="border: 1px solid #ccc; padding: 5px;"> UDP over IPv6 </td></tr> <tr><td style="border: 1px solid #ccc; padding: 5px;"> all </td><td style="border: 1px solid #ccc; padding: 5px;"> the sum of all the possible families and protocols </td></tr> </tbody></table><blockquote>Example:

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

>>> p.name

'firefox'

@@ -73,9 +84,11 @@ io(read_count=454556, write_count=3456, read_bytes=110592, write_bytes=0)</pre><

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><blockquote>Changed in 0.2.1: OSX implementation rewritten in C; no longer requiring lsof.

+Changed in 0.4.0: added 'kind' parameter.

</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><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

+Changed in 0.4.0: timeout=0 can now be used to make wait() return immediately (non blocking)

</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

@@ -91,10 +104,10 @@ user(real=1000, effective=1000, saved=1000)

>>> 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><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="Processes"></a>Processes<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Processes" class="section_anchor"></a></h3>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><hr><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

@@ -127,14 +140,22 @@ usage(total=2097147904, used=4096, free=2097143808, percent=0.0)</pre><strong

</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()

+</blockquote><hr><h3><a name="Disks"></a>Disks<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Disks" 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.disk_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>psutil.disk_io_counters<tt>(</tt>perdisk=False<tt>)</tt> <blockquote>Return system disk I/O statistics as a namedtuple including the following attributes:

+<ul><li>read_count: number of reads </li><li>write_count: number of writes </li><li>read_bytes: number of bytes read </li><li>write_bytes: number of bytes written </li><li>read_time: time spent reading from disk (in milliseconds) </li><li>write_time: time spent writing to disk (in milliseconds) </li></ul></blockquote><blockquote>If perdisk is True return the same information for every physical disk installed on the system as a dictionary with partition ames as the keys and the namedutuple described above as the values.

+</blockquote><pre class="prettyprint">>>> psutil.disk_io_counters()

+iostat(read_count=8141, write_count=2431, read_bytes=290203, write_bytes=537676, read_time=5868, write_time=94922)</pre><blockquote>New in 0.4.0

+</blockquote><hr><h3><a name="Network"></a>Network<a href="http://code.google.com/p/psutil/wiki/DocumentationDev?show=content#Network" class="section_anchor"></a></h3>psutil.network_io_counters<tt>(</tt>pernic=False<tt>)</tt> <blockquote>Return network I/O statistics as a namedtuple including the following attributes:

+<ul><li>bytes_sent: number of bytes sent </li><li>bytes_recv: number of bytes received </li><li>packets_sent: number of packets sent </li><li>packets_recv: number of packets received </li></ul></blockquote><blockquote>If pernic is True return the same information for every network interface installed on the system as a dictionary with network interface names as the keys and the namedtuple described above as the values.

+</blockquote><pre class="prettyprint">>>> psutil.network_io_counters()

+iostat(bytes_sent=1270374, bytes_recv=7828365, packets_sent=9810, packets_recv=11794)</pre><blockquote>New in 0.4.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.

@@ -155,13 +176,20 @@ usage(total=21378641920, used=4809781248, free=15482871808, percent=22.5)</pre><

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

+<script src="./DocumentationDev_files/googleapis.client__plusone.js"></script><script type="text/javascript" src="./DocumentationDev_files/dit_scripts.js"></script>

+ <script type="text/javascript">

+ _fetchOptions(

+ "", "psutil", "wikiOptions",

+ codesite_token, 1319284146);

+ _onload();

+ </script>

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

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

</script>

-</body></html>

+</body></html>

« third_party/psutil/build.py ('K') | « third_party/psutil/docs/class_diagram.png ('k') | third_party/psutil/examples/iotop.py » ('j') | third_party/psutil/psutil.gyp » ('J')