https://github.com/jmestxr/pyhan
Py汉, a Chinese Python compiler
https://github.com/jmestxr/pyhan
Last synced: 3 months ago
JSON representation
Py汉, a Chinese Python compiler
- Host: GitHub
- URL: https://github.com/jmestxr/pyhan
- Owner: jmestxr
- Created: 2023-09-18T15:28:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-23T04:14:10.000Z (over 1 year ago)
- Last Synced: 2025-01-15T05:51:31.402Z (4 months ago)
- Language: Python
- Size: 103 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Support: supported-grammar.txt
Awesome Lists containing this project
README
# Py汉 (PyHan), a.k.a. Chinese Python
(This project is still Work in Progress)
Write and execute Python code in Simplified Chinese syntax!
```
:::::::;,
:: ;:
:: :: ';,
:: ,;' ';, ,;::::::::::;,
::::::::;' :: :: ;; ;;
:: :: :: ';, ;; ;;
:: ;; ;; '; ':, ,:'
:: '::' .: '::'
:: ;; ;' .:'':.
;; ,;' ,;' ';,
,:;'' :;' ,:;' ';:,
```
## Credits
Starter code is obtained from [this tutorial](https://austinhenley.com/blog/teenytinycompiler1.html). Special thanks 🎉
## Syntax
Here are the list of syntax currently supported:
- `print` statement - `印出`
- `if/elif/else` block - `如果/或则/否则`
- `while` loop - `当`
- `break`, `continue` statements in loop - `中断`, `继续`
- Logical operators (`and`, `or`, `not`) - `与`, `或`, `非`
- Primitives ( number, string, boolean (`真`,`假`) )
- Variable assignment
- Declaring variables in Chinese characters
- Basic arithmetic (`+`, `-`, `*`, `/`)
- Parenthesis
## Example
#### **`example.pyhan`**
```
x = 1
当 x < 5:
印出("Hello，世界！")
x = x + 1
```
compiles to
#### **`example.py`**
```
x = 1
while x < 5:
print("Hello，世界！")
x = x + 1
```
## Usage
1. Clone this repo.
1. Run `python setup.py sdist` in the root directory.
1. Run `pip install .` to install Py汉 CLI.
1. Confirm that the package is installed correctly by running `pyhan` command:
### Example:
To execute the above `example.pyhan` script directly, run
```
pyhan example.pyhan
```
To compile .pyhan script without executing, use the `--compile` or `-c` option. The compiled .py script will be saved to `./out.py` by default.
```
pyhan example.pyhan -c
```
You can specify the desired file path of the compiled .py script using the `--output` or `-o` option.
```
pyhan example.pyhan -c -o example.py
```
### Delete Py汉 CLI package
Run `python -m pip uninstall pyhan`.
## Dev Guide
### Compiling a test.pyhan script
Run `python cli/pyhan_cli.py test.pyhan -c`. Compiled python script will be in `./out.py`.
### Testing
Unit test cases are written with pytest. All test files are stored in `/test` directory.
Run `pytest` to run all tests.
Run `pytest --cov` to get code coverage.
Run `pytest --cov --cov-report term-missing` to get code coverage and lines missed.