https://github.com/davidhalter/parso

A Python Parser
https://github.com/davidhalter/parso

Last synced: 4 days ago
JSON representation

A Python Parser

• Host: GitHub
• URL: https://github.com/davidhalter/parso
• Owner: davidhalter
• License: other
• Created: 2017-05-08T20:14:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T13:05:02.000Z (7 months ago)
• Last Synced: 2024-10-29T15:55:50.466Z (3 months ago)
• Language: Python
• Homepage: https://parso.readthedocs.org/en/latest/
• Size: 1.37 MB
• Stars: 614
• Watchers: 20
• Forks: 107
• Open Issues: 13
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Security: SECURITY.md
  • Authors: AUTHORS.txt

Awesome Lists containing this project

• awesome-python-ast - parso - parser that supports error recovery and round-trip parsing (Tools)
• best-of-python-dev - GitHub - 10% open · ⏱️ 21.04.2024): (Linters & Style Checkers)
• starred-awesome - parso - A Python Parser (Python)

README

        
###################################################################

parso - A Python Parser

###################################################################

.. image:: https://github.com/davidhalter/parso/workflows/Build/badge.svg?branch=master

    :target: https://github.com/davidhalter/parso/actions

    :alt: GitHub Actions 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.9")

    >>> expr = module.children[0]

    >>> expr

    PythonNode(arith_expr, [, , ])

    >>> print(expr.get_code())

    hello + 1

    >>> name = expr.children[0]

    >>> name

    

    >>> 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 `_

- `PyPI `_

- `Docs `_

- Uses `semantic versioning `_

Installation

============

.. code-block:: bash

    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 for the extremely awesome parso logo.

.. _jedi: https://github.com/davidhalter/jedi