https://github.com/xia-mc/pylang
A Python Code Optimizer Based on Static Analysis.
https://github.com/xia-mc/pylang
Last synced: 8 months ago
JSON representation
A Python Code Optimizer Based on Static Analysis.
- Host: GitHub
- URL: https://github.com/xia-mc/pylang
- Owner: xia-mc
- License: gpl-3.0
- Created: 2024-09-23T14:15:36.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-04T07:35:06.000Z (about 1 year ago)
- Last Synced: 2025-05-08T23:05:13.605Z (8 months ago)
- Language: Python
- Size: 141 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pylang
[简体中文](https://github.com/xia-mc/Pylang/blob/master/README_CN.md)
> [!NOTE]
> Pylang is in an early development stage. Expect frequent errors, crashes, and poor performance. Please avoid using it
> in any projects.
**Pylang** is a Python code optimizer based on Abstract Syntax Tree (AST) that performs static analysis to improve code
efficiency. It is designed to allow Python developers to write clean, maintainable code while benefiting from
optimizations that reduce runtime overhead.
## Features
- **Constant Folding**: Evaluate constant expressions at compile time to reduce runtime calculations.
- **Loop Unfolding**: Unroll loops to reduce overhead, improving performance for certain scenarios.
- **Unused Variable Remover**: Automatically remove unused variables to clean up code and reduce memory usage.
## TODO
- [ ] **Variable Inlining**: Automatically inline variables where applicable for improved performance.
- [ ] **Advanced Decorators**: Add support for decorators like `@inline`, `@const`, and `@native` for advanced
optimizations.
- [ ] **Releases**: Packaging the project with proper release notes and binaries for easier distribution.
- [ ] **Documentation**: Detailed API documentation and examples to guide developers in integrating Pylang into their
projects.
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/xia-mc/Pylang.git
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Run the optimizer on your Python project (Python 3.7+ require):
```bash
python Pylang.py
```
### Flags:
- F /D : Path to the file to be optimized.
- O : Path to the output folder.
- O0/O1/O2/O3: Optimize level.
- O0: Only format codes to make smaller.
- O1: Do some simple derivations and the functionality of the program will not be affected.
- O2: Do more aggressive optimizations, the behavior of certain functions (like exec) may change.
- tofile: Write logs to `latest.log` instead of printing to stdout.
example:
```bash
python ./src/main/Pylang.py -D ./src/test -O2
```
## Contribution
Feel free to submit issues, pull requests, or feature requests to help improve Pylang. Contributions and feedback are
greatly appreciated!
## Acknowledgements
This project would not have been possible without the help of the following tools and platforms:
- **[PyCharm](https://www.jetbrains.com/pycharm/)**: For providing an excellent IDE that made the development process
smooth and efficient.
- **[CPython](https://github.com/python/cpython)**: The core of Python itself, which made this project possible by
providing the powerful runtime environment on which Pylang is based.