tags
TAGS
.gdb_history
+Doc/tools/sphinx
+Doc/tools/jinja
+Doc/tools/pygments
+Doc/tools/docutils
Modules/Setup
Modules/Setup.config
Modules/Setup.local
Modules/config.c
Parser/pgen
-Lib/plat-mac/errors.rsrc.df.rsrc
Lib/lib2to3/Grammar*.pickle
Lib/lib2to3/PatternGrammar*.pickle
The typical Python prompt of the interactive shell when entering code for
an indented code block.
+ 2to3
+ A tool that tries to convert Python 2.x code to Python 3.x code by
+ handling most of the incompatibilites that can be detected by parsing the
+ source and traversing the parse tree.
+
+ 2to3 is available in the standard library as :mod:`lib2to3`; a standalone
+ entry point is provided as :file:`Tools/scripts/2to3`. See
+ :ref:`2to3-reference`.
+
abstract base class
Abstract Base Classes (abbreviated ABCs) complement :term:`duck-typing` by
providing a way to define interfaces when other techniques like :func:`hasattr`
--- /dev/null
+.. _2to3-reference:
+
+2to3 - Automated Python 2 to 3 code translation
+===============================================
+
+.. sectionauthor:: Benjamin Peterson
+
+2to3 is a Python program that reads your Python 2.x source code and applies a
+series of *fixers* to transform it into valid Python 3.x code.
+
+
+Using 2to3
+----------
+
+2to3 can be run with a list of files to transform or a directory to recursively
+traverse looking for files with the ``.py`` extension.
+
+Here is a sample Python 2.x source file, :file:`example.py`::
+
+ def greet(name):
+ print "Hello, {0}!".format(name)
+ print "What's your name?"
+ name = raw_input()
+ greet(name)
+
+It can be converted to Python 3.x code via 2to3 on the command line::
+
+ $ 2to3 example.py
+
+A diff against the original source file will be printed. 2to3 can also write
+the needed modifications right back to the source file. (A backup of the
+original file will also be made.) This is done with the :option:`-w` flag::
+
+ $ 2to3 -w example.py
+
+:file:`example.py` will now look like this::
+
+ def greet(name):
+ print("Hello, {0}!".format(name))
+ print("What's your name?")
+ name = input()
+ greet(name)
+
+Comments and and exact indentation will be preserved throughout the translation
+process.
+
+By default, 2to3 will run a set of predefined fixers. The :option:`-l` flag
+lists all avaible fixers. An explicit set of fixers to run can be given by use
+of the :option:`-f` flag. The following example runs only the ``imports`` and
+``has_key`` fixers::
+
+ $ 2to3 -f imports -f has_key example.py
+
+Some fixers are *explicit*, meaning they aren't run be default and must be
+listed on the command line. Here, in addition to the default fixers, the
+``idioms`` fixer is run::
+
+ $ 2to3 -f all -f idioms example.py
+
+Notice how ``all`` enables all default fixers.
+
+Sometimes 2to3 will find will find a place in your source code that needs to be
+changed, but 2to3 cannot fix automatically. In this case, 2to3 will print a
+warning beneath the diff for a file.
+
+
+:mod:`lib2to3` - 2to3's library
+-------------------------------
+
+.. module:: lib2to3
+ :synopsis: the 2to3 library
+.. moduleauthor:: Guido van Rossum
+.. moduleauthor:: Collin Winter
+
+.. XXX What is the public interface anyway?
:mod:`pydoc` module takes a module and generates documentation based on the
module's contents. The :mod:`doctest` and :mod:`unittest` modules contains
frameworks for writing unit tests that automatically exercise code and verify
-that the expected output is produced.
+that the expected output is produced. :program:`2to3` can translate Python 2.x
+source code into valid Python 3.x code.
The list of modules described in this chapter is:
pydoc.rst
doctest.rst
unittest.rst
+ 2to3.rst
test.rst
.. method:: get_payload([i[, decode]])
- Return a reference the current payload, which will be a list of
+ Return the current payload, which will be a list of
:class:`Message` objects when :meth:`is_multipart` is ``True``, or a
string when :meth:`is_multipart` is ``False``. If the payload is a list
and you mutate the list object, you modify the message's payload in place.
except IndexError:
pass
- If one of the iterables is potentially infinite, then the :func:`zip_longest`
- function should be wrapped with something that limits the number of calls (for
- example :func:`islice` or :func:`takewhile`).
+ If one of the iterables is potentially infinite, then the
+ :func:`izip_longest` function should be wrapped with something that limits
+ the number of calls (for example :func:`islice` or :func:`takewhile`). If
+ not specified, *fillvalue* defaults to ``None``.
.. function:: permutations(iterable[, r])
ABC that can describe an existing type or class, or if you want
to declare that some third-party class implements an ABC.
For example, if you defined a :class:`PrintableType` ABC,
-it's legal to do:
+it's legal to do::
# Register Python's types
PrintableType.register(int)
__all__ = ["Shelf","BsdDbShelf","DbfilenameShelf","open"]
+class _ClosedDict(collections.MutableMapping):
+ 'Marker for a closed dict. Access attempts raise a ValueError.'
+
+ def closed(self, *args):
+ raise ValueError('invalid operation on closed shelf')
+ __iter__ = __len__ = __getitem__ = __setitem__ = __delitem__ = keys = closed
+
+ def __repr__(self):
+ return '<Closed Dictionary>'
+
class Shelf(collections.MutableMapping):
"""Base class for shelf implementations.
self.dict.close()
except AttributeError:
pass
- self.dict = 0
+ self.dict = _ClosedDict()
def __del__(self):
if not hasattr(self, 'writeback'):
RobotTest(7, doc, good, bad)
+# From Google: http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=40364
+
+# 8.
+doc = """
+User-agent: Googlebot
+Allow: /folder1/myfile.html
+Disallow: /folder1/
+"""
+
+good = ['/folder1/myfile.html']
+bad = ['/folder1/anotherfile.html']
+
+RobotTest(8, doc, good, bad, agent="Googlebot")
+
+# 9. This file is incorrect because "Googlebot" is a substring of
+# "Googlebot-Mobile", so test 10 works just like test 9.
+doc = """
+User-agent: Googlebot
+Disallow: /
+
+User-agent: Googlebot-Mobile
+Allow: /
+"""
+
+good = []
+bad = ['/something.jpg']
+
+RobotTest(9, doc, good, bad, agent="Googlebot")
+
+good = []
+bad = ['/something.jpg']
+
+RobotTest(10, doc, good, bad, agent="Googlebot-Mobile")
+
+# 11. Get the order correct.
+doc = """
+User-agent: Googlebot-Mobile
+Allow: /
+
+User-agent: Googlebot
+Disallow: /
+"""
+
+good = []
+bad = ['/something.jpg']
+
+RobotTest(11, doc, good, bad, agent="Googlebot")
+
+good = ['/something.jpg']
+bad = []
+
+RobotTest(12, doc, good, bad, agent="Googlebot-Mobile")
+
+
+# 13. Google also got the order wrong in #8. You need to specify the
+# URLs from more specific to more general.
+doc = """
+User-agent: Googlebot
+Allow: /folder1/myfile.html
+Disallow: /folder1/
+"""
+
+good = ['/folder1/myfile.html']
+bad = ['/folder1/anotherfile.html']
+
+RobotTest(13, doc, good, bad, agent="googlebot")
+
+
+
class NetworkTestCase(unittest.TestCase):
def testPasswordProtectedSite(self):
for f in glob.glob(self.fn+"*"):
support.unlink(f)
+ def test_close(self):
+ d1 = {}
+ s = shelve.Shelf(d1, protocol=2, writeback=False)
+ s['key1'] = [1,2,3,4]
+ self.assertEqual(s['key1'], [1,2,3,4])
+ self.assertEqual(len(s), 1)
+ s.close()
+ self.assertRaises(ValueError, len, s)
+ try:
+ s['key1']
+ except ValueError:
+ pass
+ else:
+ self.fail('Closed shelf should not find a key')
+
def test_ascii_file_shelf(self):
s = shelve.open(self.fn, protocol=0)
try:
We allow that a user-agent: line is not preceded by
one or more blank lines.
"""
+ # states:
+ # 0: start state
+ # 1: saw user-agent line
+ # 2: saw an allow or disallow line
state = 0
entry = Entry()
elif line[0] == "allow":
if state != 0:
entry.rulelines.append(RuleLine(line[1], True))
+ state = 2
if state == 2:
self.entries.append(entry)
#include "Python.h"
-static int
+static Py_ssize_t
internal_bisect_right(PyObject *list, PyObject *item, Py_ssize_t lo, Py_ssize_t hi)
{
PyObject *litem;
bisect_right(PyObject *self, PyObject *args, PyObject *kw)
{
PyObject *list, *item;
- int lo = 0;
- int hi = -1;
- int index;
+ Py_ssize_t lo = 0;
+ Py_ssize_t hi = -1;
+ Py_ssize_t index;
static char *keywords[] = {"a", "x", "lo", "hi", NULL};
- if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|ii:bisect_right",
+ if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|nn:bisect_right",
keywords, &list, &item, &lo, &hi))
return NULL;
index = internal_bisect_right(list, item, lo, hi);
if (index < 0)
return NULL;
- return PyLong_FromLong(index);
+ return PyLong_FromSsize_t(index);
}
PyDoc_STRVAR(bisect_right_doc,
insort_right(PyObject *self, PyObject *args, PyObject *kw)
{
PyObject *list, *item, *result;
- int lo = 0;
- int hi = -1;
- int index;
+ Py_ssize_t lo = 0;
+ Py_ssize_t hi = -1;
+ Py_ssize_t index;
static char *keywords[] = {"a", "x", "lo", "hi", NULL};
- if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|ii:insort_right",
+ if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|nn:insort_right",
keywords, &list, &item, &lo, &hi))
return NULL;
index = internal_bisect_right(list, item, lo, hi);
if (PyList_Insert(list, index, item) < 0)
return NULL;
} else {
- result = PyObject_CallMethod(list, "insert", "iO",
+ result = PyObject_CallMethod(list, "insert", "nO",
index, item);
if (result == NULL)
return NULL;
Optional args lo (default 0) and hi (default len(a)) bound the\n\
slice of a to be searched.\n");
-static int
-internal_bisect_left(PyObject *list, PyObject *item, int lo, int hi)
+static Py_ssize_t
+internal_bisect_left(PyObject *list, PyObject *item, Py_ssize_t lo, Py_ssize_t hi)
{
PyObject *litem;
- int mid, res;
+ Py_ssize_t mid, res;
if (lo < 0) {
PyErr_SetString(PyExc_ValueError, "lo must be non-negative");
bisect_left(PyObject *self, PyObject *args, PyObject *kw)
{
PyObject *list, *item;
- int lo = 0;
- int hi = -1;
- int index;
+ Py_ssize_t lo = 0;
+ Py_ssize_t hi = -1;
+ Py_ssize_t index;
static char *keywords[] = {"a", "x", "lo", "hi", NULL};
- if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|ii:bisect_left",
+ if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|nn:bisect_left",
keywords, &list, &item, &lo, &hi))
return NULL;
index = internal_bisect_left(list, item, lo, hi);
if (index < 0)
return NULL;
- return PyLong_FromLong(index);
+ return PyLong_FromSsize_t(index);
}
PyDoc_STRVAR(bisect_left_doc,
insort_left(PyObject *self, PyObject *args, PyObject *kw)
{
PyObject *list, *item, *result;
- int lo = 0;
- int hi = -1;
- int index;
+ Py_ssize_t lo = 0;
+ Py_ssize_t hi = -1;
+ Py_ssize_t index;
static char *keywords[] = {"a", "x", "lo", "hi", NULL};
- if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|ii:insort_left",
+ if (!PyArg_ParseTupleAndKeywords(args, kw, "OO|nn:insort_left",
keywords, &list, &item, &lo, &hi))
return NULL;
index = internal_bisect_left(list, item, lo, hi);
} block;
#define MAXFREEBLOCKS 10
-static int numfreeblocks = 0;
+static Py_ssize_t numfreeblocks = 0;
static block *freeblocks[MAXFREEBLOCKS];
static block *
-newblock(block *leftlink, block *rightlink, int len) {
+newblock(block *leftlink, block *rightlink, Py_ssize_t len) {
block *b;
- /* To prevent len from overflowing INT_MAX on 64-bit machines, we
+ /* To prevent len from overflowing PY_SSIZE_T_MAX on 64-bit machines, we
* refuse to allocate new blocks if the current len is dangerously
* close. There is some extra margin to prevent spurious arithmetic
* overflows at various places. The following check ensures that
* the blocks allocated to the deque, in the worst case, can only
- * have INT_MAX-2 entries in total.
+ * have PY_SSIZE_T_MAX-2 entries in total.
*/
- if (len >= INT_MAX - 2*BLOCKLEN) {
+ if (len >= PY_SSIZE_T_MAX - 2*BLOCKLEN) {
PyErr_SetString(PyExc_OverflowError,
"cannot add more blocks to the deque");
return NULL;
PyObject_HEAD
block *leftblock;
block *rightblock;
- int leftindex; /* in range(BLOCKLEN) */
- int rightindex; /* in range(BLOCKLEN) */
- int len;
- int maxlen;
+ Py_ssize_t leftindex; /* in range(BLOCKLEN) */
+ Py_ssize_t rightindex; /* in range(BLOCKLEN) */
+ Py_ssize_t len;
+ Py_ssize_t maxlen;
long state; /* incremented whenever the indices move */
PyObject *weakreflist; /* List of weak references */
} dequeobject;
static int
_deque_rotate(dequeobject *deque, Py_ssize_t n)
{
- int i, len=deque->len, halflen=(len+1)>>1;
+ Py_ssize_t i, len=deque->len, halflen=(len+1)>>1;
PyObject *item, *rv;
if (len == 0)
static PyObject *
deque_rotate(dequeobject *deque, PyObject *args)
{
- int n=1;
+ Py_ssize_t n=1;
- if (!PyArg_ParseTuple(args, "|i:rotate", &n))
+ if (!PyArg_ParseTuple(args, "|n:rotate", &n))
return NULL;
if (_deque_rotate(deque, n) == 0)
Py_RETURN_NONE;
}
static PyObject *
-deque_item(dequeobject *deque, int i)
+deque_item(dequeobject *deque, Py_ssize_t i)
{
block *b;
PyObject *item;
- int n, index=i;
+ Py_ssize_t n, index=i;
if (i < 0 || i >= deque->len) {
PyErr_SetString(PyExc_IndexError,
{
block *b;
PyObject *item;
- int index;
- int indexlo = deque->leftindex;
+ Py_ssize_t index;
+ Py_ssize_t indexlo = deque->leftindex;
for (b = deque->leftblock; b != NULL; b = b->rightlink) {
- const int indexhi = b == deque->rightblock ?
+ const Py_ssize_t indexhi = b == deque->rightblock ?
deque->rightindex :
BLOCKLEN - 1;
if (deque->maxlen == -1)
result = Py_BuildValue("O(O)", Py_TYPE(deque), aslist);
else
- result = Py_BuildValue("O(Oi)", Py_TYPE(deque), aslist, deque->maxlen);
+ result = Py_BuildValue("O(On)", Py_TYPE(deque), aslist, deque->maxlen);
} else {
if (deque->maxlen == -1)
result = Py_BuildValue("O(OO)O", Py_TYPE(deque), aslist, Py_None, dict);
else
- result = Py_BuildValue("O(Oi)O", Py_TYPE(deque), aslist, deque->maxlen, dict);
+ result = Py_BuildValue("O(On)O", Py_TYPE(deque), aslist, deque->maxlen, dict);
}
Py_XDECREF(dict);
Py_DECREF(aslist);
deque_richcompare(PyObject *v, PyObject *w, int op)
{
PyObject *it1=NULL, *it2=NULL, *x, *y;
- int b, vs, ws, cmp=-1;
+ Py_ssize_t vs, ws;
+ int b, cmp=-1;
if (!PyObject_TypeCheck(v, &deque_type) ||
!PyObject_TypeCheck(w, &deque_type)) {
{
PyObject *iterable = NULL;
PyObject *maxlenobj = NULL;
- int maxlen = -1;
+ Py_ssize_t maxlen = -1;
char *kwlist[] = {"iterable", "maxlen", 0};
if (!PyArg_ParseTupleAndKeywords(args, kwdargs, "|OO:deque", kwlist, &iterable, &maxlenobj))
return -1;
if (maxlenobj != NULL && maxlenobj != Py_None) {
- maxlen = PyLong_AsLong(maxlenobj);
+ maxlen = PyLong_AsSsize_t(maxlenobj);
if (maxlen == -1 && PyErr_Occurred())
return -1;
if (maxlen < 0) {
typedef struct {
PyObject_HEAD
- int index;
+ Py_ssize_t index;
block *b;
dequeobject *deque;
long state; /* state when the iterator is created */
- int counter; /* number of items remaining for iteration */
+ Py_ssize_t counter; /* number of items remaining for iteration */
} dequeiterobject;
static PyTypeObject dequeiter_type;
Py_DECREF(en);
return NULL;
}
+ assert(PyLong_Check(start));
en->en_index = PyLong_AsSsize_t(start);
if (en->en_index == -1 && PyErr_Occurred()) {
PyErr_Clear();
projects / python / commitdiff