Function InitProperty

Wrapping/Python/mitk/Property.cpp:35–184

* \brief Initializes Python bindings for MITK property types. * * Registers BaseProperty and its concrete subclasses (StringProperty, * BoolProperty, IntProperty, FloatProperty, DoubleProperty, ColorProperty), * plus the PropertyNotOwnedError exception. */

 * plus the PropertyNotOwnedError exception.
 */
void InitProperty(py::module_ &m)
{
  auto propertyNotOwnedError =
    py::register_exception<PropertyNotOwnedError>(m, "PropertyNotOwnedError", PyExc_AttributeError);
  propertyNotOwnedError.attr("__doc__") =
    R"(Raised when ``set_property()`` or ``remove_property()`` is called on a
property that is provided read-only (not owned) by this object.

Subclass of ``AttributeError``. Use :py:meth:`property_is_owned` to check
before writing.
)";

  py::class_<mitk::BaseProperty, mitk::BaseProperty::Pointer>(m, "BaseProperty",
    R"(Abstract base class for typed property values.

Every property attached to an MITK object is a ``BaseProperty`` subclass:
:py:class:`StringProperty`, :py:class:`BoolProperty`,
:py:class:`IntProperty`, :py:class:`FloatProperty`,
:py:class:`DoubleProperty`, :py:class:`ColorProperty`,
:py:class:`TemporoSpatialStringProperty`.

When you read properties through the :py:attr:`Image.properties` mapping
(or via :py:meth:`get_property`), values are auto-coerced to Python-native
types. The raw ``BaseProperty`` is reachable with ``raw=True``.
)")
    .def("__str__", &mitk::BaseProperty::GetValueAsString,
      "Return the property value as a string.")
    .def("__repr__",
         [](const mitk::BaseProperty &p)
         { return "<mitk." + std::string(p.GetNameOfClass()) + ": " + p.GetValueAsString() + ">"; })
    .def("__eq__", [](const mitk::BaseProperty &a, const mitk::BaseProperty &b) { return a == b; })
    .def("to_json",
         [](const mitk::BaseProperty &p) { return mitk::ConvertPropertyToSelfContainedJson(&p).dump(); },
         R"(Serialize this property to a self-contained JSON string.

The string carries enough type information that :py:meth:`from_json` can
reconstruct the correct subclass.

Returns:
    JSON string representation of the property.
)")
    .def_static(
      "from_json",
      [](const std::string &json) { return mitk::ConvertPropertyFromSelfContainedJson(nlohmann::json::parse(json)); },
      py::arg("json"),
      R"(Reconstruct a ``BaseProperty`` subclass from JSON.

Args:
    json: JSON string produced by :py:meth:`to_json`.

Returns:
    A new ``BaseProperty`` of the appropriate subclass.
)")
    .def_property_readonly("value", nullptr,
      "Property value (overridden by subclasses with type-specific accessors).")
    .def("clone", [](const mitk::BaseProperty &p) { return p.Clone(); },
      "Return a deep copy of this property.");