PythonRunner.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidQtWidgets/Common/PythonRunner.h"
#include "MantidKernel/Logger.h"
 
#include <QDir>
#include <QTemporaryFile>
#include <QTextStream>
#include <sstream>
#include <stdexcept>
 
using namespace MantidQt::API;
 
namespace {
Mantid::Kernel::Logger g_log("PythonRunner");
 
QString PYTHON_V1_WARN = "Warning: Python API v1 call has been made.\n";
} // namespace
 
QString PythonRunner::runPythonCode(const QString &code, bool no_output) {
  using Mantid::Kernel::Logger;
 
  if (g_log.is(Logger::Priority::PRIO_DEBUG))
    g_log.debug() << "Running Python code:\n" << qPrintable(code) << "\n";
 
  if (no_output) {
    emit runAsPythonScript(code, true);
    return QString();
  }
 
  // Otherwise we need to gather the information from stdout. This is achieved
  // by redirecting the stdout stream
  // to a temproary file and then reading its contents
  // A QTemporaryFile object is used since the file is automatically deleted
  // when the object goes out of scope
  QTemporaryFile tmp_file;
  if (!tmp_file.open()) {
    throw std::runtime_error("An error occurred opening a temporary file in " + QDir::tempPath().toStdString());
  }
  // The file name is only valid when the file is open
  QString tmpstring = tmp_file.fileName();
  tmp_file.close();
  QString code_to_run = "import sys; sys.stdout = open(\"" + tmpstring + "\", 'w');\n" + code;
  emit runAsPythonScript(code_to_run, true);
 
  // Now get the output
  tmp_file.open();
  QTextStream stream(&tmp_file);
  tmpstring.clear();
 
  while (!stream.atEnd()) {
    tmpstring.append(stream.readLine().trimmed() + "\n");
  }
  if (g_log.is(Logger::Priority::PRIO_DEBUG))
    g_log.debug() << "Raw output from execution:\n" << qPrintable(tmpstring) << "\n";
  return tmpstring;
}
const QString PythonRunner::stringList2Tuple(const QStringList &list) {
  QString tuple("(");
  QStringList::const_iterator end = list.end();
  for (QStringList::const_iterator it = list.begin(); it != end; ++it) {
    tuple += "'" + *it + "',";
  }
  tuple += ")";
  return tuple;
}