tooling: Correct Pyright new warnings (#889)

Fix all  reportPrivateUsage  and reportMissingParameterType and more.

Author: Aymen-Soussi-01

tooling/docs/_tooling/extensions/score_draw_uml_funcs/__init__.py

@@ -27,9 +27,10 @@
 
 import hashlib
 import time
+from collections.abc import Callable
 from functools import cache
 from pathlib import Path
-from typing import Any, Callable
+from typing import Any
 
 from sphinx.application import Sphinx
 from sphinx_needs.logging import get_logger

tooling/docs/_tooling/extensions/score_header_service/header_service.py

@@ -16,7 +16,7 @@
 import re
 import subprocess
 from collections import defaultdict
-from typing import Any
+from typing import Any, ClassVar
 
 from github import (
     Auth,
@@ -49,7 +49,7 @@
 #     }
 
 
-def register(app: Sphinx, env: BuildEnvironment, _: str) -> None:
+def register(app: Sphinx, env: BuildEnvironment, _: str | None) -> None:
     """Register the HeaderService with the Sphinx application environment.
 
     :param app: The Sphinx application instance.
@@ -72,13 +72,13 @@ def generate_hash() -> str:
 
 
 class HeaderService(BaseService):
-    options: dict[str, str, str | int | float | bool] = {}
+    options = {}
 
     def __init__(
         self,
         app: Sphinx,
         name: str,
-        config: dict[str, str | int | float | bool],
+        config: dict[str, Any] | None,
         **kwargs: dict[str, Any],
     ) -> None:
         """Initialize the HeaderService.
@@ -162,7 +162,7 @@ def _extract_merge_commit_data(location: str) -> dict[str, str | list[str]]:
     for m in re.finditer(pattern, out, re.MULTILINE):
         data[m.group(1)].append(", ".join(m.group(2, 3)))
 
-    commit_data = {
+    commit_data: dict[str, str | list[str]] = {
         "author": author,
         "approver": data.get("Approved", "N/A"),
         "reviewer": data.get("Reviewed", "N/A"),
@@ -182,8 +182,10 @@ def _extract_github_data() -> dict[str, str | list[str]]:
         "reviewers": "N/A",
         "hash": "N/A",
     }
+
+    github: Github | None = None
+
     try:
-        github: Github | None = None
         auth = Auth.Token(_extract_github_token())
         github = Github(auth=auth)
         org: Organization.Organization = github.get_organization(_extract_org())
@@ -261,7 +263,7 @@ def _extract_team_info(org: Organization.Organization) -> dict[str, list[str]]:
     :param org: The GitHub organization instance.
     :return: A dictionary containing the team information.
     """
-    team_info = {
+    team_info: dict[str, list[str]] = {
         t.name: [m.login for m in org.get_team(t.id).get_members()]
         for t in org.get_teams()
         if t.name in APPROVER_TEAMS
@@ -278,7 +280,7 @@ def _append_approver_teams(
     :param team_info: The team information dictionary.
     :return: A list of approvers with their teams.
     """
-    approvers_with_teams = []
+    approvers_with_teams: list[str] = []
 
     for approver in approvers:
         teams = [name for name, members in team_info.items() if approver in members]

tooling/docs/_tooling/extensions/score_header_service/test/test_header_service.py

@@ -11,13 +11,15 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 import os
+from collections.abc import Callable
 from unittest.mock import ANY, MagicMock, patch
-import score_header_service.header_service as hs
+
 import pytest
+import score_header_service.header_service as hs
 
 
 @pytest.fixture(scope="session", autouse=True)
-def add_metadata(record_testsuite_property):
+def add_metadata(record_testsuite_property: Callable[[str, str | list[str]], None]):
     record_testsuite_property("Verifies", ["GD__automatic_document_header_generation"])
     record_testsuite_property(
         "Description", "It should check the generation of the header information."
@@ -44,7 +46,7 @@ def test_register():
 
 
 @patch("random.randint")
-def test_generate_hash(randint_mock):
+def test_generate_hash(randint_mock: MagicMock):
     randint_mock.return_value = 42
     assert hs.generate_hash() == "73475cb4"
 
@@ -53,11 +55,13 @@ def test_generate_hash(randint_mock):
 @patch("score_header_service.header_service._extract_github_data")
 @patch("sphinx.application.Sphinx")
 def test_request_from_directive_github_data(
-    mock_app, mock_extract_github_data, mock_generate_hash
+    mock_app: MagicMock,
+    mock_extract_github_data: MagicMock,
+    mock_generate_hash: MagicMock,
 ):
     github_data = {
         "author": "John Doe",
-        "approvers": "apover_1",
+        "approvers": "approver1",
         "reviewers": "reviewer_1",
         "hash": "abcdef",
     }
@@ -83,11 +87,13 @@ def test_request_from_directive_github_data(
 @patch("score_header_service.header_service._extract_merge_commit_data")
 @patch("sphinx.application.Sphinx")
 def test_request_from_directive_commit_data(
-    mock_app, mock_extract_merge_commit_data, mock_generate_hash
+    mock_app: MagicMock,
+    mock_extract_merge_commit_data: MagicMock,
+    mock_generate_hash: MagicMock,
 ):
     github_data = {
         "author": "John Doe",
-        "approvers": "apover_1",
+        "approvers": "approver1",
         "reviewers": "reviewer_1",
         "hash": "abcdef",
     }
@@ -115,15 +121,15 @@ def test_request_from_directive_commit_data(
 
 @patch("score_header_service.header_service.HeaderService.request_from_directive")
 @patch("sphinx.application.Sphinx")
-def test_debug(mock_app, mock_request_from_directive):
+def test_debug(mock_app: MagicMock, mock_request_from_directive: MagicMock):
     debug_data = [{"key": "value"}]
     mock_request_from_directive.return_value = debug_data
     header_service = hs.HeaderService(mock_app, "dummy-service", None)
     assert header_service.debug(None) == debug_data
 
 
 @patch("score_header_service.header_service.subprocess.run")
-def test_extract_merge_commit_data(run_mock):
+def test_extract_merge_commit_data(run_mock: MagicMock):
     lines = """abcdef
 John Doe
 Approved: {approver1} ( {approver1@mail.com} ) on {2024-11-1}
@@ -137,7 +143,8 @@ def test_extract_merge_commit_data(run_mock):
     result_mock.stdout.decode.return_value = lines
     run_mock.return_value = result_mock
 
-    assert hs._extract_merge_commit_data("/req/feature1") == {
+    # private functions just used in test
+    assert hs._extract_merge_commit_data("/req/feature1") == {  # type: ignore
         "author": "John Doe",
         "approver": ["approver1, approver1@mail.com", "approver2, approver2@mail.com"],
         "reviewer": [
@@ -157,12 +164,12 @@ def test_extract_merge_commit_data(run_mock):
 
 
 @patch("score_header_service.header_service.subprocess.run")
-def test_extract_merge_commit_data_error(run_mock):
+def test_extract_merge_commit_data_error(run_mock: MagicMock):
     result_mock = MagicMock()
     result_mock.returncode = 1
     run_mock.return_value = result_mock
 
-    assert hs._extract_merge_commit_data("/req/feature1") == {
+    assert hs._extract_merge_commit_data("/req/feature2") == {  # type: ignore
         "author": "N/A",
         "approver": "N/A",
         "reviewer": "N/A",
@@ -180,15 +187,15 @@ def test_extract_merge_commit_data_error(run_mock):
 @patch("score_header_service.header_service.Auth.Token")
 @patch("score_header_service.header_service.Github")
 def test_extract_github_data(
-    mock_github,
-    mock_auth_token,
-    mock_extract_github_token,
-    mock_extract_pull_request,
-    mock_extract_repo,
-    mock_extract_org,
-    mock_extract_team_info,
-    mock_extract_reviewers,
-    mock_extract_approvers,
+    mock_github: MagicMock,
+    mock_auth_token: MagicMock,
+    mock_extract_github_token: MagicMock,
+    mock_extract_pull_request: MagicMock,
+    mock_extract_repo: MagicMock,
+    mock_extract_org: MagicMock,
+    mock_extract_team_info: MagicMock,
+    mock_extract_reviewers: MagicMock,
+    mock_extract_approvers: MagicMock,
 ):
     mock_extract_github_token.return_value = "fake_token"
     mock_auth_token.return_value = "fake_token"
@@ -210,7 +217,7 @@ def test_extract_github_data(
     mock_extract_reviewers.return_value = "reviewer1; reviewer2"
     mock_extract_team_info.return_value = {"team1": "approver3"}
 
-    data = hs._extract_github_data()
+    data = hs._extract_github_data()  # type: ignore
     assert data == {
         "author": "author1",
         "approvers": "approver1",
@@ -220,9 +227,9 @@ def test_extract_github_data(
 
 
 @patch("score_header_service.header_service.Auth.Token")
-def test_extract_github_data_exception(mock_auth_token):
+def test_extract_github_data_exception(mock_auth_token: MagicMock):
     mock_auth_token.side_effect = Exception("Error")
-    assert hs._extract_github_data() == {
+    assert hs._extract_github_data() == {  # type: ignore
         "author": "N/A",
         "approvers": "N/A",
         "reviewers": "N/A",
@@ -232,22 +239,22 @@ def test_extract_github_data_exception(mock_auth_token):
 
 def test_extract_org():
     with patch.dict(os.environ, {"GITHUB_REPOSITORY": "org/repo"}):
-        assert hs._extract_org() == "org"
+        assert hs._extract_org() == "org"  # type: ignore
 
 
 def test_extract_repo():
     with patch.dict(os.environ, {"GITHUB_REPOSITORY": "org/repo"}):
-        assert hs._extract_repo() == "org/repo"
+        assert hs._extract_repo() == "org/repo"  # type: ignore
 
 
 def test_extract_github_token():
     with patch.dict(os.environ, {"GH_TOKEN": "fake_token"}):
-        assert hs._extract_github_token() == "fake_token"
+        assert hs._extract_github_token() == "fake_token"  # type: ignore
 
 
 def test_extract_pull_request():
     with patch.dict(os.environ, {"GITHUB_REF_NAME": "123/merge"}):
-        assert hs._extract_pull_request() == "123"
+        assert hs._extract_pull_request() == "123"  # type: ignore
 
 
 def test_extract_team_info():
@@ -268,13 +275,13 @@ def test_extract_team_info():
     mock_team1.get_members.return_value = [mock_member1, mock_member2]
     mock_org.get_teams.return_value = [mock_team1, mock_team2]
     mock_org.get_team.side_effect = lambda id: mock_team1 if id == 1 else mock_team2
-    assert hs._extract_team_info(mock_org) == {
+    assert hs._extract_team_info(mock_org) == {  # type: ignore
         "automotive-score-committers": ["approver1", "approver3"]
     }
 
 
 @patch("score_header_service.header_service._append_approver_teams")
-def test_extract_appprovers(mock_append_approver_teams):
+def test_extract_approvers(mock_append_approver_teams: MagicMock):
     mock_review1 = MagicMock()
     mock_review2 = MagicMock()
     mock_review3 = MagicMock()
@@ -285,19 +292,20 @@ def test_extract_appprovers(mock_append_approver_teams):
     mock_review2.user.login = "approver2"
     mock_review3.user.login = "approver3"
     mock_append_approver_teams.return_value = ["approver1", "approver2"]
-    assert (
-        hs._extract_approvers(
-            [mock_review1, mock_review2, mock_review3],
-            {"team1": ["approver1", "approver2"]},
-        )
-        == "approver1; approver2"
+    mock_paginated_list = MagicMock()
+    mock_paginated_list.__iter__.return_value = iter(
+        [mock_review1, mock_review2, mock_review3]
+    )
+    result = hs._extract_approvers(  # type: ignore
+        mock_paginated_list, {"team1": ["approver1", "approver2"]}
     )
+    assert result == "approver1; approver2"
 
 
 def test_append_approver_teams():
     approvers = ["approver1", "approver2"]
     team_info = {"team1": ["approver1"]}
-    assert hs._append_approver_teams(approvers, team_info) == [
+    assert hs._append_approver_teams(approvers, team_info) == [  # type: ignore
         "approver1 (team1)",
         "approver2",
     ]
@@ -313,7 +321,9 @@ def test_extract_reviewers():
     mock_review1.user.login = "reviewer1"
     mock_review2.user.login = "reviewer2"
     mock_review3.user.login = "reviewer3"
-    assert (
-        hs._extract_reviewers([mock_review1, mock_review2, mock_review3], "author1")
-        == "reviewer1; reviewer3"
+    mock_paginated_list = MagicMock()
+    mock_paginated_list.__iter__.return_value = iter(
+        [mock_review1, mock_review2, mock_review3]
     )
+    result = hs._extract_reviewers(mock_paginated_list, "author1")  # type: ignore
+    assert result == "reviewer1; reviewer3"