RunPythonScript.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 +
#pragma once
 
#include "MantidAPI/Algorithm.h"
#include "MantidPythonInterface/api/DllConfig.h"
 
#include <boost/python/dict.hpp>
 
namespace Mantid {
namespace PythonInterface {
 
class PYTHON_API_DLL RunPythonScript final : public API::Algorithm {
public:
  const std::string name() const override;
  int version() const override;
  const std::string category() const override;
  const std::string summary() const override;
  std::map<std::string, std::string> validateInputs() override;
 
private:
  bool checkGroups() override;
  void init() override;
  void exec() override;
 
  std::string scriptCode() const;
  std::shared_ptr<API::Workspace> executeScript(const std::string &script) const;
  boost::python::dict doExecuteScript(const std::string &script) const;
  boost::python::dict buildLocals() const;
  std::shared_ptr<API::Workspace> extractOutputWorkspace(const boost::python::dict &locals) const;
};
 
} // namespace PythonInterface
} // namespace Mantid