IPropertyManager.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 "MantidKernel/IPropertyManager.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/IPropertySettings.h"
#include "MantidPythonInterface/core/GetPointer.h"
#include "MantidPythonInterface/kernel/Registry/PropertyValueHandler.h"
#include "MantidPythonInterface/kernel/Registry/PropertyWithValueFactory.h"
#include "MantidPythonInterface/kernel/Registry/TypeRegistry.h"
 
#include <boost/python/class.hpp>
#include <boost/python/copy_const_reference.hpp>
#include <boost/python/dict.hpp>
#include <boost/python/iterator.hpp>
#include <boost/python/list.hpp>
#include <boost/python/register_ptr_to_python.hpp>
#include <boost/python/return_internal_reference.hpp>
#include <boost/python/stl_iterator.hpp>
#include <boost/python/str.hpp>
 
using namespace Mantid::Kernel;
namespace Registry = Mantid::PythonInterface::Registry;
using namespace boost::python;
using ExtractStdString = extract<std::string>;
 
GET_POINTER_SPECIALIZATION(IPropertyManager)
 
namespace {
void setProperty(IPropertyManager &self, const std::string &name, const boost::python::object &value) {
  ExtractStdString valuecpp(value);
  if (valuecpp.check()) {
    self.setPropertyValue(name, valuecpp());
  } else {
    try {
      const Property *p = self.getProperty(name);
      const auto &entry = Registry::TypeRegistry::retrieve(*(p->type_info()));
      entry.set(&self, name, value);
    } catch (std::invalid_argument &e) {
      throw std::invalid_argument("When converting parameter \"" + name + "\": " + e.what());
    }
  }
}
 
void setProperties(IPropertyManager &self, const boost::python::dict &kwargs) {
  const object view = kwargs.attr("items")();
  const object objectItems(handle<>(PyObject_GetIter(view.ptr())));
  auto begin = stl_input_iterator<object>(objectItems);
  auto end = stl_input_iterator<object>();
  for (auto it = begin; it != end; ++it) {
    setProperty(self, ExtractStdString((*it)[0])(), (*it)[1]);
  }
}
 
void declareProperty(IPropertyManager &self, const std::string &name, const boost::python::object &value) {
  auto p = std::unique_ptr<Property>(Registry::PropertyWithValueFactory::create(name, value, 0));
  self.declareProperty(std::move(p));
}
 
void declareOrSetProperty(IPropertyManager &self, const std::string &name, const boost::python::object &value) {
  bool propExists = self.existsProperty(name);
  if (propExists) {
    setProperty(self, name, value);
  } else {
    declareProperty(self, name, value);
  }
}
 
void declareOrReplaceProperty(IPropertyManager &self, const std::string &name,
                              const boost::python::object &defaultValue, const boost::python::object &validator,
                              const std::string &doc, const int direction) {
  auto prop =
      std::unique_ptr<Property>(Registry::PropertyWithValueFactory::create(name, defaultValue, validator, direction));
  self.declareOrReplaceProperty(std::move(prop), doc);
}
 
void setPropertySettings(IPropertyManager &self, const std::string &propName,
                         const IPropertySettings *settingsManager) {
  self.setPropertySettings(propName, std::unique_ptr<IPropertySettings>(settingsManager->clone()));
}
 
void deleteProperty(IPropertyManager &self, const std::string &propName) { self.removeProperty(propName); }
 
boost::python::list getKeys(const IPropertyManager &self) {
  const std::vector<Property *> &props = self.getProperties();
  const size_t numProps = props.size();
 
  boost::python::list result;
  for (size_t i = 0; i < numProps; ++i) {
    result.append(props[i]->name());
  }
 
  return result;
}
 
Property *get(const IPropertyManager &self, const std::string &name, const boost::python::object &value) {
  try {
    return self.getPointerToProperty(name);
  } catch (Exception::NotFoundError &) {
    return Registry::PropertyWithValueFactory::create(name, value, 0).release();
  }
}
} // namespace
 
void export_IPropertyManager() {
  register_ptr_to_python<IPropertyManager *>();
 
  class_<IPropertyManager, boost::noncopyable>("IPropertyManager", no_init)
      .def("propertyCount", &IPropertyManager::propertyCount, arg("self"),
           "Returns the number of properties being managed")
 
      .def("getProperty", &IPropertyManager::getPointerToProperty, (arg("self"), arg("name")),
           return_internal_reference<>(),
           "Returns the property of the given name. Use .value to give the "
           "value")
 
      .def("getPropertyValue", &IPropertyManager::getPropertyValue, (arg("self"), arg("name")),
           "Returns a string representation of the named property's value")
 
      .def("getProperties", &IPropertyManager::getProperties, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the list of properties managed by this object")
 
      .def("declareProperty", &declareProperty, (arg("self"), arg("name"), arg("value")), "Create a new named property")
 
      .def("declareOrReplaceProperty", &declareOrReplaceProperty,
           (arg("self"), arg("name"), arg("defaultValue"), arg("validator") = object(), arg("doc") = "",
            arg("direction") = Direction::Input),
           "Declares or replaces a named property where the type is taken from "
           "the type of the defaultValue and mapped to an appropriate C++ "
           "type")
 
      .def("setPropertyValue", &IPropertyManager::setPropertyValue, (arg("self"), arg("name"), arg("value")),
           "Set the value of the named property via a string")
 
      .def("setProperty", &setProperty, (arg("self"), arg("name"), arg("value")), "Set the value of the named property")
      .def("setProperties", &setProperties, (arg("self"), arg("kwargs")), "Set a collection of properties from a dict")
 
      .def("setPropertySettings", &setPropertySettings, (arg("self"), arg("name"), arg("settingsManager")),
           "Assign the given IPropertySettings object to the  named property")
 
      .def("setPropertyGroup", &IPropertyManager::setPropertyGroup, (arg("self"), arg("name"), arg("group")),
           "Set the group for a given property")
 
      .def("existsProperty", &IPropertyManager::existsProperty, (arg("self"), arg("name")),
           "Returns whether a property exists")
 
      // Special methods so that IPropertyManager acts like a dictionary
      // __len__, __getitem__, __setitem__, __delitem__, __iter__ and
      // __contains__
      .def("__len__", &IPropertyManager::propertyCount, arg("self"), "Returns the number of properties being managed")
      .def("__getitem__", &IPropertyManager::getPointerToProperty, (arg("self"), arg("name")),
           return_value_policy<return_by_value>(),
           "Returns the property of the given name. Use .value to give the "
           "value")
      .def("__setitem__", &declareOrSetProperty, (arg("self"), arg("name"), arg("value")),
           "Set the value of the named property or create it if it doesn't "
           "exist")
      .def("__delitem__", &deleteProperty, (arg("self"), arg("name")), "Delete the named property")
      // TODO   .def("__iter__", iterator<std::vector<std::string> > ())
      .def("__contains__", &IPropertyManager::existsProperty, (arg("self"), arg("name")),
           "Returns whether a property exists")
 
      // Bonus methods to be even more like a dict
      .def("has_key", &IPropertyManager::existsProperty, (arg("self"), arg("name")),
           "Returns whether a property exists")
      .def("keys", &getKeys, arg("self"))
      .def("values", &IPropertyManager::getProperties, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the list of properties managed by this object")
      .def("get", &get, (arg("self"), arg("name"), arg("value")), return_value_policy<return_by_value>(),
           "Returns the property of the given name. Use .value to give the "
           "value. If property with given name does not exist, returns given "
           "default value.");
}