py: warn if the client and server versions do not match

abhizer · abhizer · commit 91517c5f2837 · 2025-07-08T11:09:28.000Z
Signed-off-by: Abhinav Gyawali &lt;22275402+abhizer@users.noreply.github.com&gt;
diff --git a/python/feldera/__init__.py b/python/feldera/__init__.py
@@ -1,6 +1,9 @@
 from feldera.rest.feldera_client import FelderaClient as FelderaClient
 from feldera.pipeline import Pipeline as Pipeline
 from feldera.pipeline_builder import PipelineBuilder as PipelineBuilder
+from feldera.rest._helpers import client_version
+
+__version__ = client_version()
 
 import pretty_errors
 
diff --git a/python/feldera/enums.py b/python/feldera/enums.py
@@ -36,27 +36,28 @@ class BuildMode(Enum):
 
 class PipelineStatus(Enum):
     """
-      Represents the state that this pipeline is currently in.
-
-      .. code-block:: text
-
-                  Stopped ◄─────────── Stopping ◄───── All states can transition
-                     │                    ▲            to Stopping by either:
-    /start or /pause │                    │            (1) user calling /stop?force=true, or;
-                     ▼                    │            (2) pipeline encountering a fatal
-              ⌛Provisioning          Suspending            resource or runtime error,
-                     │                    ▲                having the system call /stop?force=true
-                     ▼                    │ /stop          effectively
-              ⌛Initializing ─────────────┤  ?force=false
-                     │                    │
-           ┌─────────┼────────────────────┴─────┐
-           │         ▼                          │
-           │       Paused  ◄──────► Unavailable │
-           │        │   ▲                ▲      │
-           │ /start │   │  /pause        │      │
-           │        ▼   │                │      │
-           │       Running ◄─────────────┘      │
-           └────────────────────────────────────┘
+    Represents the state that this pipeline is currently in.
+
+    .. code-block:: text
+
+                    Stopped ◄─────────── Stopping ◄───── All states can transition
+                       │                    ▲            to Stopping by either:
+      /start or /pause │                    │            (1) user calling /stop?force=true, or;
+                       ▼                    │            (2) pipeline encountering a fatal
+                ⌛Provisioning          Suspending            resource or runtime error,
+                       │                    ▲                having the system call /stop?force=true
+                       ▼                    │ /stop          effectively
+                ⌛Initializing ─────────────┤  ?force=false
+                       │                    │
+             ┌─────────┼────────────────────┴─────┐
+             │         ▼                          │
+             │       Paused  ◄──────► Unavailable │
+             │        │   ▲                ▲      │
+             │ /start │   │  /pause        │      │
+             │        ▼   │                │      │
+             │       Running ◄─────────────┘      │
+             └────────────────────────────────────┘
+
     """
 
     NOT_FOUND = 0
diff --git a/python/feldera/rest/_helpers.py b/python/feldera/rest/_helpers.py
@@ -0,0 +1,9 @@
+def client_version() -> str:
+    from importlib.metadata import version, PackageNotFoundError
+
+    try:
+        version = version("feldera")
+    except PackageNotFoundError:
+        version = "unknown"
+
+    return version
diff --git a/python/feldera/rest/feldera_client.py b/python/feldera/rest/feldera_client.py
@@ -11,6 +11,7 @@
 from feldera.rest.errors import FelderaTimeoutError
 from feldera.rest.pipeline import Pipeline
 from feldera.rest._httprequests import HttpRequests
+from feldera.rest._helpers import client_version
 
 
 def _validate_no_none_keys_in_map(data):
@@ -63,7 +64,13 @@ def __init__(
         self.http = HttpRequests(self.config)
 
         try:
-            self.pipelines()
+            config = self.get_config()
+            version = client_version()
+            if config.version != version:
+                logging.warn(
+                    f"Client is on version {version} while server is at "
+                    f"{config.version}. There could be incompatibilities."
+                )
         except Exception as e:
             logging.error(f"Failed to connect to Feldera API: {e}")
             raise e
