Discussion:
[Python-3000-checkins] r67237 - in python/branches/py3k: Doc/conf.py Doc/documenting/index.rst Doc/documenting/markup.rst Doc/documenting/rest.rst Doc/documenting/sphinx.rst Doc/documenting/style.rst Doc/library/http.client.rst Doc/library/locale.rst Doc/library/multiprocessing.rst Lib/http/client.py Lib/string.py Modules/posixmodule.c configure configure.in
benjamin.peterson
2008-11-16 18:33:54 UTC
Permalink
Author: benjamin.peterson
Date: Sun Nov 16 19:33:53 2008
New Revision: 67237

Log:
Merged revisions 67154,67157-67159,67175-67176,67189,67224-67227,67234 via svnmerge from
svn+ssh://pythondev at svn.python.org/python/trunk

........
r67154 | hirokazu.yamamoto | 2008-11-07 21:46:17 -0600 (Fri, 07 Nov 2008) | 1 line

Issue #4071: ntpath.abspath returned an empty string for long unicode path.
........
r67157 | georg.brandl | 2008-11-08 05:47:44 -0600 (Sat, 08 Nov 2008) | 2 lines

Don't use "HOWTO" as the title for all howto .tex files.
........
r67158 | georg.brandl | 2008-11-08 05:48:20 -0600 (Sat, 08 Nov 2008) | 2 lines

Update "Documenting" a bit. Concentrate on Python-specifics.
........
r67159 | georg.brandl | 2008-11-08 06:52:25 -0600 (Sat, 08 Nov 2008) | 2 lines

Fix warning.
........
r67175 | benjamin.peterson | 2008-11-08 19:44:32 -0600 (Sat, 08 Nov 2008) | 1 line

update link
........
r67176 | benjamin.peterson | 2008-11-08 19:52:32 -0600 (Sat, 08 Nov 2008) | 1 line

fix comment
........
r67189 | benjamin.peterson | 2008-11-11 15:56:06 -0600 (Tue, 11 Nov 2008) | 1 line

use correct name
........
r67224 | georg.brandl | 2008-11-15 02:10:04 -0600 (Sat, 15 Nov 2008) | 2 lines

#4324: fix getlocale() argument.
........
r67225 | brett.cannon | 2008-11-15 16:33:25 -0600 (Sat, 15 Nov 2008) | 1 line

Clarify the docs for the 'strict' argument to httplib.HTTPConnection.
........
r67226 | brett.cannon | 2008-11-15 16:40:44 -0600 (Sat, 15 Nov 2008) | 4 lines

The docs for httplib.HTTPConnection.putheader() have claimed for quite a while
that their could be an arbitrary number of values passed in. Turns out the code
did not match that. The code now matches the docs.
........
r67227 | georg.brandl | 2008-11-16 02:00:17 -0600 (Sun, 16 Nov 2008) | 2 lines

#4316: fix configure.in markup problem.
........
r67234 | benjamin.peterson | 2008-11-16 11:54:55 -0600 (Sun, 16 Nov 2008) | 1 line

run autoconf
........


Removed:
python/branches/py3k/Doc/documenting/sphinx.rst
Modified:
python/branches/py3k/ (props changed)
python/branches/py3k/Doc/conf.py
python/branches/py3k/Doc/documenting/index.rst
python/branches/py3k/Doc/documenting/markup.rst
python/branches/py3k/Doc/documenting/rest.rst
python/branches/py3k/Doc/documenting/style.rst
python/branches/py3k/Doc/library/http.client.rst
python/branches/py3k/Doc/library/locale.rst
python/branches/py3k/Doc/library/multiprocessing.rst
python/branches/py3k/Lib/http/client.py
python/branches/py3k/Lib/string.py
python/branches/py3k/Modules/posixmodule.c
python/branches/py3k/configure
python/branches/py3k/configure.in

Modified: python/branches/py3k/Doc/conf.py
==============================================================================
--- python/branches/py3k/Doc/conf.py (original)
+++ python/branches/py3k/Doc/conf.py Sun Nov 16 19:33:53 2008
@@ -131,7 +131,7 @@
]
# Collect all HOWTOs individually
latex_documents.extend(('howto/' + fn[:-4], 'howto-' + fn[:-4] + '.tex',
- 'HOWTO', _stdauthor, 'howto')
+ '', _stdauthor, 'howto')
for fn in os.listdir('howto')
if fn.endswith('.rst') and fn != 'index.rst')


Modified: python/branches/py3k/Doc/documenting/index.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/index.rst (original)
+++ python/branches/py3k/Doc/documenting/index.rst Sun Nov 16 19:33:53 2008
@@ -8,7 +8,7 @@
The Python language has a substantial body of documentation, much of it
contributed by various authors. The markup used for the Python documentation is
`reStructuredText`_, developed by the `docutils`_ project, amended by custom
-directives and using a toolset named *Sphinx* to postprocess the HTML output.
+directives and using a toolset named `Sphinx`_ to postprocess the HTML output.

This document describes the style guide for our documentation, the custom
reStructuredText markup introduced to support Python documentation and how it
@@ -16,6 +16,7 @@

.. _reStructuredText: http://docutils.sf.net/rst.html
.. _docutils: http://docutils.sf.net/
+.. _Sphinx: http://sphinx.pocoo.org/

If you're interested in contributing to Python's documentation, there's no need
to write reStructuredText if you're not so inclined; plain text contributions
@@ -28,7 +29,3 @@
rest.rst
markup.rst
fromlatex.rst
- sphinx.rst
-
-.. XXX add credits, thanks etc.
-

Modified: python/branches/py3k/Doc/documenting/markup.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/markup.rst (original)
+++ python/branches/py3k/Doc/documenting/markup.rst Sun Nov 16 19:33:53 2008
@@ -8,24 +8,11 @@
Documentation for "standard" reST constructs is not included here, though
they are used in the Python documentation.

-File-wide metadata
-------------------
-
-reST has the concept of "field lists"; these are a sequence of fields marked up
-like this::
-
- :Field name: Field content
-
-A field list at the very top of a file is parsed as the "docinfo", which in
-normal documents can be used to record the author, date of publication and
-other metadata. In Sphinx, the docinfo is used as metadata, too, but not
-displayed in the output.
-
-At the moment, only one metadata field is recognized:
+.. note::

-``nocomments``
- If set, the web application won't display a comment form for a page generated
- from this source file.
+ This is just an overview of Sphinx' extended markup capabilities; full
+ coverage can be found in `its own documentation
+ <http://sphinx.pocoo.org/contents.html>`_.


Meta-information markup
@@ -88,7 +75,6 @@
authors of the module code, just like ``sectionauthor`` names the author(s)
of a piece of documentation. It too does not result in any output currently.

-
.. note::

It is important to make the section title of a module-describing file
@@ -272,7 +258,7 @@
This language is used until the next ``highlightlang`` directive is
encountered.

-* The valid values for the highlighting language are:
+* The values normally used for the highlighting language are:

* ``python`` (the default)
* ``c``
@@ -799,7 +785,7 @@
-------------

The documentation system provides three substitutions that are defined by default.
-They are set in the build configuration file, see :ref:`doc-build-config`.
+They are set in the build configuration file :file:`conf.py`.

.. describe:: |release|


Modified: python/branches/py3k/Doc/documenting/rest.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/rest.rst (original)
+++ python/branches/py3k/Doc/documenting/rest.rst Sun Nov 16 19:33:53 2008
@@ -67,12 +67,6 @@
#. This is a numbered list.
#. It has two items too.

-Note that Sphinx disables the use of enumerated lists introduced by alphabetic
-or roman numerals, such as ::
-
- A. First item
- B. Second item
-

Nested lists are possible, but be aware that they must be separated from the
parent list items by blank lines::
@@ -247,5 +241,3 @@
* **Separation of inline markup:** As said above, inline markup spans must be
separated from the surrounding text by non-word characters, you have to use
an escaped space to get around that.
-
-.. XXX more?

Deleted: python/branches/py3k/Doc/documenting/sphinx.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/sphinx.rst Sun Nov 16 19:33:53 2008
+++ (empty file)
@@ -1,76 +0,0 @@
-.. highlightlang:: rest
-
-The Sphinx build system
-=======================
-
-.. XXX: intro...
-
-.. _doc-build-config:
-
-The build configuration file
-----------------------------
-
-The documentation root, that is the ``Doc`` subdirectory of the source
-distribution, contains a file named ``conf.py``. This file is called the "build
-configuration file", and it contains several variables that are read and used
-during a build run.
-
-These variables are:
-
-version : string
- A string that is used as a replacement for the ``|version|`` reST
- substitution. It should be the Python version the documentation refers to.
- This consists only of the major and minor version parts, e.g. ``2.5``, even
- for version 2.5.1.
-
-release : string
- A string that is used as a replacement for the ``|release|`` reST
- substitution. It should be the full version string including
- alpha/beta/release candidate tags, e.g. ``2.5.2b3``.
-
-Both ``release`` and ``version`` can be ``'auto'``, which means that they are
-determined at runtime from the ``Include/patchlevel.h`` file, if a complete
-Python source distribution can be found, or else from the interpreter running
-Sphinx.
-
-today_fmt : string
- A ``strftime`` format that is used to format a replacement for the
- ``|today|`` reST substitution.
-
-today : string
- A string that can contain a date that should be written to the documentation
- output literally. If this is nonzero, it is used instead of
- ``strftime(today_fmt)``.
-
-unused_files : list of strings
- A list of reST filenames that are to be disregarded during building. This
- could be docs for temporarily disabled modules or documentation that's not
- yet ready for public consumption.
-
-add_function_parentheses : bool
- If true, ``()`` will be appended to the content of ``:func:``, ``:meth:`` and
- ``:cfunc:`` cross-references.
-
-add_module_names : bool
- If true, the current module name will be prepended to all description unit
- titles (such as ``.. function::``).
-
-Builder-specific variables
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-html_download_base_url : string
- The base URL for download links on the download page.
-
-html_last_updated_fmt : string
- If this is not an empty string, it will be given to ``time.strftime()`` and
- written to each generated output file after "last updated on:".
-
-html_use_smartypants : bool
- If true, use SmartyPants to convert quotes and dashes to the typographically
- correct entities.
-
-latex_paper_size : "letter" or "a4"
- The paper size option for the LaTeX document class.
-
-latex_font_size : "10pt", "11pt" or "12pt"
- The font size option for the LaTeX document class.
\ No newline at end of file

Modified: python/branches/py3k/Doc/documenting/style.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/style.rst (original)
+++ python/branches/py3k/Doc/documenting/style.rst Sun Nov 16 19:33:53 2008
@@ -66,5 +66,5 @@
1970s.


-.. _Apple Publications Style Guide: http://developer.apple.com/documentation/UserExperience/Conceptual/APStyleGuide/AppleStyleGuide2006.pdf
+.. _Apple Publications Style Guide: http://developer.apple.com/documentation/UserExperience/Conceptual/APStyleGuide/APSG_2008.pdf


Modified: python/branches/py3k/Doc/library/http.client.rst
==============================================================================
--- python/branches/py3k/Doc/library/http.client.rst (original)
+++ python/branches/py3k/Doc/library/http.client.rst Sun Nov 16 19:33:53 2008
@@ -29,7 +29,8 @@
server. It should be instantiated passing it a host and optional port
number. If no port number is passed, the port is extracted from the host
string if it has the form ``host:port``, else the default HTTP port (80) is
- used. When True, the optional parameter *strict* causes ``BadStatusLine`` to
+ used. When True, the optional parameter *strict* (which defaults to a false
+ value) causes ``BadStatusLine`` to
be raised if the status line can't be parsed as a valid HTTP/1.0 or 1.1
status line. If the optional *timeout* parameter is given, blocking
operations (like connection attempts) will timeout after that many seconds

Modified: python/branches/py3k/Doc/library/locale.rst
==============================================================================
--- python/branches/py3k/Doc/library/locale.rst (original)
+++ python/branches/py3k/Doc/library/locale.rst Sun Nov 16 19:33:53 2008
@@ -472,7 +472,7 @@
import locale
- >>> loc = locale.getlocale(locale.LC_ALL) # get current locale
+ >>> loc = locale.getlocale() # get current locale
locale.setlocale(locale.LC_ALL, 'de_DE') # use German locale; name might vary with platform
locale.strcoll('f\xe4n', 'foo') # compare a string containing an umlaut
locale.setlocale(locale.LC_ALL, '') # use user's preferred locale
Modified: python/branches/py3k/Doc/library/multiprocessing.rst
==============================================================================
--- python/branches/py3k/Doc/library/multiprocessing.rst (original)
+++ python/branches/py3k/Doc/library/multiprocessing.rst Sun Nov 16 19:33:53 2008
@@ -1780,7 +1780,7 @@
import multiprocessing, logging
- >>> logger = multiprocessing.getLogger()
+ >>> logger = multiprocessing.get_logger()
logger.setLevel(logging.INFO)
logger.warning('doomed')
[WARNING/MainProcess] doomed

Modified: python/branches/py3k/Lib/http/client.py
==============================================================================
--- python/branches/py3k/Lib/http/client.py (original)
+++ python/branches/py3k/Lib/http/client.py Sun Nov 16 19:33:53 2008
@@ -812,7 +812,7 @@
# For HTTP/1.0, the server will assume "not chunked"
pass

- def putheader(self, header, value):
+ def putheader(self, header, *values):
"""Send a request header line to the server.

For example: h.putheader('Accept', 'text/html')
@@ -822,8 +822,11 @@

if hasattr(header, 'encode'):
header = header.encode('ascii')
- if hasattr(value, 'encode'):
- value = value.encode('ascii')
+ values = list(values)
+ for i, one_value in enumerate(values):
+ if hasattr(one_value, 'encode'):
+ values[i] = one_value.encode('ascii')
+ value = b'\r\n\t'.join(values)
header = header + b': ' + value
self._output(header)


Modified: python/branches/py3k/Lib/string.py
==============================================================================
--- python/branches/py3k/Lib/string.py (original)
+++ python/branches/py3k/Lib/string.py Sun Nov 16 19:33:53 2008
@@ -189,9 +189,8 @@
# the Formatter class
# see PEP 3101 for details and purpose of this class

-# The hard parts are reused from the C implementation. They're
-# exposed here via the sys module. sys was chosen because it's always
-# available and doesn't have to be dynamically loaded.
+# The hard parts are reused from the C implementation. They're exposed as "_"
+# prefixed methods of str and unicode.

# The overall parser is implemented in str._formatter_parser.
# The field name parser is implemented in str._formatter_field_name_split

Modified: python/branches/py3k/Modules/posixmodule.c
==============================================================================
--- python/branches/py3k/Modules/posixmodule.c (original)
+++ python/branches/py3k/Modules/posixmodule.c Sun Nov 16 19:33:53 2008
@@ -2395,13 +2395,27 @@
if (unicode_file_names()) {
PyUnicodeObject *po;
if (PyArg_ParseTuple(args, "U|:_getfullpathname", &po)) {
- Py_UNICODE woutbuf[MAX_PATH*2];
+ Py_UNICODE *wpath = PyUnicode_AS_UNICODE(po);
+ Py_UNICODE woutbuf[MAX_PATH*2], *woutbufp = woutbuf;
Py_UNICODE *wtemp;
- if (!GetFullPathNameW(PyUnicode_AS_UNICODE(po),
- sizeof(woutbuf)/sizeof(woutbuf[0]),
- woutbuf, &wtemp))
- return win32_error("GetFullPathName", "");
- return PyUnicode_FromUnicode(woutbuf, wcslen(woutbuf));
+ DWORD result;
+ PyObject *v;
+ result = GetFullPathNameW(wpath,
+ sizeof(woutbuf)/sizeof(woutbuf[0]),
+ woutbuf, &wtemp);
+ if (result > sizeof(woutbuf)/sizeof(woutbuf[0])) {
+ woutbufp = malloc(result * sizeof(Py_UNICODE));
+ if (!woutbufp)
+ return PyErr_NoMemory();
+ result = GetFullPathNameW(wpath, result, woutbufp, &wtemp);
+ }
+ if (result)
+ v = PyUnicode_FromUnicode(woutbufp, wcslen(woutbufp));
+ else
+ v = win32_error_unicode("GetFullPathNameW", wpath);
+ if (woutbufp != woutbuf)
+ free(woutbufp);
+ return v;
}
/* Drop the argument parsing error as narrow strings
are also valid. */

Modified: python/branches/py3k/configure
==============================================================================
--- python/branches/py3k/configure (original)
+++ python/branches/py3k/configure Sun Nov 16 19:33:53 2008
@@ -1,5 +1,5 @@
#! /bin/sh
-# From configure.in Revision: 66297 .
+# From configure.in Revision: 67100 .
# Guess values for system-dependent variables and create Makefiles.
# Generated by GNU Autoconf 2.61 for python 3.0.
#
@@ -2083,7 +2083,7 @@
# Defining _XOPEN_SOURCE on NetBSD version prior to the introduction of
# _NETBSD_SOURCE disables certain features (eg. setgroups). Reported by
# Marc Recht
- NetBSD/1.5 | NetBSD/1.5.* | NetBSD/1.6 | NetBSD/1.6.* | NetBSD/1.6A-S)
+ NetBSD/1.5 | NetBSD/1.5.* | NetBSD/1.6 | NetBSD/1.6.* | NetBSD/1.6[A-S])
define_xopen_source=no;;
# On Solaris 2.6, sys/wait.h is inconsistent in the usage
# of union __?sigval. Reported by Stuart Bishop.

Modified: python/branches/py3k/configure.in
==============================================================================
--- python/branches/py3k/configure.in (original)
+++ python/branches/py3k/configure.in Sun Nov 16 19:33:53 2008
@@ -260,7 +260,7 @@
# Defining _XOPEN_SOURCE on NetBSD version prior to the introduction of
# _NETBSD_SOURCE disables certain features (eg. setgroups). Reported by
# Marc Recht
- NetBSD/1.5 | NetBSD/1.5.* | NetBSD/1.6 | NetBSD/1.6.* | NetBSD/1.6[A-S])
+ NetBSD/1.5 | NetBSD/1.5.* | NetBSD/1.6 | NetBSD/1.6.* | NetBSD/1.6@<:@A-S@:>@)
define_xopen_source=no;;
# On Solaris 2.6, sys/wait.h is inconsistent in the usage
# of union __?sigval. Reported by Stuart Bishop.

Loading...