Merged revisions 58095-58132,58136-58148,58151-58197 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r58096 | brett.cannon | 2007-09-10 23:38:27 +0200 (Mon, 10 Sep 2007) | 4 lines
Fix a possible segfault from recursing too deep to get the repr of a list.
Closes issue #1096.
........
r58097 | bill.janssen | 2007-09-10 23:51:02 +0200 (Mon, 10 Sep 2007) | 33 lines
More work on SSL support.
* Much expanded test suite:
All protocols tested against all other protocols.
All protocols tested with all certificate options.
Tests for bad key and bad cert.
Test of STARTTLS functionality.
Test of RAND_* functions.
* Fixes for threading/malloc bug.
* Issue 1065 fixed:
sslsocket class renamed to SSLSocket.
sslerror class renamed to SSLError.
Function "wrap_socket" now used to wrap an existing socket.
* Issue 1583946 finally fixed:
Support for subjectAltName added.
Subject name now returned as proper DN list of RDNs.
* SSLError exported from socket as "sslerror".
* RAND_* functions properly exported from ssl.py.
* Documentation improved:
Example of how to create a self-signed certificate.
Better indexing.
........
r58098 | guido.van.rossum | 2007-09-11 00:02:25 +0200 (Tue, 11 Sep 2007) | 9 lines
Patch # 1140 (my code, approved by Effbot).
Make sure the type of the return value of re.sub(x, y, z) is the type
of y+x (i.e. unicode if either is unicode, str if they are both str)
even if there are no substitutions or if x==z (which triggered various
special cases in join_list()).
Could be backported to 2.5; no need to port to 3.0.
........
r58099 | guido.van.rossum | 2007-09-11 00:36:02 +0200 (Tue, 11 Sep 2007) | 8 lines
Patch # 1026 by Benjamin Aranguren (with Alex Martelli):
Backport abc.py and isinstance/issubclass overloading to 2.6.
I had to backport test_typechecks.py myself, and make one small change
to abc.py to avoid duplicate work when x.__class__ and type(x) are the
same.
........
r58100 | bill.janssen | 2007-09-11 01:41:24 +0200 (Tue, 11 Sep 2007) | 3 lines
A better way of finding an open port to test with.
........
r58101 | bill.janssen | 2007-09-11 03:09:19 +0200 (Tue, 11 Sep 2007) | 4 lines
Make sure test_ssl doesn't reference the ssl module in a
context where it can't be imported.
........
r58102 | bill.janssen | 2007-09-11 04:42:07 +0200 (Tue, 11 Sep 2007) | 3 lines
Fix some documentation bugs.
........
r58103 | nick.coghlan | 2007-09-11 16:01:18 +0200 (Tue, 11 Sep 2007) | 1 line
Always use the -E flag when spawning subprocesses in test_cmd_line (Issue 1056)
........
r58106 | thomas.heller | 2007-09-11 21:17:48 +0200 (Tue, 11 Sep 2007) | 3 lines
Disable some tests that fail on the 'ppc Debian unstable' buildbot to
find out if they cause the segfault on the 'alpha Debian' machine.
........
r58108 | brett.cannon | 2007-09-11 23:02:28 +0200 (Tue, 11 Sep 2007) | 6 lines
Generators had their throw() method allowing string exceptions. That's a
no-no.
Fixes issue #1147. Need to fix 2.5 to raise a proper warning if a string
exception is passed in.
........
r58112 | georg.brandl | 2007-09-12 20:03:51 +0200 (Wed, 12 Sep 2007) | 3 lines
New documentation page for the bdb module.
(This doesn't need to be merged to Py3k.)
........
r58114 | georg.brandl | 2007-09-12 20:05:57 +0200 (Wed, 12 Sep 2007) | 2 lines
Bug #1152: use non-deprecated name in example.
........
r58115 | georg.brandl | 2007-09-12 20:08:33 +0200 (Wed, 12 Sep 2007) | 2 lines
Fix #1122: wrong return type documented for various _Size() functions.
........
r58117 | georg.brandl | 2007-09-12 20:10:56 +0200 (Wed, 12 Sep 2007) | 2 lines
Fix #1139: PyFile_Encoding really is PyFile_SetEncoding.
........
r58119 | georg.brandl | 2007-09-12 20:29:18 +0200 (Wed, 12 Sep 2007) | 2 lines
bug #1154: release memory allocated by "es" PyArg_ParseTuple format specifier.
........
r58121 | bill.janssen | 2007-09-12 20:52:05 +0200 (Wed, 12 Sep 2007) | 1 line
root certificate for https://svn.python.org/, used in test_ssl
........
r58122 | georg.brandl | 2007-09-12 21:00:07 +0200 (Wed, 12 Sep 2007) | 3 lines
Bug #1153: repr.repr() now doesn't require set and dictionary items
to be orderable to properly represent them.
........
r58125 | georg.brandl | 2007-09-12 21:29:28 +0200 (Wed, 12 Sep 2007) | 4 lines
#1120: put explicit version in the shebang lines of pydoc, idle
and smtpd.py scripts that are installed by setup.py. That way, they
work when only "make altinstall" is used.
........
r58139 | mark.summerfield | 2007-09-13 16:54:30 +0200 (Thu, 13 Sep 2007) | 9 lines
Replaced variable o with obj in operator.rst because o is easy to
confuse.
Added a note about Python 3's collections.Mapping etc., above section
that describes isMappingType() etc.
Added xrefs between os, os.path, fileinput, and open().
........
r58143 | facundo.batista | 2007-09-13 20:13:15 +0200 (Thu, 13 Sep 2007) | 7 lines
Merged the decimal-branch (revisions 54886 to 58140). Decimal is now
fully updated to the latests Decimal Specification (v1.66) and the
latests test cases (v2.56).
Thanks to Mark Dickinson for all his help during this process.
........
r58145 | facundo.batista | 2007-09-13 20:42:09 +0200 (Thu, 13 Sep 2007) | 7 lines
Put the parameter watchexp back in (changed watchexp from an int
to a bool). Also second argument to watchexp is now converted
to Decimal, just as with all the other two-argument operations.
Thanks Mark Dickinson.
........
r58147 | andrew.kuchling | 2007-09-14 00:49:34 +0200 (Fri, 14 Sep 2007) | 1 line
Add various items
........
r58148 | andrew.kuchling | 2007-09-14 00:50:10 +0200 (Fri, 14 Sep 2007) | 1 line
Make target unique
........
r58154 | facundo.batista | 2007-09-14 20:58:34 +0200 (Fri, 14 Sep 2007) | 3 lines
Included the new functions, and new descriptions.
........
r58155 | thomas.heller | 2007-09-14 21:40:35 +0200 (Fri, 14 Sep 2007) | 2 lines
ctypes.util.find_library uses dump(1) instead of objdump(1) on Solaris.
Fixes issue #1777530; will backport to release25-maint.
........
r58159 | facundo.batista | 2007-09-14 23:29:52 +0200 (Fri, 14 Sep 2007) | 3 lines
Some additions (examples and a bit on the tutorial).
........
r58160 | georg.brandl | 2007-09-15 18:53:36 +0200 (Sat, 15 Sep 2007) | 2 lines
Remove bdb from the "undocumented modules" list.
........
r58164 | bill.janssen | 2007-09-17 00:06:00 +0200 (Mon, 17 Sep 2007) | 15 lines
Add support for asyncore server-side SSL support. This requires
adding the 'makefile' method to ssl.SSLSocket, and importing the
requisite fakefile class from socket.py, and making the appropriate
changes to it to make it use the SSL connection.
Added sample HTTPS server to test_ssl.py, and test that uses it.
Change SSL tests to use https://svn.python.org/, instead of
www.sf.net and pop.gmail.com.
Added utility function to ssl module, get_server_certificate,
to wrap up the several things to be done to pull a certificate
from a remote server.
........
r58173 | bill.janssen | 2007-09-17 01:16:46 +0200 (Mon, 17 Sep 2007) | 1 line
use binary mode when reading files for testAsyncore to make Windows happy
........
r58175 | raymond.hettinger | 2007-09-17 02:55:00 +0200 (Mon, 17 Sep 2007) | 7 lines
Sync-up named tuples with the latest version of the ASPN recipe.
Allows optional commas in the field-name spec (help when named tuples are used in conjuction with sql queries).
Adds the __fields__ attribute for introspection and to support conversion to dictionary form.
Adds a __replace__() method similar to str.replace() but using a named field as a target.
Clean-up spelling and presentation in doc-strings.
........
r58176 | brett.cannon | 2007-09-17 05:28:34 +0200 (Mon, 17 Sep 2007) | 5 lines
Add a bunch of GIL release/acquire points in tp_print implementations and for
PyObject_Print().
Closes issue #1164.
........
r58177 | sean.reifschneider | 2007-09-17 07:45:04 +0200 (Mon, 17 Sep 2007) | 2 lines
issue1597011: Fix for bz2 module corner-case error due to error checking bug.
........
r58180 | facundo.batista | 2007-09-17 18:26:50 +0200 (Mon, 17 Sep 2007) | 3 lines
Decimal is updated, :)
........
r58181 | facundo.batista | 2007-09-17 19:30:13 +0200 (Mon, 17 Sep 2007) | 5 lines
The methods always return Decimal classes, even if they're
executed through a subclass (thanks Mark Dickinson).
Added a bit of testing for this.
........
r58183 | sean.reifschneider | 2007-09-17 22:53:21 +0200 (Mon, 17 Sep 2007) | 2 lines
issue1082: Fixing platform and system for Vista.
........
r58185 | andrew.kuchling | 2007-09-18 03:36:16 +0200 (Tue, 18 Sep 2007) | 1 line
Add item; sort properly
........
r58186 | raymond.hettinger | 2007-09-18 05:33:19 +0200 (Tue, 18 Sep 2007) | 1 line
Handle corner cased on 0-tuples and 1-tuples. Add verbose option so people can see how it works.
........
r58192 | georg.brandl | 2007-09-18 09:24:40 +0200 (Tue, 18 Sep 2007) | 2 lines
A bit of reordering, also show more subheadings in the lang ref index.
........
r58193 | facundo.batista | 2007-09-18 18:53:18 +0200 (Tue, 18 Sep 2007) | 4 lines
Speed up of the various division operations (remainder, divide,
divideint and divmod). Thanks Mark Dickinson.
........
r58197 | raymond.hettinger | 2007-09-19 00:18:02 +0200 (Wed, 19 Sep 2007) | 1 line
Cleanup docs for NamedTuple.
........
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index fe57f12..227f721 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -395,11 +395,14 @@
.. _named-tuple-factory:
-:func:`NamedTuple` datatype factory function
---------------------------------------------
+:func:`NamedTuple` factory function
+-----------------------------------
+Named tuples assign meaning to each position in a tuple and allow for more readable,
+self-documenting code. They can be used wherever regular tuples are used, and
+they add the ability to access fields by name instead of position index.
-.. function:: NamedTuple(typename, fieldnames)
+.. function:: NamedTuple(typename, fieldnames, [verbose])
Returns a new tuple subclass named *typename*. The new subclass is used to
create tuple-like objects that have fields accessable by attribute lookup as
@@ -407,43 +410,88 @@
helpful docstring (with typename and fieldnames) and a helpful :meth:`__repr__`
method which lists the tuple contents in a ``name=value`` format.
- The *fieldnames* are specified in a single string and are separated by spaces.
- Any valid Python identifier may be used for a field name.
+ The *fieldnames* are specified in a single string with each fieldname separated by
+ a space and/or comma. Any valid Python identifier may be used for a field name.
- Example::
+ If *verbose* is true, the *NamedTuple* call will print the class definition.
- >>> Point = NamedTuple('Point', 'x y')
- >>> Point.__doc__ # docstring for the new datatype
- 'Point(x, y)'
- >>> p = Point(11, y=22) # instantiate with positional or keyword arguments
- >>> p[0] + p[1] # works just like the tuple (11, 22)
- 33
- >>> x, y = p # unpacks just like a tuple
- >>> x, y
- (11, 22)
- >>> p.x + p.y # fields also accessable by name
- 33
- >>> p # readable __repr__ with name=value style
- Point(x=11, y=22)
+ *NamedTuple* instances do not have per-instance dictionaries, so they are
+ lightweight, requiring no more memory than regular tuples.
- The use cases are the same as those for tuples. The named factories assign
- meaning to each tuple position and allow for more readable, self-documenting
- code. Named tuples can also be used to assign field names to tuples returned
- by the :mod:`csv` or :mod:`sqlite3` modules. For example::
+Example::
- from itertools import starmap
- import csv
- EmployeeRecord = NamedTuple('EmployeeRecord', 'name age title department paygrade')
- for record in starmap(EmployeeRecord, csv.reader(open("employees.csv", "rb"))):
- print(record)
+ >>> Point = NamedTuple('Point', 'x y', True)
+ class Point(tuple):
+ 'Point(x, y)'
+ __slots__ = ()
+ __fields__ = ('x', 'y')
+ def __new__(cls, x, y):
+ return tuple.__new__(cls, (x, y))
+ def __repr__(self):
+ return 'Point(x=%r, y=%r)' % self
+ def __replace__(self, field, value):
+ 'Return a new Point object replacing one field with a new value'
+ return Point(**dict(zip(('x', 'y'), self) + [(field, value)]))
+ x = property(itemgetter(0))
+ y = property(itemgetter(1))
- To cast an individual record stored as :class:`list`, :class:`tuple`, or some
- other iterable type, use the star-operator [#]_ to unpack the values::
+ >>> p = Point(11, y=22) # instantiate with positional or keyword arguments
+ >>> p[0] + p[1] # indexable like the regular tuple (11, 22)
+ 33
+ >>> x, y = p # unpack like a regular tuple
+ >>> x, y
+ (11, 22)
+ >>> p.x + p.y # fields also accessable by name
+ 33
+ >>> p # readable __repr__ with a name=value style
+ Point(x=11, y=22)
- >>> Color = NamedTuple('Color', 'name code')
- >>> m = dict(red=1, green=2, blue=3)
- >>> print(Color(*m.popitem()))
- Color(name='blue', code=3)
+Named tuples are especially useful for assigning field names to result tuples returned
+by the :mod:`csv` or :mod:`sqlite3` modules::
+
+ from itertools import starmap
+ import csv
+ EmployeeRecord = NamedTuple('EmployeeRecord', 'name age title department paygrade')
+ for record in starmap(EmployeeRecord, csv.reader(open("employees.csv", "rb"))):
+ print(emp.name, emp.title)
+
+When casting a single record to a *NamedTuple*, use the star-operator [#]_ to unpack
+the values::
+
+ >>> t = [11, 22]
+ >>> Point(*t) # the star-operator unpacks any iterable object
+ Point(x=11, y=22)
+
+In addition to the methods inherited from tuples, named tuples support
+an additonal method and an informational read-only attribute.
+
+.. method:: somenamedtuple.replace(field, value)
+
+ Return a new instance of the named tuple replacing the named *field* with a new *value*::
+
+ >>> p = Point(x=11, y=22)
+ >>> p.__replace__('x', 33)
+ Point(x=33, y=22)
+
+ >>> for recordnum, record in inventory:
+ ... inventory[recordnum] = record.replace('total', record.price * record.quantity)
+
+.. attribute:: somenamedtuple.__fields__
+
+ Return a tuple of strings listing the field names. This is useful for introspection,
+ for converting a named tuple instance to a dictionary, and for combining named tuple
+ types to create new named tuple types::
+
+ >>> p.__fields__ # view the field names
+ ('x', 'y')
+ >>> dict(zip(p.__fields__, p)) # convert to a dictionary
+ {'y': 22, 'x': 11}
+
+ >>> Color = NamedTuple('Color', 'red green blue')
+ >>> pixel_fields = ' '.join(Point.__fields__ + Color.__fields__) # combine fields
+ >>> Pixel = NamedTuple('Pixel', pixel_fields)
+ >>> Pixel(11, 22, 128, 255, 0)
+ Pixel(x=11, y=22, red=128, green=255, blue=0)'
.. rubric:: Footnotes
diff --git a/Doc/library/decimal.rst b/Doc/library/decimal.rst
index 444b20a..bbac0d4 100644
--- a/Doc/library/decimal.rst
+++ b/Doc/library/decimal.rst
@@ -14,7 +14,7 @@
The :mod:`decimal` module provides support for decimal floating point
-arithmetic. It offers several advantages over the :class:`float()` datatype:
+arithmetic. It offers several advantages over the :class:`float` datatype:
* Decimal numbers can be represented exactly. In contrast, numbers like
:const:`1.1` do not have an exact representation in binary floating point. End
@@ -22,7 +22,7 @@
:const:`1.1000000000000001` as it does with binary floating point.
* The exactness carries over into arithmetic. In decimal floating point, ``0.1
- + 0.1 + 0.1 - 0.3`` is exactly equal to zero. In binary floating point, result
+ + 0.1 + 0.1 - 0.3`` is exactly equal to zero. In binary floating point, the result
is :const:`5.5511151231257827e-017`. While near to zero, the differences
prevent reliable equality testing and differences can accumulate. For this
reason, decimal would be preferred in accounting applications which have strict
@@ -36,7 +36,7 @@
1.20`` gives :const:`1.5600`.
* Unlike hardware based binary floating point, the decimal module has a user
- settable precision (defaulting to 28 places) which can be as large as needed for
+ alterable precision (defaulting to 28 places) which can be as large as needed for
a given problem::
>>> getcontext().prec = 6
@@ -56,7 +56,7 @@
A decimal number is immutable. It has a sign, coefficient digits, and an
exponent. To preserve significance, the coefficient digits do not truncate
-trailing zeroes. Decimals also include special values such as
+trailing zeros. Decimals also include special values such as
:const:`Infinity`, :const:`-Infinity`, and :const:`NaN`. The standard also
differentiates :const:`-0` from :const:`+0`.
@@ -65,7 +65,7 @@
enablers which determine whether signals are treated as exceptions. Rounding
options include :const:`ROUND_CEILING`, :const:`ROUND_DOWN`,
:const:`ROUND_FLOOR`, :const:`ROUND_HALF_DOWN`, :const:`ROUND_HALF_EVEN`,
-:const:`ROUND_HALF_UP`, and :const:`ROUND_UP`.
+:const:`ROUND_HALF_UP`, :const:`ROUND_UP`, and :const:`ROUND_05UP`.
Signals are groups of exceptional conditions arising during the course of
computation. Depending on the needs of the application, signals may be ignored,
@@ -82,11 +82,11 @@
.. seealso::
- IBM's General Decimal Arithmetic Specification, `The General Decimal Arithmetic
- Specification <http://www2.hursley.ibm.com/decimal/decarith.html>`_.
+ * IBM's General Decimal Arithmetic Specification, `The General Decimal Arithmetic
+ Specification <http://www2.hursley.ibm.com/decimal/decarith.html>`_.
- IEEE standard 854-1987, `Unofficial IEEE 854 Text
- <http://www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html>`_.
+ * IEEE standard 854-1987, `Unofficial IEEE 854 Text
+ <http://www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html>`_.
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -123,6 +123,8 @@
Decimal("3.14")
>>> Decimal(str(2.0 ** 0.5))
Decimal("1.41421356237")
+ >>> Decimal(2) ** Decimal("0.5")
+ Decimal("1.414213562373095048801688724")
>>> Decimal("NaN")
Decimal("NaN")
>>> Decimal("-Infinity")
@@ -172,6 +174,17 @@
>>> c % a
Decimal("0.77")
+And some mathematic functions are also available to Decimal::
+
+ >>> Decimal(2).sqrt()
+ Decimal("1.414213562373095048801688724")
+ >>> Decimal(1).exp()
+ Decimal("2.718281828459045235360287471")
+ >>> Decimal("10").ln()
+ Decimal("2.302585092994045684017991455")
+ >>> Decimal("10").log10()
+ Decimal("1")
+
The :meth:`quantize` method rounds a number to a fixed exponent. This method is
useful for monetary applications that often round results to a fixed number of
places::
@@ -285,7 +298,7 @@
The *context* precision does not affect how many digits are stored. That is
determined exclusively by the number of digits in *value*. For example,
- ``Decimal("3.00000")`` records all five zeroes even if the context precision is
+ ``Decimal("3.00000")`` records all five zeros even if the context precision is
only three.
The purpose of the *context* argument is determining what to do if *value* is a
@@ -295,7 +308,7 @@
Once constructed, :class:`Decimal` objects are immutable.
-Decimal floating point objects share many properties with the other builtin
+Decimal floating point objects share many properties with the other built-in
numeric types such as :class:`float` and :class:`int`. All of the usual math
operations and special methods apply. Likewise, decimal objects can be copied,
pickled, printed, used as dictionary keys, used as set elements, compared,
@@ -315,50 +328,363 @@
.. method:: Decimal.as_tuple()
- Returns a tuple representation of the number: ``(sign, digittuple, exponent)``.
+ Return a tuple representation of the number: ``(sign, digit_tuple, exponent)``.
+.. method:: Decimal.canonical()
+
+ Return the canonical encoding of the argument. Currently, the
+ encoding of a :class:`Decimal` instance is always canonical, so
+ this operation returns its argument unchanged.
+
+ .. versionadded:: 2.6
+
.. method:: Decimal.compare(other[, context])
- Compares like :meth:`__cmp__` but returns a decimal instance::
+ Compare the values of two Decimal instances. This operation
+ behaves in the same way as the usual comparison method
+ :meth:`__cmp__`, except that :meth:`compare` returns a Decimal
+ instance rather than an integer, and if either operand is a NaN
+ then the result is a NaN::
a or b is a NaN ==> Decimal("NaN")
a < b ==> Decimal("-1")
a == b ==> Decimal("0")
a > b ==> Decimal("1")
+.. method:: Decimal.compare_signal(other[, context])
+
+ This operation is identical to the :meth:`compare` method, except
+ that all NaNs signal. That is, if neither operand is a signaling
+ NaN then any quiet NaN operand is treated as though it were a
+ signaling NaN.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.compare_total(other)
+
+ Compare two operands using their abstract representation rather
+ than their numerical value. Similar to the :meth:`compare` method,
+ but the result gives a total ordering on :class:`Decimal`
+ instances. Two :class:`Decimal` instances with the same numeric
+ value but different representations compare unequal in this
+ ordering::
+
+ >>> Decimal("12.0").compare_total(Decimal("12"))
+ Decimal("-1")
+
+ Quiet and signaling NaNs are also included in the total ordering.
+ The result of this function is ``Decimal("0")`` if both operands
+ have the same representation, ``Decimal("-1")`` if the first
+ operand is lower in the total order than the second, and
+ ``Decimal("1")`` if the first operand is higher in the total order
+ than the second operand. See the specification for details of the
+ total order.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.compare_total_mag(other)
+
+ Compare two operands using their abstract representation rather
+ than their value as in :meth:`compare_total`, but ignoring the sign
+ of each operand. ``x.compare_total_mag(y)`` is equivalent to
+ ``x.copy_abs().compare_total(y.copy_abs())``.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.copy_abs()
+
+ Return the absolute value of the argument. This operation is
+ unaffected by the context and is quiet: no flags are changed and no
+ rounding is performed.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.copy_negate()
+
+ Return the negation of the argument. This operation is unaffected
+ by the context and is quiet: no flags are changed and no rounding
+ is performed.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.copy_sign(other)
+
+ Return a copy of the first operand with the sign set to be the
+ same as the sign of the second operand. For example::
+
+ >>> Decimal("2.3").copy_sign(Decimal("-1.5"))
+ Decimal("-2.3")
+
+ This operation is unaffected by the context and is quiet: no flags
+ are changed and no rounding is performed.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.exp([context])
+
+ Return the value of the (natural) exponential function ``e**x`` at the
+ given number. The result is correctly rounded using the
+ :const:`ROUND_HALF_EVEN` rounding mode.
+
+ >>> Decimal(1).exp()
+ Decimal("2.718281828459045235360287471")
+ >>> Decimal(321).exp()
+ Decimal("2.561702493119680037517373933E+139")
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.fma(other, third[, context])
+
+ Fused multiply-add. Return self*other+third with no rounding of
+ the intermediate product self*other.
+
+ >>> Decimal(2).fma(3, 5)
+ Decimal("11")
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.is_canonical()
+
+ Return :const:`True` if the argument is canonical and
+ :const:`False` otherwise. Currently, a :class:`Decimal` instance
+ is always canonical, so this operation always returns
+ :const:`True`.
+
+ .. versionadded:: 2.6
+
+.. method:: is_finite()
+
+ Return :const:`True` if the argument is a finite number, and
+ :const:`False` if the argument is an infinity or a NaN.
+
+ .. versionadded:: 2.6
+
+.. method:: is_infinite()
+
+ Return :const:`True` if the argument is either positive or
+ negative infinity and :const:`False` otherwise.
+
+ .. versionadded:: 2.6
+
+.. method:: is_nan()
+
+ Return :const:`True` if the argument is a (quiet or signaling)
+ NaN and :const:`False` otherwise.
+
+ .. versionadded:: 2.6
+
+.. method:: is_normal()
+
+ Return :const:`True` if the argument is a *normal* finite number.
+ Return :const:`False` if the argument is zero, subnormal, infinite
+ or a NaN.
+
+ .. versionadded:: 2.6
+
+.. method:: is_qnan()
+
+ Return :const:`True` if the argument is a quiet NaN, and
+ :const:`False` otherwise.
+
+ .. versionadded:: 2.6
+
+.. method:: is_signed()
+
+ Return :const:`True` if the argument has a negative sign and
+ :const:`False` otherwise. Note that zeros and NaNs can both carry
+ signs.
+
+ .. versionadded:: 2.6
+
+.. method:: is_snan()
+
+ Return :const:`True` if the argument is a signaling NaN and
+ :const:`False` otherwise.
+
+ .. versionadded:: 2.6
+
+.. method:: is_subnormal()
+
+ Return :const:`True` if the argument is subnormal, and
+ :const:`False` otherwise.
+
+ .. versionadded:: 2.6
+
+.. method:: is_zero()
+
+ Return :const:`True` if the argument is a (positive or negative)
+ zero and :const:`False` otherwise.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.ln([context])
+
+ Return the natural (base e) logarithm of the operand. The result
+ is correctly rounded using the :const:`ROUND_HALF_EVEN` rounding
+ mode.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.log10([context])
+
+ Return the base ten logarithm of the operand. The result is
+ correctly rounded using the :const:`ROUND_HALF_EVEN` rounding mode.
+
+ .. versionadded:: 2.6
+
+.. method: Decimal.logb([context])
+
+ For a nonzero number, return the adjusted exponent of its operand
+ as a :class:`Decimal` instance. If the operand is a zero then
+ ``Decimal("-Infinity")`` is returned and the
+ :const:`DivisionByZero` flag is raised. If the operand is an
+ infinity then ``Decimal("Infinity")`` is returned.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.logical_and(other[, context])
+
+ :meth:`logical_and` is a logical operation which takes two
+ *logical operands* (see :ref:`logical_operands_label`). The result
+ is the digit-wise ``and`` of the two operands.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.logical_invert(other[, context])
+
+ :meth:`logical_invert` is a logical operation. The argument must
+ be a *logical operand* (see :ref:`logical_operands_label`). The
+ result is the digit-wise inversion of the operand.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.logical_or(other[, context])
+
+ :meth:`logical_or` is a logical operation which takes two *logical
+ operands* (see :ref:`logical_operands_label`). The result is the
+ digit-wise ``or`` of the two operands.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.logical_xor(other[, context])
+
+ :meth:`logical_xor` is a logical operation which takes two
+ *logical operands* (see :ref:`logical_operands_label`). The result
+ is the digit-wise exclusive or of the two operands.
+
+ .. versionadded:: 2.6
.. method:: Decimal.max(other[, context])
Like ``max(self, other)`` except that the context rounding rule is applied
- before returning and that :const:`NaN` values are either signalled or ignored
+ before returning and that :const:`NaN` values are either signaled or ignored
(depending on the context and whether they are signaling or quiet).
+.. method:: Decimal.max_mag(other[, context])
+
+ Similar to the :meth:`max` method, but the comparison is done using
+ the absolute values of the operands.
+
+ .. versionadded:: 2.6
.. method:: Decimal.min(other[, context])
Like ``min(self, other)`` except that the context rounding rule is applied
- before returning and that :const:`NaN` values are either signalled or ignored
+ before returning and that :const:`NaN` values are either signaled or ignored
(depending on the context and whether they are signaling or quiet).
+.. method:: Decimal.min_mag(other[, context])
+
+ Similar to the :meth:`min` method, but the comparison is done using
+ the absolute values of the operands.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.next_minus([context])
+
+ Return the largest number representable in the given context (or
+ in the current thread's context if no context is given) that is smaller
+ than the given operand.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.next_plus([context])
+
+ Return the smallest number representable in the given context (or
+ in the current thread's context if no context is given) that is
+ larger than the given operand.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.next_toward(other[, context])
+
+ If the two operands are unequal, return the number closest to the
+ first operand in the direction of the second operand. If both
+ operands are numerically equal, return a copy of the first operand
+ with the sign set to be the same as the sign of the second operand.
+
+ .. versionadded:: 2.6
.. method:: Decimal.normalize([context])
- Normalize the number by stripping the rightmost trailing zeroes and converting
+ Normalize the number by stripping the rightmost trailing zeros and converting
any result equal to :const:`Decimal("0")` to :const:`Decimal("0e0")`. Used for
producing canonical values for members of an equivalence class. For example,
``Decimal("32.100")`` and ``Decimal("0.321000e+2")`` both normalize to the
equivalent value ``Decimal("32.1")``.
+.. method:: Decimal.number_class([context])
-.. method:: Decimal.quantize(exp [, rounding[, context[, watchexp]]])
+ Return a string describing the *class* of the operand. The
+ returned value is one of the following ten strings.
- Quantize makes the exponent the same as *exp*. Searches for a rounding method
- in *rounding*, then in *context*, and then in the current context.
+ * ``"-Infinity"``, indicating that the operand is negative infinity.
+ * ``"-Normal"``, indicating that the operand is a negative normal number.
+ * ``"-Subnormal"``, indicating that the operand is negative and subnormal.
+ * ``"-Zero"``, indicating that the operand is a negative zero.
+ * ``"+Zero"``, indicating that the operand is a positive zero.
+ * ``"+Subnormal"``, indicating that the operand is positive and subnormal.
+ * ``"+Normal"``, indicating that the operand is a positive normal number.
+ * ``"+Infinity"``, indicating that the operand is positive infinity.
+ * ``"NaN"``, indicating that the operand is a quiet NaN (Not a Number).
+ * ``"sNaN"``, indicating that the operand is a signaling NaN.
- If *watchexp* is set (default), then an error is returned whenever the resulting
- exponent is greater than :attr:`Emax` or less than :attr:`Etiny`.
+ .. versionadded:: 2.6
+.. method:: Decimal.quantize(exp[, rounding[, context[, watchexp]]])
+
+ Returns a value equal to the first operand after rounding and
+ having the exponent of the second operand.
+
+ >>> Decimal("1.41421356").quantize(Decimal("1.000"))
+ Decimal("1.414")
+
+ Unlike other operations, if the length of the coefficient after the
+ quantize operation would be greater than precision, then an
+ :const:`InvalidOperation` is signaled. This guarantees that, unless
+ there is an error condition, the quantized exponent is always equal
+ to that of the right-hand operand.
+
+ Also unlike other operations, quantize never signals Underflow,
+ even if the result is subnormal and inexact.
+
+ If the exponent of the second operand is larger than that of the
+ first then rounding may be necessary. In this case, the rounding
+ mode is determined by the ``rounding`` argument if given, else by
+ the given ``context`` argument; if neither argument is given the
+ rounding mode of the current thread's context is used.
+
+ If watchexp is set (default), then an error is returned whenever
+ the resulting exponent is greater than Emax or less than Etiny.
+
+.. method:: Decimal.radix()
+
+ Return ``Decimal(10)``, the radix (base) in which the
+ :class:`Decimal` class does all its arithmetic. Included for
+ compatibility with the specification.
+
+ .. versionadded:: 2.6
.. method:: Decimal.remainder_near(other[, context])
@@ -368,16 +694,49 @@
If both are equally close, the one chosen will have the same sign as *self*.
+.. method:: Decimal.rotate(other[, context])
+
+ Return the result of rotating the digits of the first operand by
+ an amount specified by the second operand. The second operand
+ must be an integer in the range -precision through precision. The
+ absolute value of the second operand gives the number of places to
+ rotate. If the second operand is positive then rotation is to the
+ left; otherwise rotation is to the right. The coefficient of the
+ first operand is padded on the left with zeros to length precision
+ if necessary. The sign and exponent of the first operand are
+ unchanged.
+
+ .. versionadded:: 2.6
.. method:: Decimal.same_quantum(other[, context])
Test whether self and other have the same exponent or whether both are
:const:`NaN`.
+.. method:: Decimal.scaleb(other[, context])
+
+ Return the first operand with exponent adjusted by the second.
+ Equivalently, return the first operand multiplied by ``10**other``.
+ The second operand must be an integer.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.shift(other[, context])
+
+ Return the result of shifting the digits of the first operand by
+ an amount specified by the second operand. The second operand must
+ be an integer in the range -precision through precision. The
+ absolute value of the second operand gives the number of places to
+ shift. If the second operand is positive then the shift is to the
+ left; otherwise the shift is to the right. Digits shifted into the
+ coefficient are zeros. The sign and exponent of the first operand
+ are unchanged.
+
+ .. versionadded:: 2.6
.. method:: Decimal.sqrt([context])
- Return the square root to full precision.
+ Return the square root of the argument to full precision.
.. method:: Decimal.to_eng_string([context])
@@ -388,13 +747,53 @@
to 3 digits left of the decimal place. For example, converts
``Decimal('123E+1')`` to ``Decimal("1.23E+3")``
-
.. method:: Decimal.to_integral([rounding[, context]])
+ Identical to the :meth:`to_integral_value` method. The ``to_integral``
+ name has been kept for compatibility with older versions.
+
+.. method:: Decimal.to_integral_exact([rounding[, context]])
+
+ Round the argument to the nearest integer, signaling
+ :const:`Inexact` or :const:`Rounded` as appropriate if rounding
+ occurs. The rounding mode is determined by the ``rounding``
+ parameter if given, else by the given ``context``. If neither
+ parameter is given then the rounding mode of the current context is
+ used.
+
+ .. versionadded:: 2.6
+
+.. method:: Decimal.to_integral_value([rounding[, context]])
+
Rounds to the nearest integer without signaling :const:`Inexact` or
:const:`Rounded`. If given, applies *rounding*; otherwise, uses the rounding
method in either the supplied *context* or the current context.
+ .. versionchanged:: 2.6
+ renamed from ``to_integral`` to ``to_integral_value``. The old name
+ remains valid for compatibility.
+
+.. method:: Decimal.trim()
+
+ Returns its argument with *insignificant* trailing zeros removed.
+ Here, a trailing zero is considered insignificant either if it
+ follows the decimal point, or if the exponent of the argument (that
+ is, the last element of the :meth:`as_tuple` representation) is
+ positive.
+
+ .. versionadded:: 2.6
+
+.. _logical_operands_label:
+
+Logical operands
+^^^^^^^^^^^^^^^^
+
+The :meth:`logical_and`, :meth:`logical_invert`, :meth:`logical_or`,
+and :meth:`logical_xor` methods expect their arguments to be *logical
+operands*. A *logical operand* is a :class:`Decimal` instance whose
+exponent and sign are both zero, and whose digits are all either
+:const:`0` or :const:`1`.
+
.. % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -509,6 +908,8 @@
* :const:`ROUND_HALF_EVEN` (to nearest with ties going to nearest even integer),
* :const:`ROUND_HALF_UP` (to nearest with ties going away from zero), or
* :const:`ROUND_UP` (away from zero).
+ * :const:`ROUND_05UP` (away from zero if last digit after rounding towards zero
+ would have been 0 or 5; otherwise towards zero)
The *traps* and *flags* fields list any signals to be set. Generally, new
contexts should only set traps and leave the flags clear.
@@ -520,9 +921,16 @@
:const:`1`, exponents are printed with a capital :const:`E`; otherwise, a
lowercase :const:`e` is used: :const:`Decimal('6.02e+23')`.
-The :class:`Context` class defines several general purpose methods as well as a
-large number of methods for doing arithmetic directly in a given context.
+ .. versionchanged:: 2.6
+ The :const:`ROUND_05UP` rounding mode was added.
+The :class:`Context` class defines several general purpose methods as
+well as a large number of methods for doing arithmetic directly in a
+given context. In addition, for each of the :class:`Decimal` methods
+described above (with the exception of the :meth:`adjusted` and
+:meth:`as_tuple` methods) there is a corresponding :class:`Context`
+method. For example, ``C.exp(x)`` is equivalent to
+``x.exp(context=C)``.
.. method:: Context.clear_flags()
@@ -533,6 +941,9 @@
Return a duplicate of the context.
+.. method:: Context.copy_decimal(num)
+
+ Return a copy of the Decimal instance num.
.. method:: Context.create_decimal(num)
@@ -581,44 +992,21 @@
Return the sum of *x* and *y*.
-.. method:: Context.compare(x, y)
-
- Compares values numerically.
-
- Like :meth:`__cmp__` but returns a decimal instance::
-
- a or b is a NaN ==> Decimal("NaN")
- a < b ==> Decimal("-1")
- a == b ==> Decimal("0")
- a > b ==> Decimal("1")
-
-
.. method:: Context.divide(x, y)
Return *x* divided by *y*.
+.. method:: Context.divide_int(x, y)
+
+ Return *x* divided by *y*, truncated to an integer.
+
+
.. method:: Context.divmod(x, y)
Divides two numbers and returns the integer part of the result.
-.. method:: Context.max(x, y)
-
- Compare two values numerically and return the maximum.
-
- If they are numerically equal then the left-hand operand is chosen as the
- result.
-
-
-.. method:: Context.min(x, y)
-
- Compare two values numerically and return the minimum.
-
- If they are numerically equal then the left-hand operand is chosen as the
- result.
-
-
.. method:: Context.minus(x)
Minus corresponds to the unary prefix minus operator in Python.
@@ -629,14 +1017,6 @@
Return the product of *x* and *y*.
-.. method:: Context.normalize(x)
-
- Normalize reduces an operand to its simplest form.
-
- Essentially a :meth:`plus` operation with all trailing zeros removed from the
- result.
-
-
.. method:: Context.plus(x)
Plus corresponds to the unary prefix plus operator in Python. This operation
@@ -646,33 +1026,31 @@
.. method:: Context.power(x, y[, modulo])
- Return ``x ** y`` to the *modulo* if given.
+ Return ``x`` to the power of ``y``, reduced modulo ``modulo`` if
+ given.
- The right-hand operand must be a whole number whose integer part (after any
- exponent has been applied) has no more than 9 digits and whose fractional part
- (if any) is all zeros before any rounding. The operand may be positive,
- negative, or zero; if negative, the absolute value of the power is used, and the
- left-hand operand is inverted (divided into 1) before use.
+ With two arguments, compute ``x**y``. If ``x`` is negative then
+ ``y`` must be integral. The result will be inexact unless ``y`` is
+ integral and the result is finite and can be expressed exactly in
+ 'precision' digits. The result should always be correctly rounded,
+ using the rounding mode of the current thread's context.
- If the increased precision needed for the intermediate calculations exceeds the
- capabilities of the implementation then an :const:`InvalidOperation` condition
- is signaled.
+ With three arguments, compute ``(x**y) % modulo``. For the three
+ argument form, the following restrictions on the arguments hold:
- If, when raising to a negative power, an underflow occurs during the division
- into 1, the operation is not halted at that point but continues.
+ - all three arguments must be integral
+ - ``y`` must be nonnegative
+ - at least one of ``x`` or ``y`` must be nonzero
+ - ``modulo`` must be nonzero and have at most 'precision' digits
+ The result of ``Context.power(x, y, modulo)`` is identical to
+ the result that would be obtained by computing ``(x**y) %
+ modulo`` with unbounded precision, but is computed more
+ efficiently. It is always exact.
-.. method:: Context.quantize(x, y)
-
- Returns a value equal to *x* after rounding and having the exponent of *y*.
-
- Unlike other operations, if the length of the coefficient after the quantize
- operation would be greater than precision, then an :const:`InvalidOperation` is
- signaled. This guarantees that, unless there is an error condition, the
- quantized exponent is always equal to that of the right-hand operand.
-
- Also unlike other operations, quantize never signals Underflow, even if the
- result is subnormal and inexact.
+ .. versionchanged:: 2.6
+ ``y`` may now be nonintegral in ``x**y``.
+ Stricter requirements for the three-argument version.
.. method:: Context.remainder(x, y)
@@ -682,47 +1060,10 @@
The sign of the result, if non-zero, is the same as that of the original
dividend.
-
-.. method:: Context.remainder_near(x, y)
-
- Computed the modulo as either a positive or negative value depending on which is
- closest to zero. For instance, ``Decimal(10).remainder_near(6)`` returns
- ``Decimal("-2")`` which is closer to zero than ``Decimal("4")``.
-
- If both are equally close, the one chosen will have the same sign as *self*.
-
-
-.. method:: Context.same_quantum(x, y)
-
- Test whether *x* and *y* have the same exponent or whether both are
- :const:`NaN`.
-
-
-.. method:: Context.sqrt(x)
-
- Return the square root of *x* to full precision.
-
-
.. method:: Context.subtract(x, y)
Return the difference between *x* and *y*.
-
-.. method:: Context.to_eng_string()
-
- Convert to engineering-type string.
-
- Engineering notation has an exponent which is a multiple of 3, so there are up
- to 3 digits left of the decimal place. For example, converts
- ``Decimal('123E+1')`` to ``Decimal("1.23E+3")``
-
-
-.. method:: Context.to_integral(x)
-
- Rounds to the nearest integer without signaling :const:`Inexact` or
- :const:`Rounded`.
-
-
.. method:: Context.to_sci_string(x)
Converts a number to a string using scientific notation.
@@ -755,7 +1096,7 @@
Typically, clamping occurs when an exponent falls outside the context's
:attr:`Emin` and :attr:`Emax` limits. If possible, the exponent is reduced to
- fit by adding zeroes to the coefficient.
+ fit by adding zeros to the coefficient.
.. class:: DecimalException
@@ -908,7 +1249,7 @@
The number system for the :mod:`decimal` module provides special values
including :const:`NaN`, :const:`sNaN`, :const:`-Infinity`, :const:`Infinity`,
-and two zeroes, :const:`+0` and :const:`-0`.
+and two zeros, :const:`+0` and :const:`-0`.
Infinities can be constructed directly with: ``Decimal('Infinity')``. Also,
they can arise from dividing by zero when the :exc:`DivisionByZero` signal is
diff --git a/Doc/library/fileinput.rst b/Doc/library/fileinput.rst
index fd84139..a14e05b 100644
--- a/Doc/library/fileinput.rst
+++ b/Doc/library/fileinput.rst
@@ -7,8 +7,9 @@
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
-This module implements a helper class and functions to quickly write a loop over
-standard input or a list of files.
+This module implements a helper class and functions to quickly write a
+loop over standard input or a list of files. If you just want to read or
+write one file see :func:`open`.
The typical use is::
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index b5061fd..5d5dc1b 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -746,7 +746,8 @@
Python enforces that the mode, after stripping ``'U'``, begins with ``'r'``,
``'w'`` or ``'a'``.
- See also the :mod:`fileinput` module.
+ See also the :mod:`fileinput` module, the :mod:`os` module, and the
+ :mod:`os.path` module.
.. function:: ord(c)
diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index de2394e..0f8a742 100644
--- a/Doc/library/hashlib.rst
+++ b/Doc/library/hashlib.rst
@@ -36,7 +36,7 @@
Feeding string objects is to :meth:`update` is not supported, as hashes work
on bytes, not on characters.
-.. index:: single: OpenSSL
+.. index:: single: OpenSSL; (use in module hashlib)
Constructors for hash algorithms that are always present in this module are
:func:`md5`, :func:`sha1`, :func:`sha224`, :func:`sha256`, :func:`sha384`, and
diff --git a/Doc/library/operator.rst b/Doc/library/operator.rst
index f396978..40acc6b 100644
--- a/Doc/library/operator.rst
+++ b/Doc/library/operator.rst
@@ -47,18 +47,18 @@
truth tests, identity tests, and boolean operations:
-.. function:: not_(o)
- __not__(o)
+.. function:: not_(obj)
+ __not__(obj)
- Return the outcome of :keyword:`not` *o*. (Note that there is no
+ Return the outcome of :keyword:`not` *obj*. (Note that there is no
:meth:`__not__` method for object instances; only the interpreter core defines
this operation. The result is affected by the :meth:`__bool__` and
:meth:`__len__` methods.)
-.. function:: truth(o)
+.. function:: truth(obj)
- Return :const:`True` if *o* is true, and :const:`False` otherwise. This is
+ Return :const:`True` if *obj* is true, and :const:`False` otherwise. This is
equivalent to using the :class:`bool` constructor.
@@ -75,10 +75,10 @@
The mathematical and bitwise operations are the most numerous:
-.. function:: abs(o)
- __abs__(o)
+.. function:: abs(obj)
+ __abs__(obj)
- Return the absolute value of *o*.
+ Return the absolute value of *obj*.
.. function:: add(a, b)
@@ -106,12 +106,12 @@
Return ``a // b``.
-.. function:: inv(o)
- invert(o)
- __inv__(o)
- __invert__(o)
+.. function:: inv(obj)
+ invert(obj)
+ __inv__(obj)
+ __invert__(obj)
- Return the bitwise inverse of the number *o*. This is equivalent to ``~o``.
+ Return the bitwise inverse of the number *obj*. This is equivalent to ``~obj``.
.. function:: lshift(a, b)
@@ -132,10 +132,10 @@
Return ``a * b``, for *a* and *b* numbers.
-.. function:: neg(o)
- __neg__(o)
+.. function:: neg(obj)
+ __neg__(obj)
- Return *o* negated.
+ Return *obj* negated.
.. function:: or_(a, b)
@@ -144,10 +144,10 @@
Return the bitwise or of *a* and *b*.
-.. function:: pos(o)
- __pos__(o)
+.. function:: pos(obj)
+ __pos__(obj)
- Return *o* positive.
+ Return *obj* positive.
.. function:: pow(a, b)
@@ -373,24 +373,30 @@
... pass
...
>>> import operator
- >>> o = C()
- >>> operator.isMappingType(o)
+ >>> obj = C()
+ >>> operator.isMappingType(obj)
True
+.. note::
-.. function:: isCallable(o)
+ Python 3 is expected to introduce abstract base classes for
+ collection types, so it should be possible to write, for example,
+ ``isinstance(obj, collections.Mapping)`` and ``isinstance(obj,
+ collections.Sequence)``.
+
+.. function:: isCallable(obj)
.. deprecated:: 2.0
Use the :func:`callable` built-in function instead.
- Returns true if the object *o* can be called like a function, otherwise it
+ Returns true if the object *obj* can be called like a function, otherwise it
returns false. True is returned for functions, bound and unbound methods, class
objects, and instance objects which support the :meth:`__call__` method.
-.. function:: isMappingType(o)
+.. function:: isMappingType(obj)
- Returns true if the object *o* supports the mapping interface. This is true for
+ Returns true if the object *obj* supports the mapping interface. This is true for
dictionaries and all instance objects defining :meth:`__getitem__`.
.. warning::
@@ -400,9 +406,9 @@
useful than it otherwise might be.
-.. function:: isNumberType(o)
+.. function:: isNumberType(obj)
- Returns true if the object *o* represents a number. This is true for all
+ Returns true if the object *obj* represents a number. This is true for all
numeric types implemented in C.
.. warning::
@@ -412,9 +418,9 @@
useful than it otherwise might be.
-.. function:: isSequenceType(o)
+.. function:: isSequenceType(obj)
- Returns true if the object *o* supports the sequence protocol. This returns true
+ Returns true if the object *obj* supports the sequence protocol. This returns true
for all objects which define sequence methods in C, and for all instance objects
defining :meth:`__getitem__`.
@@ -484,7 +490,7 @@
+-----------------------+-------------------------+---------------------------------+
| Concatenation | ``seq1 + seq2`` | ``concat(seq1, seq2)`` |
+-----------------------+-------------------------+---------------------------------+
-| Containment Test | ``o in seq`` | ``contains(seq, o)`` |
+| Containment Test | ``obj in seq`` | ``contains(seq, obj)`` |
+-----------------------+-------------------------+---------------------------------+
| Division | ``a / b`` | ``div(a, b)`` (without |
| | | ``__future__.division``) |
@@ -508,11 +514,11 @@
+-----------------------+-------------------------+---------------------------------+
| Identity | ``a is not b`` | ``is_not(a, b)`` |
+-----------------------+-------------------------+---------------------------------+
-| Indexed Assignment | ``o[k] = v`` | ``setitem(o, k, v)`` |
+| Indexed Assignment | ``obj[k] = v`` | ``setitem(obj, k, v)`` |
+-----------------------+-------------------------+---------------------------------+
-| Indexed Deletion | ``del o[k]`` | ``delitem(o, k)`` |
+| Indexed Deletion | ``del obj[k]`` | ``delitem(obj, k)`` |
+-----------------------+-------------------------+---------------------------------+
-| Indexing | ``o[k]`` | ``getitem(o, k)`` |
+| Indexing | ``obj[k]`` | ``getitem(obj, k)`` |
+-----------------------+-------------------------+---------------------------------+
| Left Shift | ``a << b`` | ``lshift(a, b)`` |
+-----------------------+-------------------------+---------------------------------+
@@ -534,11 +540,11 @@
+-----------------------+-------------------------+---------------------------------+
| Slicing | ``seq[i:j]`` | ``getslice(seq, i, j)`` |
+-----------------------+-------------------------+---------------------------------+
-| String Formatting | ``s % o`` | ``mod(s, o)`` |
+| String Formatting | ``s % obj`` | ``mod(s, obj)`` |
+-----------------------+-------------------------+---------------------------------+
| Subtraction | ``a - b`` | ``sub(a, b)`` |
+-----------------------+-------------------------+---------------------------------+
-| Truth Test | ``o`` | ``truth(o)`` |
+| Truth Test | ``obj`` | ``truth(obj)`` |
+-----------------------+-------------------------+---------------------------------+
| Ordering | ``a < b`` | ``lt(a, b)`` |
+-----------------------+-------------------------+---------------------------------+
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 387fe54..2d87d8c 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -8,9 +8,10 @@
This module provides a more portable way of using operating system dependent
functionality than importing a 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`, and if you want to manipulate paths, see the :mod:`os.path`
-module.)
+: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
+command line see the :mod:`fileinput` module.
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
diff --git a/Doc/library/simplexmlrpcserver.rst b/Doc/library/simplexmlrpcserver.rst
index 2288907..8533bf8 100644
--- a/Doc/library/simplexmlrpcserver.rst
+++ b/Doc/library/simplexmlrpcserver.rst
@@ -142,7 +142,7 @@
import xmlrpclib
- s = xmlrpclib.Server('http://localhost:8000')
+ s = xmlrpclib.ServerProxy('http://localhost:8000')
print(s.pow(2,3)) # Returns 2**3 = 8
print(s.add(2,3)) # Returns 5
print(s.div(5,2)) # Returns 5//2 = 2
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index 852a905..851f742 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -9,6 +9,10 @@
.. sectionauthor:: Bill Janssen <bill.janssen@gmail.com>
+.. index:: single: OpenSSL; (use in module ssl)
+
+.. index:: TLS, SSL, Transport Layer Security, Secure Sockets Layer
+
This module provides access to Transport Layer Security (often known
as "Secure Sockets Layer") encryption and peer authentication
facilities for network sockets, both client-side and server-side.
@@ -19,18 +23,125 @@
.. note::
Some behavior may be platform dependent, since calls are made to the operating
- system socket APIs.
+ system socket APIs. The installed version of OpenSSL may also cause
+ variations in behavior.
This section documents the objects and functions in the ``ssl`` module;
for more general information about TLS, SSL, and certificates, the
-reader is referred to the documents in the :ref:`ssl-references` section.
+reader is referred to the documents in the "See Also" section at
+the bottom.
-This module defines a class, :class:`ssl.sslsocket`, which is
-derived from the :class:`socket.socket` type, and supports additional
+This module provides a class, :class:`ssl.SSLSocket`, which is
+derived from the :class:`socket.socket` type, and provides
+a socket-like wrapper that also encrypts and decrypts the data
+going over the socket with SSL. It supports additional
:meth:`read` and :meth:`write` methods, along with a method, :meth:`getpeercert`,
-to retrieve the certificate of the other side of the connection.
+to retrieve the certificate of the other side of the connection, and
+a method, :meth:`cipher`, to retrieve the cipher being used for the
+secure connection.
-This module defines the following functions, exceptions, and constants:
+Functions, Constants, and Exceptions
+------------------------------------
+
+.. exception:: SSLError
+
+ Raised to signal an error from the underlying SSL implementation. This
+ signifies some problem in the higher-level
+ encryption and authentication layer that's superimposed on the underlying
+ network connection. This error is a subtype of :exc:`socket.error`, which
+ in turn is a subtype of :exc:`IOError`.
+
+.. function:: wrap_socket (sock, keyfile=None, certfile=None, server_side=False, cert_reqs=CERT_NONE, ssl_version={see docs}, ca_certs=None)
+
+ Takes an instance ``sock`` of :class:`socket.socket`, and returns an instance of :class:`ssl.SSLSocket`, a subtype
+ of :class:`socket.socket`, which wraps the underlying socket in an SSL context.
+ For client-side sockets, the context construction is lazy; if the underlying socket isn't
+ connected yet, the context construction will be performed after :meth:`connect` is called
+ on the socket. For server-side sockets, if the socket has no remote peer, it is assumed
+ to be a listening socket, and the server-side SSL wrapping is automatically performed
+ on client connections accepted via the :meth:`accept` method. :func:`wrap_socket` may
+ raise :exc:`SSLError`.
+
+ The ``keyfile`` and ``certfile`` parameters specify optional files which contain a certificate
+ to be used to identify the local side of the connection. See the discussion of :ref:`ssl-certificates`
+ for more information on how the certificate is stored in the ``certfile``.
+
+ Often the private key is stored
+ in the same file as the certificate; in this case, only the ``certfile`` parameter need be
+ passed. If the private key is stored in a separate file, both parameters must be used.
+ If the private key is stored in the ``certfile``, it should come before the first certificate
+ in the certificate chain::
+
+ -----BEGIN RSA PRIVATE KEY-----
+ ... (private key in base64 encoding) ...
+ -----END RSA PRIVATE KEY-----
+ -----BEGIN CERTIFICATE-----
+ ... (certificate in base64 PEM encoding) ...
+ -----END CERTIFICATE-----
+
+ The parameter ``server_side`` is a boolean which identifies whether server-side or client-side
+ behavior is desired from this socket.
+
+ The parameter ``cert_reqs`` specifies whether a certificate is
+ required from the other side of the connection, and whether it will
+ be validated if provided. It must be one of the three values
+ :const:`CERT_NONE` (certificates ignored), :const:`CERT_OPTIONAL` (not required,
+ but validated if provided), or :const:`CERT_REQUIRED` (required and
+ validated). If the value of this parameter is not :const:`CERT_NONE`, then
+ the ``ca_certs`` parameter must point to a file of CA certificates.
+
+ The ``ca_certs`` file contains a set of concatenated "certification authority" certificates,
+ which are used to validate certificates passed from the other end of the connection.
+ See the discussion of :ref:`ssl-certificates` for more information about how to arrange
+ the certificates in this file.
+
+ The parameter ``ssl_version`` specifies which version of the SSL protocol to use.
+ Typically, the server chooses a particular protocol version, and the client
+ must adapt to the server's choice. Most of the versions are not interoperable
+ with the other versions. If not specified, for client-side operation, the
+ default SSL version is SSLv3; for server-side operation, SSLv23. These
+ version selections provide the most compatibility with other versions.
+
+ Here's a table showing which versions in a client (down the side)
+ can connect to which versions in a server (along the top):
+
+ .. table::
+
+ ======================== ========= ========= ========== =========
+ *client* / **server** **SSLv2** **SSLv3** **SSLv23** **TLSv1**
+ *SSLv2* yes no yes* no
+ *SSLv3* yes yes yes no
+ *SSLv23* yes no yes no
+ *TLSv1* no no yes yes
+ ======================== ========= ========= ========== =========
+
+ `*` In some older versions of OpenSSL (for instance, 0.9.7l on OS X 10.4),
+ an SSLv2 client could not connect to an SSLv23 server.
+
+.. function:: RAND_status()
+
+ Returns True if the SSL pseudo-random number generator has been
+ seeded with 'enough' randomness, and False otherwise. You can use
+ :func:`ssl.RAND_egd` and :func:`ssl.RAND_add` to increase the randomness
+ of the pseudo-random number generator.
+
+.. function:: RAND_egd(path)
+
+ If you are running an entropy-gathering daemon (EGD) somewhere, and ``path``
+ is the pathname of a socket connection open to it, this will read
+ 256 bytes of randomness from the socket, and add it to the SSL pseudo-random number generator
+ to increase the security of generated secret keys. This is typically only
+ necessary on systems without better sources of randomness.
+
+ See http://egd.sourceforge.net/ or http://prngd.sourceforge.net/ for
+ sources of entropy-gathering daemons.
+
+.. function:: RAND_add(bytes, entropy)
+
+ Mixes the given ``bytes`` into the SSL pseudo-random number generator.
+ The parameter ``entropy`` (a float) is a lower bound on the entropy
+ contained in string (so you can always use :const:`0.0`).
+ See :rfc:`1750` for more information on sources of entropy.
.. function:: cert_time_to_seconds(timestring)
@@ -48,12 +159,27 @@
'Wed May 9 00:00:00 2007'
>>>
-.. exception:: sslerror
+.. function:: get_server_certificate (addr, ssl_version=PROTOCOL_SSLv3, ca_certs=None)
- Raised to signal an error from the underlying SSL implementation. This
- signifies some problem in the higher-level
- encryption and authentication layer that's superimposed on the underlying
- network connection.
+ Given the address ``addr`` of an SSL-protected server, as a
+ (*hostname*, *port-number*) pair, fetches the server's certificate,
+ and returns it as a PEM-encoded string. If ``ssl_version`` is
+ specified, uses that version of the SSL protocol to attempt to
+ connect to the server. If ``ca_certs`` is specified, it should be
+ a file containing a list of root certificates, the same format as
+ used for the same parameter in :func:`wrap_socket`. The call will
+ attempt to validate the server certificate against that set of root
+ certificates, and will fail if the validation attempt fails.
+
+.. function:: DER_cert_to_PEM_cert (DER_cert_bytes)
+
+ Given a certificate as a DER-encoded blob of bytes, returns a PEM-encoded
+ string version of the same certificate.
+
+.. function:: PEM_cert_to_DER_cert (PEM_cert_string)
+
+ Given a certificate as an ASCII PEM string, returns a DER-encoded
+ sequence of bytes for that same certificate.
.. data:: CERT_NONE
@@ -84,13 +210,16 @@
.. data:: PROTOCOL_SSLv23
- Selects SSL version 2 or 3 as the channel encryption protocol. This is a setting to use for maximum compatibility
- with the other end of an SSL connection, but it may cause the specific ciphers chosen for the encryption to be
- of fairly low quality.
+ Selects SSL version 2 or 3 as the channel encryption protocol.
+ This is a setting to use with servers for maximum compatibility
+ with the other end of an SSL connection, but it may cause the
+ specific ciphers chosen for the encryption to be of fairly low
+ quality.
.. data:: PROTOCOL_SSLv3
Selects SSL version 3 as the channel encryption protocol.
+ For clients, this is the maximally compatible SSL variant.
.. data:: PROTOCOL_TLSv1
@@ -99,6 +228,69 @@
protection, if both sides can speak it.
+SSLSocket Objects
+-----------------
+
+.. method:: SSLSocket.read([nbytes=1024])
+
+ Reads up to ``nbytes`` bytes from the SSL-encrypted channel and returns them.
+
+.. method:: SSLSocket.write(data)
+
+ Writes the ``data`` to the other side of the connection, using the
+ SSL channel to encrypt. Returns the number of bytes written.
+
+.. method:: SSLSocket.getpeercert(binary_form=False)
+
+ If there is no certificate for the peer on the other end of the
+ connection, returns ``None``.
+
+ If the the parameter ``binary_form`` is :const:`False`, and a
+ certificate was received from the peer, this method returns a
+ :class:`dict` instance. If the certificate was not validated, the
+ dict is empty. If the certificate was validated, it returns a dict
+ with the keys ``subject`` (the principal for which the certificate
+ was issued), and ``notAfter`` (the time after which the certificate
+ should not be trusted). The certificate was already validated, so
+ the ``notBefore`` and ``issuer`` fields are not returned. If a
+ certificate contains an instance of the *Subject Alternative Name*
+ extension (see :rfc:`3280`), there will also be a
+ ``subjectAltName`` key in the dictionary.
+
+ The "subject" field is a tuple containing the sequence of relative
+ distinguished names (RDNs) given in the certificate's data
+ structure for the principal, and each RDN is a sequence of
+ name-value pairs::
+
+ {'notAfter': 'Feb 16 16:54:50 2013 GMT',
+ 'subject': ((('countryName', u'US'),),
+ (('stateOrProvinceName', u'Delaware'),),
+ (('localityName', u'Wilmington'),),
+ (('organizationName', u'Python Software Foundation'),),
+ (('organizationalUnitName', u'SSL'),),
+ (('commonName', u'somemachine.python.org'),))}
+
+ If the ``binary_form`` parameter is :const:`True`, and a
+ certificate was provided, this method returns the DER-encoded form
+ of the entire certificate as a sequence of bytes, or :const:`None` if the
+ peer did not provide a certificate. This return
+ value is independent of validation; if validation was required
+ (:const:`CERT_OPTIONAL` or :const:`CERT_REQUIRED`), it will have
+ been validated, but if :const:`CERT_NONE` was used to establish the
+ connection, the certificate, if present, will not have been validated.
+
+.. method:: SSLSocket.cipher()
+
+ Returns a three-value tuple containing the name of the cipher being
+ used, the version of the SSL protocol that defines its use, and the
+ number of secret bits being used. If no connection has been
+ established, returns ``None``.
+
+
+.. index:: single: certificates
+
+.. index:: single: X509 certificate
+
.. _ssl-certificates:
Certificates
@@ -127,8 +319,12 @@
side of a network connection can also be required to produce a certificate,
and that certificate can be validated to the satisfaction
of the client or server that requires such validation.
-The connection can be set to fail automatically if such
-validation is not achieved.
+The connection attempt can be set to raise an exception if
+the validation fails. Validation is done
+automatically, by the underlying OpenSSL framework; the
+application need not concern itself with its mechanics.
+But the application does usually need to provide
+sets of certificates to allow this process to take place.
Python uses files to contain certificates. They should be formatted
as "PEM" (see :rfc:`1422`), which is a base-64 encoded form wrapped
@@ -167,108 +363,55 @@
chains for each issuer you are willing to trust. Again, this file just
contains these chains concatenated together. For validation, Python will
use the first chain it finds in the file which matches.
-Some "standard" root certificates are available at
-http://www.thawte.com/roots/ (for Thawte roots) and
-http://www.verisign.com/support/roots.html (for Verisign roots).
-See also :rfc:`4158` for more discussion of the way in which
+Some "standard" root certificates are available from various certification
+authorities:
+`CACert.org <http://www.cacert.org/index.php?id=3>`_,
+`Thawte <http://www.thawte.com/roots/>`_,
+`Verisign <http://www.verisign.com/support/roots.html>`_,
+`Positive SSL <http://www.PositiveSSL.com/ssl-certificate-support/cert_installation/UTN-USERFirst-Hardware.crt>`_ (used by python.org),
+`Equifax and GeoTrust <http://www.geotrust.com/resources/root_certificates/index.asp>`_.
+
+In general, if you are using
+SSL3 or TLS1, you don't need to put the full chain in your "CA certs" file;
+you only need the root certificates, and the remote peer is supposed to
+furnish the other certificates necessary to chain from its certificate to
+a root certificate.
+See :rfc:`4158` for more discussion of the way in which
certification chains can be built.
+If you are going to create a server that provides SSL-encrypted
+connection services, you will need to acquire a certificate for that
+service. There are many ways of acquiring appropriate certificates,
+such as buying one from a certification authority. Another common
+practice is to generate a self-signed certificate. The simplest
+way to do this is with the OpenSSL package, using something like
+the following::
-sslsocket Objects
------------------
+ % openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem
+ Generating a 1024 bit RSA private key
+ .......++++++
+ .............................++++++
+ writing new private key to 'cert.pem'
+ -----
+ You are about to be asked to enter information that will be incorporated
+ into your certificate request.
+ What you are about to enter is what is called a Distinguished Name or a DN.
+ There are quite a few fields but you can leave some blank
+ For some fields there will be a default value,
+ If you enter '.', the field will be left blank.
+ -----
+ Country Name (2 letter code) [AU]:US
+ State or Province Name (full name) [Some-State]:MyState
+ Locality Name (eg, city) []:Some City
+ Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc.
+ Organizational Unit Name (eg, section) []:My Group
+ Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com
+ Email Address []:ops@myserver.mygroup.myorganization.com
+ %
-.. class:: sslsocket(sock [, keyfile=None, certfile=None, server_side=False, cert_reqs=CERT_NONE, ssl_version=PROTOCOL_SSLv23, ca_certs=None])
-
- Takes an instance ``sock`` of :class:`socket.socket`, and returns an instance of a subtype
- of :class:`socket.socket` which wraps the underlying socket in an SSL context.
- For client-side sockets, the context construction is lazy; if the underlying socket isn't
- connected yet, the context construction will be performed after :meth:`connect` is called
- on the socket.
-
- The ``keyfile`` and ``certfile`` parameters specify optional files which contain a certificate
- to be used to identify the local side of the connection. See the above discussion of :ref:`ssl-certificates`
- for more information on how the certificate is stored in the ``certfile``.
-
- Often the private key is stored
- in the same file as the certificate; in this case, only the ``certfile`` parameter need be
- passed. If the private key is stored in a separate file, both parameters must be used.
- If the private key is stored in the ``certfile``, it should come before the first certificate
- in the certificate chain::
-
- -----BEGIN RSA PRIVATE KEY-----
- ... (private key in base64 encoding) ...
- -----END RSA PRIVATE KEY-----
- -----BEGIN CERTIFICATE-----
- ... (certificate in base64 PEM encoding) ...
- -----END CERTIFICATE-----
-
- The parameter ``server_side`` is a boolean which identifies whether server-side or client-side
- behavior is desired from this socket.
-
- The parameter ``cert_reqs`` specifies whether a certificate is
- required from the other side of the connection, and whether it will
- be validated if provided. It must be one of the three values
- :const:`CERT_NONE` (certificates ignored), :const:`CERT_OPTIONAL` (not required,
- but validated if provided), or :const:`CERT_REQUIRED` (required and
- validated). If the value of this parameter is not :const:`CERT_NONE`, then
- the ``ca_certs`` parameter must point to a file of CA certificates.
-
- The parameter ``ssl_version`` specifies which version of the SSL protocol to use. Typically,
- the server specifies this, and a client connecting to it must use the same protocol. An
- SSL server using :const:`PROTOCOL_SSLv23` can understand a client connecting via SSL2, SSL3, or TLS1,
- but a client using :const:`PROTOCOL_SSLv23` can only connect to an SSL2 server.
-
- The ``ca_certs`` file contains a set of concatenated "certification authority" certificates,
- which are used to validate certificates passed from the other end of the connection.
- See the above discussion of :ref:`ssl-certificates` for more information about how to arrange
- the certificates in this file.
-
-.. method:: sslsocket.read([nbytes])
-
- Reads up to ``nbytes`` bytes from the SSL-encrypted channel and returns them.
-
-.. method:: sslsocket.write(data)
-
- Writes the ``data`` to the other side of the connection, using the SSL channel to encrypt. Returns the number
- of bytes written.
-
-.. method:: sslsocket.getpeercert()
-
- If there is no certificate for the peer on the other end of the connection, returns ``None``.
- If a certificate was received from the peer, but not validated, returns an empty ``dict`` instance.
- If a certificate was received and validated, returns a ``dict`` instance with the fields
- ``subject`` (the principal for which the certificate was issued), ``issuer`` (the signer of
- the certificate), ``notBefore`` (the time before which the certificate should not be trusted),
- and ``notAfter`` (the time after which the certificate should not be trusted) filled in.
-
- The "subject" and "issuer" fields are tuples containing the name-value fields
- given in the certificate's data structure for each principal::
-
- {'issuer': (('countryName', u'US'),
- ('stateOrProvinceName', u'Delaware'),
- ('localityName', u'Wilmington'),
- ('organizationName', u'Python Software Foundation'),
- ('organizationalUnitName', u'SSL'),
- ('commonName', u'somemachine.python.org')),
- 'notAfter': 'Feb 16 16:54:50 2013 GMT',
- 'notBefore': 'Aug 27 16:54:50 2007 GMT',
- 'subject': (('countryName', u'US'),
- ('stateOrProvinceName', u'Delaware'),
- ('localityName', u'Wilmington'),
- ('organizationName', u'Python Software Foundation'),
- ('organizationalUnitName', u'SSL'),
- ('commonName', u'somemachine.python.org')),
- 'version': 2}
-
- This certificate is said to be *self-signed*, because the subject
- and issuer are the same entity. The *version* field refers to the X509 version
- that's used for the certificate.
-
-.. method:: sslsocket.ssl_shutdown()
-
- Closes the SSL context (if any) over the socket, but leaves the socket connection
- open for further use, if both sides are willing. This is different from :meth:`socket.socket.shutdown`,
- which will close the connection, but leave the local socket available for further use.
+The disadvantage of a self-signed certificate is that it is its
+own root certificate, and no one else will have it in their cache
+of known (and trusted) root certificates.
Examples
@@ -295,12 +438,17 @@
import socket, ssl, pprint
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
- ssl_sock = ssl.sslsocket(s, ca_certs="/etc/ca_certs_file", cert_reqs=ssl.CERT_REQUIRED)
+
+ # require a certificate from the server
+ ssl_sock = ssl.wrap_socket(s,
+ ca_certs="/etc/ca_certs_file",
+ cert_reqs=ssl.CERT_REQUIRED)
ssl_sock.connect(('www.verisign.com', 443))
print(repr(ssl_sock.getpeername()))
pprint.pprint(ssl_sock.getpeercert())
+ print(pprint.pformat(ssl_sock.getpeercert()))
# Set a simple HTTP request -- use httplib in actual code.
ssl_sock.write("""GET / HTTP/1.0\r
@@ -310,35 +458,29 @@
# read all the data returned by the server.
data = ssl_sock.read()
- # note that closing the sslsocket will also close the underlying socket
+ # note that closing the SSLSocket will also close the underlying socket
ssl_sock.close()
-As of September 4, 2007, the certificate printed by this program
+As of September 6, 2007, the certificate printed by this program
looked like this::
- {'issuer': (('countryName', u'US'),
- ('organizationName', u'VeriSign, Inc.'),
- ('organizationalUnitName', u'VeriSign Trust Network'),
- ('organizationalUnitName',
- u'Terms of use at https://www.verisign.com/rpa (c)06'),
- ('commonName',
- u'VeriSign Class 3 Extended Validation SSL SGC CA')),
- 'notAfter': 'May 8 23:59:59 2009 GMT',
- 'notBefore': 'May 9 00:00:00 2007 GMT',
- 'subject': (('serialNumber', u'2497886'),
- ('1.3.6.1.4.1.311.60.2.1.3', u'US'),
- ('1.3.6.1.4.1.311.60.2.1.2', u'Delaware'),
- ('countryName', u'US'),
- ('postalCode', u'94043'),
- ('stateOrProvinceName', u'California'),
- ('localityName', u'Mountain View'),
- ('streetAddress', u'487 East Middlefield Road'),
- ('organizationName', u'VeriSign, Inc.'),
- ('organizationalUnitName', u'Production Security Services'),
- ('organizationalUnitName',
- u'Terms of use at www.verisign.com/rpa (c)06'),
- ('commonName', u'www.verisign.com')),
- 'version': 2}
+ {'notAfter': 'May 8 23:59:59 2009 GMT',
+ 'subject': ((('serialNumber', u'2497886'),),
+ (('1.3.6.1.4.1.311.60.2.1.3', u'US'),),
+ (('1.3.6.1.4.1.311.60.2.1.2', u'Delaware'),),
+ (('countryName', u'US'),),
+ (('postalCode', u'94043'),),
+ (('stateOrProvinceName', u'California'),),
+ (('localityName', u'Mountain View'),),
+ (('streetAddress', u'487 East Middlefield Road'),),
+ (('organizationName', u'VeriSign, Inc.'),),
+ (('organizationalUnitName',
+ u'Production Security Services'),),
+ (('organizationalUnitName',
+ u'Terms of use at www.verisign.com/rpa (c)06'),),
+ (('commonName', u'www.verisign.com'),))}
+
+which is a fairly poorly-formed ``subject`` field.
Server-side operation
^^^^^^^^^^^^^^^^^^^^^
@@ -354,12 +496,15 @@
bindsocket.listen(5)
When one did, you'd call :meth:`accept` on the socket to get the new socket from the other
-end, and use :func:`sslsocket` to create a server-side SSL context for it::
+end, and use :func:`wrap_socket` to create a server-side SSL context for it::
while True:
newsocket, fromaddr = bindsocket.accept()
- connstream = ssl.sslsocket(newsocket, server_side=True, certfile="mycertfile",
- keyfile="mykeyfile", ssl_protocol=ssl.PROTOCOL_TLSv1)
+ connstream = ssl.wrap_socket(newsocket,
+ server_side=True,
+ certfile="mycertfile",
+ keyfile="mykeyfile",
+ ssl_protocol=ssl.PROTOCOL_TLSv1)
deal_with_client(connstream)
Then you'd read data from the ``connstream`` and do something with it till you are finished with the client (or the client is finished with you)::
@@ -370,7 +515,8 @@
# null data means the client is finished with us
while data:
if not do_something(connstream, data):
- # we'll assume do_something returns False when we're finished with client
+ # we'll assume do_something returns False
+ # when we're finished with client
break
data = connstream.read()
# finished with client
@@ -379,16 +525,19 @@
And go back to listening for new client connections.
-.. _ssl-references:
+.. seealso::
-References
-----------
+ Class :class:`socket.socket`
+ Documentation of underlying :mod:`socket` class
-Class :class:`socket.socket`
- Documentation of underlying :mod:`socket` class
+ `Introducing SSL and Certificates using OpenSSL <http://old.pseudonym.org/ssl/wwwj-index.html>`_
+ Frederick J. Hirsch
-`Introducing SSL and Certificates using OpenSSL <http://old.pseudonym.org/ssl/wwwj-index.html>`_, by Frederick J. Hirsch
+ `RFC 1422: Privacy Enhancement for Internet Electronic Mail: Part II: Certificate-Based Key Management <http://www.ietf.org/rfc/rfc1422>`_
+ Steve Kent
-`Privacy Enhancement for Internet Electronic Mail: Part II: Certificate-Based Key Management`, :rfc:`1422`, by Steve Kent
+ `RFC 1750: Randomness Recommendations for Security <http://www.ietf.org/rfc/rfc1750>`_
+ D. Eastlake et. al.
-`Internet X.509 Public Key Infrastructure Certificate and CRL Profile`, :rfc:`3280`, Housley et. al.
+ `RFC 3280: Internet X.509 Public Key Infrastructure Certificate and CRL Profile <http://www.ietf.org/rfc/rfc3280>`_
+ Housley et. al.
diff --git a/Doc/library/undoc.rst b/Doc/library/undoc.rst
index 3cc94bb..942a924 100644
--- a/Doc/library/undoc.rst
+++ b/Doc/library/undoc.rst
@@ -19,9 +19,6 @@
Some of these are very old and/or not very robust; marked with "hmm."
-:mod:`bdb`
- --- A generic Python debugger base class (used by pdb).
-
:mod:`ihooks`
--- Import hook support (for :mod:`rexec`; may become obsolete).