Merge pull request #605 from powerapi-ng/refactor/implicit-optional-type-hints

refactor: Use union types syntax to define optional arguments

Author: gfieni

.ruff.toml

@@ -18,7 +18,5 @@ ignore = [
 
     "B006",   # mutable-argument-default
     "F401",   # unused-import
-    "RUF013", # implicit-optional
-
     "B010",   # set-attr-with-constant
 ]

src/powerapi/cli/config_parser.py

@@ -43,7 +43,7 @@
     get_longest_related_suffix
 
 
-def store_val(argument_name: str, val: Any, configuration: dict, args: list = None) -> (list, dict):
+def store_val(argument_name: str, val: Any, configuration: dict, args: list | None = None) -> (list, dict):
     """
     Action that stores the value of the argument on the parser result
 
@@ -55,7 +55,7 @@ def store_val(argument_name: str, val: Any, configuration: dict, args: list = No
     return args, configuration
 
 
-def store_true(argument_name: str, configuration: dict, val: Any = None, args: list = None) -> (list, dict):
+def store_true(argument_name: str, configuration: dict, val: Any = None, args: list | None = None) -> (list, dict):
     """
     Action that stores a True boolean value on the parser result
 
@@ -65,7 +65,7 @@ def store_true(argument_name: str, configuration: dict, val: Any = None, args: l
     return args, configuration
 
 
-def extract_file_names(argument_name: str, val: Any, configuration: dict, args: list = None):
+def extract_file_names(argument_name: str, val: Any, configuration: dict, args: list | None = None):
     """
     Action used to convert string from --files parameter into a list of file name
     """
@@ -79,7 +79,7 @@ class ConfigurationArgument:
     """
 
     def __init__(self, names: list, is_flag: bool, default_value: Any, help_text: str, argument_type: type,
-                 is_mandatory: bool, action: Callable = None):
+                 is_mandatory: bool, action: Callable | None = None):
         self.names = names
         self.is_flag = is_flag
         self.default_value = default_value

src/powerapi/cli/generator.py

@@ -287,7 +287,7 @@ class ProcessorGenerator(Generator):
     Generator that initialises the processor from config
     """
 
-    def __init__(self, component_group_name: str, processor_factory: dict[str, Callable[[dict], ProcessorActor]] = None):
+    def __init__(self, component_group_name: str, processor_factory: dict[str, Callable[[dict], ProcessorActor]] | None = None):
         Generator.__init__(self, component_group_name)
 
         self.processor_factory = processor_factory

src/powerapi/cli/parsing_manager.py

@@ -190,7 +190,7 @@ def validate(self, conf: dict) -> dict:
 
         return conf
 
-    def parse(self, args: list = None) -> dict:
+    def parse(self, args: list | None = None) -> dict:
         """
         Parse the configurations defined via le CLI, Environment Variables and configuration file.
         The priority of defined values is the following:

src/powerapi/database/base_db.py

@@ -73,7 +73,7 @@ class BaseDB:
     This class define the interface needed to fetch/save reports from/to a database.
     """
 
-    def __init__(self, report_type: type[Report], exceptions: list[type[Exception]] = None):
+    def __init__(self, report_type: type[Report], exceptions: list[type[Exception]] | None = None):
         """
         :param report_type: The type of report expected
         :param exceptions: List of exception type raised by the database module

src/powerapi/processor/pre/k8s/actor.py

@@ -45,7 +45,7 @@ class K8sPreProcessorState(ProcessorState):
     State of the Kubernetes pre-processor actor.
     """
 
-    def __init__(self, actor: Actor, target_actors: list, target_actors_names: list, api_mode: str, api_host: str, api_key: str):
+    def __init__(self, actor: Actor, target_actors: list, target_actors_names: list, api_mode: str | None, api_host: str | None, api_key: str | None):
         super().__init__(actor, target_actors, target_actors_names)
 
         self.api_mode = api_mode
@@ -71,8 +71,8 @@ class K8sPreProcessorActor(ProcessorActor):
     Pre-Processor Actor that adds Kubernetes related metadata to reports.
     """
 
-    def __init__(self, name: str, target_actors: list, target_actors_names: list, api_mode: str = None, api_host: str = None,
-                 api_key: str = None, level_logger: int = logging.WARNING, timeout: int = 5000):
+    def __init__(self, name: str, target_actors: list, target_actors_names: list, api_mode: str | None = None,
+                 api_host: str | None = None, api_key: str | None = None, level_logger: int = logging.WARNING, timeout: int = 5000):
         super().__init__(name, level_logger, timeout)
 
         self.state = K8sPreProcessorState(self, target_actors, target_actors_names, api_mode, api_key, api_host)

src/powerapi/processor/pre/k8s/monitor_agent.py

@@ -204,7 +204,7 @@ def fetch_list_all_pod_for_all_namespaces(self) -> int | None:
 
         return resource_version
 
-    def watch_list_pod_for_all_namespaces(self, resource_version: int = None):
+    def watch_list_pod_for_all_namespaces(self, resource_version: int | None = None):
         """
         Watch k8s pods events for all namespaces and update the local metadata cache accordingly.
         :param resource_version: Resource version from where the watcher begin