Fix #556: unify default output format#563
Open
thierry-martinez wants to merge 3 commits into
Open
Conversation
This commit unifies the default behavior of display routines by
introducing the context variable `default_output_format`, which is
set to `OutputFormat.ASCII` by default.
The `__str__` methods of `PauliFlow`, `XZCorrections`, `Pattern`, and
`StateVec` now directly call the corresponding `*_to_str` functions
using the default value for the `output` parameter. This default is
resolved by `ensure_output_format`, which retrieves the value of
`default_output_format`. Previously, `StateVec` produced output
without relying on the pretty-printing functions, while
`StateVec.draw` uses `OutputFormat.Unicode` by default and the other
classes called `to_ascii` directly.
In `docs/source/conf.py`, the following entry has been added to
`intersphinx_mapping`:
```python
"python": ("https://docs.python.org/3", None),
```
This enables links to the Python documentation for `ContextVar`.
The documentation of the `pretty_print` module has been changed to:
```
.. automodule:: graphix.pretty_print
:members:
```
so that all public members are included in the documentation.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #563 +/- ##
==========================================
+ Coverage 90.58% 90.62% +0.03%
==========================================
Files 49 49
Lines 7481 7499 +18
==========================================
+ Hits 6777 6796 +19
+ Misses 704 703 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit unifies the default behavior of display routines by introducing the context variable
default_output_format, which is set toOutputFormat.ASCIIby default.The
__str__methods ofPauliFlow,XZCorrections,Pattern, andStateVecnow directly call the corresponding*_to_strfunctions using the default value for theoutputparameter. This default is resolved byensure_output_format, which retrieves the value ofdefault_output_format. Previously,StateVecproduced output without relying on the pretty-printing functions, whileStateVec.drawusesOutputFormat.Unicodeby default and the other classes calledto_asciidirectly.In
docs/source/conf.py, the following entry has been added tointersphinx_mapping:This enables links to the Python documentation for
ContextVar.The documentation of the
pretty_printmodule has been changed to:so that all public members are included in the documentation.