# Using ast and cst to change Python code

## Difference between AST and CST

A brief comparison could be found in the [libcst doc](<https://libcst.readthedocs.io/en/latest/why_libcst.html>). Generally speaking, CST could keep the original source code format including the comments.

## Using AST to change Python code

Since **Python 3.9**, the helper [ast.unparse](<https://docs.python.org/3.9/library/ast.html#ast.unparse>) has been introduced, so we have both `ast.parse` and `ast.unparse` in our hands, everything is ready, finally we have an official way to change Python code.

For example, I have a the file `setup.py` as belows:

```
"""setup.py file
"""
from pkg_resources import parse_requirements
from setuptools import setup

with open("requirements.txt", encoding="utf-8") as f:
    install_requires = [str(req) for req in parse_requirements(f)]

setup(
    name="foo",
    install_requires=install_requires,
)
```

I want to change the line `install_requires=install_requires,` by `install_requires=["a==1", "b==2"],`.

Since Python3.9, I can achieve it like this:

```
import ast
import json

new_install_requires = ["a==1", "b==2"]

setup_file = open("setup.py").read()
setup = ast.parse(setup_file)

print("\n***Before change\n")
print(ast.unparse(setup))

for body in setup.body:
    try:
        if hasattr(body, "value") and hasattr(body.value, "keywords"):
            for kw in body.value.keywords:
                if kw.arg == "install_requires":
                    kw.value = ast.parse(json.dumps(new_install_requires)).body[0]
    except Exception as err:
        print(err)

print("\n***After change\n")
print(ast.unparse(setup))
```

Result from the console:

```
$ python3.9 change_setup.py

***Before change

"""setup.py file
"""
from pkg_resources import parse_requirements
from setuptools import setup
with open('requirements.txt', encoding='utf-8') as f:
    install_requires = [str(req) for req in parse_requirements(f)]
setup(name='foo', install_requires=install_requires)

***After change

"""setup.py file
"""
from pkg_resources import parse_requirements
from setuptools import setup
with open('requirements.txt', encoding='utf-8') as f:
    install_requires = [str(req) for req in parse_requirements(f)]
setup(name='foo', install_requires=
['a==1', 'b==2'])
```

> [!NOTE]
>
> You will notice that, the `ast.parse` discards all the comments. And if need to format the code, black could be a good choice.

## Using CST to change Python code

An example can be found the repo [hauntsaninja/no\_implicit\_optional](<https://github.com/hauntsaninja/no_implicit_optional>) that uses the [libcst](<https://github.com/Instagram/LibCST>) from Instagram
