Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.67 KB

README.md

File metadata and controls

51 lines (40 loc) · 1.67 KB
Raw

pemog

Python Extension-Module Generator

The goal of pemog is to generate portions of code of python extension modules in C or C++, based on a python module source code (written in python). For now, only C can be generated.

Installation

You need ghc to be installed on your system.

git clone https://github.com/Nicolas-Reyland/pemog
cd pemog
./install

You should make sure that $HOME/.local/bin is included in your path.

Usage

With python files :

pemog name input-file.py namemodule.c

The name should be the name of the module

With sketch files :

pemog name input-file.sketch namemodule.c

The sketch files describe one function of your extension module per line. Each line should be formatted like this :

function_name (arg-1-type-hint, arg2-type-hint, ...) return-type-hint

If a type is not a known (int, src, bool, etc.) type, you can replace it with the ? character. If your function does not have any return-type, you can use ? as a return type or simply not give one (the line can stop after the )).

A sketch input file could look like this :

system(str) int
test ()
example(int, str, ?)
twoplustwo (?,?) ?

It basically describes the functions you want to implement. If you do not wish to write sketch files, just give your python code (must end with .py) !

TODO :

  • Use language-python or hpython for python parsing
  • Generate code for return
  • Documentation generation based on argument types, function return-type etc.
  • Split generated code into multiple files
  • Testing