Improve typing in phirgen, fix measure args bug, pretty print PHIR

.pre-commit-config.yaml

@@ -29,7 +29,7 @@ repos:
         args: [--fix, --exit-non-zero-on-fix]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.6.0'
+    rev: 'v1.6.1'
     hooks:
     - id: mypy
       pass_filenames: false
@@ -39,5 +39,5 @@ repos:
         pytket==1.21.0,
         pytket-quantinuum==0.25.0,
         types-setuptools,
-        "git+https://github.com/CQCL/phir#egg=phir",
+        "phir",
       ]

MANIFEST.in

@@ -3,6 +3,7 @@ include *.txt
 include Makefile
 include mypy.ini
 recursive-include docs *.rst
+recursive-include docs Makefile
 recursive-include tests *.qasm
 exclude Dockerfile
 exclude .docker*

mypy.ini

@@ -48,3 +48,7 @@ warn_unused_configs = true
 
 [mypy-tests.*]
 disallow_untyped_defs = false
+
+[mypy-pytket.phir.phirgen.*]
+disallow_any_expr = false
+disallow_any_explicit = false

pyproject.toml

@@ -25,6 +25,9 @@ Repository = "https://github.com/CQCL/pytket-phir.git"
 [tool.setuptools.packages.find]
 where = ["."]
 
+[tool.setuptools.package-data]
+"pytket.phir" = ["py.typed"]
+
 [tool.pytest.ini_options]
 addopts = "-s -vv"
 pythonpath = [

pytket/phir/api.py

@@ -1,6 +1,9 @@
 import logging
 from typing import TYPE_CHECKING
 
+from rich import print
+
+from phir.model import PHIRModel
 from pytket.circuit import Circuit
 from pytket.phir.phirgen import genphir
 from pytket.phir.place_and_route import place_and_route
@@ -50,7 +53,8 @@ def pytket_to_phir(
         msg = "no machine found"
         raise ValueError(msg)
 
-    phir_output = genphir(placed)
+    phir_json = genphir(placed)
 
-    logger.info("Output: %s", phir_output)
-    return phir_output
+    if logger.getEffectiveLevel() <= logging.INFO:
+        print(PHIRModel.model_validate_json(phir_json, strict=True))  # type: ignore[misc]
+    return phir_json

pytket/phir/phirgen.py

@@ -1,19 +1,12 @@
-# mypy: disable-error-code="misc,no-any-unimported"
-
 import json
+from typing import Any
 
-from phir.model import (  # type: ignore [import-untyped]
-    Cmd,
-    DataMgmt,
-    OpType,
-    PHIRModel,
-    QOp,
-)
+from phir.model import PHIRModel
 from pytket.circuit import Command
 from pytket.phir.sharding.shard import Shard
 
 
-def write_cmd(cmd: Command, ops: list[Cmd]) -> None:
+def write_cmd(cmd: Command, ops: list[dict[str, Any]]) -> None:
     """Write a pytket command to PHIR qop.
 
     Args:
@@ -23,17 +16,19 @@ def write_cmd(cmd: Command, ops: list[Cmd]) -> None:
     gate = cmd.op.get_name().split("(", 1)[0]
     metadata, angles = (
         ({"angle_multiplier": "π"}, cmd.op.params)
-        if gate != "Measure"
+        if gate != "Measure" and cmd.op.params
         else (None, None)
     )
-    qop: QOp = {
+    qop: dict[str, Any] = {
         "metadata": metadata,
         "angles": angles,
         "qop": gate,
         "args": [],
     }
     for qbit in cmd.args:
         qop["args"].append([qbit.reg_name, qbit.index[0]])
+        if gate == "Measure":
+            break
     if cmd.bits:
         qop["returns"] = []
         for cbit in cmd.bits:
@@ -47,12 +42,12 @@ def genphir(inp: list[tuple[list[int], list[Shard], float]]) -> str:
     Args:
         inp: list of shards
     """
-    phir = {
+    phir: dict[str, Any] = {
         "format": "PHIR/JSON",
         "version": "0.1.0",
         "metadata": {"source": "pytket-phir"},
     }
-    ops: OpType = []
+    ops: list[dict[str, Any]] = []
 
     qbits = set()
     cbits = set()
@@ -82,7 +77,7 @@ def genphir(inp: list[tuple[list[int], list[Shard], float]]) -> str:
         cvar_dim.setdefault(cbit.reg_name, 0)
         cvar_dim[cbit.reg_name] += 1
 
-    decls: list[DataMgmt] = [
+    decls: list[dict[str, str | int]] = [
         {
             "data": "qvar_define",
             "data_type": "qubits",
@@ -102,5 +97,5 @@ def genphir(inp: list[tuple[list[int], list[Shard], float]]) -> str:
     ]
 
     phir["ops"] = decls + ops
-    PHIRModel.model_validate(phir)
+    PHIRModel.model_validate(phir, strict=True)
     return json.dumps(phir)

requirements.txt

@@ -1,7 +1,7 @@
 black==23.10.0
 build==1.0.3
-mypy==1.6.0
-phir @ git+https://github.com/CQCL/phir
+mypy==1.6.1
+phir==0.1.3
 pre-commit==3.5.0
 pytest==7.4.2
 pytket-quantinuum==0.25.0

tests/e2e_test.py

@@ -1,4 +1,8 @@
+from phir.model import PHIRModel
+from rich import print
+
 from pytket.phir.machine import Machine
+from pytket.phir.phirgen import genphir
 from pytket.phir.place_and_route import place_and_route
 from pytket.phir.placement import placement_check
 from pytket.phir.sharding.sharder import Sharder
@@ -35,3 +39,7 @@
     cost_1 = output[1][2]
     assert cost_0 == 2.0
     assert cost_1 == 0.0
+
+    phir_json = genphir(output)
+
+    print(PHIRModel.model_validate_json(phir_json, strict=True))  # type: ignore[misc]