Skip to main content

A preprocessor to turn python code with braces into python

Project description

CurlyPy: Python with Brackets

CurlyPy is a preprocessor that translates Python code written using curly braces ({}) into standard Python, making indentation obsolete. It provides the flexibility to use semicolons (;) as optional statement separators, making Python syntax more familiar to developers accustomed to languages like C, Java, or JavaScript.

With CurlyPy, you can write Python code using braces to define code blocks, eliminating the need for indentation while still retaining Python's powerful features.

Key Features

  • Curly Braces for Code Blocks: Use {} to denote the start and end of code blocks, removing the need for indentation.
  • Semi-Mandatory Semicolons: Semicolons (;) are supported as optional separators between statements, but they are still not strictly required after every statement. They will, however, be required if you are writing multiple instructions in the same line.
  • Flexible Syntax: Write Python code with a more structured format, closer to languages like C, Java, or JavaScript, while keeping all the strengths of Python.
  • Compatible with Python: CurlyPy preprocesses your code into standard Python, so it can be executed by any Python interpreter.
  • Dictionary and Set Types: The standard Python dictionary and set types are available in CurlyPy, using type hints.

Valid CurlyPy syntax:

# Dictionaries and sets are defined using type hints
dictionary_test: dict[str, str] = {
   "foo":"bar", 
   "baz":{
      "qux":"quux"
   }
}
set_test: set[str] = {"foo", "bar", "baz"}
print(dictionary_test["foo"], set_test)

CurlyPy makes even this syntax possible!

def check_even_odd(num) { print(f"{num} is {'even' if num % 2 == 0 else 'odd'};"); }; check_even_odd(10); check_even_odd(7);

Installation

Install from PyPI:

pip install curlypy

Usage

Once you have CurlyPy installed, you can preprocess your Python files written with curly braces and optional semicolons into standard Python.

Module usage:

# some_file.py
from curlypy import CurlyPyTranslator

translator = CurlyPyTranslator(filename="curlypython.cpy")
translated_code: str = translator.translate()

with open("translated.py", "+w") as out:
    out.write(translated_code)
# Then run translated.py using python

Command line usage:

# Example usage
>> python -m curlypy --run path/to/cpy/file --output path/to/output/python/file --keep

# To get help
>> python -m curlypy --h
usage: python -m curlypy [-h] [--output OUTPUT] [--run] [--comments] [--force] [--delete] filename

Translate and run python code with braces

positional arguments:
  filename         The filename to translate.

options:
  -h, --help       show this help message and exit
  --output OUTPUT  The output filename. Defaults to <filename>.py
  --run            Set this flag if you want to run the translated code directly after translating.
  --comments       Set this flag if you want to keep comments in the translated code.
  --force          Set this flag if you want to force the translation. i.e. dont perform any checks. Can output non working code. Defaults to False.
  --delete         Set this flag if you want to delete the translated file after running it.

CurlyPy will convert your code with brackets into traditional Python with correct indentation and block structures.

Example

Here’s how Python code with curly braces and semicolons looks with CurlyPy:

def HelloWorld(name: str) {
	if name {
		print (f"Hello {name}!")
	}
	else {
		print ("Hello World!")
	}
}

After running CurlyPy, it will be converted into regular Python:

def HelloWorld(name: str) :
   if name :
      print (f"Hello {name}!")
   else :
      print ("Hello World!")

Why CurlyPy?

Python’s indentation-based syntax is great for readability but may feel unfamiliar to developers used to brace-based languages like C, Java, or JavaScript. CurlyPy gives you the freedom to write Python code with curly braces, making it easier for those developers to transition to Python without abandoning the structured code block formatting they’re used to.

CurlyPy doesn't take away Python’s flexibility—if you love type hints and it's strong typing, you can keep using them as is. CurlyPy opens up new possibilities for those who prefer braces.

CurlyPy:

# For loop
for n in range(10){
    if n % 3 == 0 and n % 5 == 0 {
        print("FizzBuzz")
	}
    elif n % 3 == 0 {
		print("Fizz")
	}
    elif n % 5 == 0 {
		print("Buzz")
	}
    else{
        print(n)
	}
}

Translated Python:

# For loop
for n in range(10):
   if n % 3 == 0 and n % 5 == 0 :
      print("FizzBuzz")
   elif n % 3 == 0 :
      print("Fizz")
   elif n % 5 == 0 :
      print("Buzz")
   else:
      print(n)

Upcoming improvements

  • Better documentation
  • Documentation on using CurlyPy as a python module
  • Script to directly run the translated python code
  • Possibly a new name
  • Better command line argument parsing
  • Error checking

Current Limitations

  • Empty blocks are not supported, leading to a syntax error in python.
x = 5;
if x == 5 {
    ;       # Will cause python code to be problematic
}

# Use this instead
if x == 5 {
   pass;
}
  • Error checking is not implemented
def incomplete_func() {
    print("This will fail");
# Missing closing bracket, but translated code will work. (Rare case)
  • Complex typehints for dictionary and set types are not supported and will lead to a syntax error in the generated python code.
complex_type: dict[str, set[int]] = {"evens": {0, 2, 4}, "odds": {1, 3, 5}};  # Complex type hint with sets and dicts

Contributing

Contributions are welcome! If you want to contribute to CurlyPy or report an issue, please feel free to open an issue or submit a pull request.

Steps to Contribute:

  1. Fork the repository
  2. Create a new branch for your feature or bug fix
  3. Submit a pull request with a clear description of the change

Why not bython?

I wanted to make my own version of a preprocessor for Python with braces, that's all.

License

This project is licensed under the GNU General Public License. See the LICENSE file for details.


Enjoy writing Python with the structure and familiarity of braces with CurlyPy!

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

curlypy-0.0.3.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

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

curlypy-0.0.3-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file curlypy-0.0.3.tar.gz.

File metadata

  • Download URL: curlypy-0.0.3.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for curlypy-0.0.3.tar.gz
Algorithm Hash digest
SHA256 876a0e739c0f67612cbc8b7ba1f60be13b9c6365bbf01b7698f8cf5d699f31a8
MD5 ddbde5947c77ed56dd90aa5e52790f46
BLAKE2b-256 e627c2f734e0490a8c971900388d6e43731ff97f05d06590ddcd7d5036943111

See more details on using hashes here.

File details

Details for the file curlypy-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: curlypy-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for curlypy-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aa8f19ed4b20e42a05649ff012bdb2dd083b5da035cc8e7bc75ee7b24c79ab2c
MD5 f6b9b16126c47b0252d0cba7c877c58b
BLAKE2b-256 9c3ca4a8cab479fb86273334a046197125b16d132e6da17e491cbe059126035e

See more details on using hashes here.

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