summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGiampaolo Rodolà <g.rodola@gmail.com>2011-02-25 20:57:54 (GMT)
committerGiampaolo Rodolà <g.rodola@gmail.com>2011-02-25 20:57:54 (GMT)
commit18e8bcb289dd5ea77c12668ea1e2904627fc8531 (patch)
tree2913219ca3d5ff58b4f9dbb767f1ccba36c7b1f0 /Doc
parent211b81dd0916ce6e83f23b222bc06d45b904a838 (diff)
downloadcpython-18e8bcb289dd5ea77c12668ea1e2904627fc8531.zip
cpython-18e8bcb289dd5ea77c12668ea1e2904627fc8531.tar.gz
cpython-18e8bcb289dd5ea77c12668ea1e2904627fc8531.tar.bz2
Issue 10784: adds os.getpriority() and os.setpriority() functions.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/os.rst44
-rw-r--r--Doc/whatsnew/3.3.rst26
2 files changed, 60 insertions, 10 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index a1aaf1e..cd8d45bd 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -286,6 +286,22 @@ process and user.
.. versionchanged:: 3.2
Added support for Windows.
+.. function:: getpriority(which, who)
+
+ .. index:: single: process; scheduling priority
+
+ Get program scheduling priority. The value *which* is one of
+ :const:`PRIO_PROCESS`, :const:`PRIO_PGRP`, or :const:`PRIO_USER`, and *who*
+ is interpreted relative to *which* (a process identifier for
+ :const:`PRIO_PROCESS`, process group identifier for :const:`PRIO_PGRP`, and a
+ user ID for :const:`PRIO_USER`). A zero value for *who* denotes
+ (respectively) the calling process, the process group of the calling process,
+ or the real user ID of the calling process.
+
+ Availability: Unix
+
+ .. versionadded:: 3.3
+
.. function:: getresuid()
Return a tuple (ruid, euid, suid) denoting the current process's
@@ -336,6 +352,15 @@ process and user.
.. versionadded:: 3.2
+.. data:: PRIO_PROCESS
+ PRIO_PGRP
+ PRIO_USER
+
+ Parameters for :func:`getpriority` and :func:`setpriority` functions.
+
+ Availability: Unix.
+
+ .. versionadded:: 3.3
.. function:: putenv(key, value)
@@ -405,6 +430,25 @@ process and user.
Availability: Unix.
+.. function:: setpriority(which, who, priority)
+
+ .. index:: single: process; scheduling priority
+
+ Set program scheduling priority. The value *which* is one of
+ :const:`PRIO_PROCESS`, :const:`PRIO_PGRP`, or :const:`PRIO_USER`, and *who*
+ is interpreted relative to *which* (a process identifier for
+ :const:`PRIO_PROCESS`, process group identifier for :const:`PRIO_PGRP`, and a
+ user ID for :const:`PRIO_USER`). A zero value for *who* denotes
+ (respectively) the calling process, the process group of the calling process,
+ or the real user ID of the calling process.
+ *priority* is a value in the range -20 to 19. The default priority is 0;
+ lower priorities cause more favorable scheduling.
+
+ Availability: Unix
+
+ .. versionadded:: 3.3
+
+
.. function:: setregid(rgid, egid)
Set the current process's real and effective group ids.
diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst
index 78d66fe..c0cb7cf 100644
--- a/Doc/whatsnew/3.3.rst
+++ b/Doc/whatsnew/3.3.rst
@@ -71,16 +71,22 @@ New, Improved, and Deprecated Modules
os
--
-The :mod:`os` module has a new :func:`~os.sendfile` function which provides an
-efficent "zero-copy" way for copying data from one file (or socket) descriptor
-to another.
-The phrase "zero-copy" refers to the fact that all of the copying of data
-between the two descriptors is done entirely by the kernel, with no copying of
-data into userspace buffers.
-:func:`~os.sendfile` can be used to efficiently copy data from a file on disk to
-a network socket, e.g. for downloading a file.
-
-(Patch submitted by Ross Lagerwall and Giampaolo Rodolà in :issue:`10882`.)
+* The :mod:`os` module has a new :func:`~os.sendfile` function which provides
+ an efficent "zero-copy" way for copying data from one file (or socket)
+ descriptor to another. The phrase "zero-copy" refers to the fact that all of
+ the copying of data between the two descriptors is done entirely by the
+ kernel, with no copying of data into userspace buffers. :func:`~os.sendfile`
+ can be used to efficiently copy data from a file on disk to a network socket,
+ e.g. for downloading a file.
+
+ (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in :issue:`10882`.)
+
+* The :mod:`os` module has two new functions: :func:`~os.getpriority` and
+ :func:`~os.setpriority`. They can be used to get or set process
+ niceness/priority in a fashion similar to :func:`os.nice` but extended to all
+ processes instead of just the current one.
+
+ (Patch submitted by Giampaolo Rodolà in :issue:`10784`.)
Optimizations
=============