summaryrefslogtreecommitdiffstats
path: root/Doc/library/functions.rst
diff options
context:
space:
mode:
authorAlexander Belopolsky <alexander.belopolsky@gmail.com>2010-11-18 18:52:11 (GMT)
committerAlexander Belopolsky <alexander.belopolsky@gmail.com>2010-11-18 18:52:11 (GMT)
commit689aa6d3fa2ca375b6c9b9f9ef9a6b07322f9160 (patch)
tree29d62cba941b9b3f9fa59483d1a299bceb65ea7c /Doc/library/functions.rst
parentdae5b84fe77d2a7833ceb784fe1650962be6897d (diff)
downloadcpython-689aa6d3fa2ca375b6c9b9f9ef9a6b07322f9160.zip
cpython-689aa6d3fa2ca375b6c9b9f9ef9a6b07322f9160.tar.gz
cpython-689aa6d3fa2ca375b6c9b9f9ef9a6b07322f9160.tar.bz2
Merged revisions 86526 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r86526 | alexander.belopolsky | 2010-11-18 13:50:13 -0500 (Thu, 18 Nov 2010) | 1 line Issue 7828: Fixed chr() and ord() documentation for wide characters ........
Diffstat (limited to 'Doc/library/functions.rst')
-rw-r--r--Doc/library/functions.rst24
1 files changed, 14 insertions, 10 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 208f2f8..8e07673 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -105,11 +105,15 @@ are always available. They are listed here in alphabetical order.
.. function:: chr(i)
- Return the string of one character whose Unicode codepoint is the integer
+ Return the string representing a character whose Unicode codepoint is the integer
*i*. For example, ``chr(97)`` returns the string ``'a'``. This is the
- inverse of :func:`ord`. The valid range for the argument depends how Python
- was configured -- it may be either UCS2 [0..0xFFFF] or UCS4 [0..0x10FFFF].
- :exc:`ValueError` will be raised if *i* is outside that range.
+ inverse of :func:`ord`. The valid range for the argument is from 0 through
+ 1,114,111 (0x10FFFF in base 16). :exc:`ValueError` will be raised if *i* is
+ outside that range.
+
+ Note that on narrow Unicode builds, the result is a string of
+ length two for *i* greater than 65,535 (0xFFFF in hexadecimal).
+
.. function:: classmethod(function)
@@ -811,14 +815,14 @@ are always available. They are listed here in alphabetical order.
.. XXX works for bytes too, but should it?
.. function:: ord(c)
- Given a string of length one, return an integer representing the Unicode code
- point of the character. For example, ``ord('a')`` returns the integer ``97``
+ Given a string representing one Uncicode character, return an integer
+ representing the Unicode code
+ point of that character. For example, ``ord('a')`` returns the integer ``97``
and ``ord('\u2020')`` returns ``8224``. This is the inverse of :func:`chr`.
- If the argument length is not one, a :exc:`TypeError` will be raised. (If
- Python was built with UCS2 Unicode, then the character's code point must be
- in the range [0..65535] inclusive; otherwise the string length is two!)
-
+ On wide Unicode builds, if the argument length is not one, a
+ :exc:`TypeError` will be raised. On narrow Unicode builds, strings
+ of length two are accepted when they form a UTF-16 surrogate pair.
.. function:: pow(x, y[, z])