diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2021-09-19 16:07:16 -0700 |
---|---|---|
committer | Pablo Galindo <pablogsal@gmail.com> | 2021-09-20 00:32:04 +0100 |
commit | f025ea23210173b42303360aca05132e4ffdfed3 (patch) | |
tree | ee66148e0bedb7e5807a32e93507dc12cd469b38 | |
parent | db762a9b21a8af6f2ee94a6e49144dd1a1a62333 (diff) | |
download | cpython-git-f025ea23210173b42303360aca05132e4ffdfed3.tar.gz |
bpo-30637: Improve the docs of ast.parse regarding differences with compile() (GH-28459)
(cherry picked from commit e6d05a4092b4176a30d1d1596585df13c2ab676d)
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
-rw-r--r-- | Doc/library/ast.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst index 19e7bcc414..e21151bd4e 100644 --- a/Doc/library/ast.rst +++ b/Doc/library/ast.rst @@ -1917,6 +1917,19 @@ and classes for traversing abstract syntax trees: ``await`` as variable names. The lowest supported version is ``(3, 4)``; the highest is ``sys.version_info[0:2]``. + If source contains a null character ('\0'), :exc:`ValueError` is raised. + + .. warning:: + Note that succesfully parsing souce code into an AST object doesn't + guarantee that the source code provided is valid Python code that can + be executed as the compilation step can raise further :exc:`SyntaxError` + exceptions. For instance, the source ``return 42`` generates a valid + AST node for a return statement, but it cannot be compiled alone (it needs + to be inside a function node). + + In particular, :func:`ast.parse` won't do any scoping checks, which the + compilation step does. + .. warning:: It is possible to crash the Python interpreter with a sufficiently large/complex string due to stack depth limitations |