* Travis B. Hartwell
* Tim Hatch
* Janko Hauser
+ * Thomas Heller
* Bernhard Herzog
* Magnus L. Hetland
* Konrad Hinsen
indicated by the :const:`Py_TPFLAGS_HAVE_RICHCOMPARE` flag bit) and have *NULL*
values.
- The following bit masks are currently defined; these can be or-ed together using
+ The following bit masks are currently defined; these can be ORed together using
the ``|`` operator to form the value of the :attr:`tp_flags` field. The macro
:cfunc:`PyType_HasFeature` takes a type and a flags value, *tp* and *f*, and
checks whether ``tp->tp_flags & f`` is non-zero.
to find out. Starting with Python 2.4, a failing import of a module no longer
leaves the module in ``sys.modules``.
- .. index:: single: modules (in module sys)
-
.. cfunction:: PyObject* PyImport_ImportModuleNoBlock(const char *name)
- .. index::
- single: `cfunc:PyImport_ImportModule`
-
- This version of `cfunc:PyImport_ImportModule` does not block. It's intended
+ This version of :cfunc:`PyImport_ImportModule` does not block. It's intended
to be used in C function which import other modules to execute a function.
The import may block if another thread holds the import lock. The function
- `cfunc:PyImport_ImportModuleNoBlock` doesn't block. It first tries to fetch
- the module from sys.modules and falls back to `cfunc:PyImport_ImportModule`
+ :cfunc:`PyImport_ImportModuleNoBlock` doesn't block. It first tries to fetch
+ the module from sys.modules and falls back to :cfunc:`PyImport_ImportModule`
unless the the lock is hold. In the latter case the function raises an
ImportError.
Failing imports remove incomplete module objects, like with
:cfunc:`PyImport_ImportModule`.
- The function is an alias for `cfunc:PyImport_ImportModuleLevel` with -1 as
- *level*, meaning relative import.
-
.. cfunction:: PyObject* PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
:func:`compile`, load the module. Return a new reference to the module object,
or *NULL* with an exception set if an error occurred. Before Python 2.4, the
module could still be created in error cases. Starting with Python 2.4, *name*
- is removed from ``sys.modules`` in error cases, and even if *name* was already
- in ``sys.modules`` on entry to :cfunc:`PyImport_ExecCodeModule`. Leaving
- incompletely initialized modules in ``sys.modules`` is dangerous, as imports of
+ is removed from :attr:`sys.modules` in error cases, and even if *name* was already
+ in :attr:`sys.modules` on entry to :cfunc:`PyImport_ExecCodeModule`. Leaving
+ incompletely initialized modules in :attr:`sys.modules` is dangerous, as imports of
such modules have no way to know that the module object is an unknown (and
probably damaged with respect to the module author's intents) state.
__slots__ = ()
+ _fields = ('x', 'y')
+
def __new__(cls, x, y):
return tuple.__new__(cls, (x, y))
- _cast = classmethod(tuple.__new__)
+ @classmethod
+ def _make(cls, iterable):
+ 'Make a new Point object from a sequence or iterable'
+ result = tuple.__new__(cls, iterable)
+ if len(result) != 2:
+ raise TypeError('Expected 2 arguments, got %d' % len(result))
+ return result
def __repr__(self):
return 'Point(x=%r, y=%r)' % self
def _replace(self, **kwds):
'Return a new Point object replacing specified fields with new values'
- return Point._cast(map(kwds.get, ('x', 'y'), self))
-
- @property
- def _fields(self):
- return ('x', 'y')
+ result = self._make(map(kwds.pop, ('x', 'y'), self))
+ if kwds:
+ raise ValueError('Got unexpected field names: %r' % kwds.keys())
+ return result
x = property(itemgetter(0))
y = property(itemgetter(1))
EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade')
import csv
- for emp in map(EmployeeRecord._cast, csv.reader(open("employees.csv", "rb"))):
+ for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))):
print(emp.name, emp.title)
import sqlite3
conn = sqlite3.connect('/companydata')
cursor = conn.cursor()
cursor.execute('SELECT name, age, title, department, paygrade FROM employees')
- for emp in map(EmployeeRecord._cast, cursor.fetchall()):
+ for emp in map(EmployeeRecord._make, cursor.fetchall()):
print emp.name, emp.title
In addition to the methods inherited from tuples, named tuples support
-three additonal methods and a read-only attribute.
+three additional methods and one attribute.
-.. method:: namedtuple._cast(iterable)
+.. method:: namedtuple._make(iterable)
- Class method returning a new instance taking the positional arguments from the *iterable*.
- Useful for casting existing sequences and iterables to named tuples:
+ Class method that makes a new instance from an existing sequence or iterable.
::
- >>> t = [11, 22]
- >>> Point._cast(t)
- Point(x=11, y=22)
+ >>> t = [11, 22]
+ >>> Point._make(t)
+ Point(x=11, y=22)
.. method:: somenamedtuple._asdict()
.. attribute:: somenamedtuple._fields
- Return a tuple of strings listing the field names. This is useful for introspection
+ Tuple of strings listing the field names. This is useful for introspection
and for creating new named tuple types from existing named tuples.
::
A simple example (this is not recommended as a real way of generating HTML!)::
- from __future__ import with_statement
from contextlib import contextmanager
@contextmanager
And lets you write code like this::
- from __future__ import with_statement
from contextlib import closing
import urllib
For example, the following code sets the current decimal precision to 42 places,
performs a calculation, and then automatically restores the previous context::
- from __future__ import with_statement
from decimal import localcontext
with localcontext() as ctx:
* :const:`LOCK_EX` -- acquire an exclusive lock
When *operation* is :const:`LOCK_SH` or :const:`LOCK_EX`, it can also be
- bit-wise OR'd with :const:`LOCK_NB` to avoid blocking on lock acquisition.
+ bitwise ORed with :const:`LOCK_NB` to avoid blocking on lock acquisition.
If :const:`LOCK_NB` is used and the lock cannot be acquired, an
:exc:`IOError` will be raised and the exception will have an *errno*
attribute set to :const:`EACCES` or :const:`EAGAIN` (depending on the
the *flags* argument is it -- the future statements in effect around the call to
compile are ignored.
- Future statements are specified by bits which can be bitwise or-ed together to
+ Future statements are specified by bits which can be bitwise ORed together to
specify multiple statements. The bitfield required to specify a given feature
can be found as the :attr:`compiler_flag` attribute on the :class:`_Feature`
instance in the :mod:`__future__` module.
*cmp* specifies a custom comparison function of two arguments (iterable
elements) which should return a negative, zero or positive number depending on
whether the first argument is considered smaller than, equal to, or larger than
- the second argument: ``cmp=lambda x,y: cmp(x.lower(), y.lower())``
+ the second argument: ``cmp=lambda x,y: cmp(x.lower(), y.lower())``. The default
+ value is ``None``.
*key* specifies a function of one argument that is used to extract a comparison
- key from each list element: ``key=str.lower``
+ key from each list element: ``key=str.lower``. The default value is ``None``.
*reverse* is a boolean value. If set to ``True``, then the list elements are
sorted as if each comparison were reversed.
exposed.
-.. function:: UUIDCreate()
+.. function:: UuidCreate()
Return the string representation of a new unique identifier. This wraps the
Windows API functions :cfunc:`UuidCreate` and :cfunc:`UuidToString`.
.. function:: open_osfhandle(handle, flags)
Create a C runtime file descriptor from the file handle *handle*. The *flags*
- parameter should be a bit-wise OR of :const:`os.O_APPEND`, :const:`os.O_RDONLY`,
+ parameter should be a bitwise OR of :const:`os.O_APPEND`, :const:`os.O_RDONLY`,
and :const:`os.O_TEXT`. The returned file descriptor may be used as a parameter
to :func:`os.fdopen` to create a file object.
-
:mod:`numbers` --- Numeric abstract base classes
================================================
.. module:: numbers
:synopsis: Numeric abstract base classes (Complex, Real, Integral, etc.).
+
The :mod:`numbers` module (:pep:`3141`) defines a hierarchy of numeric abstract
base classes which progressively define more operations. These concepts also
provide a way to distinguish exact from inexact types. None of the types defined
This module provides a more portable way of using operating system dependent
-functionality than importing a operating system dependent built-in module like
+functionality than importing an operating system dependent built-in module like
:mod:`posix` or :mod:`nt`. If you just want to read or write a file see
:func:`open`, if you want to manipulate paths, see the :mod:`os.path`
module, and if you want to read all the lines in all the files on the
This module searches for an operating system dependent built-in module like
:mod:`mac` or :mod:`posix` and exports the same functions and data as found
-there. The design of all Python's built-in operating system dependent modules
+there. The design of all built-in operating system dependent modules of Python
is such that as long as the same functionality is available, it uses the same
interface; for example, the function ``os.stat(path)`` returns stat information
about *path* in the same format (which happens to have originated with the POSIX
.. function:: getegid()
Return the effective group id of the current process. This corresponds to the
- 'set id' bit on the file being executed in the current process. Availability:
+ "set id" bit on the file being executed in the current process. Availability:
Unix.
.. index:: single: user; effective id
- Return the current process' effective user id. Availability: Unix.
+ Return the current process's effective user id. Availability: Unix.
.. function:: getgid()
process. For most purposes, it is more useful to use the environment variable
:envvar:`LOGNAME` to find out who the user is, or
``pwd.getpwuid(os.getuid())[0]`` to get the login name of the currently
- effective user ID. Availability: Unix.
+ effective user id. Availability: Unix.
.. function:: getpgid(pid)
.. index:: single: user; id
- Return the current process' user id. Availability: Unix.
+ Return the current process's user id. Availability: Unix.
.. function:: getenv(varname[, value])
Set the list of supplemental group ids associated with the current process to
*groups*. *groups* must be a sequence, and each element must be an integer
- identifying a group. This operation is typical available only to the superuser.
+ identifying a group. This operation is typically available only to the superuser.
Availability: Unix.
.. function:: setpgrp()
- Calls the system call :cfunc:`setpgrp` or :cfunc:`setpgrp(0, 0)` depending on
+ Call the system call :cfunc:`setpgrp` or :cfunc:`setpgrp(0, 0)` depending on
which version is implemented (if any). See the Unix manual for the semantics.
Availability: Unix.
.. function:: setpgid(pid, pgrp)
- Calls the system call :cfunc:`setpgid` to set the process group id of the
+ Call the system call :cfunc:`setpgid` to set the process group id of the
process with id *pid* to the process group with id *pgrp*. See the Unix manual
for the semantics. Availability: Unix.
.. function:: getsid(pid)
- Calls the system call :cfunc:`getsid`. See the Unix manual for the semantics.
+ Call the system call :cfunc:`getsid`. See the Unix manual for the semantics.
Availability: Unix.
.. function:: setsid()
- Calls the system call :cfunc:`setsid`. See the Unix manual for the semantics.
+ Call the system call :cfunc:`setsid`. See the Unix manual for the semantics.
Availability: Unix.
.. index:: single: user; id, setting
- Set the current process' user id. Availability: Unix.
+ Set the current process's user id. Availability: Unix.
.. placed in this section since it relates to errno.... a little weak
.. function:: umask(mask)
- Set the current numeric umask and returns the previous umask. Availability:
+ Set the current numeric umask and return the previous umask. Availability:
Unix, Windows.
.. function:: lseek(fd, pos, how)
- Set the current position of file descriptor *fd* to position *pos*, modified by
- *how*: ``0`` to set the position relative to the beginning of the file; ``1`` to
- set it relative to the current position; ``2`` to set it relative to the end of
+ Set the current position of file descriptor *fd* to position *pos*, modified
+ by *how*: :const:`SEEK_SET` or ``0`` to set the position relative to the
+ beginning of the file; :const:`SEEK_CUR` or ``1`` to set it relative to the
+ current position; :const:`os.SEEK_END` or ``2`` to set it relative to the end of
the file. Availability: Macintosh, Unix, Windows.
Open a new pseudo-terminal pair. Return a pair of file descriptors ``(master,
slave)`` for the pty and the tty, respectively. For a (slightly) more portable
- approach, use the :mod:`pty` module. Availability: Macintosh, Some flavors of
+ approach, use the :mod:`pty` module. Availability: Macintosh, some flavors of
Unix.
This function is intended for low-level I/O and must be applied to a file
descriptor as returned by :func:`open` or :func:`pipe`. To read a "file object"
returned by the built-in function :func:`open` or by :func:`popen` or
- :func:`fdopen`, or ``sys.stdin``, use its :meth:`read` or :meth:`readline`
+ :func:`fdopen`, or :data:`sys.stdin`, use its :meth:`read` or :meth:`readline`
methods.
This function is intended for low-level I/O and must be applied to a file
descriptor as returned by :func:`open` or :func:`pipe`. To write a "file
object" returned by the built-in function :func:`open` or by :func:`popen` or
- :func:`fdopen`, or ``sys.stdout`` or ``sys.stderr``, use its :meth:`write`
+ :func:`fdopen`, or :data:`sys.stdout` or :data:`sys.stderr`, use its :meth:`write`
method.
The following data items are available for use in constructing the *flags*
O_TRUNC
Options for the *flag* argument to the :func:`open` function. These can be
- bit-wise OR'd together. Availability: Macintosh, Unix, Windows.
+ combined using the bitwise OR operator ``|``. Availability: Macintosh, Unix, Windows.
.. data:: O_DSYNC
O_TEXT
Options for the *flag* argument to the :func:`open` function. These can be
- bit-wise OR'd together. Availability: Windows.
+ combined using the bitwise OR operator ``|``. Availability: Windows.
.. data:: O_DIRECT
.. function:: chmod(path, mode)
Change the mode of *path* to the numeric *mode*. *mode* may take one of the
- following values (as defined in the :mod:`stat` module) or bitwise or-ed
+ following values (as defined in the :mod:`stat` module) or bitwise ORed
combinations of them:
* ``stat.S_ISUID``
.. function:: lchown(path, uid, gid)
- Change the owner and group id of *path* to the numeric *uid* and gid. This
+ Change the owner and group id of *path* to the numeric *uid* and *gid*. This
function will not follow symbolic links. Availability: Macintosh, Unix.
.. function:: major(device)
- Extracts the device major number from a raw device number (usually the
+ Extract the device major number from a raw device number (usually the
:attr:`st_dev` or :attr:`st_rdev` field from :ctype:`stat`).
.. function:: minor(device)
- Extracts the device minor number from a raw device number (usually the
+ Extract the device minor number from a raw device number (usually the
:attr:`st_dev` or :attr:`st_rdev` field from :ctype:`stat`).
.. function:: makedev(major, minor)
- Composes a raw device number from the major and minor device numbers.
+ Compose a raw device number from the major and minor device numbers.
.. function:: mkdir(path[, mode])
.. note::
:func:`makedirs` will become confused if the path elements to create include
- *os.pardir*.
+ :data:`os.pardir`.
This function handles UNC paths correctly.
.. index:: single: directory; deleting
- Removes directories recursively. Works like :func:`rmdir` except that, if the
+ Remove directories recursively. Works like :func:`rmdir` except that, if the
leaf directory is successfully removed, :func:`removedirs` tries to
successively remove every parent directory mentioned in *path* until an error
is raised (which is ignored, because it generally means that a parent directory
Rename the file or directory *src* to *dst*. If *dst* is a directory,
:exc:`OSError` will be raised. On Unix, if *dst* exists and is a file, it will
- be removed silently if the user has permission. The operation may fail on some
+ be replaced silently if the user has permission. The operation may fail on some
Unix flavors if *src* and *dst* are on different filesystems. If successful,
the renaming will be an atomic operation (this is a POSIX requirement). On
Windows, if *dst* already exists, :exc:`OSError` will be raised even if it is a
object whose attributes correspond to the members of the :ctype:`stat`
structure, namely: :attr:`st_mode` (protection bits), :attr:`st_ino` (inode
number), :attr:`st_dev` (device), :attr:`st_nlink` (number of hard links),
- :attr:`st_uid` (user ID of owner), :attr:`st_gid` (group ID of owner),
+ :attr:`st_uid` (user id of owner), :attr:`st_gid` (group id of owner),
:attr:`st_size` (size of file, in bytes), :attr:`st_atime` (time of most recent
access), :attr:`st_mtime` (time of most recent content modification),
:attr:`st_ctime` (platform dependent; time of most recent metadata change on
926L
>>>
- If :func:`stat_float_times` returns true, the time values are floats, measuring
- seconds. Fractions of a second may be reported if the system supports that. On
- Mac OS, the times are always floats. See :func:`stat_float_times` for further
- discussion.
On some Unix systems (such as Linux), the following attributes may also be
available: :attr:`st_blocks` (number of blocks allocated for file),
single: directory; walking
single: directory; traversal
- :func:`walk` generates the file names in a directory tree, by walking the tree
- either top down or bottom up. For each directory in the tree rooted at directory
+ Generate the file names in a directory tree by walking the tree
+ either top-down or bottom-up. For each directory in the tree rooted at directory
*top* (including *top* itself), it yields a 3-tuple ``(dirpath, dirnames,
filenames)``.
(which begins with *top*) to a file or directory in *dirpath*, do
``os.path.join(dirpath, name)``.
- If optional argument *topdown* is true or not specified, the triple for a
+ If optional argument *topdown* is ``True`` or not specified, the triple for a
directory is generated before the triples for any of its subdirectories
- (directories are generated top down). If *topdown* is false, the triple for a
+ (directories are generated top-down). If *topdown* is ``False``, the triple for a
directory is generated after the triples for all of its subdirectories
- (directories are generated bottom up).
+ (directories are generated bottom-up).
- When *topdown* is true, the caller can modify the *dirnames* list in-place
+ When *topdown* is ``True``, the caller can modify the *dirnames* list in-place
(perhaps using :keyword:`del` or slice assignment), and :func:`walk` will only
recurse into the subdirectories whose names remain in *dirnames*; this can be
used to prune the search, impose a specific order of visiting, or even to inform
:func:`walk` about directories the caller creates or renames before it resumes
- :func:`walk` again. Modifying *dirnames* when *topdown* is false is
+ :func:`walk` again. Modifying *dirnames* when *topdown* is ``False`` is
ineffective, because in bottom-up mode the directories in *dirnames* are
generated before *dirpath* itself is generated.
- By default errors from the ``os.listdir()`` call are ignored. If optional
+ By default errors from the :func:`listdir` call are ignored. If optional
argument *onerror* is specified, it should be a function; it will be called with
one argument, an :exc:`OSError` instance. It can report the error to continue
with the walk, or raise the exception to abort the walk. Note that the filename
is available as the ``filename`` attribute of the exception object.
By default, :func:`walk` will not walk down into symbolic links that resolve to
- directories. Set *followlinks* to True to visit directories pointed to by
+ directories. Set *followlinks* to ``True`` to visit directories pointed to by
symlinks, on systems that support them.
.. note::
- Be aware that setting *followlinks* to true can lead to infinite recursion if a
+ Be aware that setting *followlinks* to ``True`` can lead to infinite recursion if a
link points to a parent directory of itself. :func:`walk` does not keep track of
the directories it visited already.
if 'CVS' in dirs:
dirs.remove('CVS') # don't visit CVS directories
- In the next example, walking the tree bottom up is essential: :func:`rmdir`
+ In the next example, walking the tree bottom-up is essential: :func:`rmdir`
doesn't allow deleting a directory before the directory is empty::
- # Delete everything reachable from the directory named in 'top',
+ # Delete everything reachable from the directory named in "top",
# assuming there are no symbolic links.
# CAUTION: This is dangerous! For example, if top == '/', it
# could delete all your disk files.
These functions all execute a new program, replacing the current process; they
do not return. On Unix, the new executable is loaded into the current process,
- and will have the same process ID as the caller. Errors will be reported as
+ and will have the same process id as the caller. Errors will be reported as
:exc:`OSError` exceptions.
- The ``'l'`` and ``'v'`` variants of the :func:`exec\*` functions differ in how
- command-line arguments are passed. The ``'l'`` variants are perhaps the easiest
+ The "l" and "v" variants of the :func:`exec\*` functions differ in how
+ command-line arguments are passed. The "l" variants are perhaps the easiest
to work with if the number of parameters is fixed when the code is written; the
individual parameters simply become additional parameters to the :func:`execl\*`
- functions. The ``'v'`` variants are good when the number of parameters is
+ functions. The "v" variants are good when the number of parameters is
variable, with the arguments being passed in a list or tuple as the *args*
parameter. In either case, the arguments to the child process should start with
the name of the command being run, but this is not enforced.
- The variants which include a ``'p'`` near the end (:func:`execlp`,
+ The variants which include a "p" near the end (:func:`execlp`,
:func:`execlpe`, :func:`execvp`, and :func:`execvpe`) will use the
:envvar:`PATH` environment variable to locate the program *file*. When the
environment is being replaced (using one of the :func:`exec\*e` variants,
path.
For :func:`execle`, :func:`execlpe`, :func:`execve`, and :func:`execvpe` (note
- that these all end in ``'e'``), the *env* parameter must be a mapping which is
+ that these all end in "e"), the *env* parameter must be a mapping which is
used to define the environment variables for the new process; the :func:`execl`,
:func:`execlp`, :func:`execv`, and :func:`execvp` all cause the new process to
inherit the environment of the current process. Availability: Macintosh, Unix,
The standard way to exit is ``sys.exit(n)``. :func:`_exit` should normally only
be used in the child process after a :func:`fork`.
-The following exit codes are a defined, and can be used with :func:`_exit`,
+The following exit codes are defined and can be used with :func:`_exit`,
although they are not required. These are typically used for system programs
written in Python, such as a mail server's external command delivery program.
.. function:: fork()
- Fork a child process. Return ``0`` in the child, the child's process id in the
+ Fork a child process. Return ``0`` in the child and the child's process id in the
parent. Availability: Macintosh, Unix.
terminal. Return a pair of ``(pid, fd)``, where *pid* is ``0`` in the child, the
new child's process id in the parent, and *fd* is the file descriptor of the
master end of the pseudo-terminal. For a more portable approach, use the
- :mod:`pty` module. Availability: Macintosh, Some flavors of Unix.
+ :mod:`pty` module. Availability: Macintosh, some flavors of Unix.
.. function:: kill(pid, sig)
spawning new processes and retrieving their results; using that module is
preferable to using these functions.)
- If *mode* is :const:`P_NOWAIT`, this function returns the process ID of the new
+ If *mode* is :const:`P_NOWAIT`, this function returns the process id of the new
process; if *mode* is :const:`P_WAIT`, returns the process's exit code if it
exits normally, or ``-signal``, where *signal* is the signal that killed the
- process. On Windows, the process ID will actually be the process handle, so can
+ process. On Windows, the process id will actually be the process handle, so can
be used with the :func:`waitpid` function.
- The ``'l'`` and ``'v'`` variants of the :func:`spawn\*` functions differ in how
- command-line arguments are passed. The ``'l'`` variants are perhaps the easiest
+ The "l" and "v" variants of the :func:`spawn\*` functions differ in how
+ command-line arguments are passed. The "l" variants are perhaps the easiest
to work with if the number of parameters is fixed when the code is written; the
individual parameters simply become additional parameters to the
- :func:`spawnl\*` functions. The ``'v'`` variants are good when the number of
+ :func:`spawnl\*` functions. The "v" variants are good when the number of
parameters is variable, with the arguments being passed in a list or tuple as
the *args* parameter. In either case, the arguments to the child process must
start with the name of the command being run.
- The variants which include a second ``'p'`` near the end (:func:`spawnlp`,
+ The variants which include a second "p" near the end (:func:`spawnlp`,
:func:`spawnlpe`, :func:`spawnvp`, and :func:`spawnvpe`) will use the
:envvar:`PATH` environment variable to locate the program *file*. When the
environment is being replaced (using one of the :func:`spawn\*e` variants,
appropriate absolute or relative path.
For :func:`spawnle`, :func:`spawnlpe`, :func:`spawnve`, and :func:`spawnvpe`
- (note that these all end in ``'e'``), the *env* parameter must be a mapping
+ (note that these all end in "e"), the *env* parameter must be a mapping
which is used to define the environment variables for the new process; the
:func:`spawnl`, :func:`spawnlp`, :func:`spawnv`, and :func:`spawnvp` all cause
the new process to inherit the environment of the current process.
Possible values for the *mode* parameter to the :func:`spawn\*` family of
functions. If either of these values is given, the :func:`spawn\*` functions
- will return as soon as the new process has been created, with the process ID as
+ will return as soon as the new process has been created, with the process id as
the return value. Availability: Macintosh, Unix, Windows.
Execute the command (a string) in a subshell. This is implemented by calling
the Standard C function :cfunc:`system`, and has the same limitations. Changes
- to ``posix.environ``, ``sys.stdin``, etc. are not reflected in the environment
- of the executed command.
+ to :data:`os.environ`, :data:`sys.stdin`, etc. are not reflected in the
+ environment of the executed command.
On Unix, the return value is the exit status of the process encoded in the
format specified for :func:`wait`. Note that POSIX does not specify the meaning
.. function:: WCOREDUMP(status)
- Returns ``True`` if a core dump was generated for the process, otherwise it
- returns ``False``. Availability: Macintosh, Unix.
+ Return ``True`` if a core dump was generated for the process, otherwise
+ return ``False``. Availability: Macintosh, Unix.
.. function:: WIFCONTINUED(status)
- Returns ``True`` if the process has been continued from a job control stop,
- otherwise it returns ``False``. Availability: Unix.
+ Return ``True`` if the process has been continued from a job control stop,
+ otherwise return ``False``. Availability: Unix.
.. function:: WIFSTOPPED(status)
- Returns ``True`` if the process has been stopped, otherwise it returns
+ Return ``True`` if the process has been stopped, otherwise return
``False``. Availability: Unix.
.. function:: WIFSIGNALED(status)
- Returns ``True`` if the process exited due to a signal, otherwise it returns
+ Return ``True`` if the process exited due to a signal, otherwise return
``False``. Availability: Macintosh, Unix.
.. function:: WIFEXITED(status)
- Returns ``True`` if the process exited using the :manpage:`exit(2)` system call,
- otherwise it returns ``False``. Availability: Macintosh, Unix.
+ Return ``True`` if the process exited using the :manpage:`exit(2)` system call,
+ otherwise return ``False``. Availability: Macintosh, Unix.
.. function:: WEXITSTATUS(status)
defined for those names by the host operating system. This can be used to
determine the set of names known to the system. Availability: Macintosh, Unix.
-The follow data values are used to support path manipulation operations. These
+The following data values are used to support path manipulation operations. These
are defined for all platforms.
Higher-level operations on pathnames are defined in the :mod:`os.path` module.
in the Unix header files are defined; for a few symbols, default values are
provided.
+.. data:: SIO_*
+ RCVALL_*
+
+ Constants for Windows' WSAIoctl(). The constants are used as arguments to the
+ :meth:`ioctl` method of socket objects.
+
.. data:: has_ipv6
contents of the buffer (see the optional built-in module :mod:`struct` for a way
to decode C structures encoded as strings).
+
+.. method:: socket.ioctl(control, option)
+
+ :platform: Windows
+
+ The `meth:ioctl` method is a limited interface to the WSAIoctl system
+ interface. Please refer to the MSDN documentation for more information.
+
.. method:: socket.listen(backlog)
s.close()
print('Received', repr(data))
+
+The last example shows how to write a very simple network sniffer with raw
+sockets on Windows. The example requires administrator priviliges to modify
+the interface::
+
+ import socket
+
+ # the public network interface
+ HOST = socket.gethostbyname(socket.gethostname())
+
+ # create a raw socket and bind it to the public interface
+ s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)
+ s.bind((HOST, 0))
+
+ # Include IP headers
+ s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)
+
+ # receive all packages
+ s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)
+
+ # receive a package
+ print s.recvfrom(65565)
+
+ # disabled promiscous mode
+ s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)
or "-" for Not a Number (NaN) and positive or negative infinity.
+All :class:`numbers.Real` types (:class:`int` and
+:class:`float`) also include the following operations:
+
++--------------------+--------------------------------+--------+
+| Operation | Result | Notes |
++====================+================================+========+
+| ``trunc(x)`` | *x* truncated to Integral | |
++--------------------+--------------------------------+--------+
+| ``round(x[, n])`` | *x* rounded to n digits, | |
+| | rounding half to even. If n is | |
+| | omitted, it defaults to 0. | |
++--------------------+--------------------------------+--------+
+| ``math.floor(x)`` | the greatest Integral <= *x* | |
++--------------------+--------------------------------+--------+
+| ``math.ceil(x)`` | the least Integral >= *x* | |
++--------------------+--------------------------------+--------+
+
.. XXXJH exceptions: overflow (when? what operations?) zerodivision
Negative numbers are treated as their 2's complement value (this assumes a
sufficiently large number of bits that no overflow occurs during the operation).
-The priorities of the binary bit-wise operations are all lower than the numeric
+The priorities of the binary bitwise operations are all lower than the numeric
operations and higher than the comparisons; the unary operation ``~`` has the
same priority as the other unary numeric operations (``+`` and ``-``).
*cmp* specifies a custom comparison function of two arguments (list items) which
should return a negative, zero or positive number depending on whether the first
argument is considered smaller than, equal to, or larger than the second
- argument: ``cmp=lambda x,y: cmp(x.lower(), y.lower())``
+ argument: ``cmp=lambda x,y: cmp(x.lower(), y.lower())``. The default value
+ is ``None``.
*key* specifies a function of one argument that is used to extract a comparison
- key from each list element: ``key=str.lower``
+ key from each list element: ``key=str.lower``. The default value is ``None``.
*reverse* is a boolean value. If set to ``True``, then the list elements are
sorted as if each comparison were reversed.
argument is optional and defaults to ``os.SEEK_SET`` or ``0`` (absolute file
positioning); other values are ``os.SEEK_CUR`` or ``1`` (seek relative to the
current position) and ``os.SEEK_END`` or ``2`` (seek relative to the file's
- end). There is no return value. Note that if the file is opened for appending
+ end). There is no return value.
+
+ For example, ``f.seek(2, os.SEEK_CUR)`` advances the position by two and
+ ``f.seek(-3, os.SEEK_END)`` sets the position to the third to last.
+
+ Note that if the file is opened for appending
(mode ``'a'`` or ``'a+'``), any :meth:`seek` operations will be undone at the
next write. If the file is only opened for writing in append mode (mode
``'a'``), this method is essentially a no-op, but it remains useful for files
the context expression in a :keyword:`with` statement.
An example of a context manager that returns a related object is the one
- returned by ``decimal.Context.get_manager()``. These managers set the active
+ returned by :func:`decimal.localcontext`. These managers set the active
decimal context to a copy of the original decimal context and then return the
copy. This allows changes to be made to the current decimal context in the body
of the :keyword:`with` statement without affecting code outside the
In addition to these methods, lock objects can also be used via the
:keyword:`with` statement, e.g.::
- from __future__ import with_statement
import thread
a_lock = thread.allocate_lock()
:class:`Semaphore`, and :class:`BoundedSemaphore` objects may be used as
:keyword:`with` statement context managers. For example::
- from __future__ import with_statement
import threading
some_rlock = threading.RLock()
Call the underlying :cfunc:`PlaySound` function from the Platform API. The
*sound* parameter may be a filename, audio data as a string, or ``None``. Its
- interpretation depends on the value of *flags*, which can be a bit-wise ORed
+ interpretation depends on the value of *flags*, which can be a bitwise ORed
combination of the constants described below. If the system indicates an error,
:exc:`RuntimeError` is raised.
The :keyword:`if` statement
===========================
-.. index:: statement: if
+.. index::
+ statement: if
+ keyword: elif
+ keyword: else
keyword: elif
keyword: else
statement: while
keyword: else
pair: loop; statement
+ keyword: else
The :keyword:`while` statement is used for repeated execution as long as an
expression is true:
keyword: else
pair: target; list
pair: loop; statement
+ keyword: in
+ keyword: else
+ pair: target; list
object: sequence
The :keyword:`for` statement is used to iterate over the elements of a sequence
The :keyword:`try` statement
============================
-.. index:: statement: try
+.. index::
+ statement: try
+ keyword: except
+ keyword: finally
.. index:: keyword: except
The :keyword:`try` statement specifies exception handlers and/or cleanup code
try2_stmt: "try" ":" `suite`
: "finally" ":" `suite`
-The :keyword:`except` clause(s) specify one or more exception handlers. When no
+
+The :keyword:`except` clause(s) specify one or more exception handlers. When no
exception occurs in the :keyword:`try` clause, no exception handler is executed.
When an exception occurs in the :keyword:`try` suite, a search for an exception
handler is started. This search inspects the except clauses in turn until one
location for the kind of exit that was taken.
+ In Python 2.5, the :keyword:`with` statement is only allowed when the
+ ``with_statement`` feature has been enabled. It is always enabled in
+ Python 2.6.
+
.. seealso::
:pep:`0343` - The "with" statement
====================
.. index::
- pair: function; definition
statement: def
+ pair: function; definition
+ pair: function; name
+ pair: name; binding
object: user-defined function
object: function
pair: function; name
=================
.. index::
- pair: class; definition
- statement: class
object: class
- single: inheritance
+ statement: class
+ pair: class; definition
pair: class; name
pair: name; binding
pair: execution; frame
+ single: inheritance
A class definition defines a class object (see section :ref:`types`):
Foo = f1(arg)(f2(Foo))
**Programmer's note:** Variables defined in the class definition are class
-variables; they are shared by all instances. To define instance variables, they
-must be given a value in the :meth:`__init__` method or in another method. Both
-class and instance variables are accessible through the notation
-"``self.name``", and an instance variable hides a class variable with the same
-name when accessed in this way. Class variables with immutable values can be
-used as defaults for instance variables. Descriptors can be used to create
-instance variables with different implementation details.
+can be set in a method with ``self.name = value``. Both class and instance
+variables are accessible through the notation "``self.name``", and an instance
+variable hides a class variable with the same name when accessed in this way.
+Class variables can be used as defaults for instance variables, but using
+mutable values there can lead to unexpected results. For :term:`new-style
+class`\es, descriptors can be used to create instance variables with different
+implementation details.
.. XXX add link to descriptor docs above
in case of multiple inheritance.
This manual is not up-to-date with respect to new-style classes. For now,
-please see http://www.python.org/doc/newstyle.html for more information.
+please see http://www.python.org/doc/newstyle/ for more information.
.. index::
- single: class
- single: class
- single: class
+ single: class; new-style
+ single: class; classic
+ single: class; old-style
The plan is to eventually drop old-style classes, leaving only the semantics of
new-style classes. This change will probably only be feasible in Python 3.0.
-new-style classic old-style
+
+XXX Remove old style classes from docs
.. _specialnames:
.. rubric:: Footnotes
+.. [#] Since Python 2.2, a gradual merging of types and classes has been started that
+ makes this and a few other assertions made in this manual not 100% accurate and
+ complete: for example, it *is* now possible in some cases to change an object's
+ type, under certain controlled conditions. Until this manual undergoes
+ extensive revision, it must now be taken as authoritative only regarding
+ "classic classes", that are still the default, for compatibility purposes, in
+ Python 2.2 and 2.3. For more information, see
+ http://www.python.org/doc/newstyle/.
+
+.. [#] This, and other statements, are only roughly true for instances of new-style
+ classes.
+
.. [#] A descriptor can define any combination of :meth:`__get__`,
:meth:`__set__` and :meth:`__delete__`. If it does not define :meth:`__get__`,
then accessing the attribute even on an instance will return the descriptor
Raising ``0.0`` to a negative power results in a :exc:`ZeroDivisionError`.
Raising a negative number to a fractional power results in a :class:`complex`
-number. (Since Python 2.6. In earlier versions it raised a :exc:`ValueError`.)
+number. (In earlier versions it raised a :exc:`ValueError`.)
.. _unary:
.. index::
triple: unary; arithmetic; operation
- triple: unary; bit-wise; operation
+ triple: unary; bitwise; operation
-All unary arithmetic (and bit-wise) operations have the same priority:
+All unary arithmetic (and bitwise) operations have the same priority:
.. productionlist::
u_expr: `power` | "-" `u_expr` | "+" `u_expr` | "~" `u_expr`
.. index:: single: inversion
-The unary ``~`` (invert) operator yields the bit-wise inversion of its integer
-argument. The bit-wise inversion of ``x`` is defined as ``-(x+1)``. It only
-applies to integral numbers.
+
+The unary ``~`` (invert) operator yields the bitwise inversion of its plain or
+long integer argument. The bitwise inversion of ``x`` is defined as
+``-(x+1)``. It only applies to integral numbers.
.. index:: exception: TypeError
.. _bitwise:
-Binary bit-wise operations
-==========================
+Binary bitwise operations
+=========================
-.. index:: triple: binary; bit-wise; operation
+.. index:: triple: binary; bitwise; operation
Each of the three bitwise operations has a different priority level:
xor_expr: `and_expr` | `xor_expr` "^" `and_expr`
or_expr: `xor_expr` | `or_expr` "|" `xor_expr`
-.. index:: pair: bit-wise; and
+.. index:: pair: bitwise; and
The ``&`` operator yields the bitwise AND of its arguments, which must be
integers.
.. index::
- pair: bit-wise; xor
+ pair: bitwise; xor
pair: exclusive; or
The ``^`` operator yields the bitwise XOR (exclusive OR) of its arguments, which
must be integers.
.. index::
- pair: bit-wise; or
+ pair: bitwise; or
pair: inclusive; or
The ``|`` operator yields the bitwise (inclusive) OR of its arguments, which
Expression statements
=====================
-.. index:: pair: expression; statement
+.. index::
+ pair: expression; statement
+ pair: expression; list
.. index:: pair: expression; list
Expression statements are used (mostly interactively) to compute and write a
The :keyword:`pass` statement
=============================
-.. index:: statement: pass
+.. index::
+ statement: pass
+ pair: null; operation
pair: null; operation
.. productionlist::
The :keyword:`del` statement
============================
-.. index:: statement: del
- pair: deletion; target
- triple: deletion; target; list
+.. index::
+ statement: del
+ pair: deletion; target
+ triple: deletion; target; list
.. productionlist::
del_stmt: "del" `target_list`
The :keyword:`return` statement
===============================
-.. index:: statement: return
- pair: function; definition
- pair: class; definition
+.. index::
+ statement: return
+ pair: function; definition
+ pair: class; definition
.. productionlist::
return_stmt: "return" [`expression_list`]
The :keyword:`yield` statement
==============================
+.. index::
+ statement: yield
+ single: generator; function
+ single: generator; iterator
+ single: function; generator
+ exception: StopIteration
+
.. productionlist::
yield_stmt: `yield_expression`
-The yield statement is nothing but a yield expression used as a statement,
-see :ref:`yieldexpr`.
-
+The :keyword:`yield` statement is only used when defining a generator function,
+and is only used in the body of the generator function. Using a :keyword:`yield`
+statement in a function definition is sufficient to cause that definition to
+create a generator function instead of a normal function.
+>>>>>>> .merge-right.r59773
.. _raise:
The :keyword:`raise` statement
==============================
-.. index:: statement: raise
- pair: raising; exception
+.. index::
+ statement: raise
+ single: exception
+ pair: raising; exception
.. productionlist::
- raise_stmt: "raise" [`expression` ["from" `expression`]]
+ raise_stmt: "raise" [`expression` ["," `expression` ["," `expression`]]]
If no expressions are present, :keyword:`raise` re-raises the last exception
that was active in the current scope. If no exception is active in the current
The :keyword:`break` statement
==============================
-.. index:: statement: break
- statement: for
- statement: while
- pair: loop; statement
+.. index::
+ statement: break
+ statement: for
+ statement: while
+ pair: loop; statement
.. productionlist::
break_stmt: "break"
The :keyword:`continue` statement
=================================
-.. index:: statement: continue
- statement: for
- statement: while
- pair: loop; statement
- keyword: finally
+.. index::
+ statement: continue
+ statement: for
+ statement: while
+ pair: loop; statement
+ keyword: finally
.. productionlist::
continue_stmt: "continue"
.. index::
keyword: from
+ statement: from
triple: hierarchical; module; names
single: packages
single: __init__.py
The :keyword:`global` statement
===============================
-.. index:: statement: global
+.. index::
+ statement: global
+ triple: global; name; binding
.. productionlist::
global_stmt: "global" `identifier` ("," `identifier`)*
-.. index:: triple: global; name; binding
-
The :keyword:`global` statement is a declaration which holds for the entire
current code block. It means that the listed identifiers are to be interpreted
as globals. It would be impossible to assign to a global variable without
first. The statement allows encapsulated code to rebind variables outside of
the local scope besides the global (module) scope.
-.. note::
-
- The outer scope for :keyword:`nonlocal` statements cannot be the module
- scope.
-
.. XXX not implemented
The :keyword:`nonlocal` statement may prepend an assignment or augmented
assignment, but not an expression.
@abstractmethod decorator -- you can't instantiate classes w/
an abstract method.
-@abstractproperty decorator
-@abstractproperty
-def readonly(self):
- return self._x
+::
+
+ @abstractproperty decorator
+ @abstractproperty
+ def readonly(self):
+ return self._x
.. seealso::
esoteric bugfixes, that may require changes to your
code:
-* The :method:`__init__` method of :class:`collections.deque`
+* The :meth:`__init__` method of :class:`collections.deque`
now clears any existing contents of the deque
before adding elements from the iterable. This change makes the
behavior match that of ``list.__init__()``.
seen_names.add(name)
# Create and fill-in the class template
+ numfields = len(field_names)
argtxt = repr(field_names).replace("'", "")[1:-1] # tuple repr without parens or quotes
reprtxt = ', '.join('%s=%%r' % name for name in field_names)
dicttxt = ', '.join('%r: t[%d]' % (name, pos) for pos, name in enumerate(field_names))
template = '''class %(typename)s(tuple):
'%(typename)s(%(argtxt)s)' \n
__slots__ = () \n
+ _fields = %(field_names)r \n
def __new__(cls, %(argtxt)s):
return tuple.__new__(cls, (%(argtxt)s)) \n
- _cast = classmethod(tuple.__new__) \n
+ @classmethod
+ def _make(cls, iterable):
+ 'Make a new %(typename)s object from a sequence or iterable'
+ result = tuple.__new__(cls, iterable)
+ if len(result) != %(numfields)d:
+ raise TypeError('Expected %(numfields)d arguments, got %%d' %% len(result))
+ return result \n
def __repr__(self):
return '%(typename)s(%(reprtxt)s)' %% self \n
def _asdict(t):
return {%(dicttxt)s} \n
def _replace(self, **kwds):
'Return a new %(typename)s object replacing specified fields with new values'
- return %(typename)s._cast(map(kwds.get, %(field_names)r, self)) \n
- @property
- def _fields(self):
- return %(field_names)r \n\n''' % locals()
+ result = self._make(map(kwds.pop, %(field_names)r, self))
+ if kwds:
+ raise ValueError('Got unexpected field names: %%r' %% kwds.keys())
+ return result \n\n''' % locals()
for i, name in enumerate(field_names):
template += ' %s = property(itemgetter(%d))\n' % (name, i)
if verbose:
except os.error:
return
func(arg, top, names)
- exceptions = ('.', '..')
for name in names:
- if name not in exceptions:
- name = join(top, name)
- if isdir(name):
- walk(name, func, arg)
+ name = join(top, name)
+ if isdir(name):
+ walk(name, func, arg)
# Expand paths beginning with '~' or '~user'.
i += 1
rel_list = [pardir] * (len(start_list)-i) + path_list[i:]
+ if not rel_list:
+ return curdir
return join(*rel_list)
def ismount(path):
"""Test whether a path is a mount point"""
try:
- s1 = os.stat(path)
- s2 = os.stat(join(path, '..'))
+ s1 = os.lstat(path)
+ s2 = os.lstat(join(path, '..'))
except os.error:
return False # It doesn't exist -- so not a mount point :-)
dev1 = s1.st_dev
i = len(commonprefix([start_list, path_list]))
rel_list = [pardir] * (len(start_list)-i) + path_list[i:]
+ if not rel_list:
+ return curdir
return join(*rel_list)
# Set correct owner, mtime and filemode on directories.
for tarinfo in directories:
- path = os.path.join(path, tarinfo.name)
+ dirpath = os.path.join(path, tarinfo.name)
try:
- self.chown(tarinfo, path)
- self.utime(tarinfo, path)
- self.chmod(tarinfo, path)
+ self.chown(tarinfo, dirpath)
+ self.utime(tarinfo, dirpath)
+ self.chmod(tarinfo, dirpath)
except ExtractError as e:
if self.errorlevel > 1:
raise
self.assertEqual(Point.__slots__, ())
self.assertEqual(Point.__module__, __name__)
self.assertEqual(Point.__getitem__, tuple.__getitem__)
+ self.assertEqual(Point._fields, ('x', 'y'))
self.assertRaises(ValueError, namedtuple, 'abc%', 'efg ghi') # type has non-alpha char
self.assertRaises(ValueError, namedtuple, 'class', 'efg ghi') # type has keyword
namedtuple('Point0', 'x1 y2') # Verify that numbers are allowed in names
namedtuple('_', 'a b c') # Test leading underscores in a typename
+ self.assertRaises(TypeError, Point._make, [11]) # catch too few args
+ self.assertRaises(TypeError, Point._make, [11, 22, 33]) # catch too many args
+
def test_instance(self):
Point = namedtuple('Point', 'x y')
p = Point(11, 22)
self.assertEqual(repr(p), 'Point(x=11, y=22)')
self.assert_('__dict__' not in dir(p)) # verify instance has no dict
self.assert_('__weakref__' not in dir(p))
- self.assertEqual(p, Point._cast([11, 22])) # test _cast classmethod
+ self.assertEqual(p, Point._make([11, 22])) # test _make classmethod
self.assertEqual(p._fields, ('x', 'y')) # test _fields attribute
self.assertEqual(p._replace(x=1), (1, 22)) # test _replace method
self.assertEqual(p._asdict(), dict(x=11, y=22)) # test _asdict method
- # Verify that _fields is read-only
try:
- p._fields = ('F1' ,'F2')
- except AttributeError:
+ p._replace(x=1, error=2)
+ except ValueError:
pass
else:
- self.fail('The _fields attribute needs to be read-only')
+ self._fail('Did not detect an incorrect fieldname')
# verify that field string can have commas
Point = namedtuple('Point', 'x, y')
def test_odd_sizes(self):
Zero = namedtuple('Zero', '')
self.assertEqual(Zero(), ())
- self.assertEqual(Zero._cast([]), ())
+ self.assertEqual(Zero._make([]), ())
self.assertEqual(repr(Zero()), 'Zero()')
self.assertEqual(Zero()._asdict(), {})
self.assertEqual(Zero()._fields, ())
Dot = namedtuple('Dot', 'd')
self.assertEqual(Dot(1), (1,))
- self.assertEqual(Dot._cast([1]), (1,))
+ self.assertEqual(Dot._make([1]), (1,))
self.assertEqual(Dot(1).d, 1)
self.assertEqual(repr(Dot(1)), 'Dot(d=1)')
self.assertEqual(Dot(1)._asdict(), {'d':1})
Big = namedtuple('Big', names)
b = Big(*range(n))
self.assertEqual(b, tuple(range(n)))
- self.assertEqual(Big._cast(range(n)), tuple(range(n)))
+ self.assertEqual(Big._make(range(n)), tuple(range(n)))
for pos, name in enumerate(names):
self.assertEqual(getattr(b, name), pos)
repr(b) # make sure repr() doesn't blow-up
Several option flags can be used to customize the behavior of the test
runner. These are defined as module constants in doctest, and passed
-to the DocTestRunner constructor (multiple constants should be or-ed
+to the DocTestRunner constructor (multiple constants should be ORed
together).
The DONT_ACCEPT_TRUE_FOR_1 flag disables matches between True/False
tester('ntpath.relpath("a/b", "../c")', '..\\'+currentdir+'\\a\\b')
tester('ntpath.relpath("a", "b/c")', '..\\..\\a')
tester('ntpath.relpath("//conky/mountpoint/a", "//conky/mountpoint/b/c")', '..\\..\\a')
+tester('ntpath.relpath("a", "a")', '.')
if errors:
raise TestFailed(str(errors) + " errors.")
self.assertEqual(posixpath.relpath("a", "../b"), "../"+curdir+"/a")
self.assertEqual(posixpath.relpath("a/b", "../c"), "../"+curdir+"/a/b")
self.assertEqual(posixpath.relpath("a", "b/c"), "../../a")
+ self.assertEqual(posixpath.relpath("a", "a"), ".")
finally:
os.getcwd = real_getcwd
import thread, threading
import Queue
import sys
+import os
+import array
from weakref import proxy
import signal
self.assertEqual(sock.proto, 0)
sock.close()
+ def test_sock_ioctl(self):
+ if os.name != "nt":
+ return
+ self.assert_(hasattr(socket.socket, 'ioctl'))
+ self.assert_(hasattr(socket, 'SIO_RCVALL'))
+ self.assert_(hasattr(socket, 'RCVALL_ON'))
+ self.assert_(hasattr(socket, 'RCVALL_OFF'))
+
+
class BasicTCPTest(SocketConnectedTest):
def __init__(self, methodName='runTest'):
data = open(os.path.join(TEMPDIR, "ustar/symtype"), "rb").read()
self.assertEqual(md5sum(data), md5_regtype)
+ def test_extractall(self):
+ # Test if extractall() correctly restores directory permissions
+ # and times (see issue1735).
+ if sys.platform == "win32":
+ # Win32 has no support for utime() on directories or
+ # fine grained permissions.
+ return
+
+ tar = tarfile.open(tarname, encoding="iso8859-1")
+ directories = [t for t in tar if t.isdir()]
+ tar.extractall(TEMPDIR, directories)
+ for tarinfo in directories:
+ path = os.path.join(TEMPDIR, tarinfo.name)
+ self.assertEqual(tarinfo.mode & 0o777, os.stat(path).st_mode & 0o777)
+ self.assertEqual(tarinfo.mtime, os.path.getmtime(path))
+ tar.close()
+
class StreamReadTest(ReadTest):
self.assertEqual(p.port, 80)
self.assertEqual(p.geturl(), url)
+ # Addressing issue1698, which suggests Username can contain
+ # "@" characters. Though not RFC compliant, many ftp sites allow
+ # and request email addresses as usernames.
+
+ url = "http://User@example.com:Pass@www.python.org:080/doc/?query=yes#frag"
+ p = urlparse.urlsplit(url)
+ self.assertEqual(p.scheme, "http")
+ self.assertEqual(p.netloc, "User@example.com:Pass@www.python.org:080")
+ self.assertEqual(p.path, "/doc/")
+ self.assertEqual(p.query, "query=yes")
+ self.assertEqual(p.fragment, "frag")
+ self.assertEqual(p.username, "User@example.com")
+ self.assertEqual(p.password, "Pass")
+ self.assertEqual(p.hostname, "www.python.org")
+ self.assertEqual(p.port, 80)
+ self.assertEqual(p.geturl(), url)
+
+
def test_attributes_bad_port(self):
"""Check handling of non-integer ports."""
p = urlparse.urlsplit("http://www.example.net:foo")
self.assertEqual(p.port, None)
self.assertEqual(p.geturl(), uri)
+ def test_noslash(self):
+ # Issue 1637: http://foo.com?query is legal
+ self.assertEqual(urlparse.urlparse("http://example.com?blahblah=/foo"),
+ ('http', 'example.com', '', '', 'blahblah=/foo', ''))
+
def test_main():
test_support.run_unittest(UrlParseTestCase)
def username(self):
netloc = self.netloc
if "@" in netloc:
- userinfo = netloc.split("@", 1)[0]
+ userinfo = netloc.rsplit("@", 1)[0]
if ":" in userinfo:
userinfo = userinfo.split(":", 1)[0]
return userinfo
def password(self):
netloc = self.netloc
if "@" in netloc:
- userinfo = netloc.split("@", 1)[0]
+ userinfo = netloc.rsplit("@", 1)[0]
if ":" in userinfo:
return userinfo.split(":", 1)[1]
return None
def hostname(self):
netloc = self.netloc
if "@" in netloc:
- netloc = netloc.split("@", 1)[1]
+ netloc = netloc.rsplit("@", 1)[1]
if ":" in netloc:
netloc = netloc.split(":", 1)[0]
return netloc.lower() or None
def port(self):
netloc = self.netloc
if "@" in netloc:
- netloc = netloc.split("@", 1)[1]
+ netloc = netloc.rsplit("@", 1)[1]
if ":" in netloc:
port = netloc.split(":", 1)[1]
return int(port, 10)
return url[:i], url[i+1:]
def _splitnetloc(url, start=0):
- for c in '/?#': # the order is important!
- delim = url.find(c, start)
- if delim >= 0:
- break
- else:
- delim = len(url)
- return url[start:delim], url[delim:]
+ delim = len(url) # position of end of domain part of url, default is end
+ for c in '/?#': # look for delimiters; the order is NOT important
+ wdelim = url.find(c, start) # find first of this delim
+ if wdelim >= 0: # if found
+ delim = min(delim, wdelim) # use earliest delim position
+ return url[start:delim], url[delim:] # return (domain, rest)
def urlsplit(url, scheme='', allow_fragments=True):
"""Parse a URL into 5 components:
Sape Mullender
Sjoerd Mullender
Michael Muller
+John Nagle
Takahiro Nakayama
Travers Naran
Fredrik Nehr
LOCK_SH - acquire a shared lock\n\
LOCK_EX - acquire an exclusive lock\n\
\n\
-When operation is LOCK_SH or LOCK_EX, it can also be bit-wise OR'd with\n\
+When operation is LOCK_SH or LOCK_EX, it can also be bitwise ORed with\n\
LOCK_NB to avoid blocking on lock acquisition. If LOCK_NB is used and the\n\
lock cannot be acquired, an IOError will be raised and the exception will\n\
have an errno attribute set to EACCES or EAGAIN (depending on the operating\n\
Shut down the reading side of the socket (flag == SHUT_RD), the writing side\n\
of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).");
+#ifdef MS_WINDOWS
+static PyObject*
+sock_ioctl(PySocketSockObject *s, PyObject *arg)
+{
+ unsigned long cmd = SIO_RCVALL;
+ unsigned int option = RCVALL_ON;
+ DWORD recv;
+
+ if (!PyArg_ParseTuple(arg, "kI:ioctl", &cmd, &option))
+ return NULL;
+
+ if (WSAIoctl(s->sock_fd, cmd, &option, sizeof(option),
+ NULL, 0, &recv, NULL, NULL) == SOCKET_ERROR) {
+ return set_error();
+ }
+ return PyLong_FromUnsignedLong(recv);
+}
+PyDoc_STRVAR(sock_ioctl_doc,
+"ioctl(cmd, option) -> long\n\
+\n\
+Control the socket with WSAIoctl syscall. Currently only socket.SIO_RCVALL\n\
+is supported as control. Options must be one of the socket.RCVALL_*\n\
+constants.");
+
+#endif
/* List of methods for socket objects */
METH_NOARGS, getsockname_doc},
{"getsockopt", (PyCFunction)sock_getsockopt, METH_VARARGS,
getsockopt_doc},
+#ifdef MS_WINDOWS
+ {"ioctl", (PyCFunction)sock_ioctl, METH_VARARGS,
+ sock_ioctl_doc},
+#endif
{"listen", (PyCFunction)sock_listen, METH_O,
listen_doc},
{"recv", (PyCFunction)sock_recv, METH_VARARGS,
PyMODINIT_FUNC
init_socket(void)
{
- PyObject *m, *has_ipv6;
+ PyObject *m, *has_ipv6, *tmp;
if (!os_init())
return;
PyModule_AddIntConstant(m, "SHUT_RDWR", 2);
#endif
+#ifdef SIO_RCVALL
+ tmp = PyLong_FromUnsignedLong(SIO_RCVALL);
+ if (tmp == NULL)
+ return;
+ PyModule_AddObject(m, "SIO_RCVALL", tmp);
+ PyModule_AddIntConstant(m, "RCVALL_OFF", RCVALL_OFF);
+ PyModule_AddIntConstant(m, "RCVALL_ON", RCVALL_ON);
+ PyModule_AddIntConstant(m, "RCVALL_SOCKETLEVELONLY", RCVALL_SOCKETLEVELONLY);
+ PyModule_AddIntConstant(m, "RCVALL_IPLEVEL", RCVALL_IPLEVEL);
+ PyModule_AddIntConstant(m, "RCVALL_MAX", RCVALL_MAX);
+#endif /* _MSTCPIP_ */
+
/* Initialize gethostbyname lock */
#if defined(USE_GETHOSTBYNAME_LOCK) || defined(USE_GETADDRINFO_LOCK)
netdb_lock = PyThread_allocate_lock();
#if _MSC_VER >= 1300
# include <winsock2.h>
# include <ws2tcpip.h>
+# include <MSTcpIP.h> /* for SIO_RCVALL */
# define HAVE_ADDRINFO
# define HAVE_SOCKADDR_STORAGE
# define HAVE_GETADDRINFO
ROOT = os.path.abspath(os.path.join(here, par, par))
# Windows 2000 compatibility: WINVER 0x0500
# http://msdn2.microsoft.com/en-us/library/aa383745.aspx
-NMAKE = "nmake /nologo /f %s COMPILERFLAGS=-DWINVER=0x0500 %s %s"
+NMAKE = ('nmake /nologo /f %s '
+ 'COMPILERFLAGS=\"-DWINVER=0x0500 -D_WIN32_WINNT=0x0500 -DNTDDI_VERSION=NTDDI_WIN2KSP4\"'
+ '%s %s')
def nmake(makefile, command="", **kw):
defines = ' '.join(k+'='+v for k, v in kw.items())
/* Support for dynamic loading of extension modules */
+#include "Python.h"
+
#ifdef HAVE_DIRECT_H
#include <direct.h>
#endif
#include <ctype.h>
-#include "Python.h"
#include "importdl.h"
#include <windows.h>
size_t decimal_point_len;
const char *p, *decimal_point_pos;
const char *end = NULL; /* Silence gcc */
+ const char *digits_pos = NULL;
+ int negate = 0;
assert(nptr != NULL);
assert(decimal_point_len != 0);
decimal_point_pos = NULL;
+
+ /* We process any leading whitespace and the optional sign manually,
+ then pass the remainder to the system strtod. This ensures that
+ the result of an underflow has the correct sign. (bug #1725) */
+
+ p = nptr;
+ /* Skip leading space */
+ while (ISSPACE(*p))
+ p++;
+
+ /* Process leading sign, if present */
+ if (*p == '-') {
+ negate = 1;
+ p++;
+ } else if (*p == '+') {
+ p++;
+ }
+
+ /* What's left should begin with a digit, a decimal point, or one of
+ the letters i, I, n, N. It should not begin with 0x or 0X */
+ if ((!ISDIGIT(*p) &&
+ *p != '.' && *p != 'i' && *p != 'I' && *p != 'n' && *p != 'N')
+ ||
+ (*p == '0' && (p[1] == 'x' || p[1] == 'X')))
+ {
+ if (endptr)
+ *endptr = (char*)nptr;
+ errno = EINVAL;
+ return val;
+ }
+ digits_pos = p;
+
if (decimal_point[0] != '.' ||
decimal_point[1] != 0)
{
- p = nptr;
- /* Skip leading space */
- while (ISSPACE(*p))
- p++;
-
- /* Skip leading optional sign */
- if (*p == '+' || *p == '-')
- p++;
-
while (ISDIGIT(*p))
p++;
else if (strncmp(p, decimal_point, decimal_point_len) == 0)
{
/* Python bug #1417699 */
- *endptr = (char*)nptr;
+ if (endptr)
+ *endptr = (char*)nptr;
errno = EINVAL;
return val;
}
char *copy, *c;
/* We need to convert the '.' to the locale specific decimal point */
- copy = (char *)PyMem_MALLOC(end - nptr + 1 + decimal_point_len);
+ copy = (char *)PyMem_MALLOC(end - digits_pos +
+ 1 + decimal_point_len);
if (copy == NULL) {
if (endptr)
*endptr = (char *)nptr;
}
c = copy;
- memcpy(c, nptr, decimal_point_pos - nptr);
- c += decimal_point_pos - nptr;
+ memcpy(c, digits_pos, decimal_point_pos - digits_pos);
+ c += decimal_point_pos - digits_pos;
memcpy(c, decimal_point, decimal_point_len);
c += decimal_point_len;
memcpy(c, decimal_point_pos + 1, end - (decimal_point_pos + 1));
if (fail_pos)
{
if (fail_pos > decimal_point_pos)
- fail_pos = (char *)nptr + (fail_pos - copy) - (decimal_point_len - 1);
+ fail_pos = (char *)digits_pos +
+ (fail_pos - copy) -
+ (decimal_point_len - 1);
else
- fail_pos = (char *)nptr + (fail_pos - copy);
+ fail_pos = (char *)digits_pos +
+ (fail_pos - copy);
}
PyMem_FREE(copy);
}
else {
- unsigned i = 0;
- if (nptr[i] == '-')
- i++;
- if (nptr[i] == '0' && (nptr[i+1] == 'x' || nptr[i+1] == 'X'))
- fail_pos = (char*)nptr;
- else
- val = strtod(nptr, &fail_pos);
+ val = strtod(digits_pos, &fail_pos);
}
+ if (fail_pos == digits_pos)
+ fail_pos = (char *)nptr;
+
+ if (negate && fail_pos != nptr)
+ val = -val;
+
if (endptr)
*endptr = fail_pos;
@rem build release versions of things
call "%VS90COMNTOOLS%vsvars32.bat"
if not exist ..\db-4.4.20\build_win32\release\libdb44s.lib (
- devenv ..\db-4.4.20\build_win32\Berkeley_DB.sln /build Release /project db_static
+ vcbuild db-4.4.20\build_win32\Berkeley_DB.sln /build Release /project db_static
)
@rem build Python
cmd /q/c Tools\buildbot\kill_python.bat
-devenv.com /useenv /build Release PCbuild\pcbuild.sln
+vcbuild /useenv PCbuild\pcbuild.sln "Release|Win32"
@rem build the documentation
bash.exe -c 'cd Doc;make PYTHON=python2.5 update htmlhelp'
# Where is sqlite3.dll located, relative to srcdir?
sqlite_dir = "../sqlite-source-3.3.4"
# path to PCbuild directory
-PCBUILD="PC\\VS7.1"
-#PCBUILD="PCbuild"
+PCBUILD="PCbuild"
# msvcrt version
-MSVCR = "71"
-#MSVCR = "90"
+#MSVCR = "71"
+MSVCR = "90"
try:
from config import *
language=installer.FileVersion(pydllsrc, 1))
# XXX determine dependencies
if MSVCR == "90":
- version, lang = extract_msvcr90()
- dlldir.start_component("msvcr90", flags=8, keyfile="msvcr90.dll",
- uuid=msvcr90_uuid)
- dlldir.add_file("msvcr90.dll", src=os.path.abspath("msvcr90.dll"),
- version=version, language=lang)
- tmpfiles.append("msvcr90.dll")
+ # XXX don't package the CRT for the moment;
+ # this should probably use the merge module in the long run.
+ pass
+ #version, lang = extract_msvcr90()
+ #dlldir.start_component("msvcr90", flags=8, keyfile="msvcr90.dll",
+ # uuid=msvcr90_uuid)
+ #dlldir.add_file("msvcr90.dll", src=os.path.abspath("msvcr90.dll"),
+ # version=version, language=lang)
+ #tmpfiles.append("msvcr90.dll")
else:
version, lang = extract_msvcr71()
dlldir.start_component("msvcr71", flags=8, keyfile="msvcr71.dll",
projects / thirdparty / Python / cpython.git / commitdiff
