feature: add __version__ attribute to Python package (#5641)

This PR adds the `__version__` attribute to the Python package. This is
commonly added to Python packages to help observe the version of a
package through the package API. I tried to make this with dynamic
versioning in mind, but please don't hesitate to provide feedback if
this misses the mark.

Closes #5615

---------

Signed-off-by: d33bs <[email protected]>
Signed-off-by: Dave Bunten <[email protected]>

Author: d33bs

vortex-python/python/vortex/__init__.py

@@ -1,6 +1,8 @@
 # SPDX-License-Identifier: Apache-2.0
 # SPDX-FileCopyrightText: Copyright the Vortex contributors
 
+from importlib import metadata as _metadata
+
 from . import _lib, arrays, dataset, expr, file, io, ray, registry, scan
 from ._lib.arrays import (  # pyright: ignore[reportMissingModuleSource]
     AlpArray,
@@ -81,6 +83,15 @@
 
 assert _lib, "Ensure we eagerly import the Vortex native library"
 
+# Resolve the installed distribution version so it is available as vortex.__version__.
+__version__ = "unknown"
+try:
+    # Try to read the installed distribution version for the Python package name.
+    __version__ = _metadata.version("vortex-data")
+except _metadata.PackageNotFoundError:
+    # If the distribution is not installed, keep the unknown fallback.
+    pass
+
 __all__ = [
     # --- Modules ---
     "arrays",
@@ -169,4 +180,6 @@
     "ArrayIterator",
     # Scan
     "RepeatedScan",
+    # Version
+    "__version__",
 ]

vortex-python/test/test_version.py

@@ -0,0 +1,21 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright the Vortex contributors
+
+import importlib.metadata
+
+import pytest
+
+import vortex
+
+
+def test_version_matches_metadata():
+    """
+    Tests that we see the correct __version__
+    value exported by the package.
+    """
+    try:
+        expected = importlib.metadata.version("vortex-data")
+    except importlib.metadata.PackageNotFoundError:
+        pytest.skip("vortex-data distribution metadata unavailable")
+    # Ensure the exported version matches the distribution metadata.
+    assert vortex.__version__ == expected