bazel_to_cmake modernize type hints

PiperOrigin-RevId: 895684812
Change-Id: Ic1adfb4e62a25276bcdb8fe786f92142e93cb60f

Author: laramiel

tools/cmake/bazel_to_cmake/active_repository.py

@@ -12,8 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# pylint: disable=g-importing-member,missing-function-docstring
+
 import pathlib
-from typing import Dict, Set
 
 from .cmake_repository import CMakeRepository
 from .cmake_target import CMakePackage
@@ -40,14 +41,14 @@ def __init__(
       self,
       workspace: Workspace,
       repository_id: RepositoryId,
-      bindings: Dict[TargetId, TargetId],
+      bindings: dict[TargetId, TargetId],
       top_level: bool,
   ):
     self._workspace: Workspace = workspace
     self._repository_id: RepositoryId = repository_id
-    self._bindings: Dict[TargetId, TargetId] = bindings
+    self._bindings: dict[TargetId, TargetId] = bindings
     self.top_level: bool = top_level
-    self.ignored_libraries: Set[TargetId] = (
+    self.ignored_libraries: set[TargetId] = (
         workspace.global_ignored_libraries.copy()
     )
     self._repository = None
@@ -62,6 +63,9 @@ def ignore_library(self, target: TargetId) -> None:
 
     Like all `Workspace` state, this also propagates to bazel_to_cmake
     invocations for dependencies.
+
+    Args:
+      target: The TargetId of the bzl library to ignore.
     """
     assert isinstance(target, TargetId)
     self.ignored_libraries.add(target)
@@ -79,7 +83,7 @@ def repository(self) -> CMakeRepository:
     return self._repository
 
   @property
-  def bindings(self) -> Dict[TargetId, TargetId]:
+  def bindings(self) -> dict[TargetId, TargetId]:
     return self._bindings
 
   @property
@@ -99,5 +103,5 @@ def cmake_binary_dir(self) -> pathlib.PurePath:
     return self.repository.cmake_binary_dir
 
   @property
-  def repo_mapping(self) -> Dict[RepositoryId, RepositoryId]:
+  def repo_mapping(self) -> dict[RepositoryId, RepositoryId]:
     return self.repository.repo_mapping

tools/cmake/bazel_to_cmake/cmake_provider.py

@@ -17,12 +17,14 @@
 bazel build targets.
 """
 
-from typing import Tuple, Union
+# pylint: disable=g-importing-member,missing-function-docstring
+
 
 from .cmake_target import CMakePackage
 from .cmake_target import CMakeTarget
 from .cmake_target import CMakeTargetPair
 from .starlark.provider import Provider
+from .starlark.provider import ProviderTuple
 
 
 class CMakeHallucinatedTarget(Provider):
@@ -104,8 +106,8 @@ def __repr__(self):
 
 
 def make_providers(
-    source: Union[CMakeTarget, CMakeTargetPair], *providers
-) -> Tuple[Provider, ...]:
+    source: CMakeTarget | CMakeTargetPair, *providers
+) -> ProviderTuple:
   """Construct providers from a CMakeTarget or CMakeTargetPair."""
   result = ()
   if isinstance(source, CMakeTargetPair):
@@ -125,7 +127,7 @@ def make_providers(
   return result
 
 
-def default_providers(source: CMakeTargetPair) -> Tuple[Provider, ...]:
+def default_providers(source: CMakeTargetPair) -> ProviderTuple:
   return make_providers(
       source,
       CMakePackageDepsProvider,

tools/cmake/bazel_to_cmake/cmake_target.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 """CMake Provider types."""
 
-from typing import NamedTuple, Optional
+from typing import NamedTuple
 
 
 class CMakePackage(str):
@@ -27,11 +27,11 @@ class CMakeTarget(str):
 class CMakeTargetPair(NamedTuple):
   """CMakeTargetPair identifies a cmake target, optionally with an alias."""
 
-  cmake_package: Optional[CMakePackage]
+  cmake_package: CMakePackage | None
   target: CMakeTarget
-  alias: Optional[CMakeTarget] = None
+  alias: CMakeTarget | None = None
 
-  def with_alias(self, alias: Optional[CMakeTarget]) -> "CMakeTargetPair":
+  def with_alias(self, alias: CMakeTarget | None) -> 'CMakeTargetPair':
     if alias is not None:
       assert isinstance(alias, CMakeTarget)
     return self._replace(alias=alias)

tools/cmake/bazel_to_cmake/emit_alias.py

@@ -13,6 +13,8 @@
 # limitations under the License.
 """Emits a library alias."""
 
+# pylint: disable=g-importing-member,missing-function-docstring
+
 import io
 
 from .cmake_provider import CMakeAliasProvider
@@ -25,7 +27,7 @@ def emit_cc_library_aliases(
     out: io.StringIO,
     target_name: CMakeTarget,
     cmake_target_pair: CMakeTargetPair,
-) -> None:
+) -> ProviderTuple:
   """Generates common alias targets."""
 
   has_alias = False

tools/cmake/bazel_to_cmake/golden_test.py

@@ -20,7 +20,7 @@
 import pathlib
 import shutil
 import sys
-from typing import Any, Dict, List, Tuple, Union
+from typing import Any
 
 import pytest
 
@@ -57,20 +57,20 @@
 }
 
 
-def parameters() -> List[Tuple[str, Dict[str, Any]]]:
+def parameters() -> list[tuple[str, dict[str, Any]]]:
   """Returns config tuples by reading config.json from the 'testdata' subdir."""
   if UPDATE_GOLDENS:
     print('UPDATE_GOLDENS')
     testdata = pathlib.Path(__file__).resolve().with_name('testdata')
   else:
     testdata = pathlib.Path(__file__).with_name('testdata').resolve()
-  result: List[Tuple[str, Dict[str, Any]]] = []
+  result: list[tuple[str, dict[str, Any]]] = []
   for x in testdata.iterdir():
     if '__' in str(x):
       continue
     try:
       with (x / 'config.json').open('r') as f:
-        config: Dict[str, Any] = json.load(f)
+        config: dict[str, Any] = json.load(f)
     except FileNotFoundError as e:
       raise FileNotFoundError(f'Failed to read {str(x)}/config.json') from e
     config['source_directory'] = str(x)
@@ -80,9 +80,9 @@ def parameters() -> List[Tuple[str, Dict[str, Any]]]:
 
 def get_files_list(
     source_directory: pathlib.Path, include_goldens=False
-) -> List[pathlib.Path]:
+) -> list[pathlib.Path]:
   """Returns non-golden files under source directory."""
-  files: List[pathlib.Path] = []
+  files: list[pathlib.Path] = []
   try:
     for x in sorted(source_directory.glob('**/*')):
       if not x.is_file():
@@ -95,7 +95,7 @@ def get_files_list(
   return files
 
 
-def copy_tree(source_dir: str, source_files: List[str], dest_dir: pathlib.Path):
+def copy_tree(source_dir: str, source_files: list[str], dest_dir: pathlib.Path):
   """Copies source_files from source_dir to dest_dir."""
   for x in source_files:
     dest_path = dest_dir.joinpath(x)
@@ -141,7 +141,7 @@ def add_repositories(workspace: Workspace):
   )
 
   def persist_cmake_name(
-      target: Union[str, TargetId],
+      target: str | TargetId,
       cmake_alias: CMakeTarget,
   ):
     if not isinstance(target, TargetId):
@@ -231,7 +231,7 @@ def persist_cmake_name(
 
 
 @pytest.mark.parametrize('test_name,config', parameters())
-def test_golden(test_name: str, config: Dict[str, Any], tmpdir):
+def test_golden(test_name: str, config: dict[str, Any], tmpdir):
   # Start with the list of source files.
   source_directory = pathlib.Path(config['source_directory'])
   del config['source_directory']

tools/cmake/bazel_to_cmake/main.py

@@ -13,15 +13,15 @@
 # limitations under the License.
 """Main entry point for bazel_to_cmake."""
 
-# pylint: disable=relative-beyond-top-level
+# pylint: disable=relative-beyond-top-level,g-importing-member,missing-function-docstring
 
 import argparse
+from collections.abc import Iterable
 import json
 import os
 import pathlib
 import pickle
 import sys
-from typing import Dict, List, Set, Union
 
 from . import native_rules  # pylint: disable=unused-import
 from .active_repository import Repository
@@ -44,10 +44,10 @@
 
 def maybe_expand_special_targets(
     t: TargetId,
-    available: Union[Set[TargetId], List[TargetId]],
-):
+    available: Iterable[TargetId],
+) -> list[TargetId]:
   # Handle special targets t, :all, :... from the available targets.
-  result: List[TargetId] = []
+  result: list[TargetId] = []
   if t.target_name == "all":
     for u in available:
       if u.package_id == t.package_id:
@@ -65,11 +65,11 @@ def maybe_expand_special_targets(
 def get_bindings_from_args(
     args: argparse.Namespace,
     repository_id: RepositoryId,
-) -> Dict[TargetId, TargetId]:
+) -> dict[TargetId, TargetId]:
   # Add repository bindings. These provide the "native.bind" equivalent,
   # and are resolved after repo mappings. Unlike native.bind, they are
   # not restricted to only bind //external:name = alias values.
-  bindings: Dict[TargetId, TargetId] = {}
+  bindings: dict[TargetId, TargetId] = {}
   for name in args.bind:
     i = name.find("=")
     assert i > 0
@@ -85,7 +85,7 @@ def get_bindings_from_args(
 def create_root_workspace(
     args: argparse.Namespace,
     repository_id: RepositoryId,
-):
+) -> Workspace:
   """Creates a workspace for the root repository."""
   assert args.cmake_vars is not None
   try:
@@ -121,7 +121,7 @@ def create_root_workspace(
 
 def load_root_workspace(
     args: argparse.Namespace,
-):
+) -> Workspace:
   """Unpickles a workspace and loads the repository from it."""
   with open(args.load_workspace, "rb") as f:
     workspace = pickle.load(f)
@@ -139,7 +139,7 @@ def do_process_build_files(
     args: argparse.Namespace,
     active_repo: Repository,
     state: EvaluationState,
-):
+) -> set[TargetId]:
   # Load build files.
   include_packages = args.include_package or ["**"]
   exclude_packages = args.exclude_package or []
@@ -185,7 +185,7 @@ def do_process_build_files(
   return targets_to_analyze
 
 
-def run_main(args: argparse.Namespace):
+def run_main(args: argparse.Namespace) -> int:
   assert args.bazel_repo_name
   repository_id: RepositoryId = RepositoryId(args.bazel_repo_name)
 
@@ -347,7 +347,7 @@ def _persist_cmakepairs(target: TargetId, cmake_pair: CMakeTargetPair):
   return 0
 
 
-def main():
+def main() -> int:
   ap = argparse.ArgumentParser()
   # Used for sub-projects only.
   ap.add_argument("--load-workspace")

tools/cmake/bazel_to_cmake/native_aspect.py

@@ -36,7 +36,7 @@
 
 # pylint: disable=invalid-name
 
-from typing import List, Optional, Protocol, Tuple
+from typing import Any, Protocol
 
 from .starlark.bazel_target import RepositoryId
 from .starlark.bazel_target import TargetId
@@ -54,16 +54,16 @@ def __call__(
       self,  # ignored
       context: InvocationContext,
       proto_target: TargetId,
-      visibility: Optional[List[RelativeLabel]] = None,
-      **kwargs,
-  ):
+      visibility: list[RelativeLabel] | None = None,
+      **kwargs: Any,
+  ) -> None:
     pass
 
 
-_PROTO_ASPECT: List[Tuple[str, ProtoAspectCallable]] = []
+_PROTO_ASPECT: list[tuple[str, ProtoAspectCallable]] = []
 
 
-def add_proto_aspect(name: str, fn: ProtoAspectCallable):
+def add_proto_aspect(name: str, fn: ProtoAspectCallable) -> None:
   print(f"Proto aspect: {name}")
 
   _PROTO_ASPECT.append((
@@ -75,8 +75,8 @@ def add_proto_aspect(name: str, fn: ProtoAspectCallable):
 def invoke_proto_aspects(
     context: InvocationContext,
     proto_target: TargetId,
-    visibility: Optional[List[RelativeLabel]] = None,
-    **kwargs,
-):
+    visibility: list[RelativeLabel] | None = None,
+    **kwargs: Any,
+) -> None:
   for t in _PROTO_ASPECT:
     t[1](context, proto_target, visibility, **kwargs)

tools/cmake/bazel_to_cmake/native_rules.py

@@ -20,9 +20,7 @@
 https://github.com/bazelbuild/bazel/tree/master/src/main/starlark/builtins_bzl/common
 """
 
-# pylint: disable=relative-beyond-top-level,invalid-name,missing-function-docstring,g-long-lambda
-
-from typing import List, Optional
+# pylint: disable=g-importing-member
 
 from . import native_rules_alias  # pylint: disable=unused-import
 from . import native_rules_cc  # pylint: disable=unused-import
@@ -65,7 +63,7 @@ def package_group(self: InvocationContext, **kwargs):
 @register_native_build_rule
 def package(
     self: InvocationContext,
-    default_visibility: Optional[List[RelativeLabel]] = None,
+    default_visibility: list[RelativeLabel] | None = None,
     **kwargs,
 ):
   del kwargs
@@ -85,10 +83,10 @@ def existing_rule(self: InvocationContext, name: str):
 @register_native_build_rule
 def glob(
     self: InvocationContext,
-    include: List[str],
-    exclude: Optional[List[str]] = None,
+    include: list[str],
+    exclude: list[str] | None = None,
     allow_empty: bool = True,
-) -> List[str]:
+) -> list[str]:
   package_directory = self.get_source_package_dir(self.caller_package_id)
   return starlark_glob(str(package_directory), include, exclude, allow_empty)
 
@@ -203,4 +201,3 @@ def sh_test(self: InvocationContext, name: str, **kwargs):
   del self
   del name
   del kwargs
-

tools/cmake/bazel_to_cmake/native_rules_alias.py

@@ -15,7 +15,6 @@
 
 # pylint: disable=relative-beyond-top-level,invalid-name,missing-function-docstring,g-long-lambda
 import io
-from typing import List, Optional
 
 from .cmake_builder import CMakeBuilder
 from .cmake_provider import CMakeAddDependenciesProvider
@@ -41,7 +40,7 @@ def alias(
     self: InvocationContext,
     name: str,
     actual: Configurable[RelativeLabel],
-    visibility: Optional[List[RelativeLabel]] = None,
+    visibility: list[RelativeLabel] | None = None,
     **kwargs,
 ):
   del kwargs