SPHINXOPTS =
PAPER =
SOURCES =
-DISTVERSION =
+DISTVERSION = $(shell $(PYTHON) tools/sphinxext/patchlevel.py)
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
$(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
# archive the HTML
make html
- cp -pPR build/html dist/python$(DISTVERSION)-docs-html
- tar -C dist -cf dist/python$(DISTVERSION)-docs-html.tar python$(DISTVERSION)-docs-html
- bzip2 -9 -k dist/python$(DISTVERSION)-docs-html.tar
- (cd dist; zip -q -r -9 python$(DISTVERSION)-docs-html.zip python$(DISTVERSION)-docs-html)
- rm -r dist/python$(DISTVERSION)-docs-html
- rm dist/python$(DISTVERSION)-docs-html.tar
+ cp -pPR build/html dist/python-$(DISTVERSION)-docs-html
+ tar -C dist -cf dist/python-$(DISTVERSION)-docs-html.tar python-$(DISTVERSION)-docs-html
+ bzip2 -9 -k dist/python-$(DISTVERSION)-docs-html.tar
+ (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-html.zip python-$(DISTVERSION)-docs-html)
+ rm -r dist/python-$(DISTVERSION)-docs-html
+ rm dist/python-$(DISTVERSION)-docs-html.tar
# archive the text build
make text
- cp -pPR build/text dist/python$(DISTVERSION)-docs-text
- tar -C dist -cf dist/python$(DISTVERSION)-docs-text.tar python$(DISTVERSION)-docs-text
- bzip2 -9 -k dist/python$(DISTVERSION)-docs-text.tar
- (cd dist; zip -q -r -9 python$(DISTVERSION)-docs-text.zip python$(DISTVERSION)-docs-text)
- rm -r dist/python$(DISTVERSION)-docs-text
- rm dist/python$(DISTVERSION)-docs-text.tar
+ cp -pPR build/text dist/python-$(DISTVERSION)-docs-text
+ tar -C dist -cf dist/python-$(DISTVERSION)-docs-text.tar python-$(DISTVERSION)-docs-text
+ bzip2 -9 -k dist/python-$(DISTVERSION)-docs-text.tar
+ (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-text.zip python-$(DISTVERSION)-docs-text)
+ rm -r dist/python-$(DISTVERSION)-docs-text
+ rm dist/python-$(DISTVERSION)-docs-text.tar
# archive the A4 latex
-rm -r build/latex
make latex PAPER=a4
(cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
- cp build/latex/docs-pdf.zip dist/python$(DISTVERSION)-docs-pdf-a4.zip
- cp build/latex/docs-pdf.tar.bz2 dist/python$(DISTVERSION)-docs-pdf-a4.tar.bz2
+ cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-a4.zip
+ cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-a4.tar.bz2
# archive the letter latex
rm -r build/latex
make latex PAPER=letter
(cd build/latex; make clean && make all-pdf && make FMT=pdf zip bz2)
- cp build/latex/docs-pdf.zip dist/python$(DISTVERSION)-docs-pdf-letter.zip
- cp build/latex/docs-pdf.tar.bz2 dist/python$(DISTVERSION)-docs-pdf-letter.tar.bz2
+ cp build/latex/docs-pdf.zip dist/python-$(DISTVERSION)-docs-pdf-letter.zip
+ cp build/latex/docs-pdf.tar.bz2 dist/python-$(DISTVERSION)-docs-pdf-letter.tar.bz2
svn co http://svn.python.org/projects/doctools/trunk/sphinx tools/sphinx
-Then, you need to install Docutils 0.4 (the SVN snapshot won't work), either
-by checking it out via ::
+Then, you need to install Docutils, either by checking it out via ::
svn co http://svn.python.org/projects/external/docutils-0.4/docutils tools/docutils
python tools/sphinx-build.py -b<builder> . build/<outputdirectory>
-where `<builder>` is one of html, web or htmlhelp (for explanations see the make
-targets above).
+where `<builder>` is one of html, text, latex, or htmlhelp (for explanations see
+the make targets above).
Contributing
============
-For bugs in the content, the online version at http://docs.python.org/ has a
-"suggest change" facility that can be used to correct errors in the source text
-and submit them as a patch to the maintainers.
+Bugs in the content should be reported to the Python bug tracker at
+http://bugs.python.org.
-Bugs in the toolset should be reported in the Python bug tracker at
-http://bugs.python.org/.
+Bugs in the toolset should be reported in the Sphinx bug tracker at
+http://www.bitbucket.org/birkenfeld/sphinx/issues/.
You can also send a mail to the Python Documentation Team at docs@python.org,
and we will process your request as soon as possible.
``;``
The list of format units ends here; the string after the semicolon is used as
- the error message *instead* of the default error message. Clearly, ``:`` and
- ``;`` mutually exclude each other.
+ the error message *instead* of the default error message. ``:`` and ``;``
+ mutually exclude each other.
Note that any Python object references which are provided to the caller are
*borrowed* references; do not decrement their reference count!
Source Definition). Historically, most, but not all, Python releases have also
been GPL-compatible; the table below summarizes the various releases.
+<<<<<<< .working
+----------------+--------------+------------+------------+-----------------+
| Release | Derived from | Year | Owner | GPL compatible? |
+================+==============+============+============+=================+
+----------------+--------------+------------+------------+-----------------+
| 2.6 | 2.5 | 2008 | PSF | yes |
+----------------+--------------+------------+------------+-----------------+
+| 2.6.1 | 2.6 | 2008 | PSF | yes |
++----------------+--------------+------------+------------+-----------------+
| 3.0 | 2.6 | 2008 | PSF | yes |
+----------------+--------------+------------+------------+-----------------+
+
.. note::
GPL-compatible doesn't mean that we're distributing Python under the GPL. All
+++ /dev/null
-# -*- coding: utf-8 -*-
-"""
- Sphinx - Python documentation webserver
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- :copyright: 2007 by Georg Brandl.
- :license: Python license.
-"""
-
-import sys
-
-if __name__ == '__main__':
- from sphinx.web import main
- sys.exit(main(sys.argv))
<table class="docutils">
<tr><th>Format</th><th>Packed as .zip</th><th>Packed as .tar.bz2</th></tr>
<tr><td>PDF (US-Letter paper size)</td>
- <td><a href="{{ dlbase }}/python-docs-pdf-letter.zip">Download</a> (ca. 8 MB)</td>
- <td><a href="{{ dlbase }}/python-docs-pdf-letter.tar.bz2">Download</a> (ca. 8 MB)</td>
+ <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-letter.zip">Download</a> (ca. 8 MB)</td>
+ <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-letter.tar.bz2">Download</a> (ca. 8 MB)</td>
</tr>
<tr><td>PDF (A4 paper size)</td>
- <td><a href="{{ dlbase }}/python-docs-pdf-a4.zip">Download</a> (ca. 8 MB)</td>
- <td><a href="{{ dlbase }}/python-docs-pdf-a4.tar.bz2">Download</a> (ca. 8 MB)</td>
+ <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-a4.zip">Download</a> (ca. 8 MB)</td>
+ <td><a href="{{ dlbase }}/python-{{ release }}-docs-pdf-a4.tar.bz2">Download</a> (ca. 8 MB)</td>
</tr>
<tr><td>HTML</td>
- <td><a href="{{ dlbase }}/python-docs-html.zip">Download</a> (ca. 6 MB)</td>
- <td><a href="{{ dlbase }}/python-docs-html.tar.bz2">Download</a> (ca. 4 MB)</td>
+ <td><a href="{{ dlbase }}/python-{{ release }}-docs-html.zip">Download</a> (ca. 6 MB)</td>
+ <td><a href="{{ dlbase }}/python-{{ release }}-docs-html.tar.bz2">Download</a> (ca. 4 MB)</td>
</tr>
<tr><td>Plain Text</td>
<td><a href="{{ dlbase }}/python-docs-text.zip">Download</a> (ca. 2 MB)</td>
- <td><a href="{{ dlbase }}/python-docs-text.tar.bz2">Download</a> (ca. 1.5 MB)</td>
+ <td><a href="{{ dlbase }}/python-{{ release }}-docs-text.tar.bz2">Download</a> (ca. 1.5 MB)</td>
</tr>
</table>
... pass # Busy-wait for keyboard interrupt (Ctrl+C)
...
-This is commonly used for creating minimal classes such as exceptions, or
-for ignoring unwanted exceptions::
+This is commonly used for creating minimal classes::
- >>> class ParserError(Exception):
+ >>> class MyEmptyClass:
... pass
- ...
- >>> try:
- ... import audioop
- ... except ImportError:
- ... pass
- ...
+ ...
Another place :keyword:`pass` can be used is as a place-holder for a function or
-conditional body when you are working on new code, allowing you to keep
-thinking at a more abstract level. However, as :keyword:`pass` is silently
-ignored, a better choice may be to raise a :exc:`NotImplementedError`
-exception::
+conditional body when you are working on new code, allowing you to keep thinking
+at a more abstract level. The :keyword:`pass` is silently ignored::
>>> def initlog(*args):
- ... raise NotImplementedError # Open logfile if not already open
- ... if not logfp:
- ... raise NotImplementedError # Set up dummy log back-end
- ... raise NotImplementedError('Call log initialization handler')
+ ... pass # Remember to implement this!
...
-If :keyword:`pass` were used here and you later ran tests, they may fail
-without indicating why. Using :exc:`NotImplementedError` causes this code
-to raise an exception, telling you exactly where the incomplete code
-is. Note the two calling styles of the exceptions above.
-The first style, with no message but with an accompanying comment,
-lets you easily leave the comment when you remove the exception,
-which ideally would be a good description for
-the block of code the exception is a placeholder for. However, the
-third example, providing a message for the exception, will produce
-a more useful traceback.
-
.. _tut-functions:
Defining Functions
Vim and Emacs are excellent editors which support Python very well. For more
information on how to code in python in these editors, look at:
-http://www.vim.org/scripts/script.php?script_id=790
-http://sourceforge.net/projects/python-mode
+* http://www.vim.org/scripts/script.php?script_id=790
+* http://sourceforge.net/projects/python-mode
Geany is an excellent IDE with support for a lot of languages. For more
information, read: http://geany.uvena.de/
# get the user's login info
choices = '1 2 3 4'.split()
while choice not in choices:
- print('''We need to know who you are, so please choose either:
+ self.announce('''\
+We need to know who you are, so please choose either:
1. use your existing login,
2. register as a new user,
3. have the server generate a new password for you (and email it to you), or
4. quit
-Your selection [default 1]: ''', end=' ')
- choice = input()
+Your selection [default 1]: ''', log.INFO)
+ choice = raw_input()
if not choice:
choice = '1'
elif choice not in choices:
# send the info to the server and report the result
code, result = self.post_to_server(self.build_post_data('submit'),
auth)
- print('Server response (%s): %s'%(code, result))
+ self.announce('Server response (%s): %s' % (code, result),
+ log.INFO)
# possibly save the login
if not self.has_config and code == 200:
- print('I can store your PyPI login so future submissions will be faster.')
- print('(the login will be stored in %s)' % self._get_rc_file())
+ self.announce(('I can store your PyPI login so future '
+ 'submissions will be faster.'), log.INFO)
+ self.announce('(the login will be stored in %s)' % \
+ self._get_rc_file(), log.INFO)
+
choice = 'X'
while choice.lower() not in 'yn':
choice = input('Save your login (y/N)?')
from distutils.cmd import Command
DEFAULT_PYPIRC = """\
-[pypirc]
-servers =
+[distutils]
+index-servers =
pypi
[pypi]
from distutils.core import PyPIRCCommand
from distutils.core import Distribution
+from distutils.log import set_threshold
+from distutils.log import WARN
from distutils.tests import support
password:secret
"""
+WANTED = """\
+[distutils]
+index-servers =
+ pypi
+
+[pypi]
+username:tarek
+password:xxx
+"""
+
+
class PyPIRCCommandTestCase(support.TempdirManager, unittest.TestCase):
def setUp(self):
finalize_options = initialize_options
self._cmd = command
+ self.old_threshold = set_threshold(WARN)
def tearDown(self):
"""Removes the patch."""
os.environ['HOME'] = self._old_home
if os.path.exists(self.rc):
os.remove(self.rc)
+ set_threshold(self.old_threshold)
def test_server_registration(self):
# This test makes sure PyPIRCCommand knows how to:
('server', 'server-login'), ('username', 'tarek')]
self.assertEquals(config, waited)
+ def test_server_empty_registration(self):
+
+ cmd = self._cmd(self.dist)
+ rc = cmd._get_rc_file()
+ self.assert_(not os.path.exists(rc))
+
+ cmd._store_pypirc('tarek', 'xxx')
+
+ self.assert_(os.path.exists(rc))
+ content = open(rc).read()
+
+ self.assertEquals(content, WANTED)
+
+
def test_suite():
return unittest.makeSuite(PyPIRCCommandTestCase)
--- /dev/null
+"""Tests for distutils.command.register."""
+import sys
+import os
+import unittest
+
+from distutils.command.register import register
+from distutils.core import Distribution
+
+from distutils.tests import support
+from distutils.tests.test_config import PYPIRC, PyPIRCCommandTestCase
+
+class RawInputs(object):
+ """Fakes user inputs."""
+ def __init__(self, *answers):
+ self.answers = answers
+ self.index = 0
+
+ def __call__(self, prompt=''):
+ try:
+ return self.answers[self.index]
+ finally:
+ self.index += 1
+
+WANTED_PYPIRC = """\
+[distutils]
+index-servers =
+ pypi
+
+[pypi]
+username:tarek
+password:xxx
+"""
+
+class registerTestCase(PyPIRCCommandTestCase):
+
+ def test_create_pypirc(self):
+ # this test makes sure a .pypirc file
+ # is created when requested.
+
+ # let's create a fake distribution
+ # and a register instance
+ dist = Distribution()
+ dist.metadata.url = 'xxx'
+ dist.metadata.author = 'xxx'
+ dist.metadata.author_email = 'xxx'
+ dist.metadata.name = 'xxx'
+ dist.metadata.version = 'xxx'
+ cmd = register(dist)
+
+ # we shouldn't have a .pypirc file yet
+ self.assert_(not os.path.exists(self.rc))
+
+ # patching raw_input and getpass.getpass
+ # so register gets happy
+ #
+ # Here's what we are faking :
+ # use your existing login (choice 1.)
+ # Username : 'tarek'
+ # Password : 'xxx'
+ # Save your login (y/N)? : 'y'
+ inputs = RawInputs('1', 'tarek', 'y')
+ from distutils.command import register as register_module
+ register_module.raw_input = inputs.__call__
+ def _getpass(prompt):
+ return 'xxx'
+ register_module.getpass.getpass = _getpass
+ class FakeServer(object):
+ def __init__(self):
+ self.calls = []
+
+ def __call__(self, *args):
+ # we want to compare them, so let's store
+ # something comparable
+ els = args[0].items()
+ els.sort()
+ self.calls.append(tuple(els))
+ return 200, 'OK'
+
+ cmd.post_to_server = pypi_server = FakeServer()
+
+ # let's run the command
+ cmd.run()
+
+ # we should have a brand new .pypirc file
+ self.assert_(os.path.exists(self.rc))
+
+ # with the content similar to WANTED_PYPIRC
+ content = open(self.rc).read()
+ self.assertEquals(content, WANTED_PYPIRC)
+
+ # now let's make sure the .pypirc file generated
+ # really works : we shouldn't be asked anything
+ # if we run the command again
+ def _no_way(prompt=''):
+ raise AssertionError(prompt)
+ register_module.raw_input = _no_way
+
+ cmd.run()
+
+ # let's see what the server received : we should
+ # have 2 similar requests
+ self.assert_(len(pypi_server.calls), 2)
+ self.assert_(pypi_server.calls[0], pypi_server.calls[1])
+
+def test_suite():
+ return unittest.makeSuite(registerTestCase)
+
+if __name__ == "__main__":
+ unittest.main(defaultTest="test_suite")
@property
def closed(self):
- return self.writer.closed()
+ return self.writer.closed
class BufferedRandom(BufferedWriter, BufferedReader):
# Actually write the new file
super(StdoutRefactoringTool, self).write_file(new_text,
filename, old_text)
- shutil.copymode(filename, backup)
+ if not self.nobackups:
+ shutil.copymode(filename, backup)
def print_output(self, lines):
for line in lines:
self.assertRaises(ValueError, self.loads, buf)
def test_unicode(self):
- endcases = ['', '<\\u>', '<\\\u1234>', '<\n>', '<\\>',
- '<\\\U00012345>']
+ endcases = [u'', u'<\\u>', u'<\\\u1234>', u'<\n>',
+ u'<\\>', u'<\\\U00012345>']
for proto in protocols:
for u in endcases:
p = self.dumps(u, proto)
r = MockRawIO(())
w = MockRawIO()
pair = io.BufferedRWPair(r, w)
+ self.assertFalse(pair.closed)
- # XXX need implementation
+ # XXX More Tests
class BufferedRandomTest(unittest.TestCase):
Permissions History
-------------------
+- Tarek Ziadé as given SVN access on Decmeber 21 2008 by NCN,
+ for maintenance of distutils.
+
- Hirokazu Yamamoto was given SVN access on August 12 2008 by MvL,
for contributions to the Windows build.
Py_RETURN_NONE;
}
+static volatile int x;
+
/* Test the u and u# codes for PyArg_ParseTuple. May leak memory in case
of an error.
*/
/* issue4122: Undefined reference to _Py_ascii_whitespace on Windows */
/* Just use the macro and check that it compiles */
x = Py_UNICODE_ISSPACE(25);
- x = x;
tuple = PyTuple_New(1);
if (tuple == NULL)
Py_RETURN_NONE;
}
+static PyObject *
+test_empty_argparse(PyObject *self)
+{
+ /* Test that formats can begin with '|'. See issue #4720. */
+ PyObject *tuple, *dict = NULL;
+ static char *kwlist[] = {NULL};
+ int result;
+ tuple = PyTuple_New(0);
+ if (!tuple)
+ return NULL;
+ if ((result = PyArg_ParseTuple(tuple, "|:test_empty_argparse")) < 0)
+ goto done;
+ dict = PyDict_New();
+ if (!dict)
+ goto done;
+ result = PyArg_ParseTupleAndKeywords(tuple, dict, "|:test_empty_argparse", kwlist);
+ done:
+ Py_DECREF(tuple);
+ Py_XDECREF(dict);
+ if (result < 0)
+ return NULL;
+ else {
+ Py_RETURN_NONE;
+ }
+}
+
static PyObject *
codec_incrementalencoder(PyObject *self, PyObject *args)
{
{"test_long_api", (PyCFunction)test_long_api, METH_NOARGS},
{"test_long_numbits", (PyCFunction)test_long_numbits, METH_NOARGS},
{"test_k_code", (PyCFunction)test_k_code, METH_NOARGS},
+ {"test_empty_argparse", (PyCFunction)test_empty_argparse,METH_NOARGS},
{"test_null_strings", (PyCFunction)test_null_strings, METH_NOARGS},
{"test_string_from_format", (PyCFunction)test_string_from_format, METH_NOARGS},
{"test_with_docstring", (PyCFunction)test_with_docstring, METH_NOARGS,
}
}
- if (!IS_END_OF_FORMAT(*format)) {
+ if (!IS_END_OF_FORMAT(*format) && *format != '|') {
PyErr_Format(PyExc_RuntimeError,
"more argument specifiers than keyword list entries "
"(remaining format:'%s')", format);
projects / python / commitdiff