aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/parso/py2/README.rst
blob: 046e476e7b74a8a5c6071c1bf60b5e03e8be7df1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
################################################################### 
parso - A Python Parser 
################################################################### 
 
 
.. image:: https://travis-ci.org/davidhalter/parso.svg?branch=master 
    :target: https://travis-ci.org/davidhalter/parso 
    :alt: Travis CI build status 
 
.. image:: https://coveralls.io/repos/github/davidhalter/parso/badge.svg?branch=master 
    :target: https://coveralls.io/github/davidhalter/parso?branch=master 
    :alt: Coverage Status 
 
.. image:: https://pepy.tech/badge/parso 
    :target: https://pepy.tech/project/parso 
    :alt: PyPI Downloads 
 
.. image:: https://raw.githubusercontent.com/davidhalter/parso/master/docs/_static/logo_characters.png 
 
Parso is a Python parser that supports error recovery and round-trip parsing 
for different Python versions (in multiple Python versions). Parso is also able 
to list multiple syntax errors in your python file. 
 
Parso has been battle-tested by jedi_. It was pulled out of jedi to be useful 
for other projects as well. 
 
Parso consists of a small API to parse Python and analyse the syntax tree. 
 
A simple example: 
 
.. code-block:: python 
 
    >>> import parso 
    >>> module = parso.parse('hello + 1', version="3.6") 
    >>> expr = module.children[0] 
    >>> expr 
    PythonNode(arith_expr, [<Name: hello@1,0>, <Operator: +>, <Number: 1>]) 
    >>> print(expr.get_code()) 
    hello + 1 
    >>> name = expr.children[0] 
    >>> name 
    <Name: hello@1,0> 
    >>> name.end_pos 
    (1, 5) 
    >>> expr.end_pos 
    (1, 9) 
 
To list multiple issues: 
 
.. code-block:: python 
 
    >>> grammar = parso.load_grammar() 
    >>> module = grammar.parse('foo +\nbar\ncontinue') 
    >>> error1, error2 = grammar.iter_errors(module) 
    >>> error1.message 
    'SyntaxError: invalid syntax' 
    >>> error2.message 
    "SyntaxError: 'continue' not properly in loop" 
 
Resources 
========= 
 
- `Testing <https://parso.readthedocs.io/en/latest/docs/development.html#testing>`_ 
- `PyPI <https://pypi.python.org/pypi/parso>`_ 
- `Docs <https://parso.readthedocs.org/en/latest/>`_ 
- Uses `semantic versioning <https://semver.org/>`_ 
 
Installation 
============ 
 
    pip install parso 
 
Future 
====== 
 
- There will be better support for refactoring and comments. Stay tuned. 
- There's a WIP PEP8 validator. It's however not in a good shape, yet. 
 
Known Issues 
============ 
 
- `async`/`await` are already used as keywords in Python3.6. 
- `from __future__ import print_function` is not ignored. 
 
 
Acknowledgements 
================ 
 
- Guido van Rossum (@gvanrossum) for creating the parser generator pgen2 
  (originally used in lib2to3). 
- `Salome Schneider <https://www.crepes-schnaegg.ch/cr%C3%AApes-schn%C3%A4gg/kunst-f%C3%BCrs-cr%C3%AApes-mobil/>`_ 
  for the extremely awesome parso logo. 
 
 
.. _jedi: https://github.com/davidhalter/jedi