forked from openkylin/astroid
91 lines
2.8 KiB
ReStructuredText
91 lines
2.8 KiB
ReStructuredText
|
Astroid
|
||
|
|
=======
|
||
|
|
|
||
|
|
.. image:: https://coveralls.io/repos/github/PyCQA/astroid/badge.svg?branch=main
|
||
|
|
:target: https://coveralls.io/github/PyCQA/astroid?branch=main
|
||
|
|
:alt: Coverage badge from coveralls.io
|
||
|
|
|
||
|
|
.. image:: https://readthedocs.org/projects/astroid/badge/?version=latest
|
||
|
|
:target: http://astroid.readthedocs.io/en/latest/?badge=latest
|
||
|
|
:alt: Documentation Status
|
||
|
|
|
||
|
|
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
||
|
|
:target: https://github.com/ambv/black
|
||
|
|
|
||
|
|
.. image:: https://results.pre-commit.ci/badge/github/PyCQA/astroid/main.svg
|
||
|
|
:target: https://results.pre-commit.ci/latest/github/PyCQA/astroid/main
|
||
|
|
:alt: pre-commit.ci status
|
||
|
|
|
||
|
|
.. |tidelift_logo| image:: https://raw.githubusercontent.com/PyCQA/astroid/main/doc/media/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White.png
|
||
|
|
:width: 75
|
||
|
|
:height: 60
|
||
|
|
:alt: Tidelift
|
||
|
|
|
||
|
|
.. list-table::
|
||
|
|
:widths: 10 100
|
||
|
|
|
||
|
|
* - |tidelift_logo|
|
||
|
|
- Professional support for astroid is available as part of the
|
||
|
|
`Tidelift Subscription`_. Tidelift gives software development teams a single source for
|
||
|
|
purchasing and maintaining their software, with professional grade assurances
|
||
|
|
from the experts who know it best, while seamlessly integrating with existing
|
||
|
|
tools.
|
||
|
|
|
||
|
|
.. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-astroid?utm_source=pypi-astroid&utm_medium=referral&utm_campaign=readme
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
What's this?
|
||
|
|
------------
|
||
|
|
|
||
|
|
The aim of this module is to provide a common base representation of
|
||
|
|
python source code. It is currently the library powering pylint's capabilities.
|
||
|
|
|
||
|
|
It provides a compatible representation which comes from the `_ast`
|
||
|
|
module. It rebuilds the tree generated by the builtin _ast module by
|
||
|
|
recursively walking down the AST and building an extended ast. The new
|
||
|
|
node classes have additional methods and attributes for different
|
||
|
|
usages. They include some support for static inference and local name
|
||
|
|
scopes. Furthermore, astroid can also build partial trees by inspecting living
|
||
|
|
objects.
|
||
|
|
|
||
|
|
|
||
|
|
Installation
|
||
|
|
------------
|
||
|
|
|
||
|
|
Extract the tarball, jump into the created directory and run::
|
||
|
|
|
||
|
|
pip install .
|
||
|
|
|
||
|
|
|
||
|
|
If you want to do an editable installation, you can run::
|
||
|
|
|
||
|
|
pip install -e .
|
||
|
|
|
||
|
|
|
||
|
|
If you have any questions, please mail the code-quality@python.org
|
||
|
|
mailing list for support. See
|
||
|
|
http://mail.python.org/mailman/listinfo/code-quality for subscription
|
||
|
|
information and archives.
|
||
|
|
|
||
|
|
Documentation
|
||
|
|
-------------
|
||
|
|
http://astroid.readthedocs.io/en/latest/
|
||
|
|
|
||
|
|
|
||
|
|
Python Versions
|
||
|
|
---------------
|
||
|
|
|
||
|
|
astroid 2.0 is currently available for Python 3 only. If you want Python 2
|
||
|
|
support, use an older version of astroid (though note that these versions
|
||
|
|
are no longer supported).
|
||
|
|
|
||
|
|
Test
|
||
|
|
----
|
||
|
|
|
||
|
|
Tests are in the 'test' subdirectory. To launch the whole tests suite, you can use
|
||
|
|
either `tox` or `pytest`::
|
||
|
|
|
||
|
|
tox
|
||
|
|
pytest astroid
|