Pretty print #245

benjvmin93 · 2025-02-05T14:15:13Z

Before submitting, please check the following:

Make sure you have tests for the new code and that test passes (run nox)
If applicable, add a line to the [unreleased] part of CHANGELOG.md, following keep-a-changelog.
Format added code by ruff
- See CONTRIBUTING.md for more details
Make sure the checks (github actions) pass.

Then, please fill in below:

Context (if applicable):

#239

Description of the change:

New draw() methods in Circuit and Pattern classes.

Circuit.draw() generates the corresponding Qasm3 code and pass it to qiskit.draw() method. It relates on the same arguments (see qiskit.draw() method documentation).
pattern.draw() locally generates the appropriate visualization object (in the ascii, unicode, png, or latex formats)
pattern.__repr__() returns the pythonic representation useful to initialize the same object. It involves handling __repr__ method for commands. Thus, directly related to the writing of a class Command.

More details on the different changes are described in the CHANGELOG.md file.

Related issue:

…ng: see tests_patterns, tests_tnsim and tests_transpiler

… name attribute

…renciate them

…tty-print

thierry-martinez

There are still some fixes needed, and I made some remarks to clean the code and make it more general.

.github/workflows/ci.yml

CHANGELOG.md

graphix/command.py

thierry-martinez · 2025-04-04T11:33:31Z

graphix/pattern.py

+
+        output.write(self.to_latex(left_to_right))
+
+        output.write("\n\\end{document}")


Beware that \n is an escape form.

graphix/command.py

graphix/instruction.py

thierry-martinez · 2025-04-10T10:19:19Z

graphix/transpiler.py

+        """Return a string representation of the Circuit."""
+        return self.draw()
+
+    def draw(self, output: str = "text") -> TextDrawing | matplotlib.figure | PIL.Image | str:


I don't understand your argument. I think it would be more efficient if you provided a direct code suggestion, assuming you believe it's worthwhile.

tests/test_pattern.py

…tty-print

Co-authored-by: thierry-martinez <[email protected]>

…presenting pi in the proper format

…tty-print

shinich1 · 2025-04-10T17:13:47Z

if possible, can we move the implementation of drawing methods out of Pattern class (pattern module)? This has become a bit too large.

EarlMilktea · 2025-04-10T21:34:07Z

@benjvmin93 (CC: @shinich1 )

Additionally, if you're planning to add bunch of features to Pattern, I may request you to turn on mypy check against the file.

@thierry-martinez

Are there any updates on Pattern refactoring? It would be better to merge it before this large diff. is introduced.

- Add dedicated pretty-printing functions for patterns. - Improve str() and repr() for circuits, patterns, and core data types (Sign, Axis, Plane, Command, Instruction). This is a focused extract from PR TeamGraphix#245, removing any external dependencies: - Render patterns as ASCII, Unicode, or LaTeX snippets (PDF/image output removed). - Provide evaluable representations for patterns, circuits, and other core types. Per Shinichi’s suggestion (TeamGraphix#245 (comment)), move most code from `pattern.py` into a new module `pretty_print.py`. Per EarlMilktea’s suggestion (TeamGraphix#245 (comment)), add type checking to `pretty_print.py` and its tests (`test_pretty_print.py`).

* Pretty-print circuits and patterns - Add dedicated pretty-printing functions for patterns. - Improve str() and repr() for circuits, patterns, and core data types (Sign, Axis, Plane, Command, Instruction). This is a focused extract from PR #245, removing any external dependencies: - Render patterns as ASCII, Unicode, or LaTeX snippets (PDF/image output removed). - Provide evaluable representations for patterns, circuits, and other core types. Per Shinichi’s suggestion (#245 (comment)), move most code from `pattern.py` into a new module `pretty_print.py`. Per EarlMilktea’s suggestion (#245 (comment)), add type checking to `pretty_print.py` and its tests (`test_pretty_print.py`). * Fix use of `print_pattern` in examples * Add missing import * Update documentation * Update tutorial * Restore deprecated print_pattern and add arguments to converters * Add to CHANGELOG * Use `Iterable` in `Circuit.__init__` Suggested by EarlMilktea: #277 (comment) * Remove useless list collection before calling `join` Suggested by EarlMilktea: #277 (comment) * Use `Iterable` in `Pattern.__init__` and `Pattern.extend` Suggested by EarlMilktea: #277 (comment) * Use `enum.auto` instead of strings Suggested by EarlMilktea: #277 (comment) * Use the simpler `to_ascii` method in examples * Mixin for pretty-printing dataclasses * Mixin for pretty-printing Enum * Check instance of Enum in EnumMixin Suggested by EarlMilktea: #277 (comment) * Use `is not None` with `Iterable | None` EarlMilktea reported that Iterable does not implement __bool__. #277 (comment) * Annotate `self` with `DataclassInstance` Suggested by EarlMilktea: #277 (comment) * Fix ruff * Include `output_nodes` in `repr` * ruff fix with new linters * Fix swap and better code coverage * Use raw f-string Suggested by EarlMilktea: #277 (comment) * Update tutorial with `output_nodes` * Use `is not None` for `target` in `pattern_to_str` Reported by EarlMilktea: #277 (comment) * Add result type for `Circuit.__init__` Suggested by EarlMilktea: #277 (comment) * Rename `DataclassPrettyPrintMixin` and `EnumPrettyPrintMixin` Suggested by EarlMilktea: #277 (comment)

This commit introduces an OpenQASM 3 exporter for Graphix circuits. The functionality was originally proposed in TeamGraphix#245 but has not yet been merged. The added tests verify that a round-trip through the OpenQASM 3 representation preserves Graphix circuits, using the `graphix-qasm3-parser` plugin. These tests are executed by CI when the reverse-dependency is checked. In the long term the `qasm3_exporter` module will also host the pattern exporter, but that feature is intentionally omitted from this PR to keep the change focused.

This commit introduces an OpenQASM 3 exporter for Graphix circuits. The functionality was originally proposed in TeamGraphix#245 but has not yet been merged. The added tests verify that a round-trip through the OpenQASM 3 representation preserves Graphix circuits, using the graphix-qasm3-parser plugin. This plugin is therefore added as a `requirements-dev.txt` dependency. CI is updated so that `pip install .` can detect the current version number of Graphix, instead of the default `0.1`: to do so, the whole history and the tags should be available. We removed the "-e" option from CI because it is useless in the CI context. In the long term the `qasm3_exporter` module will also host the pattern exporter, but that feature is intentionally omitted from this PR to keep the change focused.

thierry-martinez · 2025-10-01T12:22:17Z

I think that most of the functionalities introduced in this PR were covered in #277. A missing part was the QASM3 exporter, which is covered with #343. The other parts were the direct export to image files or PDF (through LaTeX compilation), and the drawing of circuits using Qiskit. I think that it is preferable to leave these operations to the user, due to the dependency and maintenance costs.

This commit introduces an OpenQASM 3 exporter for Graphix circuits. The functionality was originally proposed in TeamGraphix#245 but has not yet been merged. The added tests verify that a round-trip through the OpenQASM 3 representation preserves Graphix circuits, using the graphix-qasm3-parser plugin. This plugin is therefore added as a `requirements-dev.txt` dependency. CI is updated so that `pip install .` can detect the current version number of Graphix, instead of the default `0.1`: to do so, the whole history and the tags should be available. We removed the "-e" option from CI because it is useless in the CI context. In the long term the `qasm3_exporter` module will also host the pattern exporter, but that feature is intentionally omitted from this PR to keep the change focused.

This commit introduces an OpenQASM 3 exporter for Graphix circuits. The functionality was originally proposed in #245 but has not yet been merged. The added tests verify that a round-trip through the OpenQASM 3 representation preserves Graphix circuits, using the graphix-qasm3-parser plugin. This plugin is therefore added as a `requirements-dev.txt` dependency. CI is updated so that `pip install .` can detect the current version number of Graphix, instead of the default `0.1`: to do so, the whole history and the tags should be available. We removed the "-e" option from CI because it is useless in the CI context. In the long term the `qasm3_exporter` module will also host the pattern exporter, but that feature is intentionally omitted from this PR to keep the change focused.

benjvmin93 and others added 30 commits April 8, 2024 17:15

Refacto including new command classes. Some tests are still not passi…

1699fe8

…ng: see tests_patterns, tests_tnsim and tests_transpiler

tests OK

459287b

new circuit instruction classes

4fe2f97

apply changes from instruction class in benchmark method

8e522a0

made control instructions inherit from OneQubitInstruction

f8bbcbd

update instruction determination from name to class instance + remove…

9ee5d97

… name attribute

update match for instructions and commands with an attribute to diffe…

bfb2a53

…renciate them

improved _find_op_to_be_moved + test execution speed

7829e73

improve _reorder_patter

35ace68

warnings to see execution time for tests

1e98cab

black formatting

766de39

removed debug warnings + black

83d979a

fixed all conflicts

ede1a78

typing + replace match by if/elif/else and make tests pass

eda4a46

format

e840905

Merge branch 'master' into master

923a15b

fix test

d468480

Merge branch 'master' into master

6e17dbf

Merge remote-tracking branch 'upstream/master'

1bc3992

changes for PR

d242e06

update plane attribute from M command to graphix.pauli.Plane

e23caee

update get_meas_plane more symbolic implem

037315a

more symbolic get_meas_plane using Pauli and Plane methods

aacc569

updates related to pr

d11fd82

merged remote repo + update apply_correction method with command class

791378a

fixed test + update apply_clifford method

aba3ebb

Fix diff

b0c05ec

Black transpiler

c19d12b

Fix review comments

a38b2a4

Remove match

6d9c897

benjvmin93 added 2 commits April 7, 2025 15:36

Merge branch 'pretty-print' of github.com:benjvmin93/graphix into pre…

8314903

…tty-print

fix linter error

1708489

thierry-martinez reviewed Apr 10, 2025

View reviewed changes

benjvmin93 and others added 6 commits April 10, 2025 15:05

commented poppler-windows setup in CI

045bcf4

removed private method mentions

e379ed2

Merge branch 'pretty-print' of github.com:benjvmin93/graphix into pre…

c32886a

…tty-print

suggested changes for reprensenting domain inside S command

db1ed3c

Co-authored-by: thierry-martinez <[email protected]>

changes in _angle_to_str: change parameters with mode for properly re…

04850a9

…presenting pi in the proper format

Merge branch 'pretty-print' of github.com:benjvmin93/graphix into pre…

07d5709

…tty-print

benjvmin93 added 7 commits April 14, 2025 14:21

fix angle_to_str + test

22ef798

added pattern.py to mypy checks

f68356c

remove pattern and add newly created draw_pattern file for mypy check

af091ab

ruff lint + format

8fe8469

update test drawing pattern + fix inside command for drawing clifford

a16f67a

update instruction to_qasm3 function based on Thierry's suggestion

dfbe04f

ruff format + linter

543dc16

thierry-martinez mentioned this pull request May 13, 2025

Pretty-print circuits and patterns #277

Merged

thierry-martinez mentioned this pull request Sep 30, 2025

Add OpenQASM 3 exporter for circuits qat-inria/graphix#25

Open

thierry-martinez mentioned this pull request Oct 1, 2025

Add OpenQASM 3 exporter for circuits #343

Merged

thierry-martinez closed this Oct 1, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Pretty print #245

Pretty print #245

Uh oh!

benjvmin93 commented Feb 5, 2025 •

edited

Loading

Uh oh!

thierry-martinez left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thierry-martinez Apr 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thierry-martinez Apr 10, 2025

Uh oh!

Uh oh!

shinich1 commented Apr 10, 2025

Uh oh!

EarlMilktea commented Apr 10, 2025

Uh oh!

thierry-martinez commented Oct 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		output.write(self.to_latex(left_to_right))

		output.write("\n\\end{document}")

Pretty print #245

Pretty print #245

Uh oh!

Conversation

benjvmin93 commented Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thierry-martinez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thierry-martinez Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thierry-martinez Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shinich1 commented Apr 10, 2025

Uh oh!

EarlMilktea commented Apr 10, 2025

Uh oh!

thierry-martinez commented Oct 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

benjvmin93 commented Feb 5, 2025 •

edited

Loading