NotebookBuilder.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 +
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/NotebookBuilder.h"
#include "MantidAPI/AlgorithmFactory.h"
#include "MantidAPI/HistoryItem.h"
#include "MantidKernel/Logger.h"
#include "MantidKernel/Property.h"
 
#include <boost/utility.hpp>
#include <utility>
 
namespace Mantid::API {
 
using Mantid::Kernel::PropertyHistory_const_sptr;
using Mantid::Kernel::PropertyHistory_sptr;
 
namespace {
Mantid::Kernel::Logger g_log("NotebookBuilder");
}
 
NotebookBuilder::NotebookBuilder(const std::shared_ptr<HistoryView> &view, std::string versionSpecificity)
    : m_historyItems(view->getAlgorithmsList()), m_output(), m_versionSpecificity(std::move(versionSpecificity)),
      m_nb_writer(new NotebookWriter()) {}
 
const std::string NotebookBuilder::build(const std::string &ws_name, const std::string &ws_title,
                                         const std::string &ws_comment) {
  // record workspace details in notebook
  std::string workspace_details;
  workspace_details = "Workspace History: " + ws_name + "\n";
  workspace_details += "------------------------\n";
  workspace_details += ws_title + "\n";
  workspace_details += ws_comment;
  m_nb_writer->markdownCell(workspace_details);
 
  auto iter = m_historyItems.begin();
  for (; iter != m_historyItems.end(); ++iter) {
    writeHistoryToStream(iter);
  }
  return m_nb_writer->writeNotebook();
}
 
void NotebookBuilder::writeHistoryToStream(std::vector<HistoryItem>::const_iterator &iter) {
  auto algHistory = iter->getAlgorithmHistory();
  if (iter->isUnrolled()) {
 
    m_nb_writer->markdownCell(std::string("Child algorithms of ") + algHistory->name());
 
    buildChildren(iter);
 
    m_nb_writer->markdownCell(std::string("End of child algorithms of ") + algHistory->name());
 
  } else {
    // create the string for this algorithm
    m_nb_writer->codeCell(buildAlgorithmString(algHistory));
  }
}
 
void NotebookBuilder::buildChildren(std::vector<HistoryItem>::const_iterator &iter) {
  size_t numChildren = iter->numberOfChildren();
  ++iter; // move to first child
  for (size_t i = 0; i < numChildren && iter != m_historyItems.end(); ++i, ++iter) {
    writeHistoryToStream(iter);
  }
  --iter;
}
 
const std::string NotebookBuilder::buildAlgorithmString(const AlgorithmHistory_const_sptr &algHistory) {
  std::ostringstream properties;
  const std::string name = algHistory->name();
  std::string prop;
 
  auto props = algHistory->getProperties();
  for (auto &propIter : props) {
    prop = buildPropertyString(propIter);
    if (prop.length() > 0) {
      properties << prop << ", ";
    }
  }
 
  // Three cases, we can either specify the version of every algorithm...
  if (m_versionSpecificity == "all") {
    properties << "Version=" << algHistory->version() << ", ";
  } else if (m_versionSpecificity == "old") {
    //...or only specify algorithm versions when they're not the newest version
    const auto &algName = algHistory->name();
    auto &algFactory = API::AlgorithmFactory::Instance();
    int latestVersion = 0;
 
    if (algFactory.exists(algName)) { // Check the alg still exists in Mantid
      latestVersion = AlgorithmFactory::Instance().highestVersion(algName);
    }
    // If a newer version of this algorithm exists, then this must be an old
    // version.
    if (latestVersion > algHistory->version()) {
      properties << "Version=" << algHistory->version() << ", ";
    }
  }
  // Third case is we never specify the version, so do nothing.
 
  std::string propStr = properties.str();
  if (propStr.length() > 0) {
    // remove trailing comma & space
    propStr.erase(propStr.size() - 1);
    propStr.erase(propStr.size() - 1);
  }
 
  return name + "(" + propStr + ")";
}
 
const std::string NotebookBuilder::buildPropertyString(const PropertyHistory_const_sptr &propHistory) {
  using Mantid::Kernel::Direction;
 
  // Create a vector of all non workspace property type names
  std::vector<std::string> nonWorkspaceTypes{"number", "boolean", "string"};
 
  std::string prop;
  // No need to specify value for default properties
  if (!propHistory->isDefault()) {
    // Do not give values to output properties other than workspace properties
    if (find(nonWorkspaceTypes.begin(), nonWorkspaceTypes.end(), propHistory->type()) != nonWorkspaceTypes.end() &&
        propHistory->direction() == Direction::Output) {
      g_log.debug() << "Ignoring property " << propHistory->name() << " of type " << propHistory->type() << '\n';
      // Handle numerical properties
    } else if (propHistory->type() == "number") {
      prop = propHistory->name() + "=" + propHistory->value();
      // Handle boolean properties
    } else if (propHistory->type() == "boolean") {
      std::string value = (propHistory->value() == "1" ? "True" : "False");
      prop = propHistory->name() + "=" + value;
      // Handle all other property types
    } else {
      std::string opener = "='";
      if (propHistory->value().find('\\') != std::string::npos) {
        opener = "=r'";
      }
 
      prop = propHistory->name() + opener + propHistory->value() + "'";
    }
  }
 
  return prop;
}
 
} // namespace Mantid::API