Remove pretty_name part 3 (#1402)

* Remove pretty_name part 3

Change the default implementation of Bloq.pretty_name to go via str. Removing pretty_name implementations and moving them to str or wire_symbols as necessary.

This change removes all references to pretty_name

* Remove pretty_name from notebooks.

* Change adjoint string

---------

Co-authored-by: Matthew Harrigan <[email protected]>

Author: dstrain115

qualtran/_infra/adjoint.py

@@ -167,13 +167,9 @@ def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
                 counts[bloq.adjoint()] += n
         return counts
 
-    def pretty_name(self) -> str:
-        """The subbloq's pretty_name with a dagger."""
-        return self.subbloq.pretty_name() + '†'
-
     def __str__(self) -> str:
         """Delegate to subbloq's `__str__` method."""
-        return f'Adjoint(subbloq={str(self.subbloq)})'
+        return f'{str(self.subbloq)}†'
 
     def wire_symbol(
         self, reg: Optional['Register'], idx: Tuple[int, ...] = tuple()

qualtran/_infra/adjoint_test.py

@@ -48,16 +48,16 @@ def test_serial_combo_adjoint():
     assert (
         TestSerialCombo().adjoint().decompose_bloq().debug_text()
         == """\
-Adjoint(subbloq=TestAtom('atom2'))<0>
+TestAtom('atom2')†<0>
   LeftDangle.reg -> q
-  q -> Adjoint(subbloq=TestAtom('atom1'))<1>.q
+  q -> TestAtom('atom1')†<1>.q
 --------------------
-Adjoint(subbloq=TestAtom('atom1'))<1>
-  Adjoint(subbloq=TestAtom('atom2'))<0>.q -> q
-  q -> Adjoint(subbloq=TestAtom('atom0'))<2>.q
+TestAtom('atom1')†<1>
+  TestAtom('atom2')†<0>.q -> q
+  q -> TestAtom('atom0')†<2>.q
 --------------------
-Adjoint(subbloq=TestAtom('atom0'))<2>
-  Adjoint(subbloq=TestAtom('atom1'))<1>.q -> q
+TestAtom('atom0')†<2>
+  TestAtom('atom1')†<1>.q -> q
   q -> RightDangle.reg"""
     )
 
@@ -72,16 +72,16 @@ def test_cbloq_adjoint_function():
     assert (
         adj_cbloq.debug_text()
         == """\
-Adjoint(subbloq=TestAtom('atom2'))<0>
+TestAtom('atom2')†<0>
   LeftDangle.reg -> q
-  q -> Adjoint(subbloq=TestAtom('atom1'))<1>.q
+  q -> TestAtom('atom1')†<1>.q
 --------------------
-Adjoint(subbloq=TestAtom('atom1'))<1>
-  Adjoint(subbloq=TestAtom('atom2'))<0>.q -> q
-  q -> Adjoint(subbloq=TestAtom('atom0'))<2>.q
+TestAtom('atom1')†<1>
+  TestAtom('atom2')†<0>.q -> q
+  q -> TestAtom('atom0')†<2>.q
 --------------------
-Adjoint(subbloq=TestAtom('atom0'))<2>
-  Adjoint(subbloq=TestAtom('atom1'))<1>.q -> q
+TestAtom('atom0')†<2>
+  TestAtom('atom1')†<1>.q -> q
   q -> RightDangle.reg"""
     )
 
@@ -139,7 +139,7 @@ def test_names():
     assert cast(Text, atom.wire_symbol(reg=None)).text == "TestAtom"
 
     adj_atom = Adjoint(atom)
-    assert str(adj_atom) == "Adjoint(subbloq=TestAtom)"
+    assert str(adj_atom) == "TestAtom†"
     assert cast(Text, adj_atom.wire_symbol(reg=None)).text == "TestAtom†"
 
 

qualtran/_infra/bloq.py

@@ -110,9 +110,6 @@ def signature(self) -> 'Signature':
         about this bloq.
         """
 
-    def pretty_name(self) -> str:
-        return str(self)
-
     def build_composite_bloq(self, bb: 'BloqBuilder', **soqs: 'SoquetT') -> Dict[str, 'SoquetT']:
         """Override this method to define a Bloq in terms of its constituent parts.
 
@@ -537,7 +534,7 @@ def wire_symbol(
         from qualtran.drawing import directional_text_box, Text
 
         if reg is None:
-            name = self.pretty_name()
+            name = str(self)
             if len(name) <= 10:
                 return Text(name)
             return Text(name[:8] + '..')

qualtran/_infra/bloq_test.py

@@ -28,7 +28,7 @@ def test_bloq():
     ctrl, trg = tb.signature
     assert ctrl.bitsize == 1
     assert ctrl.side == Side.THRU
-    assert tb.pretty_name() == 'TestTwoBitOp'
+    assert str(tb) == 'TestTwoBitOp'
 
     with pytest.raises(DecomposeTypeError):
         tb.decompose_bloq()

qualtran/bloqs/basic_gates/rotation_test.py

@@ -103,7 +103,7 @@ def test_as_cirq_op():
     )
 
 
-def test_pretty_name():
+def test_str():
     assert str(ZPowGate()) == "Z**1.0"
     assert str(XPowGate()) == "X**1.0"
     assert str(YPowGate()) == "Y**1.0"

qualtran/bloqs/basic_gates/z_basis_test.py

@@ -163,7 +163,7 @@ def test_zero_state_effect(bit):
 
 def test_int_state_manual():
     k = IntState(255, bitsize=8)
-    assert k.pretty_name() == '|255>'
+    assert str(k) == '|255>'
     (val,) = k.call_classically()
     assert val == 255
 
@@ -177,7 +177,7 @@ def test_int_state_manual():
 
 def test_int_effect_manual():
     k = IntEffect(255, bitsize=8)
-    assert k.pretty_name() == '<255|'
+    assert str(k) == '<255|'
     ret = k.call_classically(val=255)
     assert ret == ()
 

qualtran/bloqs/block_encoding/chebyshev_polynomial.py

@@ -93,7 +93,7 @@ def signature(self) -> Signature:
             resource=QAny(self.resource_bitsize),  # if resource_bitsize is 0, not present
         )
 
-    def pretty_name(self) -> str:
+    def __str__(self) -> str:
         return f"B[T_{self.order}({self.block_encoding})]"
 
     @property

qualtran/bloqs/chemistry/pbc/first_quantization/projectile/prepare_uv.py

@@ -14,7 +14,7 @@
 r"""PREPARE the potential energy terms of the first quantized chemistry Hamiltonian with projectile.
 """
 from functools import cached_property
-from typing import Dict, TYPE_CHECKING
+from typing import Dict, Optional, Tuple, TYPE_CHECKING
 
 from attrs import frozen
 
@@ -23,6 +23,7 @@
 from qualtran.bloqs.chemistry.pbc.first_quantization.projectile.prepare_nu import (
     PrepareNuStateWithProj,
 )
+from qualtran.drawing import Text, WireSymbol
 
 if TYPE_CHECKING:
     from qualtran.resource_counting import BloqCountDictT, SympySymbolAllocator
@@ -75,8 +76,10 @@ def signature(self) -> Signature:
             ]
         )
 
-    def pretty_name(self) -> str:
-        return r'PREP UV'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("PREP UV")
+        return super().wire_symbol(reg, idx)
 
     def build_composite_bloq(
         self, bb: BloqBuilder, mu: SoquetT, nu: SoquetT, m: SoquetT, l: SoquetT, flag_nu: SoquetT

qualtran/bloqs/chemistry/pbc/first_quantization/projectile/select_and_prepare.py

@@ -103,8 +103,10 @@ def signature(self) -> Signature:
     def adjoint(self) -> 'Bloq':
         return evolve(self, is_adjoint=not self.is_adjoint)
 
-    def pretty_name(self) -> str:
-        return 'PREP TUV'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("PREP TUV")
+        return super().wire_symbol(reg, idx)
 
     def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
         if self.is_adjoint:
@@ -140,7 +142,7 @@ def signature(self) -> Signature:
 
     def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
         if reg is None:
-            return Text(self.pretty_name())
+            return Text('MultiSwap')
         if reg.name == 'sel':
             return TextBox('In')
         elif reg.name == 'targets':
@@ -282,8 +284,10 @@ def junk_registers(self) -> Tuple[Register, ...]:
             Register('flags', QBit(), shape=(4,)),
         )
 
-    def pretty_name(self) -> str:
-        return r'PREP'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("PREP")
+        return super().wire_symbol(reg, idx)
 
     def build_composite_bloq(
         self,
@@ -461,8 +465,10 @@ def signature(self) -> Signature:
             [*self.control_registers, *self.selection_registers, *self.target_registers]
         )
 
-    def pretty_name(self) -> str:
-        return r'SELECT'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("SELECT")
+        return super().wire_symbol(reg, idx)
 
     def build_composite_bloq(
         self,

qualtran/bloqs/chemistry/pbc/first_quantization/projectile/select_t.py

@@ -13,12 +13,13 @@
 #  limitations under the License.
 r"""Bloqs for SELECT T for the first quantized chemistry Hamiltonian with a quantum projectile."""
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import Optional, Tuple, TYPE_CHECKING
 
 from attrs import frozen
 
 from qualtran import Bloq, bloq_example, QAny, QBit, Register, Signature
 from qualtran.bloqs.basic_gates import Toffoli
+from qualtran.drawing import Text, WireSymbol
 
 if TYPE_CHECKING:
     from qualtran.resource_counting import BloqCountDictT, SympySymbolAllocator
@@ -69,8 +70,10 @@ def signature(self) -> Signature:
             ]
         )
 
-    def pretty_name(self) -> str:
-        return r'SEL T'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("SEL T")
+        return super().wire_symbol(reg, idx)
 
     def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
         # Modification of the SEL T costs from the first quantized bloq with n_p replace with n_n.

qualtran/bloqs/chemistry/pbc/first_quantization/projectile/select_uv.py

@@ -14,14 +14,15 @@
 r"""Bloqs for SELECT for the U and V parts of the first quantized chemistry Hamiltonian."""
 from collections import Counter
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import Optional, Tuple, TYPE_CHECKING
 
 from attrs import frozen
 
 from qualtran import Bloq, bloq_example, QAny, QBit, QInt, Register, Signature
 from qualtran.bloqs.arithmetic import Add, SignedIntegerToTwosComplement
 from qualtran.bloqs.basic_gates import Toffoli
 from qualtran.bloqs.chemistry.pbc.first_quantization.select_uv import ApplyNuclearPhase
+from qualtran.drawing import Text, WireSymbol
 
 if TYPE_CHECKING:
     from qualtran.resource_counting import BloqCountDictT, BloqCountT, SympySymbolAllocator
@@ -75,8 +76,10 @@ def signature(self) -> Signature:
             ]
         )
 
-    def pretty_name(self) -> str:
-        return r'SEL UV'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text('SEL UV')
+        return super().wire_symbol(reg, idx)
 
     def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
         cost = Counter['Bloq']()

qualtran/bloqs/chemistry/pbc/first_quantization/select_and_prepare.py

@@ -73,8 +73,10 @@ class PrepareTUVSuperpositions(Bloq):
     def signature(self) -> Signature:
         return Signature.build(tuv=1, uv=1)
 
-    def pretty_name(self) -> str:
-        return 'PREP TUV'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("PREP TUV")
+        return super().wire_symbol(reg, idx)
 
     def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
         n_eta_zeta = (self.eta + 2 * self.lambda_zeta - 1).bit_length()
@@ -161,7 +163,7 @@ def _reshape_reg(
 
     def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
         if reg is None:
-            return Text(self.pretty_name())
+            return Text('MultiSwap')
         if reg.name == 'sel':
             return TextBox('In')
         elif reg.name == 'targets':
@@ -170,9 +172,6 @@ def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -
             return TextBox('×(y)')
         raise ValueError(f'Unknown name: {reg.name}')
 
-    def pretty_name(self) -> str:
-        return 'MultiSwap'
-
     def build_composite_bloq(
         self, bb: BloqBuilder, sel: SoquetT, targets: SoquetT, junk: SoquetT
     ) -> Dict[str, 'SoquetT']:
@@ -282,8 +281,10 @@ def l1_norm_coeffs(self) -> SymbolicFloat:
             )
         return self.sum_of_l1_coeffs
 
-    def pretty_name(self) -> str:
-        return r'PREP'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("PREP")
+        return super().wire_symbol(reg, idx)
 
     def build_composite_bloq(
         self,
@@ -447,8 +448,10 @@ def signature(self) -> Signature:
             [*self.control_registers, *self.selection_registers, *self.target_registers]
         )
 
-    def pretty_name(self) -> str:
-        return r'SELECT'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("SELECT")
+        return super().wire_symbol(reg, idx)
 
     def build_composite_bloq(
         self,

qualtran/bloqs/chemistry/pbc/first_quantization/select_t.py

@@ -13,12 +13,13 @@
 #  limitations under the License.
 r"""Bloqs for SELECT T for the first quantized chemistry Hamiltonian."""
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import Optional, Tuple, TYPE_CHECKING
 
 from attrs import frozen
 
 from qualtran import Bloq, bloq_example, BloqDocSpec, QAny, QBit, Register, Signature
 from qualtran.bloqs.basic_gates import Toffoli
+from qualtran.drawing import Text, WireSymbol
 
 if TYPE_CHECKING:
     from qualtran.resource_counting import BloqCountDictT, SympySymbolAllocator
@@ -57,8 +58,10 @@ def signature(self) -> Signature:
             ]
         )
 
-    def pretty_name(self) -> str:
-        return r'SEL T'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("SEL T")
+        return super().wire_symbol(reg, idx)
 
     def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
         # Cost is $5(n_{p} - 1) + 2$ which comes from copying each $w$ component of $p$

qualtran/bloqs/chemistry/pbc/first_quantization/select_uv.py

@@ -13,13 +13,14 @@
 #  limitations under the License.
 r"""Bloqs for SELECT for the U and V parts of the first quantized chemistry Hamiltonian."""
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import Optional, Tuple, TYPE_CHECKING
 
 from attrs import frozen
 
 from qualtran import Bloq, bloq_example, BloqDocSpec, QAny, QBit, QInt, Register, Signature
 from qualtran.bloqs.arithmetic import Add, SignedIntegerToTwosComplement
 from qualtran.bloqs.basic_gates import Toffoli
+from qualtran.drawing import Text, WireSymbol
 
 if TYPE_CHECKING:
     from qualtran.resource_counting import BloqCountDictT, SympySymbolAllocator
@@ -56,8 +57,10 @@ def signature(self) -> Signature:
             ]
         )
 
-    def pretty_name(self) -> str:
-        return r'-e^(-k_ν⋅R_l)'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text(r'-e^(-k_ν⋅R_l)')
+        return super().wire_symbol(reg, idx)
 
     def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
         n_p = self.num_bits_p
@@ -111,8 +114,10 @@ def signature(self) -> Signature:
             ]
         )
 
-    def pretty_name(self) -> str:
-        return r'SEL UV'
+    def wire_symbol(self, reg: Optional[Register], idx: Tuple[int, ...] = tuple()) -> 'WireSymbol':
+        if reg is None:
+            return Text("SEL UV")
+        return super().wire_symbol(reg, idx)
 
     def build_call_graph(self, ssa: 'SympySymbolAllocator') -> 'BloqCountDictT':
         cost_tc = (SignedIntegerToTwosComplement(self.num_bits_p), 6)