libcst

A concrete syntax tree with AST-like properties for Python 3.5, 3.6, 3.7, 3.8, 3.9, and 3.10 programs.

These details have been verified by PyPI

Maintainers

7imbrook amyreese bgw-ig zsolzsol

These details have not been verified by PyPI

Project links

Project description

A Concrete Syntax Tree (CST) parser and serializer library for Python

LibCST parses Python 3.0 -> 3.11 source code as a CST tree that keeps all formatting details (comments, whitespaces, parentheses, etc). It’s useful for building automated refactoring (codemod) applications and linters.

LibCST creates a compromise between an Abstract Syntax Tree (AST) and a traditional Concrete Syntax Tree (CST). By carefully reorganizing and naming node types and fields, we’ve created a lossless CST that looks and feels like an AST.

You can learn more about the value that LibCST provides and our motivations for the project in our documentation. Try it out with notebook examples.

Example expression:

1 + 2

CST representation:

BinaryOperation(
    left=Integer(
        value='1',
        lpar=[],
        rpar=[],
    ),
    operator=Add(
        whitespace_before=SimpleWhitespace(
            value=' ',
        ),
        whitespace_after=SimpleWhitespace(
            value=' ',
        ),
    ),
    right=Integer(
        value='2',
        lpar=[],
        rpar=[],
    ),
    lpar=[],
    rpar=[],
)

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>

Alternatively, you can import LibCST into a Python REPL and use the included parser and pretty printing functions:

>>> import libcst as cst
>>> from libcst.tool import dump
>>> print(dump(cst.parse_expression("(1 + 2)")))
BinaryOperation(
  left=Integer(
    value='1',
  ),
  operator=Add(),
  right=Integer(
    value='2',
  ),
  lpar=[
    LeftParen(),
  ],
  rpar=[
    RightParen(),
  ],
)

For a more detailed usage example, see our documentation.

Installation

LibCST requires Python 3.7+ and can be easily installed using most common Python packaging tools. We recommend installing the latest stable release from PyPI with pip:

pip install libcst

For parsing, LibCST ships with a native extension, so releases are distributed as binary wheels as well as the source code. If a binary wheel is not available for your system (Linux/Windows x86/x64 and Mac x64/arm are covered), you’ll need a recent Rust toolchain for installing.

Development

You’ll need a recent Rust toolchain for developing.

Then, 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

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

ufmt format && python -m fixit.cli.apply_fix

We use slotscheck to check the correctness of class __slots__. To check that slots are defined properly, run:

python -m slotscheck libcst

To run all tests, you’ll need to do the following in the root:

python -m unittest

You can also run individual tests by using unittest and specifying a module like this:

python -m unittest libcst.tests.test_batched_visitor

See the unittest documentation for more examples of how to run tests.

Building

In order to build LibCST, which includes a native parser module, you will need to have the Rust build tool cargo on your path. You can usually install cargo using your system package manager, but the most popular way to install cargo is using rustup.

To build just the native parser, do the following from the native directory:

cargo build

To build the libcst.native module and install libcst, run this from the root:

pip uninstall -y libcst
pip install -e .

Type Checking

We use Pyre for type-checking.

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

pyre check

Note: You may need to run the pip install -e . command prior to type checking, see the section above on building.

Generating Documents

To generate documents, do the following in the root:

sphinx-build docs/source/ docs/build/

Future

Advanced full repository facts providers like fully qualified name and call graph.

License

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

Privacy Policy and Terms of Use

Acknowledgements

Guido van Rossum for creating the parser generator pgen2 (originally used in lib2to3 and forked into parso).
David Halter for parso which provides the parser and tokenizer that LibCST sits on top of.
Zac Hatfield-Dodds for hypothesis integration which continues to help us find bugs.
Zach Hammer improved type annotation for Mypy compatibility.

Project details

These details have been verified by PyPI

Maintainers

7imbrook amyreese bgw-ig zsolzsol

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

1.5.0

Oct 10, 2024

1.4.0

May 22, 2024

1.3.1

Apr 3, 2024

1.3.0

Apr 3, 2024

1.2.0

Feb 19, 2024

1.1.0

Oct 6, 2023

1.0.1

Jun 7, 2023

1.0.0

May 25, 2023

0.4.10

May 23, 2023

0.4.9

Nov 10, 2022

0.4.8 yanked

Nov 10, 2022

Reason this release was yanked:

broken M1 wheel: https://github.com/Instagram/LibCST/issues/817

This version

0.4.7

Jul 12, 2022

0.4.6

Jul 4, 2022

0.4.5

Jun 17, 2022

0.4.4

Jun 13, 2022

0.4.3

May 11, 2022

0.4.2

May 4, 2022

0.4.1

Jan 28, 2022

0.4.0

Jan 12, 2022

0.4.0a1 pre-release

Jan 1, 2022

0.3.23

Nov 23, 2021

0.3.22

Nov 22, 2021

0.3.21

Sep 21, 2021

0.3.20

Aug 10, 2021

0.3.19

May 13, 2021

0.3.18

Mar 30, 2021

0.3.17

Feb 9, 2021

0.3.16

Dec 16, 2020

0.3.15

Dec 1, 2020

0.3.14

Nov 18, 2020

0.3.13

Oct 12, 2020

0.3.12

Oct 1, 2020

0.3.11

Sep 28, 2020

0.3.10

Aug 17, 2020

0.3.9

Aug 7, 2020

0.3.8

Jul 23, 2020

0.3.7

Jun 25, 2020

0.3.6

May 29, 2020

0.3.5

May 13, 2020

0.3.4

Mar 27, 2020

0.3.3

Mar 5, 2020

0.3.2

Feb 26, 2020

0.3.1

Feb 6, 2020

0.3.0

Jan 17, 2020

0.2.7

Jan 7, 2020

0.2.6

Jan 2, 2020

0.2.5

Dec 6, 2019

0.2.4

Nov 14, 2019

0.2.3

Nov 12, 2019

0.2.2

Oct 24, 2019

0.2.1

Oct 14, 2019

0.2.0

Oct 4, 2019

0.1.3

Sep 19, 2019

0.1.2

Aug 29, 2019

0.1.1

Aug 20, 2019

0.1

Aug 7, 2019

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

libcst-0.4.7.tar.gz (739.8 kB view details)

Uploaded Jul 12, 2022 Source

Built Distributions

libcst-0.4.7-cp310-cp310-win_amd64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.10 Windows x86-64

libcst-0.4.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.10 manylinux: glibc 2.17+ x86-64

libcst-0.4.7-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.10 manylinux: glibc 2.17+ ARM64

libcst-0.4.7-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (2.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.10 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

libcst-0.4.7-cp310-cp310-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.10 macOS 11.0+ ARM64

libcst-0.4.7-cp310-cp310-macosx_10_9_x86_64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.10 macOS 10.9+ x86-64

libcst-0.4.7-cp39-cp39-win_amd64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.9 Windows x86-64

libcst-0.4.7-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.9 manylinux: glibc 2.17+ x86-64

libcst-0.4.7-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.9 manylinux: glibc 2.17+ ARM64

libcst-0.4.7-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (2.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.9 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

libcst-0.4.7-cp39-cp39-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.9 macOS 11.0+ ARM64

libcst-0.4.7-cp39-cp39-macosx_10_9_x86_64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.9 macOS 10.9+ x86-64

libcst-0.4.7-cp38-cp38-win_amd64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.8 Windows x86-64

libcst-0.4.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.8 manylinux: glibc 2.17+ x86-64

libcst-0.4.7-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.8 manylinux: glibc 2.17+ ARM64

libcst-0.4.7-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (2.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.8 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

libcst-0.4.7-cp38-cp38-macosx_11_0_arm64.whl (1.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.8 macOS 11.0+ ARM64

libcst-0.4.7-cp38-cp38-macosx_10_9_x86_64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.8 macOS 10.9+ x86-64

libcst-0.4.7-cp37-cp37m-win_amd64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.7m Windows x86-64

libcst-0.4.7-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.7m manylinux: glibc 2.17+ x86-64

libcst-0.4.7-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.7 MB view details)

Uploaded Jul 12, 2022 CPython 3.7m manylinux: glibc 2.17+ ARM64

libcst-0.4.7-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (2.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.7m manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

libcst-0.4.7-cp37-cp37m-macosx_10_9_x86_64.whl (1.8 MB view details)

Uploaded Jul 12, 2022 CPython 3.7m macOS 10.9+ x86-64

File details

Details for the file libcst-0.4.7.tar.gz.

File metadata

Download URL: libcst-0.4.7.tar.gz
Upload date: Jul 12, 2022
Size: 739.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for libcst-0.4.7.tar.gz
Algorithm	Hash digest
SHA256	`95c52c2130531f6e726a3b077442cfd486975435fecf3db8224d43fba7b85099`
MD5	`ea6250df892d0093c764384e07bccd62`
BLAKE2b-256	`906bef2d7c86a61c6b6ae4eb48b832ba96897d4ba9743e9ece40f66625b11d60`

Algorithm	Hash digest
SHA256	`76fae68bd6b7ce069e267b3322c806b4305341cea78d161ae40e0ed641c8c660`
MD5	`40a32c32d70a73bd875eda65950547ef`
BLAKE2b-256	`448398d34ef99063e86636199fec1f644213bacf8cf3862625f51bee4f35e05c`

Algorithm	Hash digest
SHA256	`31da97bc986dc3f7a97f7d431fa911932aaf716d2f8bcda947fc964afd3b57cd`
MD5	`7c84bd9acae64b0305778354c3601ad8`
BLAKE2b-256	`b144fb012ebe79b5d0eaf79d8b93aa3c4a3faaac589802b2499680c1f6abb2f1`

Algorithm	Hash digest
SHA256	`c0d19de56aa733b4ef024527e3ce4896d4b0e9806889797f409ec24caa651a44`
MD5	`739bdb737f90483b18c9e760c3a37617`
BLAKE2b-256	`55d777a6d260a00a859ed85f4e1f54f7c003b36b3b9a5b18087b3b925ff92201`

Algorithm	Hash digest
SHA256	`71b2e2c5e33e53669c20de0853cecfac1ffb8657ee727ab8527140f39049b820`
MD5	`5d1ee11632cde547bf60bb3eee6aba4f`
BLAKE2b-256	`f414b3d31bae1f09d6a32ee6f265f5c8c51c529f2fcaf86d930d6f2870ba969c`

Algorithm	Hash digest
SHA256	`a8f47d809df59fcd83058b777b86a300154ee3a1f1b0523a398a67b5f8affd4c`
MD5	`3f30b5095aa897ab264356019a04618c`
BLAKE2b-256	`310aac1004406ae8f5cdaf12129d91d54c121a3e50c4a08f3577b6ae394ce658`

Algorithm	Hash digest
SHA256	`dc6f8965b6ca68d47e11321772887d81fa6fd8ea86e6ef87434ca2147de10747`
MD5	`354c23d65d55075edd12812757128fb3`
BLAKE2b-256	`3fd4050be7b5a5b3b7960f114ccfae30d9dec11ef628dcf8da5cadc3e00e92b0`

Algorithm	Hash digest
SHA256	`3a2b7253cd2e3f0f8a3e23b5c2acb492811d865ef36e0816091c925f32b713d2`
MD5	`65b0afc8c5c60f383d8a266b7d3bd75a`
BLAKE2b-256	`79d533b750f54b3d030049c4ed5331d36c161fcd52580b8123c845d06804b87c`

Algorithm	Hash digest
SHA256	`beb5347e46b419f782589da060e9300957e71d561aa5574309883b71f93c1dfe`
MD5	`b5edf1f0282a9034d23904c96b743f3f`
BLAKE2b-256	`7355837f4f00253cf36b65e6d0f5da53382e14fa75e85f1cf30441babcb6137e`

Algorithm	Hash digest
SHA256	`3569d9901c18940632414fb7a0943bffd326db9f726a9c041664926820857815`
MD5	`d1b9f9a738b378741ef551b39df4c28d`
BLAKE2b-256	`948e94d1e911279792332a28aebbcd1aec87d19da3c0dd07e6c2e7513b9df9f9`

Algorithm	Hash digest
SHA256	`1e541ccfeebda1ae5f005fc120a5bf3e8ac9ccfda405ec3efd3df54fc4688ac3`
MD5	`1412635c76ed638b781d0db2dad57f9f`
BLAKE2b-256	`35034a55b56db11e58312fe437f0115a4fd753deebc66e158d0c786db79ad9f0`

Algorithm	Hash digest
SHA256	`fa618dc359663a0a097c633452b104c1ca93365da7a811e655c6944f6b323239`
MD5	`373ee484f5c2fca1b0f60e764b9e6675`
BLAKE2b-256	`80d04cae0eaf69dfadc6d16829b504c8042b3e5786fd8b939be9dcc6586f71c4`

Algorithm	Hash digest
SHA256	`234293aa8681a3d47fef1716c5622797a81cbe85a9381fe023815468cfe20eed`
MD5	`214736bd87bf2d942b99dbbf25295d6f`
BLAKE2b-256	`f5c65cbf023dbf1efe8a49cb50075f599f6fc73906253053dbfea5b79dcba86e`

Algorithm	Hash digest
SHA256	`2f6766391d90472f036b88a95251c87d498ab068c377724f212ab0cc20509a68`
MD5	`ddf55f55b03bc80d279b66901a034bcf`
BLAKE2b-256	`dfd1ab01a27be0cabf636efc6f638c6bd23e7d6c8b1f4e814511936ced2d1ce7`

Algorithm	Hash digest
SHA256	`214a9c4f4f90cd5b4bfa18e17877da4dd9a896821d9af9be86fa3effdc289b9b`
MD5	`e8d8d84828dc9e2efb65d2faf164811e`
BLAKE2b-256	`6b3951e809ff8deaa1e0bc4d71a962713c8f808a857f97e5fe064e6ddf4be65a`

Algorithm	Hash digest
SHA256	`8c6bd66a8be2ffad7b968d90dae86c62fd4739c0e011d71f3e76544a891ae743`
MD5	`973a15b26e4c565181747db2479b2047`
BLAKE2b-256	`5bb40def28fb1b7fe79c049afdce259a79a6290496357f0d4654534f666e9668`

Algorithm	Hash digest
SHA256	`27a37f2b459a8b51a41e260bd89c24ae41ab1d658f610c91650c79b1bbf27138`
MD5	`ca99293e5e7e3f0bce18ea2d72279bdb`
BLAKE2b-256	`c86744433ee8f19edf9300d3be7cfd76e980f2261eff697d7e02cb860e5088be`

Algorithm	Hash digest
SHA256	`aa438131b7befc7e5a3cbadb5a7b1506305de5d62262ea0556add0152f40925e`
MD5	`67094911bb98d8bede406d9c9b99ac12`
BLAKE2b-256	`ac00aa7965c4b90d0a1a749582572c54489f391e73b4e30c05169d778b60732d`

Algorithm	Hash digest
SHA256	`0ca2771ff3cfdf1f148349f89fcae64afa365213ed5c2703a69a89319325d0c8`
MD5	`411e5b753de7887ad8f5535ba7bafbd0`
BLAKE2b-256	`7c13074c117a6ae83b301c6c78c834fbde10f0d2cabfa51528b4ba69be62ed75`

Algorithm	Hash digest
SHA256	`f56565124c2541adee0634e411b2126b3f335306d19e91ed2bfe52efa698b219`
MD5	`7f4afef3cd0d1a25fb6c7e272c25761e`
BLAKE2b-256	`506a8be2065e395e4dd9c14eb3e31e3c7870a063864f11fb235b08b5bbc2af91`

Algorithm	Hash digest
SHA256	`617f7fa2610a8c86cf22d8d03416f25391383d05bd0ad1ca8ef68023ddd6b4f6`
MD5	`6f0c7adbdbca11890ed5270e98a14bb4`
BLAKE2b-256	`26ddb4a60773aacf76b5138687c4d041cd967b31ab10f182dc1da8de3c142adb`

libcst 0.4.7

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Getting Started

Examining a sample tree

Installation

Further Reading

Development

Building

Type Checking

Generating Documents

Future

License

Privacy Policy and Terms of Use

Acknowledgements

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

Algorithm	Hash digest
SHA256	`26f86535271eaefe84a99736875566a038449f92e1a2a61ea0b588d8359fbefd`
MD5	`dea1c3b591bfe4725ed1cfddfb9d9107`
BLAKE2b-256	`491b39c02ed0add9b7b04fa781947a50c8e460c8ec76059b7d215d59ab78a7b7`

Algorithm	Hash digest
SHA256	`c3637fffe476c5b4ee2225c6474b83382518f2c1b2fe4771039e06bdd7835a4a`
MD5	`a39aeabbc508c9d5b5f18f24ee35feea`
BLAKE2b-256	`e277af3f3304a6acf7a010f8738af96e1525727d5ae7792d1223624bd9993b66`

Algorithm	Hash digest
SHA256	`bac76d69980bb3254f503f52128c256ef4d1bcbaabe4a17c3a9ebcd1fc0472c0`
MD5	`76479bb877ef3b39bf542ae2325e52e4`
BLAKE2b-256	`95b94b4a96bad1df1e64a1579e4d53d385b0e9c19cb815b24f868f280e2aecea`