Skip to main content

High-performance Brainfuck interpreter with JIT acceleration, library imports, and interactive REPL

Project description

advanced-brainfuck

advanced-brainfuck

A high-performance Brainfuck language interpreter for Python with JIT acceleration, library imports, and an interactive REPL.

Documentation | PyPI | Changelog


Features

  • JIT-accelerated execution — Compiles Brainfuck programs to an intermediate representation (IR) with run-length encoding, then executes via Numba's @jit(nopython=True) for 3-5x speedup
  • Segmented JIT with checkpoints — All programs use the JIT path; I/O operations (,, *, &) trigger checkpoints where Python handles input/output before resuming JIT execution
  • Interpreted fallback — If JIT compilation fails, falls back to interpreted IR execution with full compatibility
  • Library system — Import external .bf files with {libname} syntax; recursive imports supported
  • Interactive REPL — Run brainfuck with no arguments for an interactive shell
  • Python APIfrom brainfuck import BrainFuck for programmatic use

Quick Start

Installation

pip install advanced-brainfuck

Command Line

# Run a program and exit
brainfuck --command-line '++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.'

# Run a program from file (recommended for large programs)
brainfuck --command-line -f program.b

# Run a program then enter interactive REPL
brainfuck '+++++++++++++++++++++++++++++++++++++++++++++++++++.'

# Redirect output to a file
brainfuck --command-line --output result.txt '+++++++++[>++++++++<-]>+.'

# Save tape state after execution
brainfuck --command-line --dump tape.json '+++'

# Load tape state, run program, and dump result
brainfuck --command-line --load tape.json --output result.txt --dump out.json '.>+++.'

# Enter interactive REPL
brainfuck

Python API

from brainfuck import BrainFuck

bf = BrainFuck()
bf.execute('+++++++++++++++++++++++++++++++++++++++++++++++++++.')  # prints: 3
bf.execute('[-]')                    # clears cell 0
bf.execute('{p10}*{tochar}')         # imports and prints: |10|
bf.execute('&')                       # prints command history
bf.save_tape('tape.json')            # save tape state to file
bf.load_tape('tape.json')            # restore tape state from file
bf.interpreter()                      # starts interactive REPL

Brainfuck Commands

Standard Commands

Command Description
> Increment the data pointer
< Decrement the data pointer
+ Increment the value at the data pointer
- Decrement the value at the data pointer
. Output the value at the data pointer
, Accept one integer of input
[ Jump forward past matching ] if value is zero
] Jump back to matching [ if value is non-zero

Additional Commands

Command Description
{LIB} Import external Brainfuck code from bflib/LIB.bf
* Output all cells with pointer highlighted
& Output command history
help Show command reference (REPL only)
quit / exit Exit the REPL
save [FILE] Save tape state to JSON file (default: tape.json, REPL only)

Library Modules

The bflib/ directory contains 31 reusable Brainfuck modules:

Module Description
sum Sum current cell and next cell
sub Subtract next cell from current cell
mul Multiply current cell by next cell
mul2 Multiply current cell by two
div Divide current cell by next cell
mod Modulo of current cell divided by next cell
copy Copy current cell into next cell
move Move current cell to next cell (copy + clear)
swap Swap current cell and next cell
zero Clear current cell (set to zero)
not Logical NOT of current cell
and Logical AND of current and next cell
or Logical OR of current and next cell
eq Test if current cell equals next cell
if If current cell is non-zero, set next cell to 1
sqrt Integer square root of current cell
p5 Add 5 to current cell
p10, p32, p48, p50, p65, p100 Add 5, 10, 32 (space), 48 (digit '0'), 50, 65 ('A'), 100 to current cell
m10, m50, m100 Subtract 10, 50, 100 from current cell
toint Convert ASCII digit character to integer
tochar Convert integer (0-9) to ASCII character
newline Output a newline character (ASCII 10)
lower Convert uppercase ASCII to lowercase
upper Convert lowercase ASCII to uppercase

Architecture

Source Code → Import Resolution → IR Compilation → Execution
                                                        ↓
                                               ┌── Segmented JIT ──┐
                                               │ execute_jit()      │
                                               │ via Numba          │
                                               │                    │
                                               │ Checkpoints at:    │
                                               │  , * &             │
                                               │                    │
                                               │ Python handles I/O │
                                               │ then resumes JIT   │
                                               └────────────────────┘
                                               ┌── Fallback ────────┐
                                               │ (JIT compilation   │
                                               │  failure only)     │
                                               │ Python IR loop     │
                                               └────────────────────┘

IR Compilation

Source code is compiled to an intermediate representation with:

  • Run-length encoding+++++ becomes ('add', 5) in a single operation
  • Pre-resolved jumps[ and ] targets are computed at compile time
  • Numeric encoding — IR tuples converted to NumPy int32 arrays for JIT

Tape Memory

Cells use a pre-allocated NumPy tape of 65,536 cells (64K) for JIT execution, with a hybrid Python storage model for the REPL:

  • Pre-allocated list of 30,000 integers for indices 0-29,999 (O(1) access)
  • Sparse defaultdict for negative indices (rarely used but supported)

Requirements

  • Python >= 3.13
  • Numba >= 0.58.0
  • NumPy >= 1.24.0

Project Structure

advanced-brainfuck/
├── brainfuck/               # Python package
│   ├── __init__.py          # Public API re-exports
│   ├── __main__.py          # python -m brainfuck entry point
│   ├── core.py              # Core interpreter, compiler, JIT, CLI
│   └── bflib/               # Reusable Brainfuck library modules
│       ├── sum.bf
│       ├── copy.bf
│       ├── mul.bf
│       ├── div.bf
│       ├── toint.bf
│       └── ...              # 31 modules total
├── docs/
│   ├── spec/              # Product & technical specifications
│   ├── adr/               # Architecture decision records
│   └── features/           # Feature specifications
├── tests/
│   └── features/           # Test files
├── pyproject.toml          # Package configuration
└── README.md

License

GPLv3 — See LICENSE for details.

Project details


Download files

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

Source Distribution

advanced_brainfuck-2.2.0.tar.gz (52.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

advanced_brainfuck-2.2.0-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file advanced_brainfuck-2.2.0.tar.gz.

File metadata

  • Download URL: advanced_brainfuck-2.2.0.tar.gz
  • Upload date:
  • Size: 52.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for advanced_brainfuck-2.2.0.tar.gz
Algorithm Hash digest
SHA256 8bf1547945960623c78fa2074c073f9d7f63d429623cab73b2f3ab76ba152784
MD5 a202a65f68bcc2739a2624053b075cf1
BLAKE2b-256 4b748c1a2ae5fa4e34b144e39c2c6bbabfcfc3ba59c74d85aaef6c8f3b7b15a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for advanced_brainfuck-2.2.0.tar.gz:

Publisher: pypi-publish.yml on nullhack/advanced-brainfuck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file advanced_brainfuck-2.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for advanced_brainfuck-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2817c029b68a78bfaa13755f3d2f589c4fd0d96598defbf3be1c50d9d79b6cf
MD5 ed1ffee99391390ff5c9a81e8124f2e7
BLAKE2b-256 2c2fd0fb5fb3e9c253929aeef9df107b41aa4d6f2c4d6a1803550d2851096b7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for advanced_brainfuck-2.2.0-py3-none-any.whl:

Publisher: pypi-publish.yml on nullhack/advanced-brainfuck

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page