add number_of_points property to the PolyFile class

Author: MAfarrag

hydrolib/core/dflowfm/polyfile/models.py

@@ -161,13 +161,13 @@ def get_z_sources_sinks(self) -> Tuple[List[float], List[float]]:
             >>> polyline = PolyFile("tests/data/input/source-sink/leftsor.pliz")
             >>> z_source, z_sink = polyline.get_z_sources_sinks()
             >>> print(z_source, z_sink)
-            [-3] [-4.2]
+            [-3.0] [-4.2]
 
         in case the polyline has more than 3 columns:
             >>> polyline = PolyFile("tests/data/input/source-sink/leftsor-5-columns.pliz") #Doctest: +SKIP
             >>> z_source, z_sink = polyline.get_z_sources_sinks()
             >>> print(z_source, z_sink)
-            [-3, -2.9] [-4.2, -5.35]
+            [-3.0, -2.9] [-4.2, -5.35]
 
         in case the polyline does not have z-values:
             >>> root_dir = "tests/data/input/dflowfm_individual_files/polylines"
@@ -189,3 +189,8 @@ def get_z_sources_sinks(self) -> Tuple[List[float], List[float]]:
         z_sink: list[float | None] = z_source_sink[0]
         z_source: list[float | None] = z_source_sink[1]
         return z_source, z_sink
+
+    @property
+    def number_of_points(self) -> int:
+        """Total number of points in the PolyFile."""
+        return len(self.x)

tests/dflowfm/polyfile/test_polyline_models.py

@@ -28,6 +28,7 @@ def test_with_label(polylines_dir: Path):
     assert polyline.save_location == path.absolute()
     assert polyline.x == [0, 0]
     assert polyline.y == [0, 2]
+    assert polyline.number_of_points == 2
 
 
 def test_without_z(polylines_dir: Path):
@@ -48,6 +49,7 @@ def test_without_z(polylines_dir: Path):
     assert points[1] == Point(x=-80, y=550, z=None, data=[])
     assert polyline.x == [-80, -80]
     assert polyline.y == [-50, 550]
+    assert polyline.number_of_points == 2
 
 
 def test_with_z_and_pli_extension_2by2(polylines_dir: Path):