Skip to content
This repository was archived by the owner on Jul 5, 2023. It is now read-only.

Commit 3a7ac0c

Browse files
authored
Update README to emphasize the outdated nature (#168)
1 parent 30e5ec8 commit 3a7ac0c

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44
[![Chat at https://gitter.im/python/typed_ast](https://badges.gitter.im/python/typed_ast.svg)](https://gitter.im/python/typed_ast)
55

66
`typed_ast` is a Python 3 package that provides a Python 2.7 and Python 3
7-
parser similar to the standard `ast` library. Unlike `ast`, the parsers in
7+
parser similar to the standard `ast` library. Unlike `ast` up to Python 3.7, the parsers in
88
`typed_ast` include [PEP 484](https://www.python.org/dev/peps/pep-0484/) type
99
comments and are independent of the version of Python under which they are run.
1010
The `typed_ast` parsers produce the standard Python AST (plus type comments),
1111
and are both fast and correct, as they are based on the CPython 2.7 and 3.7
12-
parsers. `typed_ast` runs on CPython 3.6-3.10 on Linux, OS X and Windows.
12+
parsers. `typed_ast` runs on CPython 3.6-3.10 on Linux, OS X and Windows,
13+
although starting with Python 3.8, we recommend to use the native `ast` parser
14+
(see below).
1315

1416
## Development Philosophy
1517

@@ -41,9 +43,8 @@ and has limited support for parsing older versions of Python 3.
4143

4244
## Submodules
4345
### ast3
44-
The `ast3` parser produces the AST from a recent version of Python 3
45-
(currently Python 3.6). When new versions of Python 3 are released, it will be
46-
updated to match any changes in their AST. (For rationale and technical
46+
The `ast3` parser produces the AST from a Python 3 code, up to Python 3.7.
47+
(For rationale and technical
4748
details, see [here](update_process.md).) The AST it currently produces is described in
4849
[ast3/Parser/Python.asdl](ast3/Parser/Python.asdl). If you wish to limit
4950
parsing to older versions of Python 3, `ast3` can be configured to to give a

setup.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,15 @@
8383

8484
long_description = """
8585
`typed_ast` is a Python 3 package that provides a Python 2.7 and Python 3
86-
parser similar to the standard `ast` library. Unlike `ast`, the parsers in
86+
parser similar to the standard `ast` library. Unlike `ast` below Python 3.8,
87+
the parsers in
8788
`typed_ast` include PEP 484 type comments and are independent of the version of
8889
Python under which they are run. The `typed_ast` parsers produce the standard
8990
Python AST (plus type comments), and are both fast and correct, as they are
90-
based on the CPython 2.7 and 3.6 parsers.
91+
based on the CPython 2.7 and 3.7 parsers.
92+
93+
`typed_ast` does not support Python 3.8 or higher code. Use the `ast`
94+
module from Python 3.8 or above for that.
9195
""".strip()
9296

9397
_version_re = re.compile(r'__version__\s+=\s+(?P<version>.*)')

0 commit comments

Comments
 (0)