1. module python-shell
   1. function python-shell (script, options)
   2. function python-shell.run (script, options, callback)
   3. function python-shell.super_ ()
   4. object python-shell.defaultOptions
   5. object python-shell.format
   6. object python-shell.parse
2. module python-shell.format
   1. function python-shell.format.json (data)
   2. function python-shell.format.text (data)
3. module python-shell.parse
   1. function python-shell.parse.json (data)
   2. function python-shell.parse.text (data)

module python-shell

function python-shell (script, options)

• description and source-code

  python-shell = function (script, options) {
  
      function resolve(type, val) {
          if (typeof val === 'string') {
              // use a built-in function using its name
              return PythonShell[type][val];
          } else if (typeof val === 'function') {
              // use a custom function
              return val;
          }
      }
  
      var self = this;
      var errorData = '';
      EventEmitter.call(this);
  
      options = extend({}, PythonShell.defaultOptions, options);
      var pythonPath = options.pythonPath || 'python';
      var pythonOptions = toArray(options.pythonOptions);
      var scriptArgs = toArray(options.args);
  
      this.script = path.join(options.scriptPath || './', script);
      this.command = pythonOptions.concat(this.script, scriptArgs);
      this.mode = options.mode || 'text';
      this.formatter = resolve('format', options.formatter || this.mode);
      this.parser = resolve('parse', options.parser || this.mode);
      this.terminated = false;
      this.childProcess = spawn(pythonPath, this.command, options);
  
      ['stdout', 'stdin', 'stderr'].forEach(function (name) {
          self[name] = self.childProcess[name];
          self.parser && self[name].setEncoding(options.encoding || 'utf8');
      });
  
      // parse incoming data on stdout
      if (this.parser) {
          this.stdout.on('data', PythonShell.prototype.receive.bind(this));
      }
  
      // listen to stderr and emit errors for incoming data
      this.stderr.on('data', function (data) {
          errorData += ''+data;
      });
  
      this.stderr.on('end', function(){
          self.stderrHasEnded = true
          terminateIfNeeded();
      })
  
      this.stdout.on('end', function(){
          self.stdoutHasEnded = true
          terminateIfNeeded();
      })
  
      this.childProcess.on('exit', function (code) {
          self.exitCode = code;
          terminateIfNeeded();
      });
  
      function terminateIfNeeded() {
          if (!self.stderrHasEnded || !self.stdoutHasEnded || self.exitCode == null) {
              return;
          }
          var err;
          if (errorData || self.exitCode !== 0) {
              if (errorData) {
                  err = self.parseError(errorData);
              } else {
                  err = new Error('process exited with code ' + self.exitCode);
              }
              err = extend(err, {
                  executable: pythonPath,
                  options: pythonOptions.length ? pythonOptions : null,
                  script: self.script,
                  args: scriptArgs.length ? scriptArgs : null,
                  exitCode: self.exitCode
              });
              // do not emit error if only a callback is used
              if (self.listeners('error').length || !self._endCallback) {
                  self.emit('error', err);
              }
          }
          self.terminated = true;
          self.emit('close');
          self._endCallback && self._endCallback(err);
      }
  }

• example usage

  n/a

function python-shell.run (script, options, callback)

• description and source-code

  run = function (script, options, callback) {
      if (typeof options === 'function') {
          callback = options;
          options = null;
      }
  
      var pyshell = new PythonShell(script, options);
      var output = [];
  
      return pyshell.on('message', function (message) {
          output.push(message);
      }).end(function (err) {
          if (err) return callback(err);
          return callback(null, output.length ? output : null);
      });
  }

• example usage

  ...
  ## Documentation
  
  ### Running a Python script:
  
  ```js
  var PythonShell = require('python-shell');
  
  PythonShell.run('my_script.py', function (err) {
    if (err) throw err;
    console.log('finished');
  });
  ```
  
  If the script writes to stderr or exits with a non-zero code, an error will be thrown.
  ...

function python-shell.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module python-shell.format

function python-shell.format.json (data)

• description and source-code

  function toJson(data) {
      return JSON.stringify(data);
  }

• example usage

  n/a

function python-shell.format.text (data)

• description and source-code

  function toText(data) {
      if (!data) return '';
      else if (typeof data !== 'string') return data.toString();
      return data;
  }

• example usage

  n/a

module python-shell.parse

function python-shell.parse.json (data)

• description and source-code

  function asJson(data) {
      return JSON.parse(data);
  }

• example usage

  n/a

function python-shell.parse.text (data)

• description and source-code

  function asText(data) {
      return data;
  }

• example usage

  n/a