Fix test and run ruff and pyright on all affected files

Author: LowriJenkins

BlockServer/config/block.py

@@ -13,7 +13,7 @@
 # along with this program; if not, you can obtain a copy from
 # https://www.eclipse.org/org/documents/epl-v10.php or
 # http://opensource.org/licenses/eclipse-1.0.php
-from typing import Dict, Union
+from typing import Dict, TypedDict, Union
 
 from server_common.helpers import PVPREFIX_MACRO
 
@@ -41,17 +41,17 @@ def __init__(
         pv: str,
         local: bool = True,
         visible: bool = True,
-        component: str = None,
+        component: str | None = None,
         runcontrol: bool = False,
-        lowlimit: float = None,
-        highlimit: float = None,
+        lowlimit: float | None = None,
+        highlimit: float | None = None,
         suspend_on_invalid: bool = False,
         log_periodic: bool = False,
         log_rate: float = 5,
         log_deadband: float = 0,
         set_block: bool = False,
-        set_block_val: str = None,
-    ):
+        set_block_val: str | None = None,
+    ) -> None:
         """Constructor.
 
         Args:
@@ -92,24 +92,26 @@ def _get_pv(self) -> str:
             pv_name = PVPREFIX_MACRO + self.pv
         return pv_name
 
-    def set_visibility(self, visible: bool):
+    def set_visibility(self, visible: bool) -> None:
         """Toggle the visibility of the block.
 
         Args:
             visible: Whether the block is visible or not
         """
         self.visible = visible
 
-    def __str__(self):
+    def __str__(self) -> str:
         set_block_str = ""
         if self.set_block:
             set_block_str = f", SetBlockVal: {self.set_block_val}"
         return (
-            f"Name: {self.name}, PV: {self.pv}, Local: {self.local}, Visible: {self.visible}, Component: {self.component}"
-            f", RCEnabled: {self.rc_enabled}, RCLow: {self.rc_lowlimit}, RCHigh: {self.rc_highlimit}{set_block_str}"
+            f"Name: {self.name}, PV: {self.pv}, Local: {self.local}, "
+            f"Visible: {self.visible}, Component: {self.component}"
+            f", RCEnabled: {self.rc_enabled}, RCLow: {self.rc_lowlimit}, "
+            f"RCHigh: {self.rc_highlimit}{set_block_str}"
         )
 
-    def to_dict(self) -> Dict[str, Union[str, float, bool]]:
+    def to_dict(self) -> Dict[str, Union[str, float, bool, None]]:
         """Puts the block's details into a dictionary.
 
         Returns:
@@ -131,3 +133,17 @@ def to_dict(self) -> Dict[str, Union[str, float, bool]]:
             "set_block": self.set_block,
             "set_block_val": self.set_block_val,
         }
+
+
+class BlockKwargs(TypedDict, total=False):
+    visible: bool
+    component: str | None
+    runcontrol: bool
+    lowlimit: float | None
+    highlimit: float | None
+    suspend_on_invalid: bool
+    log_periodic: bool
+    log_rate: float
+    log_deadband: float
+    set_block: bool
+    set_block_val: str | None

BlockServer/config/configuration.py

@@ -17,15 +17,16 @@
 """Contains all the code for defining a configuration or component"""
 
 from collections import OrderedDict
-from typing import Dict
+from typing import Dict, Unpack
 
-from BlockServer.config.block import Block
+from server_common.helpers import PVPREFIX_MACRO
+from server_common.utilities import print_and_log
+
+from BlockServer.config.block import Block, BlockKwargs
 from BlockServer.config.group import Group
 from BlockServer.config.ioc import IOC
 from BlockServer.config.metadata import MetaData
 from BlockServer.core.constants import GRP_NONE
-from server_common.helpers import PVPREFIX_MACRO
-from server_common.utilities import print_and_log
 
 
 class Configuration:
@@ -41,7 +42,7 @@ class Configuration:
         is_component (bool): Whether it is actually a component
     """
 
-    def __init__(self, macros: Dict):
+    def __init__(self, macros: Dict) -> None:
         """Constructor.
 
         Args:
@@ -56,7 +57,14 @@ def __init__(self, macros: Dict):
         self.components = OrderedDict()
         self.is_component = False
 
-    def add_block(self, name: str, pv: str, group: str = GRP_NONE, local: bool = True, **kwargs):
+    def add_block(
+        self,
+        name: str,
+        pv: str,
+        group: str = GRP_NONE,
+        local: bool = True,
+        **kwargs: Unpack[BlockKwargs],
+    ) -> None:
         """Add a block to the configuration.
 
         Args:
@@ -85,15 +93,15 @@ def add_block(self, name: str, pv: str, group: str = GRP_NONE, local: bool = Tru
     def add_ioc(
         self,
         name: str,
-        component: str = None,
-        autostart: bool = None,
-        restart: bool = None,
-        macros: Dict = None,
-        pvs: Dict = None,
-        pvsets: Dict = None,
-        simlevel: str = None,
-        remotePvPrefix: str = None,
-    ):
+        component: str | None = None,
+        autostart: bool | None = None,
+        restart: bool | None = None,
+        macros: Dict | None = None,
+        pvs: Dict | None = None,
+        pvsets: Dict | None = None,
+        simlevel: str | None = None,
+        remote_pv_prefix: str | None = None,
+    ) -> None:
         """Add an IOC to the configuration.
 
         Args:
@@ -115,7 +123,15 @@ def add_ioc(
             )
         else:
             self.iocs[name.upper()] = IOC(
-                name, autostart, restart, component, macros, pvs, pvsets, simlevel, remotePvPrefix
+                name,
+                autostart if autostart is not None else True,
+                restart if restart is not None else True,
+                component,
+                macros,
+                pvs,
+                pvsets,
+                simlevel,
+                remote_pv_prefix,
             )
 
     def get_name(self) -> str:
@@ -128,7 +144,7 @@ def get_name(self) -> str:
             self.meta.name.decode("utf-8") if isinstance(self.meta.name, bytes) else self.meta.name
         )
 
-    def set_name(self, name: str):
+    def set_name(self, name: str) -> None:
         """Sets the configuration's name.
 
         Args:

BlockServer/config/ioc.py

@@ -39,12 +39,12 @@ def __init__(
         name: str,
         autostart: bool = True,
         restart: bool = True,
-        component: str = None,
-        macros: Dict = None,
-        pvs: Dict = None,
-        pvsets: Dict = None,
-        simlevel: str = None,
-        remote_pv_prefix: str = None,
+        component: str | None = None,
+        macros: Dict | None = None,
+        pvs: Dict | None = None,
+        pvsets: Dict | None = None,
+        simlevel: str | None = None,
+        remotePvPrefix: str | None = None,  # noqa: N803
     ) -> None:
         """Constructor.
 
@@ -60,13 +60,14 @@ def __init__(
             pvs: The IOC's PVs
             pvsets: The IOC's PV sets
             simlevel: The level of simulation
-            remote_pv_prefix: The remote pv prefix
+            remotePvPrefix: The remote pv prefix,
+                has to be formatted like this to be read in properly.
         """
         self.name = name
         self.autostart = autostart
         self.restart = restart
         self.component = component
-        self.remote_pv_prefix = remote_pv_prefix
+        self.remote_pv_prefix = remotePvPrefix
 
         if simlevel is None:
             self.simlevel = "none"
@@ -75,13 +76,18 @@ def __init__(
 
         self.macros = {}
         if macros is not None:
-            # Remove macros that are set to use default, they can be gotten from config.xml
-            # so there is no need for them to be stored in the config.
-            for name, data in macros.items():
-                if not ("useDefault" in data and data["useDefault"]):
-                    self.macros.update({name: data})
-                    self.macros[name].pop("useDefault")
-
+            if isinstance(macros, dict):
+                # Remove macros that are set to use default, they can be gotten from config.xml
+                # so there is no need for them to be stored in the config.
+                print(macros)
+                for name, data in macros.items():
+                    if "useDefault" in data and not data["useDefault"]:
+                        self.macros.update({name: data})
+                        self.macros[name].pop("useDefault")
+                    elif "useDefault" not in data:
+                        self.macros.update({name: data})
+            else:
+                self.macros = macros
         if pvs is None:
             self.pvs = {}
         else:

BlockServer/core/config_holder.py

@@ -43,7 +43,7 @@ def __init__(
         macros: Dict,
         file_manager: ConfigurationFileManager,
         is_component: bool = False,
-        test_config: Configuration = None,
+        test_config: Configuration | None = None,
     ) -> None:
         """Constructor.
 
@@ -127,7 +127,7 @@ def get_blocknames(self) -> List[str]:
                     names.append(block.name)
         return names
 
-    def get_block_details(self):
+    def get_block_details(self) -> Dict:
         """Get the configuration details for all the blocks including any in components.
 
         Returns:
@@ -183,7 +183,7 @@ def get_group_details(self) -> Dict[str, Group]:
 
         return groups
 
-    def _set_group_details(self, redefinition) -> None:
+    def _set_group_details(self, redefinition: List[Dict]) -> None:
         # Any redefinition only affects the main configuration
         homeless_blocks = self.get_blocknames()
         for grp in redefinition:
@@ -245,15 +245,15 @@ def get_ioc_names(self, include_base: bool = False) -> List[str]:
                 iocs.extend(cv.iocs)
         return iocs
 
-    def get_ioc_details(self):
+    def get_ioc_details(self) -> Dict:
         """Get the details of the IOCs in the configuration.
 
         Returns:
             A copy of all the configuration IOC details
         """
         return copy.deepcopy(self._config.iocs)
 
-    def get_component_ioc_details(self):
+    def get_component_ioc_details(self) -> Dict:
         """Get the details of the IOCs in any components.
 
         Returns:
@@ -266,7 +266,7 @@ def get_component_ioc_details(self):
                     iocs[ioc_name] = ioc
         return iocs
 
-    def get_all_ioc_details(self):
+    def get_all_ioc_details(self) -> Dict:
         """Get the details of the IOCs in the configuration and any components.
 
         Returns:
@@ -364,22 +364,22 @@ def is_dynamic(self) -> bool:
         """
         return self._config.meta.isDynamic
 
-    def configures_block_gateway_and_archiver(self):
+    def configures_block_gateway_and_archiver(self) -> bool:
         """
         Returns:
             (bool): Whether this config has a gwblock.pvlist and block_config.xml to configure the
              block gateway and archiver with.
         """
         return self._config.meta.configuresBlockGWAndArchiver
 
-    def _comps_to_list(self):
+    def _comps_to_list(self) -> List:
         comps = []
         for component_name, component_value in self._components.items():
             if component_name.lower() != DEFAULT_COMPONENT.lower():
                 comps.append({"name": component_value.get_name()})
         return comps
 
-    def _blocks_to_list(self, expand_macro: bool = False):
+    def _blocks_to_list(self, expand_macro: bool = False) -> List:
         blocks = self.get_block_details()
         blks = []
         if blocks is not None:
@@ -391,7 +391,7 @@ def _blocks_to_list(self, expand_macro: bool = False):
                 blks.append(b)
         return blks
 
-    def _groups_to_list(self):
+    def _groups_to_list(self) -> List:
         groups = self.get_group_details()
         grps = []
         if groups is not None:
@@ -404,18 +404,18 @@ def _groups_to_list(self):
                 grps.append(groups[GRP_NONE.lower()].to_dict())
         return grps
 
-    def _iocs_to_list(self):
+    def _iocs_to_list(self) -> List[Dict]:
         return [ioc.to_dict() for ioc in self._config.iocs.values()]
 
-    def _iocs_to_list_with_components(self):
+    def _iocs_to_list_with_components(self) -> List[Dict]:
         ioc_list = self._iocs_to_list()
 
         for component in self._components.values():
             for ioc in component.iocs.values():
                 ioc_list.append(ioc.to_dict())
         return ioc_list
 
-    def _to_dict(self, data_list):
+    def _to_dict(self, data_list: List) -> None | Dict:
         return None if data_list is None else {item["name"]: item for item in data_list}
 
     def set_config(self, config: Configuration, is_component: bool = False) -> None: