L2SS-200: sys.path.append imports to find modules

Finding modules relative to the location of the main methods requires
some clever sys.path.append tricks. These tricks can be removed
once packaging is in place as paths will then be relative to
setup.py

devices/clients/attribute_wrapper.py

@@ -3,7 +3,7 @@ from tango import AttrWriteType
 
 import numpy
 
-from util.wrappers import only_when_on, fault_on_error
+from devices.device_decorators import only_when_on, fault_on_error
 import logging
 
 logger = logging.getLogger()

devices/clients/opcua_client.py

 from threading import Thread
 import socket
-from util.comms_client import CommClient
 import numpy
 import opcua
 from opcua import Client
 
+from clients.comms_client import CommClient
+
 __all__ = ["OPCUAConnection"]
 
 numpy_to_OPCua_dict = {

devices/clients/sst_client.py

-import queue
-from threading import Thread
-import socket
-from util.comms_client import CommClient
-from clients.StatisticsPacket import SSTPacket
-
 from queue import Queue
-
-import numpy
+from threading import Thread
 import logging
+import numpy
+import queue
 import socket
-from datetime import datetime
-from multiprocessing import Value, Array
 import time
-from datetime import datetime
 
-__all__ = ["sst_client", "SST_collector"]
+from clients.comms_client import CommClient
+from clients.StatisticsPacket import SSTPacket
 
 logger = logging.getLogger()
 
+
 class sst_client(CommClient):
     """
       Connects to OPC-UA in the foreground or background, and sends HELLO

devices/devices/apsctl.py

@@ -11,6 +11,12 @@
 
 """
 
+# TODO(Corne): Remove sys.path.append hack once packaging is in place!
+import os, sys
+currentdir = os.path.dirname(os.path.realpath(__file__))
+parentdir = os.path.dirname(currentdir)
+sys.path.append(parentdir)
+
 # PyTango imports
 from tango.server import run
 from tango.server import device_property, attribute
@@ -18,11 +24,11 @@ from tango import AttrWriteType
 # Additional import
 
 from clients.opcua_client import OPCUAConnection
-from devices.clients.attribute_wrapper import attribute_wrapper
-from devices.devices.hardware_device import hardware_device
+from clients.attribute_wrapper import attribute_wrapper
+from devices.hardware_device import hardware_device
 
-from devices.common.lofar_logging import device_logging_to_python, log_exceptions
-from devices.common.lofar_git import get_version
+from common.lofar_logging import device_logging_to_python, log_exceptions
+from common.lofar_git import get_version
 
 import numpy
 

devices/devices/hardware_device.py

@@ -16,12 +16,12 @@ from tango.server import Device, command
 from tango import DevState, DebugIt
 # Additional import
 
-from util.attribute_wrapper import attribute_wrapper
-from util.lofar_logging import log_exceptions
+from clients.attribute_wrapper import attribute_wrapper
+from common.lofar_logging import log_exceptions
 
 __all__ = ["hardware_device"]
 
-from util.wrappers import only_in_states, fault_on_error
+from devices.device_decorators import only_in_states, fault_on_error
 
 #@log_exceptions()
 class hardware_device(Device):

devices/devices/pcc.py

@@ -11,6 +11,12 @@
 
 """
 
+# TODO(Corne): Remove sys.path.append hack once packaging is in place!
+import os, sys
+currentdir = os.path.dirname(os.path.realpath(__file__))
+parentdir = os.path.dirname(currentdir)
+sys.path.append(parentdir)
+
 # PyTango imports
 from tango import DebugIt
 from tango.server import run, command
@@ -19,13 +25,13 @@ from tango import AttrWriteType
 import numpy
 # Additional import
 
-from devices.devices.device_decorators import *
+from device_decorators import *
 
 from clients.opcua_client import OPCUAConnection
-from devices.clients.attribute_wrapper import attribute_wrapper
-from devices.devices.hardware_device import hardware_device
-from devices.common.lofar_logging import device_logging_to_python, log_exceptions
-from devices.common.lofar_git import get_version
+from clients.attribute_wrapper import attribute_wrapper
+from devices.hardware_device import hardware_device
+from common.lofar_logging import device_logging_to_python, log_exceptions
+from common.lofar_git import get_version
 
 __all__ = ["PCC", "main"]
 
@@ -244,7 +250,7 @@ class PCC(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the PCC module."""
 
-    from devices.common.lofar_logging import configure_logger
+    from common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 

devices/devices/sdp.py → devices/devices/sdp/sdp.py

@@ -11,6 +11,13 @@
 
 """
 
+# TODO(Corne): Remove sys.path.append hack once packaging is in place!
+import os, sys
+currentdir = os.path.dirname(os.path.realpath(__file__))
+parentdir = os.path.dirname(currentdir)
+parentdir = os.path.dirname(parentdir)
+sys.path.append(parentdir)
+
 # PyTango imports
 from tango.server import run
 from tango.server import device_property, attribute
@@ -18,11 +25,11 @@ from tango import AttrWriteType
 # Additional import
 
 from clients.opcua_client import OPCUAConnection
-from devices.clients.attribute_wrapper import attribute_wrapper
-from devices.devices.hardware_device import hardware_device
+from clients.attribute_wrapper import attribute_wrapper
+from devices.hardware_device import hardware_device
 
-from devices.common.lofar_logging import device_logging_to_python, log_exceptions
-from devices.common.lofar_git import get_version
+from common.lofar_logging import device_logging_to_python, log_exceptions
+from common.lofar_git import get_version
 
 import numpy
 
@@ -176,7 +183,7 @@ class SDP(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the SDP module."""
 
-    from devices.common.lofar_logging import configure_logger
+    from common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 

devices/devices/sdp_statistics/sst.py

@@ -11,6 +11,13 @@
 
 """
 
+# TODO(Corne): Remove sys.path.append hack once packaging is in place!
+import os, sys
+currentdir = os.path.dirname(os.path.realpath(__file__))
+parentdir = os.path.dirname(currentdir)
+parentdir = os.path.dirname(parentdir)
+sys.path.append(parentdir)
+
 # PyTango imports
 from tango.server import run
 from tango.server import device_property
@@ -18,10 +25,10 @@ from tango.server import device_property
 
 from clients.sst_client import sst_client
 
-from devices.clients.attribute_wrapper import attribute_wrapper
-from devices.devices.hardware_device import hardware_device
+from clients.attribute_wrapper import attribute_wrapper
+from devices.hardware_device import hardware_device
 
-from devices.common.lofar_logging import device_logging_to_python, log_exceptions
+from common.lofar_logging import device_logging_to_python, log_exceptions
 
 import numpy
 
@@ -90,11 +97,11 @@ class SST(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the Statistics Device module."""
 
-    from devices.common.lofar_logging import configure_logger
+    from common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 
-    return run((Statistics,), args=args, **kwargs)
+    return run((SST,), args=args, **kwargs)
 
 
 if __name__ == '__main__':

devices/examples/HW_device_template.py

@@ -9,13 +9,19 @@
 
 """
 
+# TODO(Corne): Remove sys.path.append hack once packaging is in place!
+import os, sys
+currentdir = os.path.dirname(os.path.realpath(__file__))
+parentdir = os.path.dirname(currentdir)
+sys.path.append(parentdir)
+
 # PyTango imports
 from tango.server import run
 from tango import AttrWriteType
 # Additional import
 
-from util.attribute_wrapper import attribute_wrapper
-from util.hardware_device import hardware_device
+from clients.attribute_wrapper import attribute_wrapper
+from devices.hardware_device import hardware_device
 
 
 __all__ = ["HW_dev"]

devices/examples/load_from_disk/ini_client.py

-from util.comms_client import CommClient
+from clients.comms_client import CommClient
 import configparser
 import numpy
 

devices/examples/load_from_disk/ini_device.py

@@ -9,18 +9,25 @@
 
 """
 
+# TODO(Corne): Remove sys.path.append hack once packaging is in place!
+import os, sys
+currentdir = os.path.dirname(os.path.realpath(__file__))
+parentdir = os.path.dirname(currentdir)
+parentdir = os.path.dirname(parentdir)
+sys.path.append(parentdir)
+
 # PyTango imports
 from tango.server import run
 from tango import AttrWriteType
 # Additional import
-from devices.clients.attribute_wrapper import attribute_wrapper
-from devices.devices.hardware_device import hardware_device
+from clients.attribute_wrapper import attribute_wrapper
+from devices.hardware_device import hardware_device
 
 
 import configparser
 import numpy
 
-from clients.ini_client import *
+from ini_client import *
 
 
 __all__ = ["ini_device"]

devices/examples/snmp/snmp.py

@@ -11,15 +11,22 @@
 
 """
 
+# TODO(Corne): Remove sys.path.append hack once packaging is in place!
+import os, sys
+currentdir = os.path.dirname(os.path.realpath(__file__))
+parentdir = os.path.dirname(currentdir)
+parentdir = os.path.dirname(parentdir)
+sys.path.append(parentdir)
+
 # PyTango imports
 from tango.server import run
 from tango.server import device_property
 from tango import AttrWriteType
 
 # Additional import
-from devices.examples.snmp.snmp_client import SNMP_client
-from devices.clients.attribute_wrapper import attribute_wrapper
-from devices.devices.hardware_device import hardware_device
+from examples.snmp.snmp_client import SNMP_client
+from clients.attribute_wrapper import attribute_wrapper
+from devices.hardware_device import hardware_device
 
 import numpy
 
@@ -111,7 +118,7 @@ class SNMP(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the PCC module."""
 
-    from devices.common.lofar_logging import configure_logger
+    from common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 

devices/examples/snmp/snmp_client.py

-from util.comms_client import CommClient
+from clients.comms_client import CommClient
+
 import snmp
+
 import numpy
 import traceback
 
@@ -156,5 +158,3 @@ class SNMP_client(CommClient):
 
         # return the read/write functions
         return _read_function, _write_function
-
-