feat: support for Pyro5

Prepare support for Debian trixie by modifying our code to work
with either Pyro4 or Pyro5.

Signed-off-by: Cedric Hombourger <[email protected]>

Author: chombourger

debian/control

@@ -72,7 +72,7 @@ Package: mtda-common
 Architecture: all
 Multi-Arch: foreign
 Depends: python3:any (>= 3.7~),
-         python3-pyro4
+         python3-pyro5 | python3-pyro4
 Description: common modules for Multi-Tenant Device Access
  Modules shared between the service and the client.
 

mtda-service

@@ -16,7 +16,6 @@ import lockfile
 import netifaces
 import os
 import os.path
-import Pyro4
 import signal
 import sys
 import socket
@@ -27,6 +26,12 @@ from systemd import daemon as sd
 from mtda.main import MultiTenantDeviceAccess
 import mtda.constants as CONSTS
 
+# Pyro
+try:
+    from Pyro5.compatibility import Pyro4
+except ImportError:
+    import Pyro4
+
 
 class Application:
 

mtda-www

@@ -22,7 +22,6 @@ import os
 import uuid
 import zmq.asyncio
 import concurrent.futures
-import Pyro4.errors
 import logging
 import abc
 import functools
@@ -33,6 +32,12 @@ import mtda.constants as CONSTS
 from mtda.console.remote import RemoteConsole
 from mtda.console.screen import ScreenOutput
 
+# Pyro
+try:
+    import Pyro5.errors as PyroErrors
+except ImportError:
+    import Pyro4.errors as PyroErrors
+
 # ---------------------------------------------------------------------------
 # Configure basic logging for better visibility of errors
 # ---------------------------------------------------------------------------
@@ -102,10 +107,10 @@ class RemoteCallHandler(BaseHandler, metaclass=abc.ABCMeta):
                          f"status={status} response={response}")
 
             self.set_status(status)
+            # For 204 No Content, we just set status and finish, no body needed
             if response is not None:
                 self.result_as_json(response)
-            # For 204 No Content, we just set status and finish, no body needed
-        except Pyro4.errors.TimeoutError:
+        except PyroErrors.TimeoutError:
             logger.warning("Remote service timed out for "
                            f"{self.__class__.__name__}")
             self.set_status(504)  # Gateway Timeout
@@ -187,7 +192,7 @@ class WebSocketHandler(tornado.websocket.WebSocketHandler):
                         {"video-info": {"format": fmt, "url": video_url}}
                 )
 
-        except Pyro4.errors.TimeoutError:
+        except PyroErrors.TimeoutError:
             logger.warning("timeout during WebSocket for session "
                            f"{self.session_id}.")
             self.write_message({"error": "timeout during WebSocket "
@@ -237,7 +242,7 @@ class WebSocketHandler(tornado.websocket.WebSocketHandler):
                                 mtda.console_send, input_data,
                                 raw=False, session=sid
                             )
-                        except Pyro4.errors.TimeoutError:
+                        except PyroErrors.TimeoutError:
                             logger.warning("timeout for console_send "
                                            f"for session {sid}.")
                             self.write_message(
@@ -1138,7 +1143,7 @@ class OpenAPIHandler(tornado.web.RequestHandler):
                 }
             }
             self.write(spec)
-        except Pyro4.errors.TimeoutError:
+        except PyroErrors.TimeoutError:
             logger.warning("Pyro4 timeout fetching agent version for OpenAPI.")
             self.set_status(504)
             self.write({"error": "timeout while fetching API version"})

mtda/client.py

@@ -11,7 +11,6 @@
 
 
 import os
-import Pyro4
 import random
 import socket
 import subprocess
@@ -24,6 +23,12 @@
 from mtda.utils import Compression
 import mtda.constants as CONSTS
 
+# Pyro
+try:
+    from Pyro5.compatibility import Pyro4
+except ImportError:
+    import Pyro4
+
 
 class Client:
 

mtda/main.py

@@ -14,7 +14,6 @@
 import glob
 import importlib
 import os
-import Pyro4
 import socket
 import subprocess
 import sys
@@ -26,6 +25,12 @@
 import mtda.constants as CONSTS
 from mtda import __version__
 
+# Pyro
+try:
+    from Pyro5.compatibility import Pyro4
+except ImportError:
+    import Pyro4
+
 
 DEFAULT_PREFIX_KEY = 'ctrl-a'
 DEFAULT_PASTEBIN_EP = "http://pastebin.com/api/api_post.php"