FM / library

/usr/share/doc/python2-docs/html/_sources/library/

/usr/share/doc/python2-docs/html/_sources/library

Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	edit dl rm
abc.rst.txt	7219	0644	edit dl rm
aepack.rst.txt	4257	0644	edit dl rm
aetools.rst.txt	3532	0644	edit dl rm
aetypes.rst.txt	4257	0644	edit dl rm
aifc.rst.txt	7086	0644	edit dl rm
al.rst.txt	5309	0644	edit dl rm
allos.rst.txt	695	0644	edit dl rm
anydbm.rst.txt	4111	0644	edit dl rm
archiving.rst.txt	424	0644	edit dl rm
argparse.rst.txt	74685	0644	edit dl rm
array.rst.txt	10524	0644	edit dl rm
ast.rst.txt	10111	0644	edit dl rm
asynchat.rst.txt	9206	0644	edit dl rm
asyncore.rst.txt	12937	0644	edit dl rm
atexit.rst.txt	3910	0644	edit dl rm
audioop.rst.txt	10395	0644	edit dl rm
autogil.rst.txt	1015	0644	edit dl rm
base64.rst.txt	6252	0644	edit dl rm
basehttpserver.rst.txt	10404	0644	edit dl rm
bastion.rst.txt	2611	0644	edit dl rm
bdb.rst.txt	12456	0644	edit dl rm
binascii.rst.txt	6508	0644	edit dl rm
binhex.rst.txt	1910	0644	edit dl rm
bisect.rst.txt	5415	0644	edit dl rm
bsddb.rst.txt	7575	0644	edit dl rm
bz2.rst.txt	8064	0644	edit dl rm
calendar.rst.txt	11282	0644	edit dl rm
carbon.rst.txt	15956	0644	edit dl rm
cd.rst.txt	11974	0644	edit dl rm
cgi.rst.txt	22853	0644	edit dl rm
cgihttpserver.rst.txt	2788	0644	edit dl rm
cgitb.rst.txt	2874	0644	edit dl rm
chunk.rst.txt	4955	0644	edit dl rm
cmath.rst.txt	7647	0644	edit dl rm
cmd.rst.txt	8565	0644	edit dl rm
code.rst.txt	7115	0644	edit dl rm
codecs.rst.txt	66966	0644	edit dl rm
codeop.rst.txt	3774	0644	edit dl rm
collections.rst.txt	41448	0644	edit dl rm
colorpicker.rst.txt	913	0644	edit dl rm
colorsys.rst.txt	1819	0644	edit dl rm
commands.rst.txt	2595	0644	edit dl rm
compileall.rst.txt	4678	0644	edit dl rm
compiler.rst.txt	37464	0644	edit dl rm
configparser.rst.txt	19607	0644	edit dl rm
constants.rst.txt	2328	0644	edit dl rm
contextlib.rst.txt	6012	0644	edit dl rm
cookie.rst.txt	9543	0644	edit dl rm
cookielib.rst.txt	27875	0644	edit dl rm
copy.rst.txt	3351	0644	edit dl rm
copy_reg.rst.txt	2329	0644	edit dl rm
crypt.rst.txt	2292	0644	edit dl rm
crypto.rst.txt	355	0644	edit dl rm
csv.rst.txt	22757	0644	edit dl rm
ctypes.rst.txt	90513	0644	edit dl rm
curses.ascii.rst.txt	9046	0644	edit dl rm
curses.panel.rst.txt	2740	0644	edit dl rm
curses.rst.txt	74877	0644	edit dl rm
custominterp.rst.txt	570	0644	edit dl rm
datatypes.rst.txt	864	0644	edit dl rm
datetime.rst.txt	74679	0644	edit dl rm
dbhash.rst.txt	3865	0644	edit dl rm
dbm.rst.txt	3117	0644	edit dl rm
debug.rst.txt	446	0644	edit dl rm
decimal.rst.txt	70926	0644	edit dl rm
development.rst.txt	640	0644	edit dl rm
difflib.rst.txt	30716	0644	edit dl rm
dircache.rst.txt	1813	0644	edit dl rm
dis.rst.txt	23248	0644	edit dl rm
distribution.rst.txt	426	0644	edit dl rm
distutils.rst.txt	1958	0644	edit dl rm
dl.rst.txt	3392	0644	edit dl rm
doctest.rst.txt	73985	0644	edit dl rm
docxmlrpcserver.rst.txt	3802	0644	edit dl rm
dumbdbm.rst.txt	2841	0644	edit dl rm
dummy_thread.rst.txt	1058	0644	edit dl rm
dummy_threading.rst.txt	799	0644	edit dl rm
easydialogs.rst.txt	10346	0644	edit dl rm
email-examples.rst.txt	1271	0644	edit dl rm
email.charset.rst.txt	9654	0644	edit dl rm
email.encoders.rst.txt	2376	0644	edit dl rm
email.errors.rst.txt	4006	0644	edit dl rm
email.generator.rst.txt	6132	0644	edit dl rm
email.header.rst.txt	7531	0644	edit dl rm
email.iterators.rst.txt	2421	0644	edit dl rm
email.message.rst.txt	25217	0644	edit dl rm
email.mime.rst.txt	9917	0644	edit dl rm
email.parser.rst.txt	10327	0644	edit dl rm
email.rst.txt	16111	0644	edit dl rm
email.utils.rst.txt	6475	0644	edit dl rm
ensurepip.rst.txt	5022	0644	edit dl rm
errno.rst.txt	6708	0644	edit dl rm
exceptions.rst.txt	18343	0644	edit dl rm
fcntl.rst.txt	7361	0644	edit dl rm
filecmp.rst.txt	5348	0644	edit dl rm
fileformats.rst.txt	302	0644	edit dl rm
fileinput.rst.txt	7417	0644	edit dl rm
filesys.rst.txt	806	0644	edit dl rm
fl.rst.txt	17646	0644	edit dl rm
fm.rst.txt	2699	0644	edit dl rm
fnmatch.rst.txt	3104	0644	edit dl rm
formatter.rst.txt	13245	0644	edit dl rm
fpectl.rst.txt	4171	0644	edit dl rm
fpformat.rst.txt	1747	0644	edit dl rm
fractions.rst.txt	5297	0644	edit dl rm
framework.rst.txt	11444	0644	edit dl rm
frameworks.rst.txt	378	0644	edit dl rm
ftplib.rst.txt	15720	0644	edit dl rm
functions.rst.txt	75554	0644	edit dl rm
functools.rst.txt	7448	0644	edit dl rm
future_builtins.rst.txt	2010	0644	edit dl rm
gc.rst.txt	9014	0644	edit dl rm
gdbm.rst.txt	4882	0644	edit dl rm
gensuitemodule.rst.txt	3113	0644	edit dl rm
getopt.rst.txt	6670	0644	edit dl rm
getpass.rst.txt	1876	0644	edit dl rm
gettext.rst.txt	29040	0644	edit dl rm
gl.rst.txt	6009	0644	edit dl rm
glob.rst.txt	2414	0644	edit dl rm
grp.rst.txt	2256	0644	edit dl rm
gzip.rst.txt	4828	0644	edit dl rm
hashlib.rst.txt	7379	0644	edit dl rm
heapq.rst.txt	13185	0644	edit dl rm
hmac.rst.txt	3073	0644	edit dl rm
hotshot.rst.txt	4289	0644	edit dl rm
htmllib.rst.txt	7379	0644	edit dl rm
htmlparser.rst.txt	11640	0644	edit dl rm
httplib.rst.txt	37454	0644	edit dl rm
i18n.rst.txt	409	0644	edit dl rm
ic.rst.txt	5005	0644	edit dl rm
idle.rst.txt	22182	0644	edit dl rm
imageop.rst.txt	4001	0644	edit dl rm
imaplib.rst.txt	17221	0644	edit dl rm
imgfile.rst.txt	2765	0644	edit dl rm
imghdr.rst.txt	2635	0644	edit dl rm
imp.rst.txt	12593	0644	edit dl rm
importlib.rst.txt	1126	0644	edit dl rm
imputil.rst.txt	7023	0644	edit dl rm
index.rst.txt	2287	0644	edit dl rm
inspect.rst.txt	28151	0644	edit dl rm
internet.rst.txt	950	0644	edit dl rm
intro.rst.txt	2803	0644	edit dl rm
io.rst.txt	39015	0644	edit dl rm
ipc.rst.txt	630	0644	edit dl rm
itertools.rst.txt	36324	0644	edit dl rm
jpeg.rst.txt	3858	0644	edit dl rm
json.rst.txt	25545	0644	edit dl rm
keyword.rst.txt	617	0644	edit dl rm
language.rst.txt	523	0644	edit dl rm
linecache.rst.txt	1887	0644	edit dl rm
locale.rst.txt	24975	0644	edit dl rm
logging.config.rst.txt	31560	0644	edit dl rm
logging.handlers.rst.txt	28153	0644	edit dl rm
logging.rst.txt	46882	0644	edit dl rm
mac.rst.txt	791	0644	edit dl rm
macos.rst.txt	3824	0644	edit dl rm
macosa.rst.txt	3964	0644	edit dl rm
macostools.rst.txt	4017	0644	edit dl rm
macpath.rst.txt	650	0644	edit dl rm
mailbox.rst.txt	68129	0644	edit dl rm
mailcap.rst.txt	3675	0644	edit dl rm
markup.rst.txt	1249	0644	edit dl rm
marshal.rst.txt	5689	0644	edit dl rm
math.rst.txt	10920	0644	edit dl rm
md5.rst.txt	2815	0644	edit dl rm
mhlib.rst.txt	3966	0644	edit dl rm
mimetools.rst.txt	4504	0644	edit dl rm
mimetypes.rst.txt	9839	0644	edit dl rm
mimewriter.rst.txt	3360	0644	edit dl rm
mimify.rst.txt	3519	0644	edit dl rm
miniaeframe.rst.txt	2564	0644	edit dl rm
misc.rst.txt	248	0644	edit dl rm
mm.rst.txt	447	0644	edit dl rm
mmap.rst.txt	10481	0644	edit dl rm
modulefinder.rst.txt	3380	0644	edit dl rm
modules.rst.txt	382	0644	edit dl rm
msilib.rst.txt	19062	0644	edit dl rm
msvcrt.rst.txt	4346	0644	edit dl rm
multifile.rst.txt	6613	0644	edit dl rm
multiprocessing.rst.txt	92621	0644	edit dl rm
mutex.rst.txt	1939	0644	edit dl rm
netdata.rst.txt	432	0644	edit dl rm
netrc.rst.txt	3119	0644	edit dl rm
new.rst.txt	2653	0644	edit dl rm
nis.rst.txt	2108	0644	edit dl rm
nntplib.rst.txt	14531	0644	edit dl rm
numbers.rst.txt	8007	0644	edit dl rm
numeric.rst.txt	751	0644	edit dl rm
operator.rst.txt	22092	0644	edit dl rm
optparse.rst.txt	77101	0644	edit dl rm
os.path.rst.txt	13094	0644	edit dl rm
os.rst.txt	82580	0644	edit dl rm
ossaudiodev.rst.txt	17309	0644	edit dl rm
othergui.rst.txt	2721	0644	edit dl rm
parser.rst.txt	15385	0644	edit dl rm
pdb.rst.txt	16043	0644	edit dl rm
persistence.rst.txt	826	0644	edit dl rm
pickle.rst.txt	37262	0644	edit dl rm
pickletools.rst.txt	1997	0644	edit dl rm
pipes.rst.txt	3786	0644	edit dl rm
pkgutil.rst.txt	7714	0644	edit dl rm
platform.rst.txt	9554	0644	edit dl rm
plistlib.rst.txt	4134	0644	edit dl rm
popen2.rst.txt	7022	0644	edit dl rm
poplib.rst.txt	6220	0644	edit dl rm
posix.rst.txt	3630	0644	edit dl rm
posixfile.rst.txt	7200	0644	edit dl rm
pprint.rst.txt	9071	0644	edit dl rm
profile.rst.txt	28666	0644	edit dl rm
pty.rst.txt	1762	0644	edit dl rm
pwd.rst.txt	2725	0644	edit dl rm
pyclbr.rst.txt	3296	0644	edit dl rm
pydoc.rst.txt	4083	0644	edit dl rm
pyexpat.rst.txt	28891	0644	edit dl rm
python.rst.txt	514	0644	edit dl rm
py_compile.rst.txt	2479	0644	edit dl rm
queue.rst.txt	7034	0644	edit dl rm
quopri.rst.txt	2670	0644	edit dl rm
random.rst.txt	13319	0644	edit dl rm
re.rst.txt	55102	0644	edit dl rm
readline.rst.txt	10513	0644	edit dl rm
repr.rst.txt	4718	0644	edit dl rm
resource.rst.txt	9595	0644	edit dl rm
restricted.rst.txt	3327	0644	edit dl rm
rexec.rst.txt	11742	0644	edit dl rm
rfc822.rst.txt	14037	0644	edit dl rm
rlcompleter.rst.txt	2494	0644	edit dl rm
robotparser.rst.txt	2190	0644	edit dl rm
runpy.rst.txt	6938	0644	edit dl rm
sched.rst.txt	4644	0644	edit dl rm
scrolledtext.rst.txt	1379	0644	edit dl rm
select.rst.txt	20705	0644	edit dl rm
sets.rst.txt	14973	0644	edit dl rm
sgi.rst.txt	322	0644	edit dl rm
sgmllib.rst.txt	10664	0644	edit dl rm
sha.rst.txt	2807	0644	edit dl rm
shelve.rst.txt	8319	0644	edit dl rm
shlex.rst.txt	11313	0644	edit dl rm
shutil.rst.txt	13491	0644	edit dl rm
signal.rst.txt	10719	0644	edit dl rm
simplehttpserver.rst.txt	4559	0644	edit dl rm
simplexmlrpcserver.rst.txt	10881	0644	edit dl rm
site.rst.txt	7880	0644	edit dl rm
smtpd.rst.txt	2464	0644	edit dl rm
smtplib.rst.txt	14906	0644	edit dl rm
sndhdr.rst.txt	1759	0644	edit dl rm
socket.rst.txt	40765	0644	edit dl rm
socketserver.rst.txt	22512	0644	edit dl rm
someos.rst.txt	599	0644	edit dl rm
spwd.rst.txt	2825	0644	edit dl rm
sqlite3.rst.txt	35448	0644	edit dl rm
ssl.rst.txt	76554	0644	edit dl rm
stat.rst.txt	7778	0644	edit dl rm
statvfs.rst.txt	1300	0644	edit dl rm
stdtypes.rst.txt	122668	0644	edit dl rm
string.rst.txt	44085	0644	edit dl rm
stringio.rst.txt	4166	0644	edit dl rm
stringprep.rst.txt	4238	0644	edit dl rm
strings.rst.txt	746	0644	edit dl rm
struct.rst.txt	17100	0644	edit dl rm
subprocess.rst.txt	33648	0644	edit dl rm
sun.rst.txt	249	0644	edit dl rm
sunau.rst.txt	7124	0644	edit dl rm
sunaudio.rst.txt	5849	0644	edit dl rm
symbol.rst.txt	975	0644	edit dl rm
symtable.rst.txt	5064	0644	edit dl rm
sys.rst.txt	47520	0644	edit dl rm
sysconfig.rst.txt	7639	0644	edit dl rm
syslog.rst.txt	3931	0644	edit dl rm
tabnanny.rst.txt	1999	0644	edit dl rm
tarfile.rst.txt	28214	0644	edit dl rm
telnetlib.rst.txt	7482	0644	edit dl rm
tempfile.rst.txt	10504	0644	edit dl rm
termios.rst.txt	3733	0644	edit dl rm
test.rst.txt	17659	0644	edit dl rm
textwrap.rst.txt	8552	0644	edit dl rm
thread.rst.txt	6588	0644	edit dl rm
threading.rst.txt	32468	0644	edit dl rm
time.rst.txt	26020	0644	edit dl rm
timeit.rst.txt	11598	0644	edit dl rm
tix.rst.txt	22693	0644	edit dl rm
tk.rst.txt	1612	0644	edit dl rm
tkinter.rst.txt	33456	0644	edit dl rm
token.rst.txt	2451	0644	edit dl rm
tokenize.rst.txt	5570	0644	edit dl rm
trace.rst.txt	6724	0644	edit dl rm
traceback.rst.txt	10711	0644	edit dl rm
ttk.rst.txt	57411	0644	edit dl rm
tty.rst.txt	1011	0644	edit dl rm
turtle.rst.txt	64097	0644	edit dl rm
types.rst.txt	6200	0644	edit dl rm
undoc.rst.txt	6550	0644	edit dl rm
unicodedata.rst.txt	5736	0644	edit dl rm
unittest.rst.txt	82952	0644	edit dl rm
unix.rst.txt	490	0644	edit dl rm
urllib.rst.txt	24960	0644	edit dl rm
urllib2.rst.txt	35211	0644	edit dl rm
urlparse.rst.txt	16071	0644	edit dl rm
user.rst.txt	2748	0644	edit dl rm
userdict.rst.txt	9290	0644	edit dl rm
uu.rst.txt	2369	0644	edit dl rm
uuid.rst.txt	8378	0644	edit dl rm
warnings.rst.txt	19815	0644	edit dl rm
wave.rst.txt	5047	0644	edit dl rm
weakref.rst.txt	12926	0644	edit dl rm
webbrowser.rst.txt	9863	0644	edit dl rm
whichdb.rst.txt	931	0644	edit dl rm
windows.rst.txt	273	0644	edit dl rm
winsound.rst.txt	5066	0644	edit dl rm
wsgiref.rst.txt	30567	0644	edit dl rm
xdrlib.rst.txt	8077	0644	edit dl rm
xml.dom.minidom.rst.txt	11208	0644	edit dl rm
xml.dom.pulldom.rst.txt	1571	0644	edit dl rm
xml.dom.rst.txt	40182	0644	edit dl rm
xml.etree.elementtree.rst.txt	35707	0644	edit dl rm
xml.rst.txt	6090	0644	edit dl rm
xml.sax.handler.rst.txt	15371	0644	edit dl rm
xml.sax.reader.rst.txt	12257	0644	edit dl rm
xml.sax.rst.txt	6460	0644	edit dl rm
xml.sax.utils.rst.txt	3560	0644	edit dl rm
xmlrpclib.rst.txt	22559	0644	edit dl rm
zipfile.rst.txt	18871	0644	edit dl rm
zipimport.rst.txt	5957	0644	edit dl rm
zlib.rst.txt	12766	0644	edit dl rm
_winreg.rst.txt	23305	0644	edit dl rm
__builtin__.rst.txt	1494	0644	edit dl rm
__future__.rst.txt	4952	0644	edit dl rm
__main__.rst.txt	535	0644	edit dl rm

Edit: /usr/share/doc/python2-docs/html/_sources/library/select.rst.txt (20705B)

:mod:`select` --- Waiting for I/O completion
============================================

.. module:: select
   :synopsis: Wait for I/O completion on multiple streams.

This module provides access to the :c:func:`select` and :c:func:`poll` functions
available in most operating systems, :c:func:`epoll` available on Linux 2.5+ and
:c:func:`kqueue` available on most BSD.
Note that on Windows, it only works for sockets; on other operating systems,
it also works for other file types (in particular, on Unix, it works on pipes).
It cannot be used on regular files to determine whether a file has grown since
it was last read.

The module defines the following:

.. exception:: error

The exception raised when an error occurs.  The accompanying value is a pair
   containing the numeric error code from :c:data:`errno` and the corresponding
   string, as would be printed by the C function :c:func:`perror`.

.. function:: epoll([sizehint=-1])

(Only supported on Linux 2.5.44 and newer.)  Returns an edge polling object,
   which can be used as Edge or Level Triggered interface for I/O events; see
   section :ref:`epoll-objects` below for the methods supported by epolling
   objects.

.. versionadded:: 2.6

.. function:: poll()

(Not supported by all operating systems.)  Returns a polling object, which
   supports registering and unregistering file descriptors, and then polling them
   for I/O events; see section :ref:`poll-objects` below for the methods supported
   by polling objects.

.. function:: kqueue()

(Only supported on BSD.)  Returns a kernel queue object; see section
   :ref:`kqueue-objects` below for the methods supported by kqueue objects.

.. versionadded:: 2.6

.. function:: kevent(ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)

(Only supported on BSD.)  Returns a kernel event object; see section
   :ref:`kevent-objects` below for the methods supported by kevent objects.

.. versionadded:: 2.6

.. function:: select(rlist, wlist, xlist[, timeout])

This is a straightforward interface to the Unix :c:func:`select` system call.
   The first three arguments are sequences of 'waitable objects': either
   integers representing file descriptors or objects with a parameterless method
   named :meth:`~io.IOBase.fileno` returning such an integer:

* *rlist*: wait until ready for reading
   * *wlist*: wait until ready for writing
   * *xlist*: wait for an "exceptional condition" (see the manual page for what
     your system considers such a condition)

Empty sequences are allowed, but acceptance of three empty sequences is
   platform-dependent. (It is known to work on Unix but not on Windows.)  The
   optional *timeout* argument specifies a time-out as a floating point number
   in seconds.  When the *timeout* argument is omitted the function blocks until
   at least one file descriptor is ready.  A time-out value of zero specifies a
   poll and never blocks.

The return value is a triple of lists of objects that are ready: subsets of the
   first three arguments.  When the time-out is reached without a file descriptor
   becoming ready, three empty lists are returned.

.. index::
      single: socket() (in module socket)
      single: popen() (in module os)

Among the acceptable object types in the sequences are Python file objects (e.g.
   ``sys.stdin``, or objects returned by :func:`open` or :func:`os.popen`), socket
   objects returned by :func:`socket.socket`.  You may also define a :dfn:`wrapper`
   class yourself, as long as it has an appropriate :meth:`~io.IOBase.fileno`
   method (that really returns a file descriptor, not just a random integer).

.. note::

.. index:: single: WinSock

File objects on Windows are not acceptable, but sockets are.  On Windows,
      the underlying :c:func:`select` function is provided by the WinSock
      library, and does not handle file descriptors that don't originate from
      WinSock.

.. attribute:: select.PIPE_BUF

Files reported as ready for writing by :func:`select`, :func:`poll` or
   similar interfaces in this module are guaranteed to not block on a write
   of up to :const:`PIPE_BUF` bytes.
   This value is guaranteed by POSIX to be at least 512.  Availability: Unix.

.. versionadded:: 2.7

.. _epoll-objects:

Edge and Level Trigger Polling (epoll) Objects
----------------------------------------------

http://linux.die.net/man/4/epoll

*eventmask*

.. method:: epoll.close()

Close the control file descriptor of the epoll object.

.. method:: epoll.fileno()

Return the file descriptor number of the control fd.

.. method:: epoll.fromfd(fd)

Create an epoll object from a given file descriptor.

.. method:: epoll.register(fd[, eventmask])

.. note::

Registering a file descriptor that's already registered raises an
     IOError -- contrary to :ref:`poll-objects`'s register.

.. method:: epoll.modify(fd, eventmask)

Modify a register file descriptor.

.. method:: epoll.unregister(fd)

Remove a registered file descriptor from the epoll object.

.. method:: epoll.poll([timeout=-1[, maxevents=-1]])

Wait for events. timeout in seconds (float)

.. _poll-objects:

Polling Objects
---------------

The :c:func:`poll` system call, supported on most Unix systems, provides better
scalability for network servers that service many, many clients at the same
time. :c:func:`poll` scales better because the system call only requires listing
the file descriptors of interest, while :c:func:`select` builds a bitmap, turns
on bits for the fds of interest, and then afterward the whole bitmap has to be
linearly scanned again. :c:func:`select` is O(highest file descriptor), while
:c:func:`poll` is O(number of file descriptors).

.. method:: poll.register(fd[, eventmask])

Register a file descriptor with the polling object.  Future calls to the
   :meth:`poll` method will then check whether the file descriptor has any
   pending I/O events.  *fd* can be either an integer, or an object with a
   :meth:`~io.IOBase.fileno` method that returns an integer.  File objects
   implement :meth:`!fileno`, so they can also be used as the argument.

*eventmask* is an optional bitmask describing the type of events you want to
   check for, and can be a combination of the constants :const:`POLLIN`,
   :const:`POLLPRI`, and :const:`POLLOUT`, described in the table below.  If not
   specified, the default value used will check for all 3 types of events.

Registering a file descriptor that's already registered is not an error, and has
   the same effect as registering the descriptor exactly once.

.. method:: poll.modify(fd, eventmask)

Modifies an already registered fd. This has the same effect as
   ``register(fd, eventmask)``.  Attempting to modify a file descriptor
   that was never registered causes an :exc:`IOError` exception with errno
   :const:`ENOENT` to be raised.

.. versionadded:: 2.6

.. method:: poll.unregister(fd)

Remove a file descriptor being tracked by a polling object.  Just like the
   :meth:`register` method, *fd* can be an integer or an object with a
   :meth:`~io.IOBase.fileno` method that returns an integer.

Attempting to remove a file descriptor that was never registered causes a
   :exc:`KeyError` exception to be raised.

.. method:: poll.poll([timeout])

Polls the set of registered file descriptors, and returns a possibly-empty list
   containing ``(fd, event)`` 2-tuples for the descriptors that have events or
   errors to report. *fd* is the file descriptor, and *event* is a bitmask with
   bits set for the reported events for that descriptor --- :const:`POLLIN` for
   waiting input, :const:`POLLOUT` to indicate that the descriptor can be written
   to, and so forth. An empty list indicates that the call timed out and no file
   descriptors had any events to report. If *timeout* is given, it specifies the
   length of time in milliseconds which the system will wait for events before
   returning. If *timeout* is omitted, negative, or :const:`None`, the call will
   block until there is an event for this poll object.

.. _kqueue-objects:

Kqueue Objects
--------------

.. method:: kqueue.close()

Close the control file descriptor of the kqueue object.

.. method:: kqueue.fileno()

Return the file descriptor number of the control fd.

.. method:: kqueue.fromfd(fd)

Create a kqueue object from a given file descriptor.

.. method:: kqueue.control(changelist, max_events[, timeout=None]) -> eventlist

Low level interface to kevent

- changelist must be an iterable of kevent object or ``None``
   - max_events must be 0 or a positive integer
   - timeout in seconds (floats possible)

.. _kevent-objects:

Kevent Objects
--------------

https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2

.. attribute:: kevent.ident

Value used to identify the event. The interpretation depends on the filter
   but it's usually the file descriptor. In the constructor ident can either
   be an int or an object with a fileno() function. kevent stores the integer
   internally.

.. attribute:: kevent.filter

Name of the kernel filter.

+---------------------------+---------------------------------------------+
   | Constant                  | Meaning                                     |
   +===========================+=============================================+
   | :const:`KQ_FILTER_READ`   | Takes a descriptor and returns whenever     |
   |                           | there is data available to read             |
   +---------------------------+---------------------------------------------+
   | :const:`KQ_FILTER_WRITE`  | Takes a descriptor and returns whenever     |
   |                           | there is data available to write            |
   +---------------------------+---------------------------------------------+
   | :const:`KQ_FILTER_AIO`    | AIO requests                                |
   +---------------------------+---------------------------------------------+
   | :const:`KQ_FILTER_VNODE`  | Returns when one or more of the requested   |
   |                           | events watched in *fflag* occurs            |
   +---------------------------+---------------------------------------------+
   | :const:`KQ_FILTER_PROC`   | Watch for events on a process id            |
   +---------------------------+---------------------------------------------+
   | :const:`KQ_FILTER_NETDEV` | Watch for events on a network device        |
   |                           | [not available on Mac OS X]                 |
   +---------------------------+---------------------------------------------+
   | :const:`KQ_FILTER_SIGNAL` | Returns whenever the watched signal is      |
   |                           | delivered to the process                    |
   +---------------------------+---------------------------------------------+
   | :const:`KQ_FILTER_TIMER`  | Establishes an arbitrary timer              |
   +---------------------------+---------------------------------------------+

.. attribute:: kevent.flags

Filter action.

.. attribute:: kevent.fflags

Filter specific flags.

:const:`KQ_FILTER_READ` and  :const:`KQ_FILTER_WRITE` filter flags:

:const:`KQ_FILTER_VNODE` filter flags:

:const:`KQ_FILTER_PROC` filter flags:

:const:`KQ_FILTER_NETDEV` filter flags (not available on Mac OS X):

.. attribute:: kevent.data

Filter specific data.

.. attribute:: kevent.udata

User defined value.

:mod:`select` --- Waiting for I/O completion ============================================ .. module:: select :synopsis: Wait for I/O completion on multiple streams. This module provides access to the :c:func:`select` and :c:func:`poll` functions available in most operating systems, :c:func:`epoll` available on Linux 2.5+ and :c:func:`kqueue` available on most BSD. Note that on Windows, it only works for sockets; on other operating systems, it also works for other file types (in particular, on Unix, it works on pipes). It cannot be used on regular files to determine whether a file has grown since it was last read. The module defines the following: .. exception:: error The exception raised when an error occurs. The accompanying value is a pair containing the numeric error code from :c:data:`errno` and the corresponding string, as would be printed by the C function :c:func:`perror`. .. function:: epoll([sizehint=-1]) (Only supported on Linux 2.5.44 and newer.) Returns an edge polling object, which can be used as Edge or Level Triggered interface for I/O events; see section :ref:`epoll-objects` below for the methods supported by epolling objects. .. versionadded:: 2.6 .. function:: poll() (Not supported by all operating systems.) Returns a polling object, which supports registering and unregistering file descriptors, and then polling them for I/O events; see section :ref:`poll-objects` below for the methods supported by polling objects. .. function:: kqueue() (Only supported on BSD.) Returns a kernel queue object; see section :ref:`kqueue-objects` below for the methods supported by kqueue objects. .. versionadded:: 2.6 .. function:: kevent(ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0) (Only supported on BSD.) Returns a kernel event object; see section :ref:`kevent-objects` below for the methods supported by kevent objects. .. versionadded:: 2.6 .. function:: select(rlist, wlist, xlist[, timeout]) This is a straightforward interface to the Unix :c:func:`select` system call. The first three arguments are sequences of 'waitable objects': either integers representing file descriptors or objects with a parameterless method named :meth:`~io.IOBase.fileno` returning such an integer: * *rlist*: wait until ready for reading * *wlist*: wait until ready for writing * *xlist*: wait for an "exceptional condition" (see the manual page for what your system considers such a condition) Empty sequences are allowed, but acceptance of three empty sequences is platform-dependent. (It is known to work on Unix but not on Windows.) The optional *timeout* argument specifies a time-out as a floating point number in seconds. When the *timeout* argument is omitted the function blocks until at least one file descriptor is ready. A time-out value of zero specifies a poll and never blocks. The return value is a triple of lists of objects that are ready: subsets of the first three arguments. When the time-out is reached without a file descriptor becoming ready, three empty lists are returned. .. index:: single: socket() (in module socket) single: popen() (in module os) Among the acceptable object types in the sequences are Python file objects (e.g. ``sys.stdin``, or objects returned by :func:`open` or :func:`os.popen`), socket objects returned by :func:`socket.socket`. You may also define a :dfn:`wrapper` class yourself, as long as it has an appropriate :meth:`~io.IOBase.fileno` method (that really returns a file descriptor, not just a random integer). .. note:: .. index:: single: WinSock File objects on Windows are not acceptable, but sockets are. On Windows, the underlying :c:func:`select` function is provided by the WinSock library, and does not handle file descriptors that don't originate from WinSock. .. attribute:: select.PIPE_BUF Files reported as ready for writing by :func:`select`, :func:`poll` or similar interfaces in this module are guaranteed to not block on a write of up to :const:`PIPE_BUF` bytes. This value is guaranteed by POSIX to be at least 512. Availability: Unix. .. versionadded:: 2.7 .. _epoll-objects: Edge and Level Trigger Polling (epoll) Objects ---------------------------------------------- http://linux.die.net/man/4/epoll *eventmask* +-----------------------+-----------------------------------------------+ | Constant | Meaning | +=======================+===============================================+ | :const:`EPOLLIN` | Available for read | +-----------------------+-----------------------------------------------+ | :const:`EPOLLOUT` | Available for write | +-----------------------+-----------------------------------------------+ | :const:`EPOLLPRI` | Urgent data for read | +-----------------------+-----------------------------------------------+ | :const:`EPOLLERR` | Error condition happened on the assoc. fd | +-----------------------+-----------------------------------------------+ | :const:`EPOLLHUP` | Hang up happened on the assoc. fd | +-----------------------+-----------------------------------------------+ | :const:`EPOLLET` | Set Edge Trigger behavior, the default is | | | Level Trigger behavior | +-----------------------+-----------------------------------------------+ | :const:`EPOLLONESHOT` | Set one-shot behavior. After one event is | | | pulled out, the fd is internally disabled | +-----------------------+-----------------------------------------------+ | :const:`EPOLLRDNORM` | Equivalent to :const:`EPOLLIN` | +-----------------------+-----------------------------------------------+ | :const:`EPOLLRDBAND` | Priority data band can be read. | +-----------------------+-----------------------------------------------+ | :const:`EPOLLWRNORM` | Equivalent to :const:`EPOLLOUT` | +-----------------------+-----------------------------------------------+ | :const:`EPOLLWRBAND` | Priority data may be written. | +-----------------------+-----------------------------------------------+ | :const:`EPOLLMSG` | Ignored. | +-----------------------+-----------------------------------------------+ .. method:: epoll.close() Close the control file descriptor of the epoll object. .. method:: epoll.fileno() Return the file descriptor number of the control fd. .. method:: epoll.fromfd(fd) Create an epoll object from a given file descriptor. .. method:: epoll.register(fd[, eventmask]) Register a fd descriptor with the epoll object. .. note:: Registering a file descriptor that's already registered raises an IOError -- contrary to :ref:`poll-objects`'s register. .. method:: epoll.modify(fd, eventmask) Modify a register file descriptor. .. method:: epoll.unregister(fd) Remove a registered file descriptor from the epoll object. .. method:: epoll.poll([timeout=-1[, maxevents=-1]]) Wait for events. timeout in seconds (float) .. _poll-objects: Polling Objects --------------- The :c:func:`poll` system call, supported on most Unix systems, provides better scalability for network servers that service many, many clients at the same time. :c:func:`poll` scales better because the system call only requires listing the file descriptors of interest, while :c:func:`select` builds a bitmap, turns on bits for the fds of interest, and then afterward the whole bitmap has to be linearly scanned again. :c:func:`select` is O(highest file descriptor), while :c:func:`poll` is O(number of file descriptors). .. method:: poll.register(fd[, eventmask]) Register a file descriptor with the polling object. Future calls to the :meth:`poll` method will then check whether the file descriptor has any pending I/O events. *fd* can be either an integer, or an object with a :meth:`~io.IOBase.fileno` method that returns an integer. File objects implement :meth:`!fileno`, so they can also be used as the argument. *eventmask* is an optional bitmask describing the type of events you want to check for, and can be a combination of the constants :const:`POLLIN`, :const:`POLLPRI`, and :const:`POLLOUT`, described in the table below. If not specified, the default value used will check for all 3 types of events. +-------------------+------------------------------------------+ | Constant | Meaning | +===================+==========================================+ | :const:`POLLIN` | There is data to read | +-------------------+------------------------------------------+ | :const:`POLLPRI` | There is urgent data to read | +-------------------+------------------------------------------+ | :const:`POLLOUT` | Ready for output: writing will not block | +-------------------+------------------------------------------+ | :const:`POLLERR` | Error condition of some sort | +-------------------+------------------------------------------+ | :const:`POLLHUP` | Hung up | +-------------------+------------------------------------------+ | :const:`POLLNVAL` | Invalid request: descriptor not open | +-------------------+------------------------------------------+ Registering a file descriptor that's already registered is not an error, and has the same effect as registering the descriptor exactly once. .. method:: poll.modify(fd, eventmask) Modifies an already registered fd. This has the same effect as ``register(fd, eventmask)``. Attempting to modify a file descriptor that was never registered causes an :exc:`IOError` exception with errno :const:`ENOENT` to be raised. .. versionadded:: 2.6 .. method:: poll.unregister(fd) Remove a file descriptor being tracked by a polling object. Just like the :meth:`register` method, *fd* can be an integer or an object with a :meth:`~io.IOBase.fileno` method that returns an integer. Attempting to remove a file descriptor that was never registered causes a :exc:`KeyError` exception to be raised. .. method:: poll.poll([timeout]) Polls the set of registered file descriptors, and returns a possibly-empty list containing ``(fd, event)`` 2-tuples for the descriptors that have events or errors to report. *fd* is the file descriptor, and *event* is a bitmask with bits set for the reported events for that descriptor --- :const:`POLLIN` for waiting input, :const:`POLLOUT` to indicate that the descriptor can be written to, and so forth. An empty list indicates that the call timed out and no file descriptors had any events to report. If *timeout* is given, it specifies the length of time in milliseconds which the system will wait for events before returning. If *timeout* is omitted, negative, or :const:`None`, the call will block until there is an event for this poll object. .. _kqueue-objects: Kqueue Objects -------------- .. method:: kqueue.close() Close the control file descriptor of the kqueue object. .. method:: kqueue.fileno() Return the file descriptor number of the control fd. .. method:: kqueue.fromfd(fd) Create a kqueue object from a given file descriptor. .. method:: kqueue.control(changelist, max_events[, timeout=None]) -> eventlist Low level interface to kevent - changelist must be an iterable of kevent object or ``None`` - max_events must be 0 or a positive integer - timeout in seconds (floats possible) .. _kevent-objects: Kevent Objects -------------- https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2 .. attribute:: kevent.ident Value used to identify the event. The interpretation depends on the filter but it's usually the file descriptor. In the constructor ident can either be an int or an object with a fileno() function. kevent stores the integer internally. .. attribute:: kevent.filter Name of the kernel filter. +---------------------------+---------------------------------------------+ | Constant | Meaning | +===========================+=============================================+ | :const:`KQ_FILTER_READ` | Takes a descriptor and returns whenever | | | there is data available to read | +---------------------------+---------------------------------------------+ | :const:`KQ_FILTER_WRITE` | Takes a descriptor and returns whenever | | | there is data available to write | +---------------------------+---------------------------------------------+ | :const:`KQ_FILTER_AIO` | AIO requests | +---------------------------+---------------------------------------------+ | :const:`KQ_FILTER_VNODE` | Returns when one or more of the requested | | | events watched in *fflag* occurs | +---------------------------+---------------------------------------------+ | :const:`KQ_FILTER_PROC` | Watch for events on a process id | +---------------------------+---------------------------------------------+ | :const:`KQ_FILTER_NETDEV` | Watch for events on a network device | | | [not available on Mac OS X] | +---------------------------+---------------------------------------------+ | :const:`KQ_FILTER_SIGNAL` | Returns whenever the watched signal is | | | delivered to the process | +---------------------------+---------------------------------------------+ | :const:`KQ_FILTER_TIMER` | Establishes an arbitrary timer | +---------------------------+---------------------------------------------+ .. attribute:: kevent.flags Filter action. +---------------------------+---------------------------------------------+ | Constant | Meaning | +===========================+=============================================+ | :const:`KQ_EV_ADD` | Adds or modifies an event | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_DELETE` | Removes an event from the queue | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_ENABLE` | Permitscontrol() to returns the event | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_DISABLE` | Disablesevent | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_ONESHOT` | Removes event after first occurrence | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_CLEAR` | Reset the state after an event is retrieved | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_SYSFLAGS` | internal event | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_FLAG1` | internal event | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_EOF` | Filter specific EOF condition | +---------------------------+---------------------------------------------+ | :const:`KQ_EV_ERROR` | See return values | +---------------------------+---------------------------------------------+ .. attribute:: kevent.fflags Filter specific flags. :const:`KQ_FILTER_READ` and :const:`KQ_FILTER_WRITE` filter flags: +----------------------------+--------------------------------------------+ | Constant | Meaning | +============================+============================================+ | :const:`KQ_NOTE_LOWAT` | low water mark of a socket buffer | +----------------------------+--------------------------------------------+ :const:`KQ_FILTER_VNODE` filter flags: +----------------------------+--------------------------------------------+ | Constant | Meaning | +============================+============================================+ | :const:`KQ_NOTE_DELETE` | *unlink()* was called | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_WRITE` | a write occurred | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_EXTEND` | the file was extended | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_ATTRIB` | an attribute was changed | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_LINK` | the link count has changed | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_RENAME` | the file was renamed | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_REVOKE` | access to the file was revoked | +----------------------------+--------------------------------------------+ :const:`KQ_FILTER_PROC` filter flags: +----------------------------+--------------------------------------------+ | Constant | Meaning | +============================+============================================+ | :const:`KQ_NOTE_EXIT` | the process has exited | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_FORK` | the process has called *fork()* | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_EXEC` | the process has executed a new process | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_PCTRLMASK` | internal filter flag | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_PDATAMASK` | internal filter flag | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_TRACK` | follow a process across *fork()* | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_CHILD` | returned on the child process for | | | *NOTE_TRACK* | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_TRACKERR` | unable to attach to a child | +----------------------------+--------------------------------------------+ :const:`KQ_FILTER_NETDEV` filter flags (not available on Mac OS X): +----------------------------+--------------------------------------------+ | Constant | Meaning | +============================+============================================+ | :const:`KQ_NOTE_LINKUP` | link is up | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_LINKDOWN` | link is down | +----------------------------+--------------------------------------------+ | :const:`KQ_NOTE_LINKINV` | link state is invalid | +----------------------------+--------------------------------------------+ .. attribute:: kevent.data Filter specific data. .. attribute:: kevent.udata User defined value.