Make type hints work for pyuff_ustb objects

pyproject.toml

@@ -16,7 +16,7 @@ description = "An implementation of USTB's ultrasound file format (UFF) in Pytho
 name = "pyuff_ustb"
 readme = "README.md"
 requires-python = ">=3.9"
-version = "2.0.2"
+version = "2.0.3"
 
 [project.urls]
 "Bug Tracker" = "https://github.com/magnusdk/pyuff_ustb/issues"

pyuff_ustb/__init__.py

@@ -2,4 +2,4 @@
 from pyuff_ustb.objects import *
 
 __all__ = pyuff_ustb.objects.__all__
-__version__ = "2.0.2"
+__version__ = "2.0.3"

pyuff_ustb/objects/apodization.py

@@ -17,6 +17,11 @@
     from pyuff_ustb.objects.wave import Wave
     from pyuff_ustb.objects.window import Window
 
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
 
 class Apodization(Uff):
     """:class:`Uff` class to hold apodization data.

pyuff_ustb/objects/beamformed_data.py

@@ -17,6 +17,11 @@
     from pyuff_ustb.objects.scans.scan import Scan
     from pyuff_ustb.objects.wave import Wave
 
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
 
 class BeamformedData(Uff):
     """:class:`Uff` class to hold beamformed data.

pyuff_ustb/objects/channel_data.py

@@ -16,6 +16,11 @@
     from pyuff_ustb.objects.pulse import Pulse
     from pyuff_ustb.objects.wave import Wave
 
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
 
 class ChannelData(Uff):
     """:class:`Uff` class to hold channel data.

pyuff_ustb/objects/phantom.py

@@ -1,8 +1,16 @@
+from typing import TYPE_CHECKING
+
 import numpy as np
 
 from pyuff_ustb.objects.uff import Uff, compulsory_property, dependent_property
 from pyuff_ustb.readers import LazyArray, LazyScalar
 
+if TYPE_CHECKING:
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
 
 class Phantom(Uff):
     """:class:`Uff` class for a phantom definition.

pyuff_ustb/objects/point.py

@@ -1,8 +1,16 @@
+from typing import TYPE_CHECKING
+
 import numpy as np
 
 from pyuff_ustb.objects.uff import Uff, compulsory_property, dependent_property
 from pyuff_ustb.readers import LazyScalar
 
+if TYPE_CHECKING:
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
 
 class Point(Uff):
     """:class:`Uff` class to define a point location.

pyuff_ustb/objects/pulse.py

@@ -1,8 +1,16 @@
+from typing import TYPE_CHECKING
+
 import numpy as np
 
 from pyuff_ustb.objects.uff import Uff, compulsory_property
 from pyuff_ustb.readers import LazyArray, LazyScalar
 
+if TYPE_CHECKING:
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
 
 class Pulse(Uff):
     """:class:`Uff` class for a pulse definition.

pyuff_ustb/objects/uff.py

@@ -1,7 +1,17 @@
 import copy
 from enum import Enum
 from functools import cached_property
-from typing import Any, Generic, List, Optional, Sequence, Tuple, TypeVar, Union
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Generic,
+    List,
+    Optional,
+    Sequence,
+    Tuple,
+    TypeVar,
+    Union,
+)
 
 import h5py
 import numpy as np
@@ -42,6 +52,13 @@ class dependent_property(property):
     written to an UFF file."""
 
 
+if TYPE_CHECKING:
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
+
 class Uff:
     """The base class of all UFF objects.
 

pyuff_ustb/objects/wave.py

@@ -16,6 +16,11 @@
     from pyuff_ustb.objects.probes.probe import Probe
     from pyuff_ustb.objects.wavefront import Wavefront
 
+    # Make sure properties are treated as properties when type checking
+    compulsory_property = property
+    optional_property = property
+    dependent_property = property
+
 
 class Wave(Uff):
     """:class:`Uff` class that describes a transmitted wave.

setup.py

@@ -3,7 +3,7 @@
 
 setup(
     name="pyuff_ustb",
-    version="2.0.2",
+    version="2.0.3",
     author_email="magnus.kvalevag@ntnu.no",
     packages=find_packages(),
     install_requires=["numpy", "h5py"],