diff --git a/skabase/SKABaseDevice/SKABaseDevice.py b/skabase/SKABaseDevice/SKABaseDevice.py index d84716dac0d67a0fa840bc2fb4bfb527f4d32256..a4c7e8b468ad6222b677b93ecd908a6525d45e67 100644 --- a/skabase/SKABaseDevice/SKABaseDevice.py +++ b/skabase/SKABaseDevice/SKABaseDevice.py @@ -145,7 +145,6 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): ### Can this not be known through self which is a Device commands = [] device_proxy = DeviceProxy(self.get_name()) - print("Device Proxy is:", device_proxy) cmd_config_list = device_proxy.command_list_query() for device_cmd_config in cmd_config_list: commands.append(get_dp_command( @@ -234,22 +233,27 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): This method logs the message to SKA Element Logger, Central Logger and Storage Logger. - :param dev_log_msg: DevString - Message to log + :param dev_log_msg: DevString. + + Message to log :param dev_log_level: DevEnum + Logging level of the message. The message can have one of the following - logging level. + logging level: LOG_FATAL + LOG_ERROR + LOG_WARN + LOG_INFO + LOG_DEBUG :return: None """ # Element Level Logging - print("devLogMsg is: ", dev_log_msg) if self._element_logging_level >= int(tango.LogLevel.LOG_FATAL) and dev_log_level == int( tango.LogLevel.LOG_FATAL): self.fatal_stream(dev_log_msg) @@ -460,6 +464,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.always_executed_hook) ENABLED START # """ Method that is always executed before any device command gets executed. + :return: None """ # PROTECTED REGION END # // SKABaseDevice.always_executed_hook @@ -468,6 +473,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.delete_device) ENABLED START # """ Method to cleanup when device is stopped. + :return: None """ # PROTECTED REGION END # // SKABaseDevice.delete_device @@ -480,6 +486,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.buildState_read) ENABLED START # """ Reads the Build State of the device. + :return: None """ return self._build_state @@ -489,6 +496,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.versionId_read) ENABLED START # """ Reads the Version Id of the device. + :return: None """ return self._version_id @@ -498,6 +506,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.centralLoggingLevel_read) ENABLED START # """ Reads the central logging level of the device. + :return: Central logging level of the device """ return self._central_logging_level @@ -507,7 +516,9 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.centralLoggingLevel_write) ENABLED START # """ Sets central logging level of the device + :param value: Logging level for Central Logger + :return: None """ self._central_logging_level = value @@ -517,6 +528,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.elementLoggingLevel_read) ENABLED START # """ Reads element logging level of the device. + :return: Element logging level of the device. """ return self._element_logging_level @@ -526,7 +538,9 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.elementLoggingLevel_write) ENABLED START # """ Sets element logging level of the device + :param value: Logging Level for Element Logger + :return: None """ self._element_logging_level = value @@ -536,6 +550,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.storageLoggingLevel_read) ENABLED START # """ Reads storage logging level of the device. + :return: Storage logging level of the device. """ return self._storage_logging_level @@ -545,8 +560,10 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.storageLoggingLevel_write) ENABLED START # """ Sets logging level at storage. + :param value: Logging Level for storage logger - :return: + + :return: None. """ self._storage_logging_level = value if self._storage_logging_level == int(tango.LogLevel.LOG_FATAL): @@ -567,6 +584,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.healthState_read) ENABLED START # """ Reads Health State of the device. + :return: Health State of the device """ return self._health_state @@ -576,6 +594,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.adminMode_read) ENABLED START # """ Reads Admin Mode of the device. + :return: Admin Mode of the device """ return self._admin_mode @@ -585,7 +604,9 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.adminMode_write) ENABLED START # """ Sets Admin Mode of the device. + :param value: Admin Mode of the device. + :return: None """ self._admin_mode = value @@ -595,6 +616,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.controlMode_read) ENABLED START # """ Reads Control Mode of the device. + :return: Control Mode of the device """ return self._control_mode @@ -604,7 +626,9 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.controlMode_write) ENABLED START # """ Sets Control Mode of the device. + :param value: Control mode value + :return: None """ self._control_mode = value @@ -614,6 +638,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.simulationMode_read) ENABLED START # """ Reads Simulation Mode of the device. + :return: Simulation Mode of the device. """ return self._simulation_mode @@ -623,7 +648,9 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.simulationMode_write) ENABLED START # """ Sets Simulation Mode of the device + :param value: SimulationMode + :return: None """ self._simulation_mode = value @@ -633,6 +660,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.testMode_read) ENABLED START # """ Reads Test Mode of the device. + :return: Test Mode of the device """ return self._test_mode @@ -642,7 +670,9 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.testMode_write) ENABLED START # """ Sets Test Mode of the device. + :param value: Test Mode + :return: None """ self._test_mode = value @@ -659,6 +689,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.GetVersionInfo) ENABLED START # """ Returns the version information of the device. + :return: Version version details of the device. """ return ['{}, {}'.format(self.__class__.__name__, self.read_buildState())] @@ -671,6 +702,7 @@ class SKABaseDevice(with_metaclass(DeviceMeta, Device)): # PROTECTED REGION ID(SKABaseDevice.Reset) ENABLED START # """ Reset device to its default state. + :return: None """ # PROTECTED REGION END # // SKABaseDevice.Reset @@ -684,8 +716,11 @@ def main(args=None, **kwargs): # PROTECTED REGION ID(SKABaseDevice.main) ENABLED START # """ Main function of the SKABaseDevice module. + :param args: None + :param kwargs: + :return: """ return run((SKABaseDevice,), args=args, **kwargs) diff --git a/skabase/SKALogger/SKALogger.py b/skabase/SKALogger/SKALogger.py index 77d6ea4eb914cb602f96f72a60cba94a81ea748c..16034ef7d2b5f1a32cd2ceb599b1658434478f65 100644 --- a/skabase/SKALogger/SKALogger.py +++ b/skabase/SKALogger/SKALogger.py @@ -190,12 +190,18 @@ class SKALogger(with_metaclass(DeviceMeta, SKABaseDevice)): central_logging_device = argin[1][:] i = 0 while i < len(central_logging_level[:]): - self.info_stream("Central Logging level : %s, Device : %s", - central_logging_level[i], - central_logging_level[i]) - dev_proxy = DeviceProxy(central_logging_device[i]) - dev_proxy.centralLoggingLevel = central_logging_level[i] + try: + self.info_stream("Central Logging level : %s, Device : %s", + central_logging_level[i], + central_logging_level[i]) + dev_proxy = DeviceProxy(central_logging_device[i]) + dev_proxy.centralLoggingLevel = central_logging_level[i] + except DevFailed as dev_failed: + self.error_stream("Failed to set Central Logging level for [%s]", central_logging_level[i]) + str_exception = "Exception: " + str(dev_failed) + self.error_stream(str_exception) i += 1 + # PROTECTED REGION END # // SKALogger.SetCentralLoggingLevel @command(dtype_in='DevVarLongStringArray', doc_in="Element logging level for selected devices",) @@ -224,11 +230,16 @@ class SKALogger(with_metaclass(DeviceMeta, SKABaseDevice)): element_logging_device = argin[1][:] i = 0 while i < len(element_logging_level[:]): - self.info_stream("Element Logging level : %s, Device : %s", - element_logging_level[i], - element_logging_device[i]) - dev_proxy = DeviceProxy(element_logging_device[i]) - dev_proxy.elementLoggingLevel = element_logging_level[i] + try: + self.info_stream("Element Logging level : %s, Device : %s", + element_logging_level[i], + element_logging_device[i]) + dev_proxy = DeviceProxy(element_logging_device[i]) + dev_proxy.elementLoggingLevel = element_logging_level[i] + except DevFailed as dev_failed: + self.error_stream("Failed to set Element Logging level for [%s]", element_logging_device[i]) + str_exception = "Exception: " + str(dev_failed) + self.error_stream(str_exception) i += 1 # PROTECTED REGION END # // SKALogger.SetElementLoggingLevel @@ -258,11 +269,16 @@ class SKALogger(with_metaclass(DeviceMeta, SKABaseDevice)): storage_logging_device = argin[1][:] i = 0 while i < len(storage_logging_level[:]): - self.info_stream("Storage logging level : %s, Device : %s", - storage_logging_level[i], - storage_logging_device[i]) - dev_proxy = DeviceProxy(storage_logging_device[i]) - dev_proxy.storageLoggingLevel = storage_logging_level[i] + try: + self.info_stream("Storage logging level : %s, Device : %s", + storage_logging_level[i], + storage_logging_device[i]) + dev_proxy = DeviceProxy(storage_logging_device[i]) + dev_proxy.storageLoggingLevel = storage_logging_level[i] + except DevFailed as dev_failed: + self.error_stream("Failed to set Storage Logging level for [%s]", storage_logging_device[i]) + str_exception = "Exception: " + str(dev_failed) + self.error_stream(str_exception) i += 1 # PROTECTED REGION END # // SKALogger.SetStorageLoggingLevel diff --git a/skabase/SKAMaster/SKAMaster.py b/skabase/SKAMaster/SKAMaster.py index 8e224ed46d8bc637c01484cee1f9353b2f86f631..fb7321887c6695027055b971aac5493f7e62c5cf 100644 --- a/skabase/SKAMaster/SKAMaster.py +++ b/skabase/SKAMaster/SKAMaster.py @@ -178,12 +178,18 @@ class SKAMaster(with_metaclass(DeviceMeta, SKABaseDevice)): # PROTECTED REGION ID(SKAMaster.isCapabilityAchievable) ENABLED START # """ Checks of provided capabilities can be achieved by the resource(s). - :param argin: DevVarLongStringArray. An array consisting pair of DevLong and - DevString. A single entry consists of\n - [nrInstances]: DevLong. Number of instances of the capability - [Capability types]: DevString. Type of capability + + :param argin: DevVarLongStringArray. + + An array consisting pair of + [nrInstances]: DevLong. Number of instances of the capability. + + [Capability types]: DevString. Type of capability. + :return: DevBoolean + True if capability can be achieved. + False if cannot. """ command_name = 'isCapabilityAchievable' diff --git a/skabase/SKATelState/SKATelState.py b/skabase/SKATelState/SKATelState.py index bd57c7226500acdbfc77cce1c44814194faa0b27..b4e20e518da8ba7466b8b02626b3e9e977097949 100644 --- a/skabase/SKATelState/SKATelState.py +++ b/skabase/SKATelState/SKATelState.py @@ -92,8 +92,11 @@ def main(args=None, **kwargs): # PROTECTED REGION ID(SKATelState.main) ENABLED START # """ Main function of the module - :param args: None + + :param args: None by default. + :param kwargs: + :return: """ return run((SKATelState,), args=args, **kwargs)