Mailman 3 August 2007 - Python-checkins

buildbot warnings in amd64 XP trunk
by buildbot＠python.org Aug. 1, 2007

Aug. 1, 2007

The Buildbot has detected a new failure of amd64 XP trunk. Full details are available at: http://www.python.org/dev/buildbot/all/amd64%2520XP%2520trunk/builds/81 Buildbot URL: http://www.python.org/dev/buildbot/all/ Build Reason: Build Source Stamp: [branch trunk] HEAD Blamelist: facundo.batista Build had warnings: warnings test Excerpt from the test logfile: 2 tests failed: test_ctypes test_winsound ====================================================================== ERROR: test_extremes (test.test_winsound.BeepTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "C:\buildbot\trunk.heller-windows-amd64\build\lib\test\test_winsound.py", line 18, in test_extremes winsound.Beep(37, 75) RuntimeError: Failed to beep ====================================================================== ERROR: test_increasingfrequency (test.test_winsound.BeepTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "C:\buildbot\trunk.heller-windows-amd64\build\lib\test\test_winsound.py", line 23, in test_increasingfrequency winsound.Beep(i, 75) RuntimeError: Failed to beep ====================================================================== ERROR: test_alias_asterisk (test.test_winsound.PlaySoundTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "C:\buildbot\trunk.heller-windows-amd64\build\lib\test\test_winsound.py", line 64, in test_alias_asterisk winsound.PlaySound('SystemAsterisk', winsound.SND_ALIAS) RuntimeError: Failed to play sound ====================================================================== ERROR: test_alias_exclamation (test.test_winsound.PlaySoundTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "C:\buildbot\trunk.heller-windows-amd64\build\lib\test\test_winsound.py", line 74, in test_alias_exclamation winsound.PlaySound('SystemExclamation', winsound.SND_ALIAS) RuntimeError: Failed to play sound ====================================================================== ERROR: test_alias_exit (test.test_winsound.PlaySoundTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "C:\buildbot\trunk.heller-windows-amd64\build\lib\test\test_winsound.py", line 84, in test_alias_exit winsound.PlaySound('SystemExit', winsound.SND_ALIAS) RuntimeError: Failed to play sound ====================================================================== ERROR: test_alias_hand (test.test_winsound.PlaySoundTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "C:\buildbot\trunk.heller-windows-amd64\build\lib\test\test_winsound.py", line 94, in test_alias_hand winsound.PlaySound('SystemHand', winsound.SND_ALIAS) RuntimeError: Failed to play sound ====================================================================== ERROR: test_alias_question (test.test_winsound.PlaySoundTest) ---------------------------------------------------------------------- Traceback (most recent call last): File "C:\buildbot\trunk.heller-windows-amd64\build\lib\test\test_winsound.py", line 104, in test_alias_question winsound.PlaySound('SystemQuestion', winsound.SND_ALIAS) RuntimeError: Failed to play sound sincerely, -The Buildbot

1 0

buildbot warnings in PPC64 Debian trunk
by buildbot＠python.org Aug. 1, 2007

Aug. 1, 2007

The Buildbot has detected a new failure of PPC64 Debian trunk. Full details are available at: http://www.python.org/dev/buildbot/all/PPC64%2520Debian%2520trunk/builds/86 Buildbot URL: http://www.python.org/dev/buildbot/all/ Build Reason: Build Source Stamp: [branch trunk] HEAD Blamelist: facundo.batista Build had warnings: warnings test Excerpt from the test logfile: make: *** [buildbottest] Segmentation fault sincerely, -The Buildbot

1 0

r56653 - python/trunk/Lib/test/test_smtplib.py
by facundo.batista Aug. 1, 2007

Aug. 1, 2007

Author: facundo.batista Date: Thu Aug 2 01:18:36 2007 New Revision: 56653 Modified: python/trunk/Lib/test/test_smtplib.py Log: Allow the OS to select a free port for each test server. For DebuggingServerTests, construct SMTP objects with a localhost argument to avoid abysmally long FQDN lookups (not relevant to items under test) on some machines that would cause the test to fail. Moved server setup code in the server function inside the try block to avoid the possibility of setup failure hanging the test. Minor edits to conform to PEP 8. [GSoC - Alan McIntyre] Modified: python/trunk/Lib/test/test_smtplib.py ============================================================================== --- python/trunk/Lib/test/test_smtplib.py (original) +++ python/trunk/Lib/test/test_smtplib.py Thu Aug 2 01:18:36 2007 @@ -11,21 +11,25 @@ from unittest import TestCase from test import test_support +# PORT is used to communicate the port number assigned to the server +# to the test client HOST = "localhost" -PORT = 54328 +PORT = None def server(evt, buf): - serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM) - serv.settimeout(3) - serv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) - serv.bind(("", PORT)) - serv.listen(5) try: + serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + serv.settimeout(3) + serv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) + serv.bind(("", 0)) + global PORT + PORT = serv.getsockname()[1] + serv.listen(5) conn, addr = serv.accept() except socket.timeout: pass else: - n = 200 + n = 500 while buf and n > 0: r, w, e = select.select([], [conn], []) if w: @@ -38,6 +42,7 @@ conn.close() finally: serv.close() + PORT = None evt.set() class GeneralTests(TestCase): @@ -46,7 +51,16 @@ self.evt = threading.Event() servargs = (self.evt, "220 Hola mundo\n") threading.Thread(target=server, args=servargs).start() - time.sleep(.1) + + # wait until server thread has assigned a port number + n = 500 + while PORT is None and n > 0: + time.sleep(0.01) + n -= 1 + + # wait a little longer (sometimes connections are refused + # on slow machines without this additional wait) + time.sleep(0.5) def tearDown(self): self.evt.wait() @@ -69,7 +83,8 @@ def testNonnumericPort(self): # check that non-numeric port raises ValueError - self.assertRaises(socket.error, smtplib.SMTP, "localhost", "bogus") + self.assertRaises(socket.error, smtplib.SMTP, + "localhost", "bogus") def testTimeoutDefault(self): # default @@ -96,61 +111,104 @@ # Test server using smtpd.DebuggingServer -def debugging_server(evt): - serv = smtpd.DebuggingServer(("", PORT), ('nowhere', -1)) +def debugging_server(serv_evt, client_evt): + serv = smtpd.DebuggingServer(("", 0), ('nowhere', -1)) + global PORT + PORT = serv.getsockname()[1] try: - asyncore.loop(timeout=.01, count=300) + if hasattr(select, 'poll'): + poll_fun = asyncore.poll2 + else: + poll_fun = asyncore.poll + + n = 1000 + while asyncore.socket_map and n > 0: + poll_fun(0.01, asyncore.socket_map) + + # when the client conversation is finished, it will + # set client_evt, and it's then ok to kill the server + if client_evt.isSet(): + serv.close() + break + + n -= 1 + except socket.timeout: pass finally: # allow some time for the client to read the result time.sleep(0.5) + serv.close() asyncore.close_all() - evt.set() + PORT = None + time.sleep(0.5) + serv_evt.set() MSG_BEGIN = '---------- MESSAGE FOLLOWS ----------\n' MSG_END = '------------ END MESSAGE ------------\n' # Test behavior of smtpd.DebuggingServer +# NOTE: the SMTP objects are created with a non-default local_hostname +# argument to the constructor, since (on some systems) the FQDN lookup +# caused by the default local_hostname sometimes takes so long that the +# test server times out, causing the test to fail. class DebuggingServerTests(TestCase): def setUp(self): + # temporarily replace sys.stdout to capture DebuggingServer output self.old_stdout = sys.stdout self.output = StringIO.StringIO() sys.stdout = self.output - self.evt = threading.Event() - threading.Thread(target=debugging_server, args=(self.evt,)).start() - time.sleep(.5) + self.serv_evt = threading.Event() + self.client_evt = threading.Event() + serv_args = (self.serv_evt, self.client_evt) + threading.Thread(target=debugging_server, args=serv_args).start() + + # wait until server thread has assigned a port number + n = 500 + while PORT is None and n > 0: + time.sleep(0.01) + n -= 1 + + # wait a little longer (sometimes connections are refused + # on slow machines without this additional wait) + time.sleep(0.5) def tearDown(self): - self.evt.wait() + # indicate that the client is finished + self.client_evt.set() + # wait for the server thread to terminate + self.serv_evt.wait() + # restore sys.stdout sys.stdout = self.old_stdout def testBasic(self): # connect - smtp = smtplib.SMTP(HOST, PORT) - smtp.sock.close() + smtp = smtplib.SMTP(HOST, PORT, local_hostname='localhost', timeout=3) + smtp.quit() def testEHLO(self): - smtp = smtplib.SMTP(HOST, PORT) - self.assertEqual(smtp.ehlo(), (502, 'Error: command "EHLO" not implemented')) - smtp.sock.close() + smtp = smtplib.SMTP(HOST, PORT, local_hostname='localhost', timeout=3) + expected = (502, 'Error: command "EHLO" not implemented') + self.assertEqual(smtp.ehlo(), expected) + smtp.quit() def testHELP(self): - smtp = smtplib.SMTP(HOST, PORT) + smtp = smtplib.SMTP(HOST, PORT, local_hostname='localhost', timeout=3) self.assertEqual(smtp.help(), 'Error: command "HELP" not implemented') - smtp.sock.close() + smtp.quit() def testSend(self): # connect and send mail m = 'A test message' - smtp = smtplib.SMTP(HOST, PORT) + smtp = smtplib.SMTP(HOST, PORT, local_hostname='localhost', timeout=3) smtp.sendmail('John', 'Sally', m) - smtp.sock.close() + smtp.quit() - self.evt.wait() + self.client_evt.set() + self.serv_evt.wait() self.output.flush() mexpect = '%s%s\n%s' % (MSG_BEGIN, m, MSG_END) self.assertEqual(self.output.getvalue(), mexpect) @@ -166,17 +224,28 @@ self.evt = threading.Event() servargs = (self.evt, "199 no hello for you!\n") threading.Thread(target=server, args=servargs).start() - time.sleep(.5) + + # wait until server thread has assigned a port number + n = 500 + while PORT is None and n > 0: + time.sleep(0.01) + n -= 1 + + # wait a little longer (sometimes connections are refused + # on slow machines without this additional wait) + time.sleep(0.5) def tearDown(self): self.evt.wait() sys.stdout = self.old_stdout def testFailingHELO(self): - self.assertRaises(smtplib.SMTPConnectError, smtplib.SMTP, HOST, PORT) + self.assertRaises(smtplib.SMTPConnectError, smtplib.SMTP, + HOST, PORT, 'localhost', 3) def test_main(verbose=None): - test_support.run_unittest(GeneralTests, DebuggingServerTests, BadHELOServerTests) + test_support.run_unittest(GeneralTests, DebuggingServerTests, + BadHELOServerTests) if __name__ == '__main__': test_main()

1 0

r56647 - peps/trunk/pep-3119.txt
by guido.van.rossum Aug. 1, 2007

Aug. 1, 2007

Author: guido.van.rossum Date: Wed Aug 1 19:29:38 2007 New Revision: 56647 Modified: peps/trunk/pep-3119.txt Log: Add @abstractproperty. PEP 3141 needs it for .real, .imag. Modified: peps/trunk/pep-3119.txt ============================================================================== --- peps/trunk/pep-3119.txt (original) +++ peps/trunk/pep-3119.txt Wed Aug 1 19:29:38 2007 @@ -237,8 +237,8 @@ The new standard library module ``abc``, written in pure Python, serves as an ABC support framework. It defines a metaclass -``ABCMeta`` and a decorator ``@abstractmethod``. A sample -implementation is given by [13]_. +``ABCMeta`` and decorators ``@abstractmethod`` and +``@abstractproperty``. A sample implementation is given by [13]_. The ``ABCMeta`` class overrides ``__instancecheck__`` and ``__subclasscheck__`` and defines a ``register`` method. The @@ -340,11 +340,6 @@ affects subclasses derived using regular inheritance; "virtual subclasses" registered with the ``register()`` method are not affected. -It has been suggested that we should also provide a way to define -abstract data attributes. As it is easy to add these in a later -stage, and as the use case is considerably less common (apart from -pure documentation), we punt on this for now. - **Implementation:** The ``@abstractmethod`` decorator sets the function attribute ``__isabstractmethod__`` to the value ``True``. The ``ABCMeta.__new__`` method computes the type attribute @@ -366,6 +361,36 @@ useful as an end-point for a super-call in framework using a cooperative multiple-inheritance [7]_, [8]_. +A second decorator, ``@abstractproperty``, is defined in order to +define abstract data attributes. Its implementation is a subclass of +the built-in ``property`` class that adds an ``__isabstractmethod__`` +attribute:: + + class abstractproperty(property): + __isabstractmethod__ = True + +It can be used in two ways:: + + class C(metaclass=ABCMeta): + + # A read-only property: + + @abstractproperty + def readonly(self): + return self.__x + + # A read-write property (cannot use decorator syntax): + + def getx(self): + return self.__x + def setx(self, value): + self.__x = value + x = abstractproperty(getx, setx) + +A subclass inheriting an abstract property (declared using either the +decorator syntax or the longer form) cannot be instantiated unless it +overrides that abstract property with a concrete property. + ABCs for Containers and Iterators ---------------------------------

1 0

r56646 - peps/trunk/pep-3141.txt
by guido.van.rossum Aug. 1, 2007

Aug. 1, 2007

Author: guido.van.rossum Date: Wed Aug 1 19:11:55 2007 New Revision: 56646 Modified: peps/trunk/pep-3141.txt Log: New version from Jeffrey. Cut NaN. Add __r*__ methods. Other stuff. Modified: peps/trunk/pep-3141.txt ============================================================================== --- peps/trunk/pep-3141.txt (original) +++ peps/trunk/pep-3141.txt Wed Aug 1 19:11:55 2007 @@ -45,30 +45,11 @@ We begin with a Number class to make it easy for people to be fuzzy about what kind of number they expect. This class only helps with -overloading; it doesn't provide any operations. +overloading; it doesn't provide any operations. :: - class Number(metaclass=MetaABC): pass + class Number(metaclass=ABCMeta): pass -Some types (primarily ``float``) define "Not a Number" (NaN) values -that return false for any comparison, including equality with -themselves, and are maintained through operations. That is, ``nan + x --> nan`` and ``nan == nan -> False`` Because this doesn't work well -with the Reals (which are otherwise totally ordered by ``<``), Guido -suggested we might put NaN in its own type. It is conceivable that -this can still be represented by C doubles but be included in a -different ABC at runtime. **Open issue:** Is this a good idea?:: - - class UndefinedNumber(Number): - """Implement IEEE 754 semantics.""" - def __lt__(self, other): return false - def __eq__(self, other): return false - ... - def __add__(self, other): return self - def __radd__(self, other): return self - ... - # Should we demand a conversion to float? - Most implementations of complex numbers will be hashable, but if you need to rely on that, you'll have to check it explicitly: mutable numbers are supported by this hierarchy. :: @@ -76,28 +57,36 @@ class Complex(Number): """Complex defines the operations that work on the builtin complex type. - In short, those are: a conversion to complex, .real, .imag, +, - -, *, /, abs(), .conjugate, ==, and !=. + In short, those are: a conversion to complex, .real, .imag, +, -, + *, /, abs(), .conjugate, ==, and !=. - If it is given heterogenous arguments, and doesn't have - special knowledge about them, it should fall back to the - builtin complex type as described below. + If it is given heterogenous arguments, and doesn't have special + knowledge about them, it should fall back to the builtin complex + type as described below. """ @abstractmethod def __complex__(self): """Return a builtin complex instance.""" - @abstractmethod - @property + def __bool__(self): + """True if self != 0.""" + return self != 0 + + @abstractproperty def real(self): - """Retrieve the real component of this number, which should subclass Real.""" + """Retrieve the real component of this number. + + This should subclass Real. + """ raise NotImplementedError - @abstractmethod - @property + @abstractproperty def imag(self): - """Retrieve the real component of this number, which should subclass Real.""" + """Retrieve the real component of this number. + + This should subclass Real. + """ raise NotImplementedError @abstractmethod @@ -105,22 +94,48 @@ raise NotImplementedError @abstractmethod - def __sub__(self, other): + def __radd__(self, other): raise NotImplementedError @abstractmethod def __neg__(self): raise NotImplementedError + def __pos__(self): + return self + + def __sub__(self, other): + return self + -other + + def __rsub__(self, other): + return -self + other + @abstractmethod def __mul__(self, other): raise NotImplementedError @abstractmethod + def __rmul__(self, other): + raise NotImplementedError + + @abstractmethod def __div__(self, other): raise NotImplementedError @abstractmethod + def __rdiv__(self, other): + raise NotImplementedError + + @abstractmethod + def __pow__(self, exponent): + """Like division, a**b should promote to complex when necessary.""" + raise NotImplementedError + + @abstractmethod + def __rpow__(self, base): + raise NotImplementedError + + @abstractmethod def __abs__(self): """Returns the Real distance from 0.""" raise NotImplementedError @@ -140,7 +155,7 @@ The ``Real`` ABC indicates that the value is on the real line, and supports the operations of the ``float`` builtin. Real numbers are -totally ordered. (NaNs were handled above).:: +totally ordered except for NaNs (which this PEP basically ignores). :: class Real(Complex): """To Complex, Real adds the operations that work on real numbers. @@ -152,38 +167,61 @@ """ @abstractmethod - def __float__(self): - """Any Real can be converted to a native float object.""" + def __float__(self): + """Any Real can be converted to a native float object.""" raise NotImplementedError - + @abstractmethod - def __trunc__(self): - """Returns an Integral of the same sign as self whose abs is <= self's abs.""" + def __trunc__(self): + """Truncates self to an Integral. + + Returns an Integral i such that: + * i>0 iff self>0 + * abs(i) <= abs(self). + """ raise NotImplementedError def __divmod__(self, other): - """The pair (self // other, self % other).""" + """The pair (self // other, self % other). + + Sometimes this can be computed faster than the pair of + operations. + """ return (self // other, self % other) + def __rdivmod__(self, other): + """The pair (self // other, self % other). + + Sometimes this can be computed faster than the pair of + operations. + """ + return (other // self, other % self) + @abstractmethod def __floordiv__(self, other): """The floor() of self/other.""" raise NotImplementedError @abstractmethod + def __rfloordiv__(self, other): + """The floor() of other/self.""" + raise NotImplementedError + + @abstractmethod def __mod__(self, other): - """.""" + raise NotImplementedError + + @abstractmethod + def __rmod__(self, other): raise NotImplementedError @abstractmethod def __lt__(self, other): + """< on Reals defines a total ordering, except perhaps for NaN.""" raise NotImplementedError def __le__(self, other): - # Assume that if other is Real, it defines an ordering - # consistent with this class, or returns NotImplemented. - if isinstance(other, Real): - return not (other < self) + raise NotImplementedError # Concrete implementations of Complex abstract methods. @@ -198,25 +236,28 @@ def imag(self): return 0 + def conjugate(self): + """Conjugate is a no-op for Reals.""" + return self + There is no built-in rational type, but it's straightforward to write, -so we provide an ABC for it. *Open issue*: Add Demo/classes/Rat.py to -the stdlib?:: +so we provide an ABC for it. **Open issue**: Add Demo/classes/Rat.py +to the stdlib? :: class Rational(Real, Exact): """.numerator and .denominator should be in lowest terms.""" - @abstractmethod - @property + @abstractproperty def numerator(self): raise NotImplementedError - @abstractmethod - @property + @abstractproperty def denominator(self): raise NotImplementedError # Concrete implementation of Real's conversion to float. + def __float__(self): return self.numerator / self.denominator @@ -230,26 +271,64 @@ def __int__(self): raise NotImplementedError + def __index__(self): + return int(self) + + @abstractmethod + def __pow__(self, exponent, modulus): + """self ** exponent % modulus, but maybe faster. + + Implement this if you want to support the 3-argument version + of pow(). Otherwise, just implement the 2-argument version + described in Complex. Raise a TypeError if exponent < 0 or any + argument isn't Integral. + """ + raise NotImplementedError + @abstractmethod def __lshift__(self, other): raise NotImplementedError @abstractmethod + def __rlshift__(self, other): + raise NotImplementedError + + @abstractmethod def __rshift__(self, other): raise NotImplementedError @abstractmethod + def __rrshift__(self, other): + raise NotImplementedError + + @abstractmethod def __and__(self, other): raise NotImplementedError @abstractmethod + def __rand__(self, other): + raise NotImplementedError + + @abstractmethod def __xor__(self, other): raise NotImplementedError @abstractmethod + def __rxor__(self, other): + raise NotImplementedError + + @abstractmethod def __or__(self, other): raise NotImplementedError + @abstractmethod + def __ror__(self, other): + raise NotImplementedError + + @abstractmethod + def __invert__(self): + raise NotImplementedError + # Concrete implementations of Rational and Real abstract methods. def __float__(self): @@ -277,12 +356,51 @@ types have this problem. Every instance of ``Integral`` and ``Rational`` should be Exact, but ``Reals`` and ``Complexes`` may or may not be. (Do we really only need one of these, and the other is -defined as ``not`` the first?):: +defined as ``not`` the first?) :: class Exact(Number): pass class Inexact(Number): pass +Changes to operations and __magic__ methods +------------------------------------------- + +To support more precise narrowing from float to int (and more +generally, from Real to Integral), I'm proposing the following new +__magic__ methods, to be called from the corresponding library +functions. All of these return Integrals rather than Reals. + +1. ``__trunc__(self)``, called from a new builtin ``trunc(x)``, which + returns the Integral closest to ``x`` between 0 and ``x``. + +2. ``__floor__(self)``, called from ``math.floor(x)``, which returns + the greatest Integral ``<= x``. + +3. ``__ceil__(self)``, called from ``math.ceil(x)``, which returns the + least Integral ``>= x``. + +4. ``__round__(self)``, called from ``round(x)``, with returns the + Integral closest to ``x``, rounding half toward even. We could + support the 2-argument version, but then we'd only return an + Integral if the second argument were ``<= 0``. + +5. ``__properfraction__(self)``, called from a new function, + ``math.properfraction(x)``, which resembles C's ``modf()``: returns + a pair ``(n:Integral, r:Real)`` where ``x == n + r``, both ``n`` + and ``r`` have the same sign as ``x``, and ``abs(r) < 1``. **Open + issue:** Oh, we already have ``math.modf``. Do we want to keep the + bad name? + +Because the ``int()`` conversion from ``float`` is equivalent to but +less explicit than ``trunc()``, let's remove it. + +``complex.__{divmod,mod,floordiv,int,float}__`` should also go +away. These should continue to raise ``TypeError`` to help confused +porters, but should not appear in ``help(complex)`` to avoid confusing +more people. **Open issue:** This is difficult to do with the +``PyNumberMethods`` struct. What's the best way to accomplish it? + + Notes for type implementors --------------------------- @@ -298,7 +416,7 @@ complex's range or precision. Adding More Numeric ABCs ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ There are, of course, more possible ABCs for numbers, and this would be a poor hierarchy if it precluded the possibility of adding @@ -308,7 +426,7 @@ MyFoo.register(Real) Implementing the arithmetic operations --------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ We want to implement the arithmetic operations so that mixed-mode operations either call an implementation whose author knew about the

1 0

r56645 - in doctools/trunk: TODO converter/newfiles/conf.py converter/newfiles/doc_sphinx.rst sphinx/builder.py sphinx/patchlevel.py sphinx/templates/sidebar.html
by georg.brandl Aug. 1, 2007

Aug. 1, 2007

Author: georg.brandl Date: Wed Aug 1 18:06:45 2007 New Revision: 56645 Added: doctools/trunk/sphinx/patchlevel.py Modified: doctools/trunk/TODO doctools/trunk/converter/newfiles/conf.py doctools/trunk/converter/newfiles/doc_sphinx.rst doctools/trunk/sphinx/builder.py doctools/trunk/sphinx/templates/sidebar.html Log: Automatically get version info from the patchlevel.h file. Modified: doctools/trunk/TODO ============================================================================== --- doctools/trunk/TODO (original) +++ doctools/trunk/TODO Wed Aug 1 18:06:45 2007 @@ -3,7 +3,7 @@ - "often used" combo box in sidebar - discuss and debug comments system -- write new Makefile, handle automatic version info and checkout +- write new Makefile, handle automatic checkout - write a "printable" builder (export to latex, most probably) - discuss lib -> ref section move - prepare for databases other than sqlite for comments Modified: doctools/trunk/converter/newfiles/conf.py ============================================================================== --- doctools/trunk/converter/newfiles/conf.py (original) +++ doctools/trunk/converter/newfiles/conf.py Wed Aug 1 18:06:45 2007 @@ -6,11 +6,17 @@ # that aren't pickleable (module imports are okay, they're removed automatically). # -# The default replacements for |version| and |release|: +# The default replacements for |version| and |release|. +# If 'auto', Sphinx looks for the Include/patchlevel.h file in the current Python +# source tree and replaces the values accordingly. +# # The short X.Y version. -version = '2.6' +# version = '2.6' +version = 'auto' # The full version, including alpha/beta/rc tags. -release = '2.6a0' +# release = '2.6a0' +release = 'auto' + # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: today = '' Modified: doctools/trunk/converter/newfiles/doc_sphinx.rst ============================================================================== --- doctools/trunk/converter/newfiles/doc_sphinx.rst (original) +++ doctools/trunk/converter/newfiles/doc_sphinx.rst Wed Aug 1 18:06:45 2007 @@ -17,17 +17,22 @@ These variables are: -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``. - 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. @@ -37,7 +42,7 @@ output literally. If this is nonzero, it is used instead of ``strftime(today_fmt)``. -unused_file : list of strings +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. Modified: doctools/trunk/sphinx/builder.py ============================================================================== --- doctools/trunk/sphinx/builder.py (original) +++ doctools/trunk/sphinx/builder.py Wed Aug 1 18:06:45 2007 @@ -31,6 +31,7 @@ from .writer import HTMLWriter from .util.console import bold, purple, green from .htmlhelp import build_hhx +from .patchlevel import get_version_info, get_sys_version_info from .environment import BuildEnvironment from .highlighting import pygments, get_stylesheet @@ -96,6 +97,18 @@ for key, val in self.config.items(): if isinstance(val, types.ModuleType): del self.config[key] + # replace version info if 'auto' + if self.config['version'] == 'auto' or self.config['revision'] == 'auto': + try: + version, release = get_version_info(srcdirname) + except (IOError, OSError): + print >>warning_stream, 'WARNING: Can\'t get version info from ' \ + 'Include/patchlevel.h, using version of this interpreter.' + version, release = get_sys_version_info() + if self.config['version'] == 'auto': + self.config['version'] = version + if self.config['release'] == 'auto': + self.config['release'] = release if confoverrides: self.config.update(confoverrides) Added: doctools/trunk/sphinx/patchlevel.py ============================================================================== --- (empty file) +++ doctools/trunk/sphinx/patchlevel.py Wed Aug 1 18:06:45 2007 @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +""" + sphinx.patchlevel + ~~~~~~~~~~~~~~~~~ + + Extract version info from Include/patchlevel.h. + Adapted from Doc/tools/getversioninfo. + + :copyright: 2007 by Georg Brandl. + :license: Python license. +""" +from __future__ import with_statement + +import os +import re +import sys + +def get_version_info(srcdir): + patchlevel_h = os.path.join(srcdir, '..', "Include", "patchlevel.h") + + # This won't pick out all #defines, but it will pick up the ones we + # care about. + rx = re.compile(r"\s*#define\s+([a-zA-Z][a-zA-Z_0-9]*)\s+([a-zA-Z_0-9]+)") + + d = {} + with open(patchlevel_h) as f: + for line in f: + m = rx.match(line) + if m is not None: + name, value = m.group(1, 2) + d[name] = value + + release = version = "%s.%s" % (d["PY_MAJOR_VERSION"], d["PY_MINOR_VERSION"]) + micro = int(d["PY_MICRO_VERSION"]) + if micro != 0: + release += "." + str(micro) + + level = d["PY_RELEASE_LEVEL"] + suffixes = { + "PY_RELEASE_LEVEL_ALPHA": "a", + "PY_RELEASE_LEVEL_BETA": "b", + "PY_RELEASE_LEVEL_GAMMA": "c", + } + if level != "PY_RELEASE_LEVEL_FINAL": + release += suffixes[level] + str(int(d["PY_RELEASE_SERIAL"])) + return version, release + + +def get_sys_version_info(): + major, minor, micro, level, serial = sys.version_info + release = version = '%s.%s' % (major, minor) + if micro: + release += '.%s' % micro + if level != 'final': + release += '%s%s' % (level[0], serial) + return version, release Modified: doctools/trunk/sphinx/templates/sidebar.html ============================================================================== --- doctools/trunk/sphinx/templates/sidebar.html (original) +++ doctools/trunk/sphinx/templates/sidebar.html Wed Aug 1 18:06:45 2007 @@ -23,7 +23,7 @@ {% elif builder == 'html' %} <li><a href="{{ pathto(sourcename, true)|e }}">Show Source</a></li> {% endif %} - <li><a href="http://bugs.python.org/XXX?page={{ sourcename|e }}">Report Bug</a></li> + {# <li><a href="http://bugs.python.org/XXX?page={{ sourcename|e }}">Report Bug</a></li> #} </ul> {% endif %} {% if current_page_name == "index" %}

1 0

r56644 - in doctools/trunk: TODO sphinx/templates/layout.html
by georg.brandl Aug. 1, 2007

Aug. 1, 2007

Author: georg.brandl Date: Wed Aug 1 17:36:52 2007 New Revision: 56644 Modified: doctools/trunk/TODO doctools/trunk/sphinx/templates/layout.html Log: Add a navbar at the bottom too. Modified: doctools/trunk/TODO ============================================================================== --- doctools/trunk/TODO (original) +++ doctools/trunk/TODO Wed Aug 1 17:36:52 2007 @@ -3,10 +3,8 @@ - "often used" combo box in sidebar - discuss and debug comments system -- navigation links at the bottom too - write new Makefile, handle automatic version info and checkout - write a "printable" builder (export to latex, most probably) -- discuss the default role - discuss lib -> ref section move - prepare for databases other than sqlite for comments - look at the old tools/ scripts, what functionality should be rewritten Modified: doctools/trunk/sphinx/templates/layout.html ============================================================================== --- doctools/trunk/sphinx/templates/layout.html (original) +++ doctools/trunk/sphinx/templates/layout.html Wed Aug 1 17:36:52 2007 @@ -42,6 +42,7 @@ {% block head %}{% endblock %} </head> <body> +{% filter capture('relbar') %} <div class="related"> <h3>Navigation</h3> <ul> @@ -63,6 +64,7 @@ {%- endfor %} </ul> </div> +{% endfilter %} <div class="document"> <div class="documentwrapper"> {%- if builder != 'htmlhelp' %} @@ -80,6 +82,7 @@ {%- endif %} <div class="clearer"></div> </div> +{{ relbar }} <div class="footer"> © <a href="{{ pathto('copyright.rst') }}">Copyright</a> 1990-2007, Python Software Foundation.

1 0

r56643 - in doctools/trunk: converter/newfiles/conf.py converter/newfiles/doc_sphinx.rst converter/util.py sphinx/roles.py
by georg.brandl Aug. 1, 2007

Aug. 1, 2007

Author: georg.brandl Date: Wed Aug 1 17:31:10 2007 New Revision: 56643 Modified: doctools/trunk/converter/newfiles/conf.py doctools/trunk/converter/newfiles/doc_sphinx.rst doctools/trunk/converter/util.py doctools/trunk/sphinx/roles.py Log: Strip parentheses during conversion, add them during build. Modified: doctools/trunk/converter/newfiles/conf.py ============================================================================== --- doctools/trunk/converter/newfiles/conf.py (original) +++ doctools/trunk/converter/newfiles/conf.py Wed Aug 1 17:31:10 2007 @@ -37,5 +37,5 @@ # typographically correct entities. use_smartypants = True -# If true, trailing '()' will be stripped from :func: etc. cross-references. -strip_trailing_parentheses = False +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True Modified: doctools/trunk/converter/newfiles/doc_sphinx.rst ============================================================================== --- doctools/trunk/converter/newfiles/doc_sphinx.rst (original) +++ doctools/trunk/converter/newfiles/doc_sphinx.rst Wed Aug 1 17:31:10 2007 @@ -50,6 +50,6 @@ If true, use SmartyPants to convert quotes and dashes to the typographically correct entities. -strip_trailing_parentheses : bool - If true, trailing parentheses will be stripped from ``:func:`` etc. - crossreferences. \ No newline at end of file +add_function_parentheses : bool + If true, ``()`` will be appended to the content of ``:func:``, ``:meth:`` and + ``:cfunc:`` cross-references. \ No newline at end of file Modified: doctools/trunk/converter/util.py ============================================================================== --- doctools/trunk/converter/util.py (original) +++ doctools/trunk/converter/util.py Wed Aug 1 17:31:10 2007 @@ -70,6 +70,7 @@ wordchars_e = alphanum + u'+`(-' bad_markup_re = re.compile(r'(:[a-zA-Z0-9_-]+:)?(`{1,2})[ ]*(.+?)[ ]*(\2)') quoted_code_re = re.compile(r'\\`(``.+?``)\'') +paren_re = re.compile(r':(func|meth|cfunc):`(.*?)\(\)`') def repair_bad_inline_markup(text): # remove quoting from `\code{x}' @@ -80,6 +81,9 @@ # special: literal backquotes xtext = xtext.replace('``````', '\x02') + # remove () from function markup + xtext = paren_re.sub(r':\1:`\2`', xtext) + ntext = [] lasti = 0 l = len(xtext) Modified: doctools/trunk/sphinx/roles.py ============================================================================== --- doctools/trunk/sphinx/roles.py (original) +++ doctools/trunk/sphinx/roles.py Wed Aug 1 17:31:10 2007 @@ -98,9 +98,9 @@ # 'token' is the default role inside 'productionlist' directives if typ == '': typ = 'token' - if env.config.get('strip_trailing_parentheses', False): - if text[-2:] == '()': - text = text[:-2] + if typ in ('func', 'meth', 'cfunc') and \ + env.config.get('add_function_parentheses', True): + text += '()' pnode = addnodes.pending_xref(rawtext) pnode['reftype'] = typ pnode['reftarget'] = ws_re.sub('', text)

1 0

r56642 - in doctools/trunk: TODO converter/newfiles/doc_markup.rst sphinx/roles.py sphinx/style/default.css
by georg.brandl Aug. 1, 2007

Aug. 1, 2007

Author: georg.brandl Date: Wed Aug 1 16:09:18 2007 New Revision: 56642 Modified: doctools/trunk/TODO doctools/trunk/converter/newfiles/doc_markup.rst doctools/trunk/sphinx/roles.py doctools/trunk/sphinx/style/default.css Log: Make system messages stand out in HTML output. Modified: doctools/trunk/TODO ============================================================================== --- doctools/trunk/TODO (original) +++ doctools/trunk/TODO Wed Aug 1 16:09:18 2007 @@ -1,6 +1,7 @@ Global TODO =========== +- "often used" combo box in sidebar - discuss and debug comments system - navigation links at the bottom too - write new Makefile, handle automatic version info and checkout @@ -11,4 +12,3 @@ - look at the old tools/ scripts, what functionality should be rewritten - add search via Xapian? - optionally have a contents tree view in the sidebar (AJAX based)? - Modified: doctools/trunk/converter/newfiles/doc_markup.rst ============================================================================== --- doctools/trunk/converter/newfiles/doc_markup.rst (original) +++ doctools/trunk/converter/newfiles/doc_markup.rst Wed Aug 1 16:09:18 2007 @@ -362,11 +362,17 @@ .. describe:: envvar - An environment variable. Index entries are generated. + An environment variable. Index entries are generated. .. describe:: file - The name of a file or directory. + The name of a file or directory. Within the contents, you can use curly + braces to indicate a "variable" part, for example:: + + ... is installed in :file:`/usr/lib/python2.{x}/site-packages` ... + + In the built documentation, the ``x`` will be displayed differently to + indicate that it is to be replaced by the Python minor version. .. describe:: guilabel Modified: doctools/trunk/sphinx/roles.py ============================================================================== --- doctools/trunk/sphinx/roles.py (original) +++ doctools/trunk/sphinx/roles.py Wed Aug 1 16:09:18 2007 @@ -21,9 +21,6 @@ generic_docroles = { 'command' : nodes.strong, 'dfn' : nodes.emphasis, - 'file' : nodes.emphasis, - 'filenq' : nodes.emphasis, - 'filevar' : nodes.emphasis, 'guilabel' : nodes.strong, 'kbd' : nodes.literal, 'keyword' : nodes.literal, @@ -114,7 +111,25 @@ def menusel_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): - return [nodes.emphasis(rawtext, text.replace('-->', u'\N{TRIANGULAR BULLET}'))], [] + return [nodes.emphasis( + rawtext, utils.unescape(text).replace('-->', u'\N{TRIANGULAR BULLET}'))], [] + + +_filevar_re = re.compile('{([^}]+)}') + +def file_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): + text = utils.unescape(text) + retnodes = [] + pos = 0 + for m in _filevar_re.finditer(text): + if m.start() > pos: + txt = text[pos:m.start()] + retnodes.append(nodes.literal(txt, txt)) + retnodes.append(nodes.emphasis('', '', nodes.literal(m.group(1), m.group(1)))) + pos = m.end() + if pos < len(text): + retnodes.append(nodes.literal(text[pos:], text[pos:])) + return retnodes, [] specific_docroles = { @@ -137,6 +152,7 @@ 'token' : xfileref_role, 'menuselection' : menusel_role, + 'file' : file_role, } for rolename, func in specific_docroles.iteritems(): Modified: doctools/trunk/sphinx/style/default.css ============================================================================== --- doctools/trunk/sphinx/style/default.css (original) +++ doctools/trunk/sphinx/style/default.css Wed Aug 1 16:09:18 2007 @@ -744,6 +744,12 @@ margin-bottom: 10px; } +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + /* :::: PRINT :::: */ @media print { div.documentwrapper {

1 0

r56641 - in doctools/trunk/converter: filenamemap.py newfiles/TODO newfiles/doc_markup.rst restwriter.py
by georg.brandl Aug. 1, 2007

Aug. 1, 2007

Author: georg.brandl Date: Wed Aug 1 14:46:16 2007 New Revision: 56641 Modified: doctools/trunk/converter/filenamemap.py doctools/trunk/converter/newfiles/TODO doctools/trunk/converter/newfiles/doc_markup.rst doctools/trunk/converter/restwriter.py Log: Get rid of the remaining warnings in the conversion. Modified: doctools/trunk/converter/filenamemap.py ============================================================================== --- doctools/trunk/converter/filenamemap.py (original) +++ doctools/trunk/converter/filenamemap.py Wed Aug 1 14:46:16 2007 @@ -546,6 +546,7 @@ toctree_mapping = { 'mac/scripting': ['gensuitemodule', 'aetools', 'aepack', 'aetypes', 'miniae'], 'mac/toolbox': ['colorpicker'], + 'mac/undoc': [], 'lib/libstrings': ['string', 're', 'struct', 'difflib', 'stringio', 'textwrap', 'codecs', 'unicodedata', 'stringprep', 'fpformat'], 'lib/datatypes': ['datetime', 'calendar', 'collections', 'heapq', 'bisect', @@ -601,6 +602,7 @@ 'lib/libsgi': ['al', 'cd', 'fl', 'fm', 'gl', 'imgfile', 'jpeg'], 'lib/libsun': ['sunaudio'], 'lib/windows': ['msilib', 'msvcrt', '_winreg', 'winsound'], + 'lib/tkinter': [], } # map sourcefilename to [pre, post] Modified: doctools/trunk/converter/newfiles/TODO ============================================================================== --- doctools/trunk/converter/newfiles/TODO (original) +++ doctools/trunk/converter/newfiles/TODO Wed Aug 1 14:46:16 2007 @@ -14,5 +14,5 @@ * write "About these documents" * finish "Documenting Python" * extend copyright.rst -* merge ACKS into about.rst * fix the "quadruple" index term +* fix :file: and |version| in install \ No newline at end of file Modified: doctools/trunk/converter/newfiles/doc_markup.rst ============================================================================== --- doctools/trunk/converter/newfiles/doc_markup.rst (original) +++ doctools/trunk/converter/newfiles/doc_markup.rst Wed Aug 1 14:46:16 2007 @@ -368,8 +368,6 @@ The name of a file or directory. -.. XXX: filenq, filevar - .. describe:: guilabel Labels presented as part of an interactive user interface should be marked Modified: doctools/trunk/converter/restwriter.py ============================================================================== --- doctools/trunk/converter/restwriter.py (original) +++ doctools/trunk/converter/restwriter.py Wed Aug 1 14:46:16 2007 @@ -332,6 +332,8 @@ # loses comments, but huh return EmptyNode() if isinstance(subnode, InlineNode): + if subnode.cmdname in ('filevar', 'envvar'): + return NodeList([TextNode('{'), do(subnode.args[0]), TextNode('}')]) if subnode.cmdname == 'optional': # this is not mapped to ReST markup return subnode @@ -639,7 +641,7 @@ self.write_directive('deprecated', text(node.args[0]), node.args[1], spbelow=False) elif cmdname == 'localmoduletable': - if self.toctree: + if self.toctree is not None: self.write_directive('toctree', '', spbelow=True, spabove=True) with self.indented(): for entry in self.toctree: @@ -830,7 +832,7 @@ # maps argumentless commands to text simplecmd_mapping = { - 'NULL': '`NULL`', + 'NULL': '*NULL*', 'shortversion': '|version|', 'version': '|release|', 'today': '|today|', @@ -848,6 +850,7 @@ 'method': 'meth', 'module': 'mod', 'programopt': 'option', + 'filenq': 'file', # these mean: no change 'cdata': '', 'class': '', @@ -857,8 +860,6 @@ 'dfn': '', 'envvar': '', 'file': '', - 'filenq': '', - 'filevar': '', 'guilabel': '', 'kbd': '', 'keyword': '', @@ -890,7 +891,7 @@ if cmdname in ('code', 'bfcode', 'samp', 'texttt', 'regexp'): self.visit_wrapped('``', self.get_textonly_node(content, 'code', warn=1), '``', noescape=True) - elif cmdname in ('emph', 'textit'): + elif cmdname in ('emph', 'textit', 'var'): self.visit_wrapped('*', self.get_textonly_node(content, 'emph', warn=1), '*') elif cmdname in ('strong', 'textbf'): @@ -898,7 +899,7 @@ warn=1), '**') elif cmdname in ('b', 'textrm', 'email'): self.visit_node(content) - elif cmdname in ('var', 'token'): + elif cmdname == 'token': # \token appears in productionlists only self.visit_wrapped('`', self.get_textonly_node(content, 'var', warn=1), '`') @@ -948,11 +949,13 @@ self.visit_wrapped('(', node.args[1], ')') elif cmdname == 'longprogramopt': self.visit_wrapped(':option:`--', content, '`') + elif cmdname == 'filevar': + self.visit_wrapped(':file:`{', content, '}`') elif cmdname == '': self.visit_node(content) # stray commands from distutils elif cmdname in ('argument name', 'value', 'attribute', 'option name'): - self.visit_wrapped('`', content, '`') + self.visit_wrapped('*', content, '*') else: self.visit_wrapped(':%s:`' % (self.role_mapping[cmdname] or cmdname), self.get_textonly_node(

1 0