third_party/psutil/docs/documentation.html - Issue 6246123: Moving psutil to third_party. This is first step for Media Performance test project.

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

Issue 6246123: Moving psutil to third_party. This is first step for Media Performance test project. (Closed) Base URL: http://git.chromium.org/git/chromium.git@trunk

Patch Set: modification based on code review's comments Created 9 years, 11 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

new file mode 100644

index 0000000000000000000000000000000000000000..990913e6fbaa5eb63d60c5252c0ff400ad925dd3

--- /dev/null

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

@@ -0,0 +1,77 @@

+<html>

+ <head>

+ <title>Documentation</title>

+ </head>

+ <body>

+<style>

+</style>

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

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

+>>> p.name

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

+ </div>

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