mirrors/LibCST
1
0
Fork 0
mirror of https://github.com/Instagram/LibCST.git synced 2025-12-23 10:35:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A concrete syntax tree parser and serializer library for Python that preserves many aspects of Python's abstract syntax tree https://libcst.readthedocs.io/
81 commits 100 branches 53 tags 8.7 MiB
Find a file
Jennifer Taylor 60763fc5dc Implement an ensure_type helper 
We already have several places in unit tests that need this, as well
as a spot in an existing codemod that could benefit from it. So,
implement ensure_type which can be used to refine the type of a node to
an exact node type. I purposefully left the node type as 'object'
instead of libcst.CSTNode so that it could be used with RemovalSentinel
or MaybeSentinel without needing to import these.
2019-07-23 13:13:53 -07:00
.circleci add sphinx autodoc templates and docs CI job 2019-07-22 20:05:27 -07:00
.github add initial PULL_REQUEST_TEMPLATE.md 2019-07-22 19:59:57 -07:00
docs/source add sphinx autodoc templates and docs CI job 2019-07-22 20:05:27 -07:00
libcst Implement an ensure_type helper 2019-07-23 13:13:53 -07:00
stubs Add runtime type validation support 2019-07-22 19:53:49 -07:00
.editorconfig Add config files to make tools easier to use 2019-07-22 19:53:49 -07:00
.flake8 Remove Instagram-specific bits from flake8 config 2019-07-22 20:05:07 -07:00
.gitignore add sphinx autodoc templates and docs CI job 2019-07-22 20:05:27 -07:00
.pyre_configuration add pyre CI job 2019-07-22 20:04:29 -07:00
CODE_OF_CONDUCT.md add Code Of Conduct file 2019-07-22 19:59:50 -07:00
CONTRIBUTING.md add test command and rephrase coding style. 2019-07-22 19:59:57 -07:00
LICENSE first commit 2019-05-29 11:32:49 -07:00
pyproject.toml Add config files to make tools easier to use 2019-07-22 19:53:49 -07:00
README.md Add CI build status badge to Readme 2019-07-22 20:05:01 -07:00
requirements-dev.txt add sphinx autodoc templates and docs CI job 2019-07-22 20:05:27 -07:00
requirements.txt Add runtime type validation support 2019-07-22 19:53:49 -07:00
setup.py add sphinx autodoc templates and docs CI job 2019-07-22 20:05:27 -07:00
tox.ini add sphinx autodoc templates and docs CI job 2019-07-22 20:05:27 -07:00

README.md

LibCST

CircleCI

TODO: Add documentation.

Getting Started

Examining a sample tree

To examine the tree that is parsed from a particular file, do the following:

python -m libcst.tool print <some_py_file.py>

Development

Start by setting up and activating a virtualenv:

git clone git@github.com:Instagram/LibCST.git libcst
cd libcst
python3 -m venv ../libcst-env/  # just an example, put this wherever you want
source ../libcst-env/bin/activate
pip install --upgrade pip  # optional, if you have an old system version of pip
pip install -r requirements.txt -r requirements-dev.txt
# If you're done with the virtualenv, you can leave it by running:
deactivate

Auto-formatting code with isort and Black

We use isort and black to format code. To format changes to be conformant, run the following in the root:

isort -q -y && black libcst/

Running tests

To run all tests, do the following in the root:

python3 setup.py test

Verifying types with Pyre

To verify types for the library, do the following in the root:

pyre check

License

LibCST is MIT licensed, as found in the LICENSE file.