Update typing aliases to use collections.abc instead

dev_tools/autogenerate-bloqs-notebooks-v2.py

@@ -43,7 +43,7 @@
     python dev_tools/autogenerate-bloqs-notebooks-v2.py
 """
 
-from typing import Iterable, List
+from collections.abc import Iterable
 
 from qualtran_dev_tools.bloq_finder import get_bloqdocspecs
 from qualtran_dev_tools.jupyter_autogen import NotebookSpecV2, render_notebook
@@ -85,7 +85,7 @@ def render_notebooks():
         render_notebook(nbspec)
 
 
-def _get_toc_section_lines(caption: str, entries: List[str], maxdepth: int = 2) -> List[str]:
+def _get_toc_section_lines(caption: str, entries: list[str], maxdepth: int = 2) -> list[str]:
     """Helper function to get the lines for a section of the table-of-contents."""
     return (
         ['.. toctree::', f'    :maxdepth: {maxdepth}', f'    :caption: {caption}:', '']

dev_tools/bloq-method-overrides-report.py

@@ -11,14 +11,14 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
-from typing import ForwardRef, Set, Type
+from typing import ForwardRef
 
 from qualtran_dev_tools.bloq_finder import get_bloq_classes
 
 from qualtran import Bloq
 
 
-def _call_graph(bc: Type[Bloq]):
+def _call_graph(bc: type[Bloq]):
     """Check that a bloq class overrides the right call graph methods.
 
     - Override `build_call_graph` with canonical type annotations.
@@ -42,7 +42,7 @@ def _call_graph(bc: Type[Bloq]):
         )
     if annot['ssa'] != 'SympySymbolAllocator':
         print(f"{bc}.build_call_graph `ssa: 'SympySymbolAllocator'`")
-    if annot['return'] != Set[ForwardRef('BloqCountT')]:  # type: ignore[misc]
+    if annot['return'] != set[ForwardRef('BloqCountT')]:  # type: ignore[misc]
         print(f"{bc}.build_call_graph -> 'BloqCountT'")
 
 

dev_tools/bloq-quickstarter.html

@@ -215,7 +215,7 @@ <h3>Code</h3>
       signature += "\n        ])"
 
       const template = `from functools import cached_property
-from typing import Dict, Optional, Set, Union
+from typing import Optional, Union
 
 from attrs import frozen
 
@@ -238,10 +238,10 @@ <h3>Code</h3>
     def signature(self) -> 'Signature':
         ${signature}
 
-    def build_composite_bloq(self, bb: 'BloqBuilder'${build_sig}) -> Dict[str, 'SoquetT']:
+    def build_composite_bloq(self, bb: 'BloqBuilder'${build_sig}) -> dict[str, 'SoquetT']:
         raise NotImplementedError("Implement or delete.")
 
-    def bloq_counts(self, ssa: Optional['SympySymbolAllocator'] = None) -> Set['BloqCountT']:
+    def bloq_counts(self, ssa: Optional['SympySymbolAllocator'] = None) -> set['BloqCountT']:
         raise NotImplementedError("Implement or delete.")
 
     def short_name(self) -> str:

dev_tools/qualtran_dev_tools/all_call_graph.py

@@ -15,7 +15,7 @@
 """Generate the library-wide call graph from all bloq examples."""
 import logging
 import warnings
-from typing import Iterable
+from collections.abc import Iterable
 
 import networkx as nx
 

dev_tools/qualtran_dev_tools/bloq_finder.py

@@ -14,15 +14,15 @@
 import importlib
 import inspect
 import subprocess
+from collections.abc import Callable, Iterable
 from pathlib import Path
-from typing import Callable, Iterable, List, Tuple, Type
 
 from qualtran import Bloq, BloqDocSpec, BloqExample
 
 from .git_tools import get_git_root
 
 
-def _get_paths(bloqs_root: Path, filter_func: Callable[[Path], bool]) -> List[Path]:
+def _get_paths(bloqs_root: Path, filter_func: Callable[[Path], bool]) -> list[Path]:
     """Get *.py files based on `filter_func`."""
     cp = subprocess.run(
         ['git', 'ls-files', '*.py'],
@@ -38,7 +38,7 @@ def _get_paths(bloqs_root: Path, filter_func: Callable[[Path], bool]) -> List[Pa
     return paths
 
 
-def get_bloq_module_paths(bloqs_root: Path) -> List[Path]:
+def get_bloq_module_paths(bloqs_root: Path) -> list[Path]:
     """Get *.py files for non-test, non-init modules under `bloqs_root`."""
 
     def is_module_path(path: Path) -> bool:
@@ -53,7 +53,7 @@ def is_module_path(path: Path) -> bool:
     return _get_paths(bloqs_root, is_module_path)
 
 
-def get_bloq_test_module_paths(bloqs_root: Path) -> List[Path]:
+def get_bloq_test_module_paths(bloqs_root: Path) -> list[Path]:
     """Get *_test.py files under `bloqs_root`."""
 
     def is_test_module_path(path: Path) -> bool:
@@ -70,7 +70,7 @@ def _bloq_modpath_to_modname(path: Path) -> str:
     return 'qualtran.bloqs.' + str(path)[: -len('.py')].replace('/', '.')
 
 
-def modpath_to_bloqs(path: Path) -> Iterable[Type[Bloq]]:
+def modpath_to_bloqs(path: Path) -> Iterable[type[Bloq]]:
     """Given a module path, return all the `Bloq` classes defined within."""
     modname = _bloq_modpath_to_modname(path)
     mod = importlib.import_module(modname)
@@ -88,7 +88,7 @@ def modpath_to_bloqs(path: Path) -> Iterable[Type[Bloq]]:
         yield cls
 
 
-def modpath_to_bloq_exs(path: Path) -> Iterable[Tuple[str, str, BloqExample]]:
+def modpath_to_bloq_exs(path: Path) -> Iterable[tuple[str, str, BloqExample]]:
     """Given a module path, return all the `BloqExample`s defined within."""
     modname = _bloq_modpath_to_modname(path)
     mod = importlib.import_module(modname)
@@ -97,7 +97,7 @@ def modpath_to_bloq_exs(path: Path) -> Iterable[Tuple[str, str, BloqExample]]:
         yield modname, name, obj
 
 
-def modpath_to_bloqdocspecs(path: Path) -> Iterable[Tuple[str, str, BloqDocSpec]]:
+def modpath_to_bloqdocspecs(path: Path) -> Iterable[tuple[str, str, BloqDocSpec]]:
     """Given a module path, return all the `BloqDocSpec`s defined within."""
     modname = _bloq_modpath_to_modname(path)
     mod = importlib.import_module(modname)
@@ -106,35 +106,35 @@ def modpath_to_bloqdocspecs(path: Path) -> Iterable[Tuple[str, str, BloqDocSpec]
         yield modname, name, obj
 
 
-def get_bloq_classes() -> List[Type[Bloq]]:
+def get_bloq_classes() -> list[type[Bloq]]:
     reporoot = get_git_root()
     bloqs_root = reporoot / 'qualtran/bloqs'
     paths = get_bloq_module_paths(bloqs_root)
-    bloq_clss: List[Type[Bloq]] = []
+    bloq_clss: list[type[Bloq]] = []
     for path in paths:
         bloq_clss.extend(modpath_to_bloqs(path))
     return bloq_clss
 
 
-def get_bloq_examples() -> List[BloqExample]:
+def get_bloq_examples() -> list[BloqExample]:
     reporoot = get_git_root()
     bloqs_root = reporoot / 'qualtran/bloqs'
     paths = get_bloq_module_paths(bloqs_root)
 
-    bexamples: List[BloqExample] = []
+    bexamples: list[BloqExample] = []
     for path in paths:
         for modname, name, be in modpath_to_bloq_exs(path):
             bexamples.append(be)
 
     return bexamples
 
 
-def get_bloqdocspecs() -> List[BloqDocSpec]:
+def get_bloqdocspecs() -> list[BloqDocSpec]:
     reporoot = get_git_root()
     bloqs_root = reporoot / 'qualtran/bloqs'
     paths = get_bloq_module_paths(bloqs_root)
 
-    bdspecs: List[BloqDocSpec] = []
+    bdspecs: list[BloqDocSpec] = []
     for path in paths:
         for modname, name, bds in modpath_to_bloqdocspecs(path):
             bdspecs.append(bds)

dev_tools/qualtran_dev_tools/bloq_report_card.py

@@ -13,7 +13,8 @@
 #  limitations under the License.
 import time
 import warnings
-from typing import Any, Dict, Iterable, List, Optional, Set, Type
+from collections.abc import Iterable
+from typing import Any, Optional
 
 import pandas as pd
 import pandas.io.formats.style
@@ -31,7 +32,7 @@
 from .bloq_finder import get_bloq_classes, get_bloq_examples
 
 
-def _get_package(bloq_cls: Type[Bloq]) -> str:
+def _get_package(bloq_cls: type[Bloq]) -> str:
     """The package name for a bloq class"""
     return '.'.join(bloq_cls.__module__.split('.')[:-1])
 
@@ -56,8 +57,8 @@ def format_status(v: BloqCheckResult):
 
 
 def bloq_classes_with_no_examples(
-    bclasses: Iterable[Type[Bloq]], bexamples: Iterable[BloqExample]
-) -> Set[Type[Bloq]]:
+    bclasses: Iterable[type[Bloq]], bexamples: Iterable[BloqExample]
+) -> set[type[Bloq]]:
     ks = set(bclasses)
     for be in bexamples:
         try:
@@ -72,13 +73,13 @@ def bloq_classes_with_no_examples(
 CHECKCOLS = ['make', 'decomp', 'counts', 'serialize', 'qtyping']
 
 
-def record_for_class_with_no_examples(k: Type[Bloq]) -> Dict[str, Any]:
+def record_for_class_with_no_examples(k: type[Bloq]) -> dict[str, Any]:
     return {'bloq_cls': k.__name__, 'package': _get_package(k), 'name': '-'} | {
         check_name: BloqCheckResult.MISSING for check_name in CHECKCOLS
     }
 
 
-def record_for_bloq_example(be: BloqExample) -> Dict[str, Any]:
+def record_for_bloq_example(be: BloqExample) -> dict[str, Any]:
     start = time.perf_counter()
     record = {
         'bloq_cls': be.bloq_cls.__name__,
@@ -101,7 +102,7 @@ def show_bloq_report_card(df: pd.DataFrame) -> pandas.io.formats.style.Styler:
 
 
 def get_bloq_report_card(
-    bclasses: Optional[Iterable[Type[Bloq]]] = None,
+    bclasses: Optional[Iterable[type[Bloq]]] = None,
     bexamples: Optional[Iterable[BloqExample]] = None,
     package_prefix: str = 'qualtran.bloqs.',
 ) -> pd.DataFrame:
@@ -115,7 +116,7 @@ def get_bloq_report_card(
         skips = ['qubitization_qpe_hubbard_model_small', 'qubitization_qpe_hubbard_model_large']
         bexamples = [bex for bex in bexamples if bex.name not in skips]
 
-    records: List[Dict[str, Any]] = []
+    records: list[dict[str, Any]] = []
     missing_bclasses = bloq_classes_with_no_examples(bclasses, bexamples)
     records.extend(record_for_class_with_no_examples(k) for k in missing_bclasses)
     records.extend(record_for_bloq_example(be) for be in bexamples)

dev_tools/qualtran_dev_tools/clean_notebooks.py

@@ -15,13 +15,13 @@
 import subprocess
 from pathlib import Path
 from tempfile import NamedTemporaryFile
-from typing import Any, List
+from typing import Any
 
 import nbformat
 from nbconvert.preprocessors import ClearMetadataPreprocessor, ClearOutputPreprocessor
 
 
-def get_nb_rel_paths(rootdir) -> List[Path]:
+def get_nb_rel_paths(rootdir) -> list[Path]:
     """List all checked-in *.ipynb files within `rootdir`."""
     cp = subprocess.run(
         ['git', 'ls-files', '*.ipynb'],

dev_tools/qualtran_dev_tools/incremental_coverage.py

@@ -14,7 +14,7 @@
 
 import os.path
 import re
-from typing import cast, Dict, List, Optional, Set, Tuple
+from typing import cast, Optional
 
 from . import shell_tools
 from .prepared_env import PreparedEnv
@@ -57,7 +57,7 @@
 EXPLICIT_OPT_OUT_COMMENT = "#coverage:ignore"
 
 
-def diff_to_new_interesting_lines(unified_diff_lines: List[str]) -> Dict[int, str]:
+def diff_to_new_interesting_lines(unified_diff_lines: list[str]) -> dict[int, str]:
     """Extracts a set of 'interesting' lines out of a GNU unified diff format.
 
     Format:
@@ -124,7 +124,7 @@ def fix_line_from_coverage_file(line):
 
 def get_incremental_uncovered_lines(
     abs_path: str, base_commit: str, actual_commit: Optional[str]
-) -> List[Tuple[int, str, str]]:
+) -> list[tuple[int, str, str]]:
     """Find touched but uncovered lines in the given file.
 
     Uses git diff and the annotation files created by `pytest --cov-report annotate` to find
@@ -190,9 +190,9 @@ def line_content_counts_as_uncovered_manual(content: str) -> bool:
     return True
 
 
-def determine_ignored_lines(content: str) -> Set[int]:
+def determine_ignored_lines(content: str) -> set[int]:
     lines = content.split("\n")
-    result: List[int] = []
+    result: list[int] = []
 
     i = 0
     while i < len(lines):
@@ -222,7 +222,7 @@ def determine_ignored_lines(content: str) -> Set[int]:
     return {e + 1 for e in result}
 
 
-def naive_find_end_of_scope(lines: List[str], i: int) -> int:
+def naive_find_end_of_scope(lines: list[str], i: int) -> int:
     # TODO: deal with line continuations, which may be less indented.
     # Github issue: https://github.com/quantumlib/Cirq/issues/2968
     line = lines[i]