Programs as Objects
Project description
Programlib: programs as objects
Programlib is a tool that turns programs in any programming language into convenient Python objects, letting you run any string as a C++/Python/Clojure/etc program from a Python script. This project is aimed to help develop automatic programming and genetic software improvement systems, though many other applications are possible.
Installation
Programlib can be installed with
pip install programlib
However, you have to also make sure that the programming languages you want to use are installed.
By default, programlib uses command line tools that come with the programming languages, i.e. python3
or javac
.
Standard usage
Create a program object with
from programlib import Program
program = Program(source_code, language='C++')
This object has
- a
run
method that runs the program and returns a list of strings it printed tostdout
. You can optionally provide a list of input strings as well. - a
test
method that takes a list of test cases. A test case is a tuple of 2 lists: the first list is the input strings, the second is the expected output strings. The method returns percentage of output strings that matched expectations. - a
save
method that will save the source code to a file at the specified path.
See also examples
.
Currently supported programming languages out of the box are C++, Python, Java, Clojure, Ruby, Rust, Go, Haskell, Scala, Kotlin, PHP, C#, Swift, D, Julia, Clojure, Elixir and Erlang. See "Advanced usage" below for instructions on how to add other languages.
Advanced usage
Language configuration
When you create a program object with a language name like language='C++'
, programlib
retrieves an appropriate language configuration from it's database.
If you have a different opinion on how to compile or run in this language or want to use a language that is not supported out of the box, you can create your own language configuration object:
from programlib import Program, Language
language = Language(
build_cmd='g++ {name}.cpp -o {name}',
run_cmd='./{name}',
source='{name}.cpp',
artefacts=['{name}']
)
program = Program(source_code, language=language)
source
parameter describes the naming convention for the source file (usually {name}.extension
). Make sure that this parameter contains a {name}
placeholder, so that programlib
can keep track of several source files at the same time.
build_cmd
and run_cmd
respectively instruct programlib
which commands to use to compile and run the program in this language.
artefacts
is a list of all the files produced by build_cmd
command.
It is needed to clean up the artefacts when the program object is destroyed.
Error handling
Any output written to stderr
is considered an error.
By default, any errors at build time or run time will lead to an exception being raised, with 2 exceptions:
test
function that catches exceptions during test cases execution and marks these tests as failed.- Setting
program.run(force=True)
orprogram.test(force=True)
will makeprogramlib
ignore all errors.
You can check program.stdout
and program.stderr
to see what the program printed to stdout
and stderr
during the last run (or, if in was never run, during build).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for programlib-4.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3450f24b382da0d00949e4d36f57083445b5029c7ad0f168d20c7e6f2d9be07 |
|
MD5 | 5120a9a2f24f15bc780f45d9a6e6e807 |
|
BLAKE2b-256 | e967251ae65df74caa66185dfd30d515e7a56f9425a83765060bc7e57bf43fe5 |