Expose changelog in custom operators

Author: PProfizi

src/ansys/dpf/core/changelog.py

@@ -30,7 +30,6 @@
 from ansys.dpf.core.check_version import version_requires
 
 
-@version_requires("11.0")
 class Changelog:
     """Changelog of an operator.
 
@@ -55,6 +54,7 @@ def __init__(self, gdc: dpf.GenericDataContainer = None, server=None):
             gdc.set_property(property_name="changes", prop=changes_sf)
             gdc.set_property(property_name="class", prop="Changelog")
         self.gdc = gdc
+        self._server = server
 
     def append(self, version: Version, changes: str):
         """Append a version and associated changes description to the changelog."""
@@ -124,7 +124,7 @@ def major_bump(self, changes: str) -> Changelog:
         self.append(version=new_version, changes=changes)
         return self
 
-    def expect_version(self, version: Version) -> Changelog:
+    def expect_version(self, version: Version | str) -> Changelog:
         """Check the current latest version of the changelog.
 
         Useful when chaining version bumps to check the resulting version is as expected.
@@ -140,6 +140,8 @@ def expect_version(self, version: Version) -> Changelog:
         changelog:
             Returns the current changelog to allow for chaining calls to bumps.
         """
+        if isinstance(version, str):
+            version = Version(version)
         if self.last_version != version:
             raise ValueError(
                 f"Last version in the changelog ({self.last_version}) does not match expected version ({version})."

src/ansys/dpf/core/custom_operator.py

@@ -37,6 +37,7 @@
 import zipfile
 
 import numpy
+from packaging.version import Version
 
 from ansys.dpf import core as dpf
 from ansys.dpf.core import (
@@ -55,6 +56,8 @@
     external_operator_api,
     functions_registry,
 )
+from ansys.dpf.core.changelog import Changelog
+from ansys.dpf.core.check_version import version_requires
 from ansys.dpf.gate import capi, dpf_vector, integral_types, object_handler
 
 
@@ -400,3 +403,39 @@ def name(self) -> str:
         This name can then be used to instantiate the Operator.
         """
         pass
+
+    @property
+    @version_requires("11.0")
+    def changelog(self) -> Changelog:
+        """Return the changelog of this operator.
+
+        Requires DPF 11.0 (2026 R1) or above.
+
+        Returns
+        -------
+        changelog:
+            Changelog of the operator.
+        """
+        from ansys.dpf.core.operators.utility.operator_changelog import operator_changelog
+
+        return Changelog(operator_changelog(operator_name=self.name).eval())
+
+    @changelog.setter
+    @version_requires("11.0")
+    def changelog(self, changelog: Changelog):
+        """Set the changelog of this operator.
+
+        Requires DPF 11.0 (2026 R1) or above.
+
+        """
+        self.specification.set_changelog(changelog)
+
+    @property
+    @version_requires("11.0")
+    def version(self) -> Version:
+        """Return the current version of the operator based on its changelog.
+
+        Requires DPF 11.0 (2026 R1) or above.
+
+        """
+        return self.changelog.last_version

src/ansys/dpf/core/dpf_operator.py

@@ -933,8 +933,8 @@ def specification(self):
         else:
             return Specification(operator_name=self.name, server=self._server)
 
-    @version_requires("11.0")
     @property
+    @version_requires("11.0")
     def changelog(self) -> Changelog:
         """Return the changelog of this operator.
 
@@ -947,10 +947,13 @@ def changelog(self) -> Changelog:
         """
         from ansys.dpf.core.operators.utility.operator_changelog import operator_changelog
 
-        return Changelog(operator_changelog(operator_name=self.name, server=self._server).eval())
+        return Changelog(
+            gdc=operator_changelog(operator_name=self.name, server=self._server).eval(),
+            server=self._server,
+        )
 
-    @version_requires("11.0")
     @property
+    @version_requires("11.0")
     def version(self) -> Version:
         """Return the current version of the operator.
 

src/ansys/dpf/core/operator_specification.py

@@ -32,6 +32,7 @@
 from typing import Union
 
 from ansys.dpf.core import common, mapping_types, server as server_module
+from ansys.dpf.core.changelog import Changelog
 from ansys.dpf.core.check_version import server_meet_version, version_requires
 from ansys.dpf.gate import (
     integral_types,
@@ -497,6 +498,15 @@ def config_specification(self) -> ConfigSpecification:
                 )
         return self._config_specification
 
+    @version_requires("11.0")
+    def set_changelog(self, changelog: Changelog):
+        """Set the changelog for this operator specification.
+
+        Requires DPF 11.0 (2026 R1) or above.
+
+        """
+        self._api.operator_specification_set_changelog(self, changelog.gdc)
+
 
 class CustomConfigOptionSpec(ConfigOptionSpec):
     """Custom documentation of a configuration option available for a given operator."""

tests/test_python_plugins.py

@@ -28,6 +28,7 @@
 import pytest
 
 from ansys.dpf import core as dpf
+from ansys.dpf.core.changelog import Changelog
 from ansys.dpf.core.custom_operator import update_virtual_environment_for_custom_operators
 from ansys.dpf.core.errors import DPFServerException
 from ansys.dpf.core.operator_specification import (
@@ -408,3 +409,22 @@ def test_custom_op_with_spec(server_type_remote_process, testfiles_dir):
     outf = op.outputs.field()
     expected = np.ones((3, 3), dtype=np.float64) + 4.0
     assert np.allclose(outf.data, expected)
+
+
+@conftest.raises_for_servers_version_under("11.0")
+def test_custom_op_changelog(server_type_remote_process, testfiles_dir):
+    from packaging.version import Version
+
+    dpf.load_library(
+        dpf.path_utilities.to_server_os(
+            Path(testfiles_dir) / "pythonPlugins", server_type_remote_process
+        ),
+        "py_operator_with_changelog",
+        "load_operators",
+        server=server_type_remote_process,
+    )
+    op = dpf.Operator("custom_add_to_field", server=server_type_remote_process)
+    changelog = op.changelog
+    assert isinstance(changelog, Changelog)
+    assert changelog.last_version == Version("1.0.0")
+    assert changelog[Version("1.0.0")] == "Major bump"

tests/testfiles/pythonPlugins/operator_with_changelog.py

@@ -0,0 +1,63 @@
+# Copyright (C) 2020 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from ansys.dpf.core import Field
+from ansys.dpf.core.changelog import Changelog
+from ansys.dpf.core.custom_operator import CustomOperatorBase, record_operator
+from ansys.dpf.core.operator_specification import (
+    CustomSpecification,
+    PinSpecification,
+    SpecificationProperties,
+)
+
+
+class AddFloatToFieldData(CustomOperatorBase):
+    def run(self):
+        field = self.get_input(0, Field)
+        to_add = self.get_input(1, float)
+        data = field.data
+        data += to_add
+        self.set_output(0, field)
+        self.set_succeeded()
+
+    @property
+    def specification(self):
+        spec = CustomSpecification()
+        spec.description = "Add a custom value to all the data of an input Field"
+        spec.inputs = {
+            0: PinSpecification("field", [Field], "Field on which float value is added."),
+            1: PinSpecification("to_add", [float], "Data to add."),
+        }
+        spec.outputs = {
+            0: PinSpecification("field", [Field], "Field on which the float value is added.")
+        }
+        spec.properties = SpecificationProperties("custom add to field", "math")
+        spec.set_changelog(changelog=Changelog().major_bump("Major bump").expect_version("1.0.0"))
+        return spec
+
+    @property
+    def name(self):
+        return "custom_add_to_field"
+
+
+def load_operators(*args):
+    record_operator(AddFloatToFieldData, *args)