Skip to main content

Allows object oriented running of code/commands

Project description

commandRunner is yet another package created to handle running commands, scripts or programs on the command line. The principle class lets you run anything locally on your machine. Later classes are targetted at Analytics and data processing platforms such as Grid Engine and HADOOP. The class attempts to run commands in a moderately thread safe way by requiring that you provide with sufficient information that it can build a uniquely labelled temp directory for all input and output files. This means that this can play nicely with things like Celery workers.

Release 0.2

This release supports running commands on localhost. It also uses interpolation for the commands with the same syntax and python templates


In the future we’ll provide classes to run commands over RServe, Grid Engine, Hadoop, Octave, and SAS Server.


This is the basic usages:

from commandRunner import *

r = commandRunner(tmp_id="ID_STRING", tmp_path=,/tmp/"
        ", out_glob=.out",
                  command="ls /tmp > $OUTPUT", input_data="STRING OF DATA")
exit_status = r.run_cmd(success_params=[0])

__init__ initalises all the class variables needed and performs the command string interpolation.

r.prepare() builds a temporary directory and makes any input file which is needed. In this instance “ID_STRING”, and a path where temporary files can be placed are used to create a tempdir called /tmp/ID_STRING/. Next it takes and string of data and makes and input file given the provided input file ending (.in) which would be /tmp/ID_STRING/ and this file would contain “STRING OF DATA”.

tmp_id, tmp_path and command are required.

in_glob is only required if the command contains $INPUT and input data is given

r.run_cmd(success_params=[0]) runs the command string provided. First anything labelled $OUTPUT of $INPUT will be replaced with the path to the temporary files the process will generate. In this instance “ls /tmp > $OUTPUT” will become “ls /tmp > /tmp/ID_STRING/ID_STRING.out”. We can provide an array of unix exits statuses we consider to be succesful exists, default is [0]. Any command will be run so this is potentially very dangerous. The exit status of the command is returned.

r.tidy() cleans up deleting any input and output files and the temporary working directory. Any data in the output file is read in to r.output_data


Run tests with:

python test


  1. Implement rserveRunner for running commands in r
  2. Implement geRunner for running commands on Grid Engine
  3. Implement hadoopRunner for running command on Hadoop
  4. Refactor commandRunner to abstract base class
  5. Move commandRunner tests out of localRunner tests
  6. Implement sasRunner for a SAS backend
  7. Implement octaveRunner for Octave backend
  8. matlab? mathematica?

Project details

Download files

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

Files for commandRunner, version 0.2.8
Filename, size File type Python version Upload date Hashes
Filename, size commandRunner-0.2.8.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page