Phyton 🌱

Phyton (Greek Φυτόν for "plant") is a Python interpreter that accepts multiple spellings of keywords, designed to confuse bad spellers!

Inspired by a suggestion from Michael A. Covington, author of Natural Language Processing for Prolog Programmers 🙌

Features

• Accepts common misspellings of Python keywords
• Interactive REPL mode
• File execution mode
• Friendly error messages
• Fuzzy matching for unknown misspellings (optional)
• Supports creative variations like prin for print, deff for def, etc.

Supported Misspellings

Keywords

• def → deff, define, defin
• if → iff, iif
• elif → elsif, elseif, else_if
• else → els, elze
• for → fore, four, fr
• while → wile, whyle, whil
• in → inn, iin
• return → retrun, retrn, ret
• import → imprt, imort, importt
• from → frm, fom
• as → az, ass
• class → clas, clss, klass
• try → tri, tyr
• except → exept, excpt, catch
• finally → finaly, finale
• with → wth, wit
• and → andd, adn, &
• or → orr, |
• not → nott, no, !

Built-ins

• True → true, TRUE, tru
• False → false, FALSE, fals
• None → none, NONE, null, nil
• print → prin, prnt, pritn

Usage

Interactive Mode

# Using Python directly
python3 phyton.py

# Using the launcher script
./phyton

File Execution

# Using Python directly (fuzzy matching disabled by default)
python3 phyton.py examples/quick_start.phy

# Using the launcher script (recommended)
./phyton examples/quick_start.phy

# Enable fuzzy matching for unknown misspellings
python3 phyton.py --fuzzy examples/quick_start.phy
./phyton --fuzzy examples/quick_start.phy

Command Line Options

Phyton accepts misspelled command line options too! Try these:

# These all work thanks to option misspelling correction:
./phyton --halp                    # → --help
./phyton --fuzy file.phy           # → --fuzzy  
./phyton --interactiv              # → --interactive

Fuzzy Matching

Phyton includes fuzzy matching that can correct unknown misspellings not in the predefined dictionary:

# Default behavior - fuzzy matching disabled
python3 phyton.py your_file.phy

# Enable fuzzy matching for unknown misspellings
python3 phyton.py --fuzzy your_file.phy

# Interactive mode (fuzzy disabled by default)
python3 phyton.py --interactive

Examples of fuzzy corrections:

• defff → def
• printt → print
• prrint → print

⚡ Note: Fuzzy matching is disabled by default for predictable behavior. Use --fuzzy to enable advanced spelling correction.

Examples

All example files are located in the examples/ folder with memorable names:

• quick_start.phy - Perfect first Phyton program
• hello_world.phy - Classic programming with misspellings
• spelling_game.phy - Interactive spelling game
• advanced_features.phy - Complex programming constructs
• bad_spellers_paradise.phy - Maximum misspelling density
• spelling_nightmare.phy - Ultimate stress test

See examples/README.md for detailed descriptions and learning path.

Examples

Quick Start Example

# This is valid Phyton code!
deff greet(name):
    prin(f"Hello, {name}!")

iff name == "World":
    greet("Phyton")
els:
    greet("Python")

Advanced Example

klass Plant:
    deff __init__(self, species):
        self.species = species
    
    deff grow(self):
        retrun f"{self.species} is growing! 🌿"

fore i inn range(3):
    plant = Plant(f"Plant {i}")
    prin(plant.grow())

For more examples, see the examples/ folder!

Quick Start

1. Try the demo: ./demo.sh - Runs all 6 examples
2. Start simple: ./phyton examples/quick_start.phy
3. Go interactive: ./phyton for REPL mode
4. Explore: Check examples/README.md for learning path

Testing

Phyton includes a comprehensive test suite to ensure all functionality works correctly.

Running Tests

# Install test dependencies
pip install -r requirements.txt

# Run all tests with pytest
python -m pytest test_phyton.py -v

# Run tests with coverage
python -m pytest test_phyton.py --cov=phyton --cov-report=term

# Check code quality with pylint
pylint phyton.py
pylint test_phyton.py

Test Coverage

The test suite includes 130 tests covering:

• All keyword mappings (33 tests)
• Fuzzy matching functionality (15 tests)
• Command-line argument parsing (20 tests)
• File execution and error handling (25 tests)
• Interactive mode (10 tests)
• Edge cases and comprehensive coverage (27 tests)

Current coverage: 79% with perfect pylint score (10/10)

Continuous Integration

GitHub Actions automatically runs all tests on:

• Python 3.8, 3.9, 3.10, 3.11, and 3.12
• Code quality checks with pylint
• Coverage reporting

File Extensions

While Phyton can execute any .py file, we recommend using .phy extension for Phyton files to distinguish them from regular Python files.

Contributing

Feel free to add more creative misspellings! The goal is to accept as many common typos and variations as possible while still being functional.

When contributing:

1. Add tests for new functionality
2. Ensure all tests pass: python -m pytest test_phyton.py
3. Check code quality: pylint phyton.py test_phyton.py
4. Update documentation as needed

Why?

Because everyone deserves to code, even if they can't spell "def" correctly! 🌱