From b970f1d7c792e624dc5fa1456d3f9d5e8590727f Mon Sep 17 00:00:00 2001
From: lukken <lukken@astron.nl>
Date: Tue, 22 Jun 2021 08:14:12 +0000
Subject: [PATCH] L2SS-200: File restructuring for Python files

---
 devices/clients/__init__.py                        |  0
 devices/{util => clients}/attribute_wrapper.py     |  0
 devices/{util => clients}/comms_client.py          |  0
 .../{opcua_connection.py => opcua_client.py}       |  0
 devices/common/__init__.py                         |  0
 devices/{util => common}/lofar_git.py              |  2 +-
 devices/{util => common}/lofar_logging.py          |  0
 devices/devices/__init__.py                        |  0
 devices/{APSCTL.py => devices/apsctl.py}           | 12 ++++++------
 .../wrappers.py => devices/device_decorators.py}   |  0
 devices/{util => devices}/hardware_device.py       |  0
 devices/{PCC.py => devices/pcc.py}                 | 14 +++++++-------
 devices/{SDP.py => devices/sdp.py}                 | 12 ++++++------
 devices/devices/sdp/__init__.py                    |  0
 devices/devices/sdp_statistics/__init__.py         |  0
 .../sdp_statistics/sst.py}                         |  9 ++++-----
 .../sdp_statistics/statistics_packet.py}           |  0
 devices/examples/__init__.py                       |  0
 devices/examples/load_from_disk/__init__.py        |  0
 .../load_from_disk}/ini_client.py                  |  0
 .../{ => examples/load_from_disk}/ini_device.py    |  6 ++----
 devices/examples/snmp/__init__.py                  |  0
 devices/{SNMP.py => examples/snmp/snmp.py}         |  8 ++++----
 .../snmp/snmp_client.py}                           |  0
 devices/test/__init__.py                           |  0
 devices/test/clients/__init__.py                   |  0
 devices/{ => test}/clients/test_client.py          |  0
 devices/test/devices/__init__.py                   |  0
 .../{RandomData.py => test/devices/random_data.py} |  0
 devices/{ => test/devices}/test_device.py          |  4 ++--
 devices/toolkit/__init__.py                        |  0
 devices/{util => toolkit}/archiver.py              |  1 -
 .../get_internal_attribute_history.py              |  0
 devices/{util => toolkit}/lofar2_config.py         |  0
 devices/{util => toolkit}/lts_cold_start.py        |  4 ++--
 devices/{util => toolkit}/startup.py               |  0
 devices/{ => toolkit}/udp_simulator.py             |  0
 37 files changed, 34 insertions(+), 38 deletions(-)
 create mode 100644 devices/clients/__init__.py
 rename devices/{util => clients}/attribute_wrapper.py (100%)
 rename devices/{util => clients}/comms_client.py (100%)
 rename devices/clients/{opcua_connection.py => opcua_client.py} (100%)
 create mode 100644 devices/common/__init__.py
 rename devices/{util => common}/lofar_git.py (97%)
 rename devices/{util => common}/lofar_logging.py (100%)
 create mode 100644 devices/devices/__init__.py
 rename devices/{APSCTL.py => devices/apsctl.py} (96%)
 rename devices/{util/wrappers.py => devices/device_decorators.py} (100%)
 rename devices/{util => devices}/hardware_device.py (100%)
 rename devices/{PCC.py => devices/pcc.py} (95%)
 rename devices/{SDP.py => devices/sdp.py} (96%)
 create mode 100644 devices/devices/sdp/__init__.py
 create mode 100644 devices/devices/sdp_statistics/__init__.py
 rename devices/{Statistics.py => devices/sdp_statistics/sst.py} (91%)
 rename devices/{SDP_statistics.py => devices/sdp_statistics/statistics_packet.py} (100%)
 create mode 100644 devices/examples/__init__.py
 create mode 100644 devices/examples/load_from_disk/__init__.py
 rename devices/{clients => examples/load_from_disk}/ini_client.py (100%)
 rename devices/{ => examples/load_from_disk}/ini_device.py (97%)
 create mode 100644 devices/examples/snmp/__init__.py
 rename devices/{SNMP.py => examples/snmp/snmp.py} (93%)
 rename devices/{clients/SNMP_client.py => examples/snmp/snmp_client.py} (100%)
 create mode 100644 devices/test/__init__.py
 create mode 100644 devices/test/clients/__init__.py
 rename devices/{ => test}/clients/test_client.py (100%)
 create mode 100644 devices/test/devices/__init__.py
 rename devices/{RandomData.py => test/devices/random_data.py} (100%)
 rename devices/{ => test/devices}/test_device.py (97%)
 create mode 100644 devices/toolkit/__init__.py
 rename devices/{util => toolkit}/archiver.py (94%)
 rename devices/{util => toolkit}/get_internal_attribute_history.py (100%)
 rename devices/{util => toolkit}/lofar2_config.py (100%)
 rename devices/{util => toolkit}/lts_cold_start.py (98%)
 rename devices/{util => toolkit}/startup.py (100%)
 rename devices/{ => toolkit}/udp_simulator.py (100%)

diff --git a/devices/clients/__init__.py b/devices/clients/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/util/attribute_wrapper.py b/devices/clients/attribute_wrapper.py
similarity index 100%
rename from devices/util/attribute_wrapper.py
rename to devices/clients/attribute_wrapper.py
diff --git a/devices/util/comms_client.py b/devices/clients/comms_client.py
similarity index 100%
rename from devices/util/comms_client.py
rename to devices/clients/comms_client.py
diff --git a/devices/clients/opcua_connection.py b/devices/clients/opcua_client.py
similarity index 100%
rename from devices/clients/opcua_connection.py
rename to devices/clients/opcua_client.py
diff --git a/devices/common/__init__.py b/devices/common/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/util/lofar_git.py b/devices/common/lofar_git.py
similarity index 97%
rename from devices/util/lofar_git.py
rename to devices/common/lofar_git.py
index e95f6bdf3..353748d98 100644
--- a/devices/util/lofar_git.py
+++ b/devices/common/lofar_git.py
@@ -52,7 +52,7 @@ def get_version(repo: git.Repo = None) -> str:
 
     branch = repo.active_branch
     commit = repo.commit()
-    tags = { tag.commit: tag for tag in repo.tags }
+    tags = {tag.commit: tag for tag in repo.tags}
 
     if commit in tags:
         commit_str = "{}".format(tags[commit])
diff --git a/devices/util/lofar_logging.py b/devices/common/lofar_logging.py
similarity index 100%
rename from devices/util/lofar_logging.py
rename to devices/common/lofar_logging.py
diff --git a/devices/devices/__init__.py b/devices/devices/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/APSCTL.py b/devices/devices/apsctl.py
similarity index 96%
rename from devices/APSCTL.py
rename to devices/devices/apsctl.py
index 068ec2ab4..5187aa8eb 100644
--- a/devices/APSCTL.py
+++ b/devices/devices/apsctl.py
@@ -17,12 +17,12 @@ from tango.server import device_property, attribute
 from tango import AttrWriteType
 # Additional import
 
-from clients.opcua_connection import OPCUAConnection
-from util.attribute_wrapper import attribute_wrapper
-from util.hardware_device import hardware_device
+from clients.opcua_client import OPCUAConnection
+from devices.clients.attribute_wrapper import attribute_wrapper
+from devices.devices.hardware_device import hardware_device
 
-from util.lofar_logging import device_logging_to_python, log_exceptions
-from util.lofar_git import get_version
+from devices.common.lofar_logging import device_logging_to_python, log_exceptions
+from devices.common.lofar_git import get_version
 
 import numpy
 
@@ -188,7 +188,7 @@ class APSCTL(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the SDP module."""
 
-    from util.lofar_logging import configure_logger
+    from devices.common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 
diff --git a/devices/util/wrappers.py b/devices/devices/device_decorators.py
similarity index 100%
rename from devices/util/wrappers.py
rename to devices/devices/device_decorators.py
diff --git a/devices/util/hardware_device.py b/devices/devices/hardware_device.py
similarity index 100%
rename from devices/util/hardware_device.py
rename to devices/devices/hardware_device.py
diff --git a/devices/PCC.py b/devices/devices/pcc.py
similarity index 95%
rename from devices/PCC.py
rename to devices/devices/pcc.py
index e8eb9bc94..fe2a1841d 100644
--- a/devices/PCC.py
+++ b/devices/devices/pcc.py
@@ -19,13 +19,13 @@ from tango import AttrWriteType
 import numpy
 # Additional import
 
-from util.wrappers import *
+from devices.devices.device_decorators import *
 
-from clients.opcua_connection import OPCUAConnection
-from util.attribute_wrapper import attribute_wrapper
-from util.hardware_device import hardware_device
-from util.lofar_logging import device_logging_to_python, log_exceptions
-from util.lofar_git import get_version
+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
 
 __all__ = ["PCC", "main"]
 
@@ -244,7 +244,7 @@ class PCC(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the PCC module."""
 
-    from util.lofar_logging import configure_logger
+    from devices.common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 
diff --git a/devices/SDP.py b/devices/devices/sdp.py
similarity index 96%
rename from devices/SDP.py
rename to devices/devices/sdp.py
index 56091d98b..f6eb07f27 100644
--- a/devices/SDP.py
+++ b/devices/devices/sdp.py
@@ -17,12 +17,12 @@ from tango.server import device_property, attribute
 from tango import AttrWriteType
 # Additional import
 
-from clients.opcua_connection import OPCUAConnection
-from util.attribute_wrapper import attribute_wrapper
-from util.hardware_device import hardware_device
+from clients.opcua_client import OPCUAConnection
+from devices.clients.attribute_wrapper import attribute_wrapper
+from devices.devices.hardware_device import hardware_device
 
-from util.lofar_logging import device_logging_to_python, log_exceptions
-from util.lofar_git import get_version
+from devices.common.lofar_logging import device_logging_to_python, log_exceptions
+from devices.common.lofar_git import get_version
 
 import numpy
 
@@ -168,7 +168,7 @@ class SDP(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the SDP module."""
 
-    from util.lofar_logging import configure_logger
+    from devices.common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 
diff --git a/devices/devices/sdp/__init__.py b/devices/devices/sdp/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/devices/sdp_statistics/__init__.py b/devices/devices/sdp_statistics/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/Statistics.py b/devices/devices/sdp_statistics/sst.py
similarity index 91%
rename from devices/Statistics.py
rename to devices/devices/sdp_statistics/sst.py
index 856beffde..28874a3d0 100644
--- a/devices/Statistics.py
+++ b/devices/devices/sdp_statistics/sst.py
@@ -14,15 +14,14 @@
 # PyTango imports
 from tango.server import run
 from tango.server import device_property
-from tango import AttrWriteType
 # Additional import
 
 from clients.sst_client import sst_client
 
-from util.attribute_wrapper import attribute_wrapper
-from util.hardware_device import hardware_device
+from devices.clients.attribute_wrapper import attribute_wrapper
+from devices.devices.hardware_device import hardware_device
 
-from util.lofar_logging import device_logging_to_python, log_exceptions
+from devices.common.lofar_logging import device_logging_to_python, log_exceptions
 
 import numpy
 
@@ -91,7 +90,7 @@ class SST(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the Statistics Device module."""
 
-    from util.lofar_logging import configure_logger
+    from devices.common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 
diff --git a/devices/SDP_statistics.py b/devices/devices/sdp_statistics/statistics_packet.py
similarity index 100%
rename from devices/SDP_statistics.py
rename to devices/devices/sdp_statistics/statistics_packet.py
diff --git a/devices/examples/__init__.py b/devices/examples/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/examples/load_from_disk/__init__.py b/devices/examples/load_from_disk/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/clients/ini_client.py b/devices/examples/load_from_disk/ini_client.py
similarity index 100%
rename from devices/clients/ini_client.py
rename to devices/examples/load_from_disk/ini_client.py
diff --git a/devices/ini_device.py b/devices/examples/load_from_disk/ini_device.py
similarity index 97%
rename from devices/ini_device.py
rename to devices/examples/load_from_disk/ini_device.py
index dbc6e6159..c1c273171 100644
--- a/devices/ini_device.py
+++ b/devices/examples/load_from_disk/ini_device.py
@@ -11,12 +11,10 @@
 
 # PyTango imports
 from tango.server import run
-from tango.server import device_property
 from tango import AttrWriteType
-from tango import DevState
 # Additional import
-from util.attribute_wrapper import attribute_wrapper
-from util.hardware_device import hardware_device
+from devices.clients.attribute_wrapper import attribute_wrapper
+from devices.devices.hardware_device import hardware_device
 
 
 import configparser
diff --git a/devices/examples/snmp/__init__.py b/devices/examples/snmp/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/SNMP.py b/devices/examples/snmp/snmp.py
similarity index 93%
rename from devices/SNMP.py
rename to devices/examples/snmp/snmp.py
index eb90b2768..7962d2fd7 100644
--- a/devices/SNMP.py
+++ b/devices/examples/snmp/snmp.py
@@ -17,9 +17,9 @@ from tango.server import device_property
 from tango import AttrWriteType
 
 # Additional import
-from clients.SNMP_client import SNMP_client
-from util.attribute_wrapper import attribute_wrapper
-from util.hardware_device import hardware_device
+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
 
 import numpy
 
@@ -111,7 +111,7 @@ class SNMP(hardware_device):
 def main(args=None, **kwargs):
     """Main function of the PCC module."""
 
-    from util.lofar_logging import configure_logger
+    from devices.common.lofar_logging import configure_logger
     import logging
     configure_logger(logging.getLogger())
 
diff --git a/devices/clients/SNMP_client.py b/devices/examples/snmp/snmp_client.py
similarity index 100%
rename from devices/clients/SNMP_client.py
rename to devices/examples/snmp/snmp_client.py
diff --git a/devices/test/__init__.py b/devices/test/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/test/clients/__init__.py b/devices/test/clients/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/clients/test_client.py b/devices/test/clients/test_client.py
similarity index 100%
rename from devices/clients/test_client.py
rename to devices/test/clients/test_client.py
diff --git a/devices/test/devices/__init__.py b/devices/test/devices/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/RandomData.py b/devices/test/devices/random_data.py
similarity index 100%
rename from devices/RandomData.py
rename to devices/test/devices/random_data.py
diff --git a/devices/test_device.py b/devices/test/devices/test_device.py
similarity index 97%
rename from devices/test_device.py
rename to devices/test/devices/test_device.py
index 6a6290711..22fe3c2bb 100644
--- a/devices/test_device.py
+++ b/devices/test/devices/test_device.py
@@ -17,8 +17,8 @@ from tango import DevState
 # Additional import
 
 from clients.test_client import test_client
-from util.attribute_wrapper import *
-from util.hardware_device import *
+from devices.clients.attribute_wrapper import *
+from devices.devices.hardware_device import *
 
 __all__ = ["test_device", "main"]
 
diff --git a/devices/toolkit/__init__.py b/devices/toolkit/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/devices/util/archiver.py b/devices/toolkit/archiver.py
similarity index 94%
rename from devices/util/archiver.py
rename to devices/toolkit/archiver.py
index 70f43d88a..3764a7b16 100644
--- a/devices/util/archiver.py
+++ b/devices/toolkit/archiver.py
@@ -1,6 +1,5 @@
 #! /usr/bin/env python3
 
-from .lofar2_config import configure_logging
 from tango import DeviceProxy
 
 
diff --git a/devices/util/get_internal_attribute_history.py b/devices/toolkit/get_internal_attribute_history.py
similarity index 100%
rename from devices/util/get_internal_attribute_history.py
rename to devices/toolkit/get_internal_attribute_history.py
diff --git a/devices/util/lofar2_config.py b/devices/toolkit/lofar2_config.py
similarity index 100%
rename from devices/util/lofar2_config.py
rename to devices/toolkit/lofar2_config.py
diff --git a/devices/util/lts_cold_start.py b/devices/toolkit/lts_cold_start.py
similarity index 98%
rename from devices/util/lts_cold_start.py
rename to devices/toolkit/lts_cold_start.py
index 18b2bbb01..baaadade2 100644
--- a/devices/util/lts_cold_start.py
+++ b/devices/toolkit/lts_cold_start.py
@@ -1,8 +1,8 @@
 #! /usr/bin/env python3
 import logging
 from time import sleep
-from .startup import startup
-from .lofar2_config import configure_logging
+from devices.toolkit.startup import startup
+from devices.toolkit.lofar2_config import configure_logging
 
 
 def start_device(device: str):
diff --git a/devices/util/startup.py b/devices/toolkit/startup.py
similarity index 100%
rename from devices/util/startup.py
rename to devices/toolkit/startup.py
diff --git a/devices/udp_simulator.py b/devices/toolkit/udp_simulator.py
similarity index 100%
rename from devices/udp_simulator.py
rename to devices/toolkit/udp_simulator.py
-- 
GitLab