Add filter type hints

Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>

Author: LecrisUT

fmf/utils.py

@@ -1,5 +1,7 @@
 """ Logging, config, constants & utilities """
 
+from __future__ import annotations
+
 import copy
 import logging
 import os
@@ -89,6 +91,7 @@ class ReferenceError(GeneralError):
 
 class FetchError(GeneralError):
     """ Fatal error in helper command while fetching """
+
     # Keep previously used format of the message
 
     def __str__(self):
@@ -194,7 +197,7 @@ def info(message, newline=True):
 #  Filtering
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-def evaluate(expression, data, _node=None):
+def evaluate(expression: str, data: dict[str, Any], _node: fmf.base.Tree | None = None) -> Any:
     """
     Evaluate arbitrary Python expression against given data
 
@@ -210,7 +213,8 @@ def evaluate(expression, data, _node=None):
         raise FilterError("Internal key is not defined: {}".format(error))
 
 
-def filter(filter, data, sensitive=True, regexp=False):
+def filter(filter: str, data: dict[str, Any],
+           sensitive: bool = True, regexp: bool = False) -> bool:
     """
     Return true if provided filter matches given dictionary of values
 
@@ -323,6 +327,7 @@ def check_clause(clause):
     return any([check_clause(clause)
                 for clause in re.split(r"\s*\|\s*", filter)])
 
+
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #  Logging
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -620,6 +625,7 @@ def invalidate_cache():
     if issues:  # pragma: no cover
         raise GeneralError("\n".join(issues))
 
+
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #  Fetch Tree from the Remote Repository
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -755,7 +761,7 @@ def fetch_repo(url, ref=None, destination=None, env=None):
                 if os.path.isfile(os.path.join(destination, '.git', 'shallow')):
                     # Make fetch get all remote refs (branches...)
                     run(["git", "config", "remote.origin.fetch",
-                        "+refs/heads/*:refs/remotes/origin/*"], cwd=destination)
+                         "+refs/heads/*:refs/remotes/origin/*"], cwd=destination)
                     # Fetch the whole history
                     run(['git', 'fetch', '--unshallow'], cwd=destination)
                     run(['git', 'checkout', '-f', ref], cwd=destination, env=env)