Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

a few compile() and ast doc improvements

This commit is contained in:
Benjamin Peterson 2008-11-08 16:55:33 +00:00
parent 0d2fa3aea5
commit d923f987d1
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/library/ast.rst
View File

@ -21,13 +21,12 @@ abstract syntax grammar. The abstract syntax itself might change with each
Python release; this module helps to find out programmatically what the current Python release; this module helps to find out programmatically what the current
grammar looks like. grammar looks like.
An abstract syntax tree can be generated by passing :data:`_ast.PyCF_ONLY_AST` An abstract syntax tree can be generated by passing :data:`ast.PyCF_ONLY_AST` as
as a flag to the :func:`compile` builtin function, or using the :func:`parse` a flag to the :func:`compile` builtin function, or using the :func:`parse`
helper provided in this module. The result will be a tree of objects whose helper provided in this module. The result will be a tree of objects whose
classes all inherit from :class:`ast.AST`. classes all inherit from :class:`ast.AST`. An abstract syntax tree can be
compiled into a Python code object using the built-in :func:`compile` function.
A modified abstract syntax tree can be compiled into a Python code object using
the built-in :func:`compile` function.
Node classes Node classes
------------ ------------
@ -126,7 +125,7 @@ and classes for traversing abstract syntax trees:
.. function:: parse(expr, filename='<unknown>', mode='exec') .. function:: parse(expr, filename='<unknown>', mode='exec')
Parse an expression into an AST node. Equivalent to ``compile(expr, Parse an expression into an AST node. Equivalent to ``compile(expr,
filename, mode, PyCF_ONLY_AST)``. filename, mode, ast.PyCF_ONLY_AST)``.
.. function:: literal_eval(node_or_string) .. function:: literal_eval(node_or_string)

19
Doc/library/functions.rst
View File

@ -199,15 +199,8 @@ available. They are listed here in alphabetical order.
Compile the *source* into a code or AST object. Code objects can be executed Compile the *source* into a code or AST object. Code objects can be executed
by an :keyword:`exec` statement or evaluated by a call to :func:`eval`. by an :keyword:`exec` statement or evaluated by a call to :func:`eval`.
*source* can either be a string or an AST object. Refer to the :mod:`_ast` *source* can either be a string or an AST object. Refer to the :mod:`ast`
module documentation for information on how to compile into and from AST module documentation for information on how to work with AST objects.
objects.
When compiling a string with multi-line statements, two caveats apply: line
endings must be represented by a single newline character (``'\n'``), and the
input must be terminated by at least one newline character. If line endings
are represented by ``'\r\n'``, use the string :meth:`replace` method to
change them into ``'\n'``.
The *filename* argument should give the file from which the code was read; The *filename* argument should give the file from which the code was read;
pass some recognizable value if it wasn't read from a file (``'<string>'`` is pass some recognizable value if it wasn't read from a file (``'<string>'`` is
@ -237,6 +230,14 @@ available. They are listed here in alphabetical order.
This function raises :exc:`SyntaxError` if the compiled source is invalid, This function raises :exc:`SyntaxError` if the compiled source is invalid,
and :exc:`TypeError` if the source contains null bytes. and :exc:`TypeError` if the source contains null bytes.
.. note::
When compiling a string with multi-line statements, line endings must be
represented by a single newline character (``'\n'``), and the input must
be terminated by at least one newline character. If line endings are
represented by ``'\r\n'``, use :meth:`str.replace` to change them into
``'\n'``.
.. versionadded:: 2.6 .. versionadded:: 2.6
Support for compiling AST objects. Support for compiling AST objects.