summaryrefslogtreecommitdiffstats
path: root/Doc/library/symbol.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/symbol.rst')
-rw-r--r--Doc/library/symbol.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/Doc/library/symbol.rst b/Doc/library/symbol.rst
new file mode 100644
index 0000000..1735276
--- /dev/null
+++ b/Doc/library/symbol.rst
@@ -0,0 +1,32 @@
+
+:mod:`symbol` --- Constants used with Python parse trees
+========================================================
+
+.. module:: symbol
+ :synopsis: Constants representing internal nodes of the parse tree.
+.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+
+
+This module provides constants which represent the numeric values of internal
+nodes of the parse tree. Unlike most Python constants, these use lower-case
+names. Refer to the file :file:`Grammar/Grammar` in the Python distribution for
+the definitions of the names in the context of the language grammar. The
+specific numeric values which the names map to may change between Python
+versions.
+
+This module also provides one additional data object:
+
+
+.. data:: sym_name
+
+ Dictionary mapping the numeric values of the constants defined in this module
+ back to name strings, allowing more human-readable representation of parse trees
+ to be generated.
+
+
+.. seealso::
+
+ Module :mod:`parser`
+ The second example for the :mod:`parser` module shows how to use the
+ :mod:`symbol` module.
+