# HG changeset patch # Parent db93af6080e7b1ff570b9104dc2439ab93f77b46 Issue #26462: Fix syntax highlighting for code blocks in documentation Patch by Julien. diff -r db93af6080e7 Doc/distutils/examples.rst --- a/Doc/distutils/examples.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/distutils/examples.rst Tue Jul 26 02:34:52 2016 +0000 @@ -245,7 +245,9 @@ setup(name='foobar') -Running the ``check`` command will display some warnings:: +Running the ``check`` command will display some warnings: + +.. code-block:: shell-session $ python setup.py check running check @@ -274,7 +276,9 @@ url='http://example.com', long_description=desc) Where the long description is broken, ``check`` will be able to detect it -by using the :mod:`docutils` parser:: +by using the :mod:`docutils` parser: + +.. code-block:: shell-session $ python setup.py check --restructuredtext running check @@ -286,7 +290,9 @@ The :func:`distutils.core.setup` function provides a command-line interface that allows you to query the metadata fields of a project through the -``setup.py`` script of a given project:: +``setup.py`` script of a given project: + +.. code-block:: shell-session $ python setup.py --name distribute diff -r db93af6080e7 Doc/distutils/packageindex.rst --- a/Doc/distutils/packageindex.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/distutils/packageindex.rst Tue Jul 26 02:34:52 2016 +0000 @@ -233,7 +233,9 @@ To prevent registering broken reStructuredText content, you can use the :program:`rst2html` program that is provided by the :mod:`docutils` package and -check the ``long_description`` from the command line:: +check the ``long_description`` from the command line: + +.. code-block:: shell-session $ python setup.py --long-description | rst2html.py > output.html diff -r db93af6080e7 Doc/distutils/sourcedist.rst --- a/Doc/distutils/sourcedist.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/distutils/sourcedist.rst Tue Jul 26 02:34:52 2016 +0000 @@ -133,7 +133,9 @@ The manifest template has one command per line, where each command specifies a set of files to include or exclude from the source distribution. For an -example, again we turn to the Distutils' own manifest template:: +example, again we turn to the Distutils' own manifest template: + +.. code-block:: none include *.txt recursive-include examples *.txt *.py diff -r db93af6080e7 Doc/extending/building.rst --- a/Doc/extending/building.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/extending/building.rst Tue Jul 26 02:34:52 2016 +0000 @@ -55,7 +55,9 @@ necessarily need a compiler and distutils to install the extension. A distutils package contains a driver script, :file:`setup.py`. This is a plain -Python file, which, in the most simple case, could look like this:: +Python file, which, in the most simple case, could look like this: + +.. code-block:: python3 from distutils.core import setup, Extension @@ -96,7 +98,9 @@ In many cases, building an extension is more complex, since additional preprocessor defines and libraries may be needed. This is demonstrated in the -example below. :: +example below. + +.. code-block:: python3 from distutils.core import setup, Extension @@ -161,4 +165,3 @@ python setup.py bdist_wininst python setup.py bdist_rpm python setup.py bdist_dumb - diff -r db93af6080e7 Doc/extending/embedding.rst --- a/Doc/extending/embedding.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/extending/embedding.rst Tue Jul 26 02:34:52 2016 +0000 @@ -157,7 +157,9 @@ c = c + b return c -then the result should be:: +then the result should be: + +.. code-block:: shell-session $ call multiply multiply 3 2 Will compute 3 times 2 @@ -291,16 +293,20 @@ be directly useful to you: * ``pythonX.Y-config --cflags`` will give you the recommended flags when - compiling:: + compiling: - $ /opt/bin/python3.4-config --cflags - -I/opt/include/python3.4m -I/opt/include/python3.4m -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes + .. code-block:: shell-session + + $ /opt/bin/python3.4-config --cflags + -I/opt/include/python3.4m -I/opt/include/python3.4m -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes * ``pythonX.Y-config --ldflags`` will give you the recommended flags when - linking:: + linking: - $ /opt/bin/python3.4-config --ldflags - -L/opt/lib/python3.4/config-3.4m -lpthread -ldl -lutil -lm -lpython3.4m -Xlinker -export-dynamic + .. code-block:: shell-session + + $ /opt/bin/python3.4-config --ldflags + -L/opt/lib/python3.4/config-3.4m -lpthread -ldl -lutil -lm -lpython3.4m -Xlinker -export-dynamic .. note:: To avoid confusion between several Python installations (and especially diff -r db93af6080e7 Doc/extending/extending.rst --- a/Doc/extending/extending.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/extending/extending.rst Tue Jul 26 02:34:52 2016 +0000 @@ -792,7 +792,9 @@ format unit, it returns whatever object is described by that format unit. To force it to return a tuple of size 0 or one, parenthesize the format string. -Examples (to the left the call, to the right the resulting Python value):: +Examples (to the left the call, to the right the resulting Python value): + +.. code-block:: none Py_BuildValue("") None Py_BuildValue("i", 123) 123 @@ -1348,4 +1350,3 @@ .. [#] These guarantees don't hold when you use the "old" style calling convention --- this is still found in much existing code. - diff -r db93af6080e7 Doc/extending/newtypes.rst --- a/Doc/extending/newtypes.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/extending/newtypes.rst Tue Jul 26 02:34:52 2016 +0000 @@ -209,7 +209,9 @@ setup(name="noddy", version="1.0", ext_modules=[Extension("noddy", ["noddy.c"])]) -in a file called :file:`setup.py`; then typing :: +in a file called :file:`setup.py`; then typing: + +.. code-block:: shell-session $ python setup.py build @@ -1513,4 +1515,3 @@ .. [#] Even in the third version, we aren't guaranteed to avoid cycles. Instances of string subclasses are allowed and string subclasses could allow cycles even if normal strings don't. - diff -r db93af6080e7 Doc/faq/extending.rst --- a/Doc/faq/extending.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/faq/extending.rst Tue Jul 26 02:34:52 2016 +0000 @@ -146,7 +146,9 @@ just allow the standard traceback mechanism to work. Then, the output will go wherever your ``write()`` method sends it. -The easiest way to do this is to use the :class:`io.StringIO` class:: +The easiest way to do this is to use the :class:`io.StringIO` class: + +.. code-block:: pycon >>> import io, sys >>> sys.stdout = io.StringIO() @@ -156,7 +158,9 @@ foo hello world! -A custom object to do the same would look like this:: +A custom object to do the same would look like this: + +.. code-block:: pycon >>> import io, sys >>> class StdoutCatcher(io.TextIOBase): @@ -222,11 +226,15 @@ When using GDB with dynamically loaded extensions, you can't set a breakpoint in your extension until your extension is loaded. -In your ``.gdbinit`` file (or interactively), add the command:: +In your ``.gdbinit`` file (or interactively), add the command: + +.. code-block:: none br _PyImport_LoadDynamicModule -Then, when you run GDB:: +Then, when you run GDB: + +.. code-block:: shell-session $ gdb /local/bin/python gdb) run myscript.py diff -r db93af6080e7 Doc/howto/clinic.rst --- a/Doc/howto/clinic.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/howto/clinic.rst Tue Jul 26 02:34:52 2016 +0000 @@ -152,7 +152,9 @@ For my example I'm using ``_pickle.Pickler.dump()``. 2. If the call to the ``PyArg_Parse`` function uses any of the - following format units:: + following format units: + + .. code-block:: none O& O! diff -r db93af6080e7 Doc/howto/logging-cookbook.rst --- a/Doc/howto/logging-cookbook.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/howto/logging-cookbook.rst Tue Jul 26 02:34:52 2016 +0000 @@ -377,7 +377,9 @@ root.warning('Look out!') listener.stop() -which, when run, will produce:: +which, when run, will produce: + +.. code-block:: none MainThread: Look out! @@ -1860,7 +1862,9 @@ logger = logging.getLogger('mylogger') logger.debug('A debug message') -To run this, you will probably need to run as ``root``:: +To run this, you will probably need to run as ``root``: + +.. code-block:: shell-session $ sudo python3.3 chowntest.py $ cat chowntest.log @@ -2485,7 +2489,9 @@ completion, the status is as it was before so message #6 appears (like message #1) whereas message #7 doesn't (just like message #2). -If we run the resulting script, the result is as follows:: +If we run the resulting script, the result is as follows: + +.. code-block:: shell-session $ python logctx.py 1. This should appear just once on stderr. @@ -2495,12 +2501,16 @@ 6. This should appear just once on stderr. If we run it again, but pipe ``stderr`` to ``/dev/null``, we see the following, -which is the only message written to ``stdout``:: +which is the only message written to ``stdout``: + +.. code-block:: shell-session $ python logctx.py 2>/dev/null 5. This should appear twice - once on stderr and once on stdout. -Once again, but piping ``stdout`` to ``/dev/null``, we get:: +Once again, but piping ``stdout`` to ``/dev/null``, we get: + +.. code-block:: shell-session $ python logctx.py >/dev/null 1. This should appear just once on stderr. diff -r db93af6080e7 Doc/howto/logging.rst --- a/Doc/howto/logging.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/howto/logging.rst Tue Jul 26 02:34:52 2016 +0000 @@ -106,7 +106,9 @@ logging.warning('Watch out!') # will print a message to the console logging.info('I told you so') # will not print anything -If you type these lines into a script and run it, you'll see:: +If you type these lines into a script and run it, you'll see: + +.. code-block:: none WARNING:root:Watch out! @@ -230,7 +232,9 @@ import logging logging.warning('%s before you %s', 'Look', 'leap!') -will display:: +will display: + +.. code-block:: none WARNING:root:Look before you leap! @@ -594,7 +598,9 @@ logger.error('error message') logger.critical('critical message') -Running this module from the command line produces the following output:: +Running this module from the command line produces the following output: + +.. code-block:: shell-session $ python simple_logging_module.py 2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message @@ -653,7 +659,9 @@ format=%(asctime)s - %(name)s - %(levelname)s - %(message)s datefmt= -The output is nearly identical to that of the non-config-file-based example:: +The output is nearly identical to that of the non-config-file-based example: + +.. code-block:: shell-session $ python simple_logging_config.py 2005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message @@ -1073,4 +1081,3 @@ Useful handlers included with the logging module. :ref:`A logging cookbook ` - diff -r db93af6080e7 Doc/howto/regex.rst --- a/Doc/howto/regex.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/howto/regex.rst Tue Jul 26 02:34:52 2016 +0000 @@ -74,7 +74,9 @@ devoted to discussing various metacharacters and what they do. Here's a complete list of the metacharacters; their meanings will be discussed -in the rest of this HOWTO. :: +in the rest of this HOWTO. + +.. code-block:: none . ^ $ * + ? { } [ ] \ | ( ) diff -r db93af6080e7 Doc/howto/unicode.rst --- a/Doc/howto/unicode.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/howto/unicode.rst Tue Jul 26 02:34:52 2016 +0000 @@ -613,7 +613,9 @@ print(os.listdir(b'.')) print(os.listdir('.')) -will produce the following output:: +will produce the following output: + +.. code-block:: shell-session amk:~$ python t.py [b'filename\xe4\x94\x80abc', ...] diff -r db93af6080e7 Doc/library/2to3.rst --- a/Doc/library/2to3.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/2to3.rst Tue Jul 26 02:34:52 2016 +0000 @@ -33,14 +33,18 @@ name = raw_input() greet(name) -It can be converted to Python 3.x code via 2to3 on the command line:: +It can be converted to Python 3.x code via 2to3 on the command line: + +.. code-block:: shell-session $ 2to3 example.py A diff against the original source file is printed. 2to3 can also write the needed modifications right back to the source file. (A backup of the original file is made unless :option:`-n` is also given.) Writing the changes back is -enabled with the :option:`-w` flag:: +enabled with the :option:`-w` flag: + +.. code-block:: shell-session $ 2to3 -w example.py @@ -56,18 +60,24 @@ By default, 2to3 runs a set of :ref:`predefined fixers <2to3-fixers>`. The :option:`-l` flag lists all available fixers. An explicit set of fixers to run -can be given with :option:`-f`. Likewise the :option:`!-x` explicitly disables a -fixer. The following example runs only the ``imports`` and ``has_key`` fixers:: +can be given with :option:`-f`. Likewise the :option:`-x` explicitly disables a +fixer. The following example runs only the ``imports`` and ``has_key`` fixers: + +.. code-block:: shell-session $ 2to3 -f imports -f has_key example.py -This command runs every fixer except the ``apply`` fixer:: +This command runs every fixer except the ``apply`` fixer: + +.. code-block:: shell-session $ 2to3 -x apply example.py Some fixers are *explicit*, meaning they aren't run by default and must be listed on the command line to be run. Here, in addition to the default fixers, -the ``idioms`` fixer is run:: +the ``idioms`` fixer is run: + +.. code-block:: shell-session $ 2to3 -f all -f idioms example.py @@ -113,7 +123,9 @@ The :option:`--add-suffix` option specifies a string to append to all output filenames. The :option:`-n` flag is required when specifying this as backups -are not necessary when writing to different filenames. Example:: +are not necessary when writing to different filenames. Example: + +.. code-block:: shell-session $ 2to3 -n -W --add-suffix=3 example.py @@ -122,7 +134,9 @@ .. versionadded:: 3.2.3 The :option:`--add-suffix` option was added. -To translate an entire project from one directory tree to another use:: +To translate an entire project from one directory tree to another use: + +.. code-block:: shell-session $ 2to3 --output-dir=python3-version/mycode -W -n python2-version/mycode diff -r db93af6080e7 Doc/library/argparse.rst --- a/Doc/library/argparse.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/argparse.rst Tue Jul 26 02:34:52 2016 +0000 @@ -45,7 +45,9 @@ print(args.accumulate(args.integers)) Assuming the Python code above is saved into a file called ``prog.py``, it can -be run at the command line and provides useful help messages:: +be run at the command line and provides useful help messages: + +.. code-block:: shell-session $ python prog.py -h usage: prog.py [-h] [--sum] N [N ...] @@ -60,7 +62,9 @@ --sum sum the integers (default: find the max) When run with the appropriate arguments, it prints either the sum or the max of -the command-line integers:: +the command-line integers: + +.. code-block:: shell-session $ python prog.py 1 2 3 4 4 @@ -68,7 +72,9 @@ $ python prog.py 1 2 3 4 --sum 10 -If invalid arguments are passed in, it will issue an error:: +If invalid arguments are passed in, it will issue an error: + +.. code-block:: shell-session $ python prog.py a b c usage: prog.py [-h] [--sum] N [N ...] @@ -194,7 +200,9 @@ args = parser.parse_args() The help for this program will display ``myprogram.py`` as the program name -(regardless of where the program was invoked from):: +(regardless of where the program was invoked from): + +.. code-block:: shell-session $ python myprogram.py --help usage: myprogram.py [-h] [--foo FOO] @@ -596,7 +604,9 @@ args = parser.parse_args() If ``-h`` or ``--help`` is supplied at the command line, the ArgumentParser -help will be printed:: +help will be printed: + +.. code-block:: shell-session $ python myprogram.py --help usage: myprogram.py [-h] [--foo FOO] diff -r db93af6080e7 Doc/library/ast.rst --- a/Doc/library/ast.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/ast.rst Tue Jul 26 02:34:52 2016 +0000 @@ -99,6 +99,7 @@ The abstract grammar is currently defined as follows: .. literalinclude:: ../../Parser/Python.asdl + :language: none :mod:`ast` Helpers diff -r db93af6080e7 Doc/library/asyncio-dev.rst --- a/Doc/library/asyncio-dev.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/asyncio-dev.rst Tue Jul 26 02:34:52 2016 +0000 @@ -321,14 +321,18 @@ print("Pending tasks at exit: %s" % asyncio.Task.all_tasks(loop)) loop.close() -Expected output:: +Expected output: + +.. code-block:: none (1) create file (2) write into file (3) close file Pending tasks at exit: set() -Actual output:: +Actual output: + +.. code-block:: none (3) close file (2) write into file @@ -369,13 +373,17 @@ If a pending task is destroyed, the execution of its wrapped :ref:`coroutine ` did not complete. It is probably a bug and so a warning is logged. -Example of log:: +Example of log: + +.. code-block:: none Task was destroyed but it is pending! task: wait_for=> :ref:`Enable the debug mode of asyncio ` to get the -traceback where the task was created. Example of log in debug mode:: +traceback where the task was created. Example of log in debug mode: + +.. code-block:: none Task was destroyed but it is pending! source_traceback: Object created at (most recent call last): diff -r db93af6080e7 Doc/library/cgi.rst --- a/Doc/library/cgi.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/cgi.rst Tue Jul 26 02:34:52 2016 +0000 @@ -442,7 +442,9 @@ invoked as a script, the file will dump its environment and the contents of the form in HTML form. Give it the right mode etc, and send it a request. If it's installed in the standard :file:`cgi-bin` directory, it should be possible to -send it a request by entering a URL into your browser of the form:: +send it a request by entering a URL into your browser of the form: + +.. code-block:: none http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home @@ -534,4 +536,3 @@ order the field values should be supplied in, but knowing whether a request was received from a conforming browser, or even from a browser at all, is tedious and error-prone. - diff -r db93af6080e7 Doc/library/cmd.rst --- a/Doc/library/cmd.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/cmd.rst Tue Jul 26 02:34:52 2016 +0000 @@ -314,7 +314,9 @@ Here is a sample session with the turtle shell showing the help functions, using -blank lines to repeat commands, and the simple record and playback facility:: +blank lines to repeat commands, and the simple record and playback facility: + +.. code-block:: none Welcome to the turtle shell. Type help or ? to list commands. @@ -373,4 +375,3 @@ (turtle) bye Thank you for using Turtle - diff -r db93af6080e7 Doc/library/decimal.rst --- a/Doc/library/decimal.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/decimal.rst Tue Jul 26 02:34:52 2016 +0000 @@ -57,6 +57,8 @@ alterable precision (defaulting to 28 places) which can be as large as needed for a given problem: + .. code-block:: pycon + >>> from decimal import * >>> getcontext().prec = 6 >>> Decimal(1) / Decimal(7) @@ -121,7 +123,9 @@ The usual start to using decimals is importing the module, viewing the current context with :func:`getcontext` and, if necessary, setting new values for -precision, rounding, or enabled traps:: +precision, rounding, or enabled traps: + +.. code-block:: pycon >>> from decimal import * >>> getcontext() @@ -135,7 +139,9 @@ Construction from an integer or a float performs an exact conversion of the value of that integer or float. Decimal numbers include special values such as :const:`NaN` which stands for "Not a number", positive and negative -:const:`Infinity`, and :const:`-0`:: +:const:`Infinity`, and :const:`-0`: + +.. code-block:: pycon >>> getcontext().prec = 28 >>> Decimal(10) @@ -157,8 +163,9 @@ If the :exc:`FloatOperation` signal is trapped, accidental mixing of decimals and floats in constructors or ordering comparisons raises -an exception:: - +an exception: + +.. doctest:: >>> c = getcontext() >>> c.traps[FloatOperation] = True >>> Decimal(3.14) @@ -192,7 +199,9 @@ Decimal('5.85988') If the internal limits of the C version are exceeded, constructing -a decimal raises :class:`InvalidOperation`:: +a decimal raises :class:`InvalidOperation`: + +.. code-block:: pycon >>> Decimal("1e9999999999999999999") Traceback (most recent call last): @@ -235,6 +244,7 @@ And some mathematical functions are also available to Decimal: +.. doctest:: >>> getcontext().prec = 28 >>> Decimal(2).sqrt() Decimal('1.414213562373095048801688724') @@ -249,6 +259,8 @@ useful for monetary applications that often round results to a fixed number of places: +.. code-block:: pycon + >>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN) Decimal('7.32') >>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP) @@ -294,7 +306,9 @@ Contexts also have signal flags for monitoring exceptional conditions encountered during computations. The flags remain set until explicitly cleared, so it is best to clear the flags before each set of monitored computations by -using the :meth:`clear_flags` method. :: +using the :meth:`clear_flags` method. + +.. code-block:: pycon >>> setcontext(ExtendedContext) >>> getcontext().clear_flags() @@ -404,7 +418,9 @@ There are some small differences between arithmetic on Decimal objects and arithmetic on integers and floats. When the remainder operator ``%`` is applied to Decimal objects, the sign of the result is the sign of the - *dividend* rather than the sign of the divisor:: + *dividend* rather than the sign of the divisor: + + .. code-block:: pycon >>> (-7) % 4 1 @@ -413,7 +429,9 @@ The integer division operator ``//`` behaves analogously, returning the integer part of the true quotient (truncating towards zero) rather than its - floor, so as to preserve the usual identity ``x == (x // y) * y + x % y``:: + floor, so as to preserve the usual identity ``x == (x // y) * y + x % y``: + + .. code-block:: pycon >>> -7 // 4 -2 @@ -498,6 +516,8 @@ :class:`Decimal` instances with the same numeric value but different representations compare unequal in this ordering: + .. code-block:: pycon + >>> Decimal('12.0').compare_total(Decimal('12')) Decimal('-1') diff -r db93af6080e7 Doc/library/doctest.rst --- a/Doc/library/doctest.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/doctest.rst Tue Jul 26 02:34:52 2016 +0000 @@ -88,14 +88,18 @@ doctest.testmod() If you run :file:`example.py` directly from the command line, :mod:`doctest` -works its magic:: +works its magic: + +.. code-block:: shell-session $ python example.py $ There's no output! That's normal, and it means all the examples worked. Pass ``-v`` to the script, and :mod:`doctest` prints a detailed log of what -it's trying, and prints a summary at the end:: +it's trying, and prints a summary at the end: + +.. code-block:: shell-session $ python example.py -v Trying: @@ -109,7 +113,9 @@ [1, 1, 2, 6, 24, 120] ok -And so on, eventually ending with:: +And so on, eventually ending with: + +.. code-block:: none Trying: factorial(1e100) @@ -196,7 +202,9 @@ That short script executes and verifies any interactive Python examples contained in the file :file:`example.txt`. The file content is treated as if it were a single giant docstring; the file doesn't need to contain a Python -program! For example, perhaps :file:`example.txt` contains this:: +program! For example, perhaps :file:`example.txt` contains this: + +.. code-block:: none The ``example`` module ====================== diff -r db93af6080e7 Doc/library/email-examples.rst --- a/Doc/library/email-examples.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/email-examples.rst Tue Jul 26 02:34:52 2016 +0000 @@ -59,7 +59,9 @@ .. literalinclude:: ../includes/email-read-alternative-new-api.py -Up to the prompt, the output from the above is:: +Up to the prompt, the output from the above is: + +.. code-block:: none To: Penelope Pussycat , Fabrette Pussycat From: Pepé Le Pew diff -r db93af6080e7 Doc/library/html.parser.rst --- a/Doc/library/html.parser.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/html.parser.rst Tue Jul 26 02:34:52 2016 +0000 @@ -61,7 +61,9 @@ parser.feed('Test' '

Parse me!

') -The output will then be:: +The output will then be: + +.. code-block:: none Encountered a start tag: html Encountered a start tag: head diff -r db93af6080e7 Doc/library/idle.rst --- a/Doc/library/idle.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/idle.rst Tue Jul 26 02:34:52 2016 +0000 @@ -524,7 +524,7 @@ Command line usage ^^^^^^^^^^^^^^^^^^ -:: +.. code-block:: none idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ... diff -r db93af6080e7 Doc/library/logging.config.rst --- a/Doc/library/logging.config.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/logging.config.rst Tue Jul 26 02:34:52 2016 +0000 @@ -243,7 +243,9 @@ handler. All *other* keys are passed through as keyword arguments to the - handler's constructor. For example, given the snippet:: + handler's constructor. For example, given the snippet: + + .. code-block:: yaml handlers: console: @@ -352,7 +354,9 @@ configuration to indicate that a connection exists between the source and the destination object with that id. -So, for example, consider the following YAML snippet:: +So, for example, consider the following YAML snippet: + +.. code-block:: yaml formatters: brief: @@ -409,7 +413,9 @@ configuration dictionary and which returns the instantiated object. This is signalled by an absolute import path to the factory being made available under the special key ``'()'``. Here's a concrete -example:: +example: + +.. code-block:: yaml formatters: brief: @@ -626,7 +632,9 @@ :func:`dictConfig`, so it's worth considering transitioning to this newer API when it's convenient to do so. -Examples of these sections in the file are given below. :: +Examples of these sections in the file are given below. : + +.. code-block:: ini [loggers] keys=root,log02,log03,log04,log05,log06,log07 @@ -638,7 +646,9 @@ keys=form01,form02,form03,form04,form05,form06,form07,form08,form09 The root logger must specify a level and a list of handlers. An example of a -root logger section is given below. :: +root logger section is given below. : + +.. code-block:: ini [logger_root] level=NOTSET @@ -655,7 +665,9 @@ file. For loggers other than the root logger, some additional information is required. -This is illustrated by the following example. :: +This is illustrated by the following example. : + +.. code-block:: ini [logger_parser] level=DEBUG @@ -673,7 +685,8 @@ say the name used by the application to get the logger. Sections which specify handler configuration are exemplified by the following. -:: + +.. code-block:: ini [handler_hand01] class=StreamHandler @@ -693,7 +706,9 @@ The ``args`` entry, when :func:`eval`\ uated in the context of the ``logging`` package's namespace, is the list of arguments to the constructor for the handler class. Refer to the constructors for the relevant handlers, or to the examples -below, to see how typical entries are constructed. :: +below, to see how typical entries are constructed. + +.. code-block:: ini [handler_hand02] class=FileHandler @@ -744,7 +759,9 @@ formatter=form09 args=('localhost:9022', '/log', 'GET') -Sections which specify formatter configuration are typified by the following. :: +Sections which specify formatter configuration are typified by the following. + +.. code-block:: ini [formatter_form01] format=F1 %(asctime)s %(levelname)s %(message)s @@ -780,5 +797,3 @@ Module :mod:`logging.handlers` Useful handlers included with the logging module. - - diff -r db93af6080e7 Doc/library/optparse.rst --- a/Doc/library/optparse.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/optparse.rst Tue Jul 26 02:34:52 2016 +0000 @@ -678,7 +678,9 @@ this option on the command line, it expands your ``version`` string (by replacing ``%prog``), prints it to stdout, and exits. -For example, if your script is called ``/usr/bin/foo``:: +For example, if your script is called ``/usr/bin/foo``: + +.. code-block:: shell-session $ /usr/bin/foo --version foo 1.0 @@ -728,14 +730,18 @@ error status 2. Consider the first example above, where the user passes ``4x`` to an option -that takes an integer:: +that takes an integer: + +.. code-block:: shell-session $ /usr/bin/foo -n 4x Usage: foo [options] foo: error: option -n: invalid integer value: '4x' -Or, where the user fails to pass a value at all:: +Or, where the user fails to pass a value at all: + +.. code-block:: shell-session $ /usr/bin/foo -n Usage: foo [options] diff -r db93af6080e7 Doc/library/pickletools.rst --- a/Doc/library/pickletools.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/pickletools.rst Tue Jul 26 02:34:52 2016 +0000 @@ -30,7 +30,9 @@ untrusted source, ``-m pickletools`` is a safer option because it does not execute pickle bytecode. -For example, with a tuple ``(1, 2)`` pickled in file ``x.pickle``:: +For example, with a tuple ``(1, 2)`` pickled in file ``x.pickle``: + +.. code-block:: shell-session $ python -m pickle x.pickle (1, 2) @@ -106,4 +108,3 @@ Returns a new equivalent pickle string after eliminating unused ``PUT`` opcodes. The optimized pickle is shorter, takes less transmission time, requires less storage space, and unpickles more efficiently. - diff -r db93af6080e7 Doc/library/pyexpat.rst --- a/Doc/library/pyexpat.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/pyexpat.rst Tue Jul 26 02:34:52 2016 +0000 @@ -86,7 +86,9 @@ separator. For example, if *namespace_separator* is set to a space character (``' '``) and - the following document is parsed:: + the following document is parsed: + + .. code-block:: xml >> make_archive(archive_name, 'gztar', root_dir) '/Users/tarek/myarchive.tar.gz' -The resulting archive contains:: +The resulting archive contains: + +.. code-block:: shell-session $ tar -tzvf /Users/tarek/myarchive.tar.gz drwx------ tarek/staff 0 2010-02-01 16:23:40 ./ @@ -646,4 +648,3 @@ .. _`Other Environment Variables`: http://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003 - diff -r db93af6080e7 Doc/library/socketserver.rst --- a/Doc/library/socketserver.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/socketserver.rst Tue Jul 26 02:34:52 2016 +0000 @@ -499,7 +499,9 @@ The output of the example should look something like this: -Server:: +Server: + +.. code-block:: shell-session $ python TCPServer.py 127.0.0.1 wrote: @@ -507,7 +509,9 @@ 127.0.0.1 wrote: b'python is nice' -Client:: +Client: + +.. code-block:: shell-session $ python TCPClient.py hello world with TCP Sent: hello world with TCP @@ -619,7 +623,9 @@ server.shutdown() -The output of the example should look something like this:: +The output of the example should look something like this: + +.. code-block:: shell-session $ python ThreadedTCPServer.py Server loop running in thread: Thread-1 diff -r db93af6080e7 Doc/library/subprocess.rst --- a/Doc/library/subprocess.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/subprocess.rst Tue Jul 26 02:34:52 2016 +0000 @@ -954,7 +954,7 @@ Replacing /bin/sh shell backquote ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:: +.. code-block:: python output=`mycmd myarg` # becomes @@ -964,7 +964,7 @@ Replacing shell pipeline ^^^^^^^^^^^^^^^^^^^^^^^^ -:: +.. code-block:: python output=`dmesg | grep hda` # becomes @@ -977,7 +977,9 @@ to receive a SIGPIPE if p2 exits before p1. Alternatively, for trusted input, the shell's own pipeline support may still -be used directly:: +be used directly: + +.. code-block:: python output=`dmesg | grep hda` # becomes diff -r db93af6080e7 Doc/library/sys.rst --- a/Doc/library/sys.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/sys.rst Tue Jul 26 02:34:52 2016 +0000 @@ -1287,7 +1287,9 @@ A dictionary of the various implementation-specific flags passed through the :option:`-X` command-line option. Option names are either mapped to - their values, if given explicitly, or to :const:`True`. Example:: + their values, if given explicitly, or to :const:`True`. Example: + + .. code-block:: shell-session $ ./python -Xa=b -Xc Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50) diff -r db93af6080e7 Doc/library/sysconfig.rst --- a/Doc/library/sysconfig.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/sysconfig.rst Tue Jul 26 02:34:52 2016 +0000 @@ -229,7 +229,9 @@ Using :mod:`sysconfig` as a script ---------------------------------- -You can use :mod:`sysconfig` as a script with Python's *-m* option:: +You can use :mod:`sysconfig` as a script with Python's *-m* option: + +.. code-block:: shell-session $ python -m sysconfig Platform: "macosx-10.4-i386" diff -r db93af6080e7 Doc/library/tarfile.rst --- a/Doc/library/tarfile.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/tarfile.rst Tue Jul 26 02:34:52 2016 +0000 @@ -654,25 +654,35 @@ with tar archives. If you want to create a new tar archive, specify its name after the :option:`-c` -option and then list the filename(s) that should be included:: +option and then list the filename(s) that should be included: + +.. code-block:: shell-session $ python -m tarfile -c monty.tar spam.txt eggs.txt -Passing a directory is also acceptable:: +Passing a directory is also acceptable: + +.. code-block:: shell-session $ python -m tarfile -c monty.tar life-of-brian_1979/ If you want to extract a tar archive into the current directory, use -the :option:`-e` option:: +the :option:`-e` option: + +.. code-block:: shell-session $ python -m tarfile -e monty.tar You can also extract a tar archive into a different directory by passing the -directory's name:: +directory's name: + +.. code-block:: shell-session $ python -m tarfile -e monty.tar other-dir/ -For a list of the files in a tar archive, use the :option:`-l` option:: +For a list of the files in a tar archive, use the :option:`-l` option: + +.. code-block:: shell-session $ python -m tarfile -l monty.tar diff -r db93af6080e7 Doc/library/zipimport.rst --- a/Doc/library/zipimport.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/library/zipimport.rst Tue Jul 26 02:34:52 2016 +0000 @@ -147,7 +147,9 @@ -------- Here is an example that imports a module from a ZIP archive - note that the -:mod:`zipimport` module is not explicitly used. :: +:mod:`zipimport` module is not explicitly used. + +.. code-block:: shell-session $ unzip -l example.zip Archive: example.zip diff -r db93af6080e7 Doc/reference/expressions.rst --- a/Doc/reference/expressions.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/reference/expressions.rst Tue Jul 26 02:34:52 2016 +0000 @@ -1406,7 +1406,9 @@ Lambda expressions (sometimes called lambda forms) are used to create anonymous functions. The expression ``lambda arguments: expression`` yields a function -object. The unnamed object behaves like a function object defined with :: +object. The unnamed object behaves like a function object defined with: + +.. code-block:: none def (arguments): return expression diff -r db93af6080e7 Doc/reference/lexical_analysis.rst --- a/Doc/reference/lexical_analysis.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/reference/lexical_analysis.rst Tue Jul 26 02:34:52 2016 +0000 @@ -794,7 +794,10 @@ .. index:: single: operators -The following tokens are operators:: +The following tokens are operators: + +.. code-block:: none + + - * ** / // % @ << >> & | ^ ~ @@ -808,7 +811,9 @@ .. index:: single: delimiters -The following tokens serve as delimiters in the grammar:: +The following tokens serve as delimiters in the grammar: + +.. code-block:: none ( ) [ ] { } , : . ; @ = -> @@ -821,12 +826,16 @@ but also perform an operation. The following printing ASCII characters have special meaning as part of other -tokens or are otherwise significant to the lexical analyzer:: +tokens or are otherwise significant to the lexical analyzer: + +.. code-block:: none ' " # \ The following printing ASCII characters are not used in Python. Their -occurrence outside string literals and comments is an unconditional error:: +occurrence outside string literals and comments is an unconditional error: + +.. code-block:: none $ ? ` diff -r db93af6080e7 Doc/tutorial/controlflow.rst --- a/Doc/tutorial/controlflow.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/tutorial/controlflow.rst Tue Jul 26 02:34:52 2016 +0000 @@ -504,7 +504,9 @@ client="John Cleese", sketch="Cheese Shop Sketch") -and of course it would print:: +and of course it would print: + +.. code-block:: none -- Do you have any Limburger ? -- I'm sorry, we're all out of Limburger diff -r db93af6080e7 Doc/tutorial/interpreter.rst --- a/Doc/tutorial/interpreter.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/tutorial/interpreter.rst Tue Jul 26 02:34:52 2016 +0000 @@ -94,7 +94,9 @@ usually three greater-than signs (``>>>``); for continuation lines it prompts with the *secondary prompt*, by default three dots (``...``). The interpreter prints a welcome message stating its version number and a copyright notice -before printing the first prompt:: +before printing the first prompt: + +.. code-block:: shell-session $ python3.6 Python 3.6 (default, Sep 16 2015, 09:25:04) diff -r db93af6080e7 Doc/tutorial/modules.rst --- a/Doc/tutorial/modules.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/tutorial/modules.rst Tue Jul 26 02:34:52 2016 +0000 @@ -140,7 +140,9 @@ you can make the file usable as a script as well as an importable module, because the code that parses the command line only runs if the module is -executed as the "main" file:: +executed as the "main" file: + +.. code-block:: shell-session $ python fibo.py 50 1 1 2 3 5 8 13 21 34 diff -r db93af6080e7 Doc/whatsnew/2.3.rst --- a/Doc/whatsnew/2.3.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/whatsnew/2.3.rst Tue Jul 26 02:34:52 2016 +0000 @@ -291,7 +291,9 @@ The new :mod:`zipimport` module adds support for importing modules from a ZIP- format archive. You don't need to import the module explicitly; it will be automatically imported if a ZIP archive's filename is added to ``sys.path``. -For example:: +For example: + +.. code-block:: shell-session amk@nyman:~/src/python$ unzip -l /tmp/example.zip Archive: /tmp/example.zip @@ -1761,7 +1763,9 @@ strings containing the remaining arguments. Invoking the script with the various arguments now works as you'd expect it to. -Note that the length argument is automatically converted to an integer. :: +Note that the length argument is automatically converted to an integer. + +.. code-block:: shell-session $ ./python opt.py -i data arg1 @@ -1771,7 +1775,9 @@ [] $ -The help message is automatically generated for you:: +The help message is automatically generated for you: + +.. code-block:: shell-session $ ./python opt.py --help usage: opt.py [options] @@ -2078,4 +2084,3 @@ MacIntyre, Lalo Martins, Chad Netzer, Gustavo Niemeyer, Neal Norwitz, Hans Nowak, Chris Reedy, Francesco Ricciardi, Vinay Sajip, Neil Schemenauer, Roman Suzi, Jason Tishler, Just van Rossum. - diff -r db93af6080e7 Doc/whatsnew/2.4.rst --- a/Doc/whatsnew/2.4.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/whatsnew/2.4.rst Tue Jul 26 02:34:52 2016 +0000 @@ -1425,7 +1425,9 @@ print word Running the above function's tests with :const:`doctest.REPORT_UDIFF` specified, -you get the following output:: +you get the following output: + +.. code-block:: none ********************************************************************** File "t.py", line 15, in g diff -r db93af6080e7 Doc/whatsnew/2.7.rst --- a/Doc/whatsnew/2.7.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/whatsnew/2.7.rst Tue Jul 26 02:34:52 2016 +0000 @@ -2290,7 +2290,9 @@ written in pure Python could cause a segmentation fault by taking a :c:type:`PyCObject` from module A and somehow substituting it for the :c:type:`PyCObject` in module B. Capsules know their own name, -and getting the pointer requires providing the name:: +and getting the pointer requires providing the name: + +.. code-block:: c void *vtable; @@ -2616,4 +2618,3 @@ suggestions, corrections and assistance with various drafts of this article: Nick Coghlan, Philip Jenvey, Ryan Lovett, R. David Murray, Hugh Secker-Walker. - diff -r db93af6080e7 Doc/whatsnew/3.0.rst --- a/Doc/whatsnew/3.0.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/whatsnew/3.0.rst Tue Jul 26 02:34:52 2016 +0000 @@ -117,7 +117,9 @@ print("There are <", 2**32, "> possibilities!", sep="") -which produces:: +which produces: + +.. code-block:: none There are <4294967296> possibilities! diff -r db93af6080e7 Doc/whatsnew/3.2.rst --- a/Doc/whatsnew/3.2.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/whatsnew/3.2.rst Tue Jul 26 02:34:52 2016 +0000 @@ -160,6 +160,8 @@ parser_m.add_argument('-c', '--course', type=int, required=True) parser_m.add_argument('-s', '--speed', type=int, default=0) +.. code-block:: shell-session + $ ./helm.py --help # top level help (launch and move) $ ./helm.py launch --help # help for launch options $ ./helm.py launch --missiles # set missiles=True and torpedos=False @@ -478,7 +480,9 @@ * The interpreter can now be started with a quiet option, ``-q``, to prevent the copyright and version information from being displayed in the interactive - mode. The option can be introspected using the :attr:`sys.flags` attribute:: + mode. The option can be introspected using the :attr:`sys.flags` attribute: + + .. code-block:: shell-session $ python -q >>> sys.flags @@ -573,7 +577,9 @@ by Benjamin Peterson in :issue:`8413`.) * Warnings are now easier to control using the :envvar:`PYTHONWARNINGS` - environment variable as an alternative to using ``-W`` at the command line:: + environment variable as an alternative to using ``-W`` at the command line: + + .. code-block:: shell-session $ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::' @@ -595,7 +601,9 @@ object ensures it closes the underlying operating system resource (usually, a file descriptor), the delay in deallocating the object could produce various issues, especially under Windows. Here is an example - of enabling the warning from the command line:: + of enabling the warning from the command line: + + .. code-block:: shell-session $ python -q -Wdefault >>> f = open("foo", "wb") @@ -1720,7 +1728,9 @@ test discovery can find tests within packages, locating any test importable from the top-level directory. The top-level directory can be specified with the `-t` option, a pattern for matching files with ``-p``, and a directory to - start discovery with ``-s``:: + start discovery with ``-s``: + + .. code-block:: shell-session $ python -m unittest discover -s my_proj_dir -p _test.py @@ -1895,7 +1905,9 @@ The :mod:`pydoc` module now provides a much-improved Web server interface, as well as a new command-line option ``-b`` to automatically open a browser window -to display that server:: +to display that server: + +.. code-block:: shell-session $ pydoc3.2 -b @@ -1998,7 +2010,9 @@ '/Users/raymondhettinger/Library/Python/3.2/lib/python/site-packages' Conveniently, some of site's functionality is accessible directly from the -command-line:: +command-line: + +.. code-block:: shell-session $ python -m site --user-base /Users/raymondhettinger/.local @@ -2031,7 +2045,9 @@ * :func:`~sysconfig.get_config_vars` returns a dictionary of platform specific variables. -There is also a convenient command-line interface:: +There is also a convenient command-line interface: + +.. code-block:: doscon C:\Python32>python -m sysconfig Platform: "win32" @@ -2265,7 +2281,9 @@ The demonstration code for the :mod:`turtle` module was moved from the *Demo* directory to main library. It includes over a dozen sample scripts with lively displays. Being on :attr:`sys.path`, it can now be run directly -from the command-line:: +from the command-line: + +.. code-block:: shell-session $ python -m turtledemo @@ -2701,4 +2719,3 @@ * Due to the new :term:`GIL` implementation, :c:func:`PyEval_InitThreads()` cannot be called before :c:func:`Py_Initialize()` anymore. - diff -r db93af6080e7 Doc/whatsnew/3.3.rst --- a/Doc/whatsnew/3.3.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/whatsnew/3.3.rst Tue Jul 26 02:34:52 2016 +0000 @@ -871,7 +871,9 @@ :envvar:`PYTHONFAULTHANDLER` environment variable or by using :option:`-X` ``faulthandler`` command line option. -Example of a segmentation fault on Linux: :: +Example of a segmentation fault on Linux: + +.. code-block:: shell-session $ python -q -X faulthandler >>> import ctypes @@ -997,7 +999,9 @@ (:issue:`12016`) Incremental CJK codec encoders are no longer reset at each call to their -encode() methods. For example:: +encode() methods. For example: + +.. code-block:: shell-session $ ./python -q >>> import codecs diff -r db93af6080e7 Doc/whatsnew/3.5.rst --- a/Doc/whatsnew/3.5.rst Mon Jul 25 02:39:20 2016 +0000 +++ b/Doc/whatsnew/3.5.rst Tue Jul 26 02:34:52 2016 +0000 @@ -291,6 +291,8 @@ NumPy 1.10 has support for the new operator:: +.. code-block:: pycon + >>> import numpy >>> x = numpy.ones(3) @@ -742,7 +744,9 @@ With the new module, bundling your application is as simple as putting all the files, including a ``__main__.py`` file, into a directory ``myapp`` -and running:: +and running: + +.. code-block:: shell-session $ python -m zipapp myapp $ python myapp.pyz @@ -2532,4 +2536,3 @@ :c:type:`PyTypeObject` was replaced with a :c:member:`tp_as_async` slot. Refer to :ref:`coro-objects` for new types, structures and functions. -