Kill TD

Author: okorach-sonar

cli/measures_export.py

@@ -51,7 +51,7 @@ def __get_measures_history(obj: object, wanted_metrics: types.KeyList, convert_o
         ratings = convert_options.get("ratings", "letters")
         percents = convert_options.get("percents", "float")
         for m in data:
-            m[2] = measures.format(obj.endpoint, m[1], m[2], ratings, percents)
+            m[2] = measures.format_measure(obj.endpoint, m[1], m[2], ratings, percents)
     return obj.component_data() | {"history": data}
 
 

sonar/branches.py

@@ -401,8 +401,7 @@ def audit(self, audit_settings: types.ConfigSettings) -> list[Problem]:
         try:
             if audit_settings.get(c.AUDIT_MODE_PARAM, "") == "housekeeper":
                 return self.__audit_last_analysis(audit_settings)
-            else:
-                return self.__audit_last_analysis(audit_settings) + self.__audit_never_analyzed() + self._audit_component(audit_settings)
+            return self.__audit_last_analysis(audit_settings) + self.__audit_never_analyzed() + self._audit_component(audit_settings)
         except Exception as e:
             log.error("%s while auditing %s, audit skipped", util.error_msg(e), str(self))
         return []

sonar/findings.py

@@ -21,15 +21,18 @@
 
 from __future__ import annotations
 import concurrent.futures
-from datetime import datetime
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from datetime import datetime
+    from sonar.util import types
+
 import re
 import Levenshtein
 
 import sonar.logging as log
 import sonar.sqobject as sq
 import sonar.platform as pf
-from sonar.util import types
 from sonar.util import constants as c, issue_defs as idefs
 from sonar import exceptions
 

sonar/measures.py

@@ -23,7 +23,7 @@
 from __future__ import annotations
 
 import json
-from typing import Any, Optional
+from typing import Any, Optional, Union
 from sonar import metrics, exceptions, platform
 from sonar.util.types import ApiPayload, ApiParams, KeyList
 from sonar.util import cache, constants as c
@@ -121,8 +121,8 @@ def is_a_percent(self) -> bool:
     def is_an_effort(self) -> bool:
         return metrics.is_an_effort(self.endpoint, self.key)
 
-    def format(self, ratings: str = "letters", percents: str = "float") -> any:
-        return format(self.endpoint, self.key, self.value, ratings=ratings, percents=percents)
+    def format_measure(self, ratings: str = "letters", percents: str = "float") -> any:
+        return format_measure(self.endpoint, self.key, self.value, ratings=ratings, percents=percents)
 
 
 def get(concerned_object: object, metrics_list: KeyList, **kwargs) -> dict[str, Measure]:
@@ -171,7 +171,7 @@ def get_history(concerned_object: object, metrics_list: KeyList, **kwargs) -> li
     return res_list
 
 
-def get_rating_letter(rating: Any) -> str:
+def get_rating_letter(rating: Union[int, float, str]) -> str:
     """
     :param any rating: The rating as repturned by the API (a str or float)
     :return: The rating converted from number to letter, if number between 1 and 5, else the unchanged rating
@@ -197,7 +197,7 @@ def get_rating_number(rating_letter: str) -> int:
     return rating_letter
 
 
-def format(endpoint: platform.Platform, metric_key: str, value: Any, ratings: str = "letters", percents: str = "float") -> Any:
+def format_measure(endpoint: platform.Platform, metric_key: str, value: Any, ratings: str = "letters", percents: str = "float") -> Any:
     """Formats a measure"""
     try:
         metric = metrics.Metric.get_object(endpoint, metric_key)

sonar/portfolios.py

@@ -26,19 +26,23 @@
 from __future__ import annotations
 
 import re
-from typing import Optional, Union, Any
+from typing import Optional, Union, Any, TYPE_CHECKING
 import json
 from http import HTTPStatus
 from threading import Lock
 
+if TYPE_CHECKING:
+    from sonar.util import types
+    from sonar.branches import Branch
+
 import sonar.logging as log
 import sonar.platform as pf
-from sonar.util import types, cache
+from sonar.util import cache
 import sonar.util.constants as c
 
 from sonar import aggregations, exceptions, applications, app_branches
 from sonar.projects import Project
-from sonar.branches import Branch
+
 
 import sonar.permissions.permissions as perms
 import sonar.permissions.portfolio_permissions as pperms
@@ -538,7 +542,7 @@ def add_application_branch(self, app_key: str, branch: str = c.DEFAULT_BRANCH) -
         self._applications[app_key].append(branch)
         return True
 
-    def add_subportfolio(self, key: str, name: str = None, by_ref: bool = False) -> Portfolio:
+    def add_subportfolio(self, key: str, name: Optional[str] = None, by_ref: bool = False) -> Portfolio:
         """Adds a subportfolio to a portfolio, defined by key, name and by reference option"""
 
         log.info("Adding sub-portfolios to %s", str(self))

sonar/settings.py

@@ -440,7 +440,7 @@ def get_all(endpoint: pf.Platform, project: Optional[object] = None) -> dict[str
     return get_bulk(endpoint, component=project, include_not_set=True)
 
 
-def new_code_to_string(data: Any) -> Union[int, str, None]:
+def new_code_to_string(data: Union[int, str, dict[str, str]]) -> Union[int, str, None]:
     """Converts a new code period from anything to int str"""
     if isinstance(data, (int, str)):
         return data
@@ -539,10 +539,9 @@ def encode(setting: Setting, setting_value: Any) -> dict[str, Any]:
     """Encodes the params to pass to api/settings/set according to setting value type"""
     if isinstance(setting_value, list):
         return {"values": setting_value} if isinstance(setting_value[0], str) else {"fieldValues": [json.dumps(v) for v in setting_value]}
-    elif isinstance(setting_value, bool):
+    if isinstance(setting_value, bool):
         return {"value": str(setting_value).lower()}
-    else:
-        return {"values" if setting.multi_valued else "value": setting_value}
+    return {"values" if setting.multi_valued else "value": setting_value}
 
 
 def reset_setting(endpoint: pf.Platform, setting_key: str, project: Optional[object] = None) -> bool:

sonar/tasks.py

@@ -20,7 +20,7 @@
 
 """Abstraction of the SonarQube background task concept"""
 
-from typing import Optional
+from typing import Optional, Any
 from datetime import datetime
 import time
 import json
@@ -441,7 +441,7 @@ def audit(self, audit_settings: types.ConfigSettings) -> list[Problem]:
         return problems
 
 
-def search(endpoint: pf.Platform, only_current: bool = False, component_key: Optional[str] = None, **kwargs) -> list[Task]:
+def search(endpoint: pf.Platform, only_current: bool = False, component_key: Optional[str] = None, **kwargs: Any) -> list[Task]:
     """Searches background tasks
 
     :param Platform endpoint: Reference to the SonarQube platform

sonar/util/component_helper.py

@@ -21,7 +21,6 @@
 import re
 from typing import Optional
 
-from sonar.util import constants as c
 from sonar import platform, components, projects, applications, portfolios
 
 

sonar/webhooks.py

@@ -21,7 +21,7 @@
 """Abstraction of the SonarQube webhook concept"""
 
 from __future__ import annotations
-from typing import Optional
+from typing import Optional, ClassVar
 
 import json
 
@@ -41,10 +41,10 @@ class WebHook(sq.SqObject):
     Abstraction of the SonarQube "webhook" concept
     """
 
-    CACHE = cache.Cache()
-    API = {c.CREATE: "webhooks/create", c.READ: "webhooks/list", c.UPDATE: "webhooks/update", c.LIST: "webhooks/list", c.DELETE: "webhooks/delete"}
-    SEARCH_KEY_FIELD = "key"
-    SEARCH_RETURN_FIELD = "webhooks"
+    CACHE: ClassVar[cache.Cache] = cache.Cache()
+    API: ClassVar[dict[str, str]] = {c.CREATE: "webhooks/create", c.READ: "webhooks/list", c.UPDATE: "webhooks/update", c.LIST: "webhooks/list", c.DELETE: "webhooks/delete"}
+    SEARCH_KEY_FIELD: ClassVar[str] = "key"
+    SEARCH_RETURN_FIELD: ClassVar[str] = "webhooks"
 
     def __init__(self, endpoint: pf.Platform, name: str, url: str, secret: Optional[str] = None, project: Optional[str] = None) -> None:
         """Constructor"""