https://github.com/basemax/brainfuck-interpreter-python
Brainfuck Interpreter in Python is a fully featured Brainfuck interpreter written in Python. It supports interactive mode, executing code from files, or running raw Brainfuck code passed as command-line arguments.
https://github.com/basemax/brainfuck-interpreter-python
brainfuck brainfuck-debugger brainfuck-interpreter brainfuck-interpreters brainfuck-language brainfuck-parser brainfuck-programs interpreter interpreter-design lexer parser py py3 python python3
Last synced: 7 months ago
JSON representation
Brainfuck Interpreter in Python is a fully featured Brainfuck interpreter written in Python. It supports interactive mode, executing code from files, or running raw Brainfuck code passed as command-line arguments.
- Host: GitHub
- URL: https://github.com/basemax/brainfuck-interpreter-python
- Owner: BaseMax
- License: mit
- Created: 2025-03-12T20:11:48.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T20:30:37.000Z (7 months ago)
- Last Synced: 2025-03-12T21:28:33.876Z (7 months ago)
- Topics: brainfuck, brainfuck-debugger, brainfuck-interpreter, brainfuck-interpreters, brainfuck-language, brainfuck-parser, brainfuck-programs, interpreter, interpreter-design, lexer, parser, py, py3, python, python3
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Brainfuck Interpreter in Python
[](LICENSE)
Brainfuck Interpreter in Python is a fully featured Brainfuck interpreter written in Python. This interpreter is a port and improvement over the original C version by Fabian Mastenbroek. It supports interactive mode, executing code from files, or running raw Brainfuck code passed as command-line arguments.
## Features
- **Interactive Console:** Launch an interactive session to enter Brainfuck code.
- **File Mode:** Execute Brainfuck code stored in `.bf` files.
- **Raw Code Execution:** Provide raw Brainfuck code directly on the command line.
- **Piped Input:** Execute Brainfuck code provided via standard input.
- **Error Handling:** Clear error messages for parse errors and runtime errors (e.g. tape overruns/underruns).
- **Modular Codebase:** Clean, well-documented code split into modular functions for parsing, execution, and CLI handling.
## Installation
### Requirements
- Python 3.6 or later
### Clone the Repository
```bash
git clone https://github.com/BaseMax/brainfuck-interpreter-python.git
cd brainfuck-interpreter-python
```
There is no additional installation step required; the interpreter is contained within a single Python script.
## Usage
You can run the interpreter in several ways:
### Interactive Mode
If you run the interpreter without any arguments, it will start in interactive mode:
```bash
python3 brainfuck-interpreter.py
```
Then, enter Brainfuck code at the prompt (>> ). Use Ctrl-D (or Ctrl-Z on Windows) to exit.
### Running a File
If an argument ends with .bf, the interpreter treats it as a file containing Brainfuck code:
```bash
python3 brainfuck-interpreter.py program.bf
```
### Running Raw Code
If an argument does not end with .bf, it is treated as raw Brainfuck code:
```bash
python3 brainfuck-interpreter.py "++++++++[>++++++++<-]>+.[-]<"
```
### Piped Input
You can also pipe Brainfuck code into the interpreter:
```bash
echo "+++++[>+++++<-]>." | python3 brainfuck-interpreter.py
```
## Command Line Options
- `-h, --help`
Show the help message.
- `-v, --version`
Show version information.
The interpreter automatically distinguishes between file paths (ending with .bf) and raw Brainfuck code provided as arguments.
## Contributing
Contributions are welcome! If you have ideas for improvements or bug fixes, please fork the repository and open a pull request. For major changes, please open an issue first to discuss what you would like to change.
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Author
© 2025 Max Base (Seyyed Ali Mohammadiyeh)