.. cvar:: int PyTrace_C_EXCEPTION
The value for the *what* parameter to :ctype:`Py_tracefunc` functions when a C
- function has thrown an exception.
+ function has raised an exception.
.. cvar:: int PyTrace_C_RETURN
*s*. Return *NULL* if an exception was raised by the codec.
-.. cfunction:: PyObject* PyUnicode_DecodeUTF8Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
+.. cfunction:: PyObject* PyUnicode_DecodeUTF7Stateful(const char *s, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
If *consumed* is *NULL*, behave like :cfunc:`PyUnicode_DecodeUTF7`. If
*consumed* is not *NULL*, trailing incomplete UTF-7 base-64 sections will not
('tutorial/index', 'tutorial.tex',
'Python Tutorial', _stdauthor, 'manual'),
('using/index', 'using.tex',
- 'Python Setup', _stdauthor, 'manual'),
+ 'Python Setup and Usage', _stdauthor, 'manual'),
('whatsnew/' + version, 'whatsnew.tex',
'What\'s New in Python', 'A. M. Kuchling', 'howto'),
]
if reply != 200:
sys.stdout.write(httpobj.getfile().read())
-Note that in general for a percent-encoded POST operations, query strings must be
-quoted by using :func:`urllib.quote`. For example to send name="Guy Steele,
-Jr."::
+Note that in general for percent-encoded POST operations, query strings must be
+quoted using :func:`urllib.quote`. For example to send name="Guy Steele, Jr."::
>>> from urllib import quote
>>> x = quote("Guy Steele, Jr.")
* ``"exception"``: An exception has occurred.
* ``"c_call"``: A C function is about to be called.
* ``"c_return"``: A C function has returned.
- * ``"c_exception"``: A C function has thrown an exception.
+ * ``"c_exception"``: A C function has raised an exception.
For the Python events, specialized functions (see below) are called. For
the C events, no action is taken.
.. exception:: DocTestFailure(test, example, got)
- An exception thrown by :class:`DocTestRunner` to signal that a doctest example's
+ An exception raised by :class:`DocTestRunner` to signal that a doctest example's
actual output did not match its expected output. The constructor arguments are
used to initialize the member variables of the same names.
.. exception:: UnexpectedException(test, example, exc_info)
- An exception thrown by :class:`DocTestRunner` to signal that a doctest example
- raised an unexpected exception. The constructor arguments are used to
- initialize the member variables of the same names.
+ An exception raised by :class:`DocTestRunner` to signal that a doctest
+ example raised an unexpected exception. The constructor arguments are used
+ to initialize the member variables of the same names.
:exc:`UnexpectedException` defines the following member variables:
.. exception:: MessageParseError()
- This is the base class for exceptions thrown by the :class:`~email.parser.Parser`
+ This is the base class for exceptions raised by the :class:`~email.parser.Parser`
class. It is derived from :exc:`MessageError`.
returns the current global and local dictionary, respectively, which may be
useful to pass around for use by :func:`eval` or :func:`execfile`.
+ See :func:`ast.literal_eval` for a function that can safely evaluate strings
+ with expressions containing only literals.
+
.. function:: execfile(filename[, globals[, locals]])
At the top of the I/O hierarchy is the abstract base class :class:`IOBase`. It
defines the basic interface to a stream. Note, however, that there is no
separation between reading and writing to streams; implementations are allowed
-to throw an :exc:`IOError` if they do not support a given operation.
+to raise an :exc:`IOError` if they do not support a given operation.
Extending :class:`IOBase` is :class:`RawIOBase` which deals simply with the
reading and writing of raw bytes to a stream. :class:`FileIO` subclasses
encoders and decoders. Otherwise, it will be a :exc:`ValueError` to encode
such floats.
- If *sort_keys* is ``True`` (the default), then the output of dictionaries
+ If *sort_keys* is ``True`` (default ``False``), then the output of dictionaries
will be sorted by key; this is useful for regression tests to ensure that
JSON serializations can be compared on a day-to-day basis.
.. function:: getline(filename, lineno[, module_globals])
- Get line *lineno* from file named *filename*. This function will never throw an
+ Get line *lineno* from file named *filename*. This function will never raise an
exception --- it will return ``''`` on errors (the terminating newline character
will be included for lines that are found).
Copy the *count* bytes starting at offset *src* to the destination index
*dest*. If the mmap was created with :const:`ACCESS_READ`, then calls to
- move will throw a :exc:`TypeError` exception.
+ move will raise a :exc:`TypeError` exception.
.. method:: read(num)
Resizes the map and the underlying file, if any. If the mmap was created
with :const:`ACCESS_READ` or :const:`ACCESS_COPY`, resizing the map will
- throw a :exc:`TypeError` exception.
+ raise a :exc:`TypeError` exception.
.. method:: rfind(string[, start[, end]])
Write the bytes in *string* into memory at the current position of the
file pointer; the file position is updated to point after the bytes that
were written. If the mmap was created with :const:`ACCESS_READ`, then
- writing to it will throw a :exc:`TypeError` exception.
+ writing to it will raise a :exc:`TypeError` exception.
.. method:: write_byte(byte)
Write the single-character string *byte* into memory at the current
position of the file pointer; the file position is advanced by ``1``. If
the mmap was created with :const:`ACCESS_READ`, then writing to it will
- throw a :exc:`TypeError` exception.
-
-
+ raise a :exc:`TypeError` exception.
.. literalinclude:: ../includes/mp_synchronize.py
-An showing how to use queues to feed tasks to a collection of worker process and
-collect the results:
+An example showing how to use queues to feed tasks to a collection of worker
+process and collect the results:
.. literalinclude:: ../includes/mp_workers.py
.. function:: getresgid()
Return a tuple (rgid, egid, sgid) denoting the current process's
- real, effective, and saved user ids.
+ real, effective, and saved group ids.
Availability: Unix.
The :func:`expr` function parses the parameter *source* as if it were an input
to ``compile(source, 'file.py', 'eval')``. If the parse succeeds, an ST object
is created to hold the internal parse tree representation, otherwise an
- appropriate exception is thrown.
+ appropriate exception is raised.
.. function:: suite(source)
The :func:`suite` function parses the parameter *source* as if it were an input
to ``compile(source, 'file.py', 'exec')``. If the parse succeeds, an ST object
is created to hold the internal parse tree representation, otherwise an
- appropriate exception is thrown.
+ appropriate exception is raised.
.. function:: sequence2st(sequence)
to the Python grammar and all nodes are valid node types in the host version of
Python, an ST object is created from the internal representation and returned
to the called. If there is a problem creating the internal representation, or
- if the tree cannot be validated, a :exc:`ParserError` exception is thrown. An
+ if the tree cannot be validated, a :exc:`ParserError` exception is raised. An
ST object created this way should not be assumed to compile correctly; normal
- exceptions thrown by compilation may still be initiated when the ST object is
+ exceptions raised by compilation may still be initiated when the ST object is
passed to :func:`compilest`. This may indicate problems not related to syntax
(such as a :exc:`MemoryError` exception), but may also be due to constructs such
as the result of parsing ``del f(0)``, which escapes the Python parser but is
.. exception:: ParserError
Exception raised when a failure occurs within the parser module. This is
- generally produced for validation failures rather than the built in
- :exc:`SyntaxError` thrown during normal parsing. The exception argument is
+ generally produced for validation failures rather than the built-in
+ :exc:`SyntaxError` raised during normal parsing. The exception argument is
either a string describing the reason of the failure or a tuple containing a
sequence causing the failure from a parse tree passed to :func:`sequence2st`
and an explanatory string. Calls to :func:`sequence2st` need to be able to
will only need to be aware of the simple string values.
Note that the functions :func:`compilest`, :func:`expr`, and :func:`suite` may
-throw exceptions which are normally thrown by the parsing and compilation
+raise exceptions which are normally thrown by the parsing and compilation
process. These include the built in exceptions :exc:`MemoryError`,
:exc:`OverflowError`, :exc:`SyntaxError`, and :exc:`SystemError`. In these
cases, these exceptions carry all the meaning normally associated with them.
Called if the XML document hasn't been declared as being a standalone document.
This happens when there is an external subset or a reference to a parameter
entity, but the XML declaration does not set standalone to ``yes`` in an XML
- declaration. If this handler returns ``0``, then the parser will throw an
+ declaration. If this handler returns ``0``, then the parser will raise an
:const:`XML_ERROR_NOT_STANDALONE` error. If this handler is not set, no
exception is raised by the parser for this condition.
responsible for creating the sub-parser using
``ExternalEntityParserCreate(context)``, initializing it with the appropriate
callbacks, and parsing the entity. This handler should return an integer; if it
- returns ``0``, the parser will throw an
+ returns ``0``, the parser will raise an
:const:`XML_ERROR_EXTERNAL_ENTITY_HANDLING` error, otherwise parsing will
continue.
and ESMTP options suppressed.
This method will return normally if the mail is accepted for at least one
- recipient. Otherwise it will throw an exception. That is, if this method does
- not throw an exception, then someone should get your mail. If this method does
- not throw an exception, it returns a dictionary, with one entry for each
+ recipient. Otherwise it will raise an exception. That is, if this method does
+ not raise an exception, then someone should get your mail. If this method does
+ not raise an exception, it returns a dictionary, with one entry for each
recipient that was refused. Each entry contains a tuple of the SMTP error code
and the accompanying error message sent by the server.
Shut down one or both halves of the connection. If *how* is :const:`SHUT_RD`,
further receives are disallowed. If *how* is :const:`SHUT_WR`, further sends
are disallowed. If *how* is :const:`SHUT_RDWR`, further sends and receives are
- disallowed.
+ disallowed. Depending on the platform, shutting down one half of the connection
+ can also close the opposite half (e.g. on Mac OS X, ``shutdown(SHUT_WR)`` does
+ not allow further reads on the other end of the connection).
Note that there are no methods :meth:`read` or :meth:`write`; use
:meth:`~socket.recv` and :meth:`~socket.send` without *flags* argument instead.
the format string (integers for positional arguments, and strings for
named arguments), and a reference to the *args* and *kwargs* that was
passed to vformat. The set of unused args can be calculated from these
- parameters. :meth:`check_unused_args` is assumed to throw an exception if
+ parameters. :meth:`check_unused_args` is assumed to raise an exception if
the check fails.
.. method:: format_field(value, format_spec)
precision: `integer`
type: "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%"
-The *fill* character can be any character other than '}' (which signifies the
-end of the field). The presence of a fill character is signaled by the *next*
-character, which must be one of the alignment options. If the second character
-of *format_spec* is not a valid alignment option, then it is assumed that both
-the fill character and the alignment option are absent.
+The *fill* character can be any character other than '{' or '}'. The presence
+of a fill character is signaled by the character following it, which must be
+one of the alignment options. If the second character of *format_spec* is not
+a valid alignment option, then it is assumed that both the fill character and
+the alignment option are absent.
The meaning of the various alignment options is as follows:
Exceptions raised in the child process, before the new program has started to
execute, will be re-raised in the parent. Additionally, the exception object
will have one extra attribute called :attr:`child_traceback`, which is a string
-containing traceback information from the childs point of view.
+containing traceback information from the child's point of view.
The most common exception raised is :exc:`OSError`. This occurs, for example,
when trying to execute a non-existent file. Applications should prepare for
A C function has returned. *arg* is ``None``.
``'c_exception'``
- A C function has thrown an exception. *arg* is ``None``.
+ A C function has raised an exception. *arg* is ``None``.
Note that as an exception is propagated down the chain of callers, an
``'exception'`` event is generated at each level.
variable allows one or more threads to wait until they are notified by another
thread.
+ See :ref:`condition-objects`.
+
.. function:: current_thread()
currentThread()
with the :meth:`clear` method. The :meth:`wait` method blocks until the flag
is true.
+ See :ref:`event-objects`.
+
.. class:: local
acquired it, subsequent attempts to acquire it block, until it is released; any
thread may release it.
+ See :ref:`lock-objects`.
+
.. function:: RLock()
reentrant lock, the same thread may acquire it again without blocking; the
thread must release it once for each time it has acquired it.
+ See :ref:`rlock-objects`.
+
.. function:: Semaphore([value])
:noindex:
if necessary until it can return without making the counter negative. If not
given, *value* defaults to 1.
+ See :ref:`semaphore-objects`.
+
.. function:: BoundedSemaphore([value])
.. class:: Thread
+ :noindex:
A class that represents a thread of control. This class can be safely
subclassed in a limited fashion.
+ See :ref:`thread-objects`.
+
.. class:: Timer
+ :noindex:
A thread that executes a function after a specified interval has passed.
+ See :ref:`timer-objects`.
+
.. function:: settrace(func)
Allow an application to set the locale for errors and warnings.
SAX parsers are not required to provide localization for errors and warnings; if
- they cannot support the requested locale, however, they must throw a SAX
+ they cannot support the requested locale, however, they must raise a SAX
exception. Applications may request a locale change in the middle of a parse.
The execution of the :keyword:`with` statement with one "item" proceeds as follows:
-#. The context expression is evaluated to obtain a context manager.
+#. The context expression (the expression given in the :token:`with_item`) is
+ evaluated to obtain a context manager.
#. The context manager's :meth:`__exit__` is loaded for later use.
| ``+``, ``-`` | Addition and subtraction |
+-----------------------------------------------+-------------------------------------+
| ``*``, ``/``, ``//``, ``%`` | Multiplication, division, remainder |
+| | [#]_ |
+-----------------------------------------------+-------------------------------------+
| ``+x``, ``-x``, ``~x`` | Positive, negative, bitwise NOT |
+-----------------------------------------------+-------------------------------------+
the :keyword:`is` operator, like those involving comparisons between instance
methods, or constants. Check their documentation for more info.
+.. [#] The ``%`` is also used for string formatting; the same precedence applies.
+
.. [#] The power operator ``**`` binds less tightly than an arithmetic or
bitwise unary operator on its right, that is, ``2**-1`` is ``0.5``.
<span class="linkdescr">keep this under your pillow</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">Language Reference</a><br/>
<span class="linkdescr">describes syntax and language elements</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto("using/index") }}">Python Setup</a><br/>
+ <p class="biglink"><a class="biglink" href="{{ pathto("using/index") }}">Python Setup and Usage</a><br/>
<span class="linkdescr">how to use Python on different platforms</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("howto/index") }}">Python HOWTOs</a><br/>
<span class="linkdescr">in-depth documents on specific topics</span></p>
.. _using-index:
-################
- Python Setup
-################
+##########################
+ Python Setup and Usage
+##########################
This part of the documentation is devoted to general information on the setup
deprecated APIs and removes support for Python versions earlier than 2.3. The
3.0 version of the package uses a new incremental parser for MIME messages,
available in the :mod:`email.FeedParser` module. The new parser doesn't require
- reading the entire message into memory, and doesn't throw exceptions if a
+ reading the entire message into memory, and doesn't raise exceptions if a
message is malformed; instead it records any problems in the :attr:`defect`
attribute of the message. (Developed by Anthony Baxter, Barry Warsaw, Thomas
Wouters, and others.)
Permissions History
-------------------
+- Lukasz Langa was given commit access on Sep 08 2010 by GFB,
+ at suggestion of Antoine Pitrou, for general bug fixing.
+
+- Daniel Stutzbach was given commit access on Aug 22 2010 by MvL,
+ for general bug fixing.
+
+- Ask Solem was given commit access on Aug 17 2010 by MvL,
+ on recommendation by Jesse Noller, for work on the multiprocessing
+ library.
+
+- George Boutsioukis was given commit access on Aug 10 2010
+ by MvL, for work on 2to3.
+
+- Éric Araujo was given commit access on Aug 10 2010 by BAC,
+ at suggestion of Tarek Ziadé.
+
+- Terry Reedy was given commit access on Aug 04 2010 by MvL,
+ at suggestion of Nick Coghlan.
+
- Brian Quinlan was given commit access on Jul 26 2010 by GFB,
for work related to PEP 3148.
Perform the requested operation on file descriptor fd. The operation\n\
is defined by op and is operating system dependent. These constants are\n\
available from the fcntl module. The argument arg is optional, and\n\
-defaults to 0; it may be an int or a string. If arg is given as a string,\n\
+defaults to 0; it may be an int or a string. If arg is given as a string,\n\
the return value of fcntl is a string of that length, containing the\n\
-resulting value put in the arg buffer by the operating system.The length\n\
-of the arg string is not allowed to exceed 1024 bytes. If the arg given\n\
+resulting value put in the arg buffer by the operating system. The length\n\
+of the arg string is not allowed to exceed 1024 bytes. If the arg given\n\
is an integer or if none is specified, the result value is an integer\n\
corresponding to the return value of the fcntl call in the C code.");
#ifdef HAVE_GETRESGID
PyDoc_STRVAR(posix_getresgid__doc__,
"getresgid() -> (rgid, egid, sgid)\n\n\
-Get tuple of the current process's real, effective, and saved user ids.");
+Get tuple of the current process's real, effective, and saved group ids.");
static PyObject*
posix_getresgid (PyObject *self, PyObject *noargs)
projects / python / commitdiff