karabo.native 3.0.2__tar.gz → 3.0.3__tar.gz

{karabo_native-3.0.2/src/karabo.native.egg-info → karabo_native-3.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karabo.native
-Version: 3.0.2
+Version: 3.0.3
 Summary: Karabo's native data Python types and models
 Author-email: European XFEL GmbH <opensource@xfel.eu>
 Maintainer-email: "S. Hauf" <steffen.hauf@xfel.eu>, "D. Goeries" <dennis.goeries@xfel.eu>
@@ -15,7 +15,7 @@ Classifier: Intended Audience :: Science/Research
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: lxml==6.0.0
+Requires-Dist: lxml==6.0.1
 Requires-Dist: numpy==2.1.3
 Requires-Dist: pint>=0.24.4
 Requires-Dist: pytest==8.3.3

{karabo_native-3.0.2 → karabo_native-3.0.3}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta" # If not defined, then legacy behavior c
 
 
 [project]
-version = "3.0.2"
+version = "3.0.3"
 name = "karabo.native"
 description = "Karabo's native data Python types and models"
 readme = "README.md"
@@ -41,7 +41,7 @@ classifiers = [
 # For an analysis of this field vs pip's requirements files see:
 # https://packaging.python.org/discussions/install-requires-vs-requirements/
 dependencies = [
-  "lxml==6.0.0",
+  "lxml==6.0.1",
   "numpy==2.1.3",
   "pint>=0.24.4",
   "pytest==8.3.3",

karabo_native-3.0.3/src/karabo/__init__.py

@@ -0,0 +1 @@
+__version__ = '3.0.3'

karabo_native-3.0.3/src/karabo/_version.py

@@ -0,0 +1 @@
+version = '3.0.3'

{karabo_native-3.0.2 → karabo_native-3.0.3}/src/karabo/common/scenemodel/shapes.py

@@ -17,6 +17,8 @@ from xml.etree.ElementTree import SubElement
 
 from traits.api import CInt, Property, String
 
+from karabo.common.utils import get_arrowhead_points
+
 from .bases import BaseShapeObjectData
 from .const import ARROW_MIN_SIZE, NS_KARABO, NS_SVG, SVG_GROUP_TAG
 from .io_utils import get_numbers, set_numbers
@@ -180,16 +182,11 @@ def _write_base_shape_data(model, element):
         write("fill-opacity", str(model.fill_opacity))
 
 
-def _write_arrow_data(model, element):
-    _write_base_shape_data(model, element)
-    set_numbers(("x", "y", "width", "height", "x1", "y1", "x2", "y2", "hx1",
-                 "hy1", "hx2", "hy2", ), model, element)
-
-
 @register_scene_reader("Line", xmltag=NS_SVG + "line", version=1)
 def __line_reader(element):
     """A reader for Line objects in Version 1 scenes"""
-    # Check if it is an older arrow with XML defs arrow head.
+    # The arrow created in Karabogui2.20 or older has arrow head as
+    # marker-end. We have a separate reader for this.
     if "marker-end" in element.attrib:
         return __arrow_reader(element)
 
@@ -209,23 +206,39 @@ def __line_writer(model, parent):
 
 # Don't register because this is called from the line reader
 def __arrow_reader(element):
+    """Reader for arrow with marker-end as header, from Karabogui 2.20 or
+    older. Karabogui 2.21 onwards, the arrow head is stored as polygon which
+    can be calculated from the line coordinates x1,y1, x2,y2.
+
+    This can be deleted when all the arrows with marker-end are updated to
+    arrows with polygon.
+    """
     traits = _read_base_shape_data(element)
-    traits.update(get_numbers(("x1", "y1", "x2", "y2"), element))
+    points = get_numbers(("x1", "y1", "x2", "y2"), element)
+    hx1, hy1, hx2, hy2 = get_arrowhead_points(**points)
+    points.update({"hx1": hx1, "hy1": hy1, "hx2": hx2, "hy2": hy2})
+    traits.update(points)
     return ArrowPolygonModel(**traits)
 
 
-def __set_points(model, polygon_element):
-    """ Sets the arrowhead points as string. eg 'x1,y1 x2,y2 x3,y3' """
+def _write_arrow_polygon(model, element):
+    """Sets the arrowhead points as string. Eg 'x1,y1 x2,y2 x3,y3'.
+
+    The points are only written to svg files so that the arrow header can
+    appear in any svg editor - like inkscape.
+    They are never read by model, as they are calculated from the line points.
+    """
+
     points = (f"{model.x2},{model.y2} "
               f"{model.hx1},{model.hy1} "
               f"{model.hx2},{model.hy2} ")
-    polygon_element.set("points", points)
+    element.set("points", points)
 
 
-def __get_points(polygon_element):
-    """Reads the polygon element's points . Point is stored as
-    'x1,y1 x2,y2 x3,y3'  """
-    points = polygon_element.get("points").strip()
+def _read_arrow_polygon(element):
+    """Reads the polygon element's points. SVG stores the points,
+    for example, for triangle as 'x1,y1 x2,y2 x3,y3'  """
+    points = element.get("points").strip()
     _, hp1, hp2 = points.split(" ")
     hx1, hy1 = hp1.split(",")
     hx2, hy2 = hp2.split(",")
@@ -235,25 +248,27 @@ def __get_points(polygon_element):
 @register_scene_reader("ArrowPolygonModel", xmltag=SVG_GROUP_TAG,
                        version=2)
 def arrow_polygon_reader(element):
+    # Read the line
     line = element.find(NS_SVG + "line")
-    polygon = element.find(NS_SVG + "polygon")
-    # line and polygon are None if the model is written  by UnknownWidget,
-    # from older KaraboGUI.
+
+    # The line and polygon sub-elements are not present if the model is
+    # written by 'UnknownWidget' for arrow with polygon, from Karabogui 2.20 or
+    # older. However, the parent element still has the information to
+    # regenerate the line. Hence, reading the data from the parent 'element'.
     if line is None:
         traits = _read_base_shape_data(element)
+        points = get_numbers(("x1", "y1", "x2", "y2"), element)
+        hx1, hy1, hx2, hy2 = get_arrowhead_points(**points)
+        points.update({"hx1": hx1, "hy1": hy1, "hx2": hx2, "hy2": hy2})
+        traits.update(points)
     else:
         traits = _read_base_shape_data(line)
+        traits.update(get_numbers(("x1", "y1", "x2", "y2"), line))
+
+        polygon = element.find(NS_SVG + "polygon")
+        points = _read_arrow_polygon(element=polygon)
+        traits.update(points)
 
-    if polygon is None:
-        hx1 = element.attrib["hx1"]
-        hx2 = element.attrib["hx2"]
-        hy1 = element.attrib["hy1"]
-        hy2 = element.attrib["hy2"]
-        points = {"hx1": hx1, "hy1": hy1, "hx2": hx2, "hy2": hy2}
-    else:
-        points = __get_points(polygon_element=polygon)
-    traits.update(points)
-    traits.update(get_numbers(("x", "y", "x1", "y1", "x2", "y2"), element))
     return ArrowPolygonModel(**traits)
 
 
@@ -269,12 +284,10 @@ def arrow_polygon_writer(model, parent):
     set_numbers(("x1", "y1", "x2", "y2"), model, line)
 
     polygon_element = SubElement(element, NS_SVG + "polygon")
-    __set_points(model=model, polygon_element=polygon_element)
+    _write_arrow_polygon(model, polygon_element)
     model.fill = model.stroke
-    # Write all the model values to element also, so that in KaraboGUI
-    # older  than 2.21 the unsupported widget is shown.
-    _write_arrow_data(model, element)
     _write_base_shape_data(model, polygon_element)
+
     return element
 
 

{karabo_native-3.0.2 → karabo_native-3.0.3}/src/karabo/common/scenemodel/tests/test_shapes.py

@@ -13,6 +13,7 @@
 # Karabo is distributed in the hope that it will be useful, but WITHOUT ANY
 # WARRANTY; without even the implied warranty of MERCHANTABILITY or
 # FITNESS FOR A PARTICULAR PURPOSE.
+from karabo.common.utils import get_arrowhead_points
 from karabo.testing.utils import temp_xml_file
 
 from ..model import UnknownXMLDataModel
@@ -143,10 +144,75 @@ def test_svg_arrow():
         assert arrow_model.y1 == 50
         assert arrow_model.x2 == 95
         assert arrow_model.y2 == 75
+        hx1, hy1, hx2, hy2 = get_arrowhead_points(
+            arrow_model.x1, arrow_model.y1, arrow_model.x2, arrow_model.y2)
+
+        assert hx1 == arrow_model.hx1
+        assert hy1 == arrow_model.hy1
+        assert hx2 == arrow_model.hx2
+        assert hy2 == arrow_model.hy2
 
         assert arrow_model.stroke == "#000"
         assert arrow_model.stroke_width == 5
 
+        read_model = single_model_round_trip(arrow_model)
+        assert read_model.x1 == arrow_model.x1
+        assert read_model.x2 == arrow_model.x2
+        assert read_model.y1 == arrow_model.y1
+        assert read_model.y2 == arrow_model.y2
+
+
+def test_arrow_with_polygon():
+    # A round trip for the model
+    traits = _base_shape_traits()
+    traits.update({"x1": 0, "y1": 1, "x2": 2, "y2": 3})
+    arrow_model = ArrowPolygonModel(**traits)
+    read_model = single_model_round_trip(arrow_model)
+
+    assert read_model.x1 == 0
+    assert read_model.y1 == 1
+    assert read_model.x2 == 2
+    assert read_model.y2 == 3
+
+    assert arrow_model.hx1 == read_model.hx1
+    assert arrow_model.hy1 == read_model.hy1
+    assert arrow_model.hx2 == read_model.hx2
+    assert arrow_model.hy2 == read_model.hy2
+
+
+def test_polygon_arrow_from_xml_def():
+
+    # SVG from UnknownWidget in Karabo2.20 for the polygon arrow created in
+    # Karabo2.21
+    SCENE_SVG = (
+        """<svg:svg xmlns:krb="http://karabo.eu/scene" xmlns:svg='http://www.w3.org/2000/svg'
+         krb:version="2" krb:uuid="7bf41ba7-e675-46d4-82d3-a56b5662e965" height="768" width="1024">
+    <svg:rect krb:class="ArrowPolygonModel" krb:widget="ArrowPolygonModel" krb:keys=""
+              x="50" y="130" width="150" height="10" stroke="#000000" stroke-opacity="1.0"
+              stroke-linecap="butt" stroke-dashoffset="0.0" stroke-width="1.0"
+              stroke-dasharray="" stroke-style="1" stroke-linejoin="miter"
+              stroke-miterlimit="4.0" fill="#000000" fill-opacity="1.0" x1="50" y1="130"
+              x2="200" y2="130" hx1="190" hy1="133" hx2="190" hy2="127">
+    </svg:rect>
+    </svg:svg>""" # noqa
+    )
+    with temp_xml_file(SCENE_SVG) as fn:
+        scene_model = read_scene(fn)
+        assert len(scene_model.children) == 1
+        arrow = scene_model.children[0]
+        assert isinstance(arrow, ArrowPolygonModel)
+        assert arrow.x == 50
+        assert arrow.y == 130
+        assert arrow.x1 == 50
+        assert arrow.y1 == 130
+        assert arrow.x2 == 200
+        assert arrow.y2 == 130
+
+        assert arrow.hx1 == 190
+        assert arrow.hy1 == 133
+        assert arrow.hx2 == 190
+        assert arrow.hy2 == 127
+
 
 def test_svg_defs():
     SCENE_SVG = (

karabo_native-3.0.3/src/karabo/common/tests/test_util.py

@@ -0,0 +1,78 @@
+# This file is part of Karabo.
+#
+# http://www.karabo.eu
+#
+# Copyright (C) European XFEL GmbH Schenefeld. All rights reserved.
+#
+# Karabo is free software: you can redistribute it and/or modify it under
+# the terms of the MPL-2 Mozilla Public License.
+#
+# You should have received a copy of the MPL-2 Public License along with
+# Karabo. If not, see <https://www.mozilla.org/en-US/MPL/2.0/>.
+#
+# Karabo is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.
+from karabo.common.api import WeakMethodRef
+from karabo.common.utils import get_arrowhead_points
+
+
+def test_weak_method_ref():
+    """Test that we can safely call bound methods"""
+    global called
+    called = False
+
+    class Device:
+        def move(self):
+            global called
+            called = True
+
+    device = Device()
+    func = WeakMethodRef(device.move)
+    func()
+    assert called is True
+    called = False
+    del device
+    func()
+    assert called is False
+
+
+def test_get_arrowhead_points():
+    # Test case 1: Horizontal line
+    x1, y1, x2, y2 = 0, 0, 100, 0
+    hx1, hy1, hx2, hy2 = get_arrowhead_points(x1, y1, x2, y2)
+
+    assert hx1 < x2 and hx2 < x2, (
+        "Arrowhead points should be behind the endpoint")
+    assert hx1 == hx2, (
+        "Arrowhead points should have the same x-coordinate")
+    assert hy1 == - hy2, "Left y should be negative of right y "
+
+    # Test case 2: Vertical line
+    x1, y1, x2, y2 = 0, 0, 0, 100
+    hx1, hy1, hx2, hy2 = get_arrowhead_points(x1, y1, x2, y2)
+    assert hy1 < y2 and hy2 < y2, (
+        "Arrowhead points should be above the endpoint")
+    assert round(hx1, 9) == round(-hx2, 9), (
+        "left x should be negative right x")
+    assert hy1 == hy2
+
+    # Test case 3: Diagonal line
+    x1, y1, x2, y2 = 0, 0, 100, 100
+    hx1, hy1, hx2, hy2 = get_arrowhead_points(x1, y1, x2, y2)
+
+    assert not hx1 == hx2, "Arrowhead points X-coordinates should be distinct"
+    assert not hy1 == hy2, "Arrowhead points Y-coordinates should be distinct"
+    assert hx1 < x2 and hx2 < x2, (
+        "Arrowhead points should be behind the endpoint")
+    assert hy1 < y2 and hy2 < y2, (
+        "Arrowhead points should be below the endpoint")
+
+    # Test case 4: Negative coordinates
+    x1, y1, x2, y2 = -100, -100, -200, -200
+    hx1, hy1, hx2, hy2 = get_arrowhead_points(x1, y1, x2, y2)
+
+    assert not hx1 == hx2, "Arrowhead points X-coordinates should be distinct"
+    assert not hy1 == hy2, "Arrowhead points Y-coordinates should be distinct"
+    assert hx1 == hy2
+    assert hy1 == hx2

{karabo_native-3.0.2 → karabo_native-3.0.3}/src/karabo/common/utils.py

@@ -17,6 +17,7 @@
 # WARRANTY; without even the implied warranty of MERCHANTABILITY or
 # FITNESS FOR A PARTICULAR PURPOSE.
 #############################################################################
+import math
 import weakref
 from inspect import signature
 from types import MethodType
@@ -105,3 +106,20 @@ class WeakMethodRef:
 
     def _owner_deleted(self, ref):
         self.obj = None
+
+
+def get_arrowhead_points(x1: int, y1: int, x2: int, y2: int) -> (
+        tuple)[int, int, int, int]:
+    """Calculate the two points for the arrow head for the given lines"""
+    arrow_size = 10
+    angle_offset = math.pi / 10
+    angle = math.atan2(y2 - y1, x2 - x1)
+
+    # The points for the arrowhead triangle
+    hx1 = round(x2 - arrow_size * math.cos(angle - angle_offset))
+    hy1 = round(y2 - arrow_size * math.sin(angle - angle_offset))
+
+    hx2 = round(x2 - arrow_size * math.cos(angle + angle_offset))
+    hy2 = round(y2 - arrow_size * math.sin(angle + angle_offset))
+
+    return hx1, hy1, hx2, hy2

{karabo_native-3.0.2 → karabo_native-3.0.3}/src/karabo/native/schema/descriptors.py

@@ -69,8 +69,6 @@ class Attribute:
     __slots__ = ["default", "dtype", "name"]
 
     def __init__(self, default=None, dtype=None):
-        if dtype is np.float32:
-            dtype = np.float64
         self.name = None
         self.dtype = dtype
         self.default = self.check(default)

{karabo_native-3.0.2 → karabo_native-3.0.3}/src/karabo/native/schema/tests/descriptor_test.py

@@ -337,7 +337,7 @@ class Tests(TestCase):
                         defaultValue=[1, 2, 3])
         default = d.defaultValue
         # Test that the values are casted to floats
-        self.assertEqual(type(default[0]), np.float64)
+        self.assertEqual(type(default[0]), np.float32)
         self.assertEqual(d.defaultValue, [1.0, 2.0, 3.0])
 
         v = d.toKaraboValue([2, 3, 4])
@@ -1117,13 +1117,16 @@ class Tests(TestCase):
                 desc, 1, 10, 0, 11,  # Desc, minInc, maxInc, minExc, maxExc,
                 3)  # value
 
-        # We assert numpy attributes as well for Float and Double, they will
-        # be casted, but all attribute for floating points have 64 bit!
-        for desc in [Float, Double]:
-            self.assert_numpy_attributes(
-                desc, 1.30, 10.02,  # Desc, minInc, maxInc,
-                0.12, 11.37,  # minExc, maxExc,
-                3.07, dtype=np.float64)  # default value, dtype
+        # We assert numpy attributes as well for Float and Double
+        self.assert_numpy_attributes(
+            Float, 1.30, 10.02,  # Desc, minInc, maxInc,
+            0.12, 11.37,  # minExc, maxExc,
+            3.07, dtype=np.float32)  # default value, dtype
+
+        self.assert_numpy_attributes(
+            Double, 1.30, 10.02,  # Desc, minInc, maxInc,
+            0.12, 11.37,  # minExc, maxExc,
+            3.07, dtype=np.float64)  # default value, dtype
 
         # Attributes are casted to their numpy type
         d = Int8(defaultValue=8.2)

karabo_native-3.0.3/src/karabo/version.py

@@ -0,0 +1 @@
+version = '3.0.3'

{karabo_native-3.0.2 → karabo_native-3.0.3/src/karabo.native.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karabo.native
-Version: 3.0.2
+Version: 3.0.3
 Summary: Karabo's native data Python types and models
 Author-email: European XFEL GmbH <opensource@xfel.eu>
 Maintainer-email: "S. Hauf" <steffen.hauf@xfel.eu>, "D. Goeries" <dennis.goeries@xfel.eu>
@@ -15,7 +15,7 @@ Classifier: Intended Audience :: Science/Research
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: lxml==6.0.0
+Requires-Dist: lxml==6.0.1
 Requires-Dist: numpy==2.1.3
 Requires-Dist: pint>=0.24.4
 Requires-Dist: pytest==8.3.3

{karabo_native-3.0.2 → karabo_native-3.0.3}/src/karabo.native.egg-info/requires.txt

@@ -1,4 +1,4 @@
-lxml==6.0.0
+lxml==6.0.1
 numpy==2.1.3
 pint>=0.24.4
 pytest==8.3.3

karabo_native-3.0.2/src/karabo/__init__.py

@@ -1 +0,0 @@
-__version__ = '3.0.2'

karabo_native-3.0.2/src/karabo/_version.py

@@ -1 +0,0 @@
-version = '3.0.2'

karabo_native-3.0.2/src/karabo/common/tests/test_util.py

@@ -1,36 +0,0 @@
-# This file is part of Karabo.
-#
-# http://www.karabo.eu
-#
-# Copyright (C) European XFEL GmbH Schenefeld. All rights reserved.
-#
-# Karabo is free software: you can redistribute it and/or modify it under
-# the terms of the MPL-2 Mozilla Public License.
-#
-# You should have received a copy of the MPL-2 Public License along with
-# Karabo. If not, see <https://www.mozilla.org/en-US/MPL/2.0/>.
-#
-# Karabo is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE.
-from karabo.common.api import WeakMethodRef
-
-
-def test_weak_method_ref():
-    """Test that we can safely call bound methods"""
-    global called
-    called = False
-
-    class Device:
-        def move(self):
-            global called
-            called = True
-
-    device = Device()
-    func = WeakMethodRef(device.move)
-    func()
-    assert called is True
-    called = False
-    del device
-    func()
-    assert called is False

karabo_native-3.0.2/src/karabo/version.py

@@ -1 +0,0 @@
-version = '3.0.2'