Fix QuantumCircuit.draw() not outputting pdf in latex mode #10212
Conversation
qiskit-bot
added
the
Community PR
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
|
|
There was a problem hiding this comment.
Thanks for this! I also can't think of a sensible way to test this - we made the same fix in #8629 and couldn't think of a test there either.
Please could you add a short "bugfix" release note (reno new --edit <some identifier>) that mentions that we've fixed this regression in the LaTeX drawer of QuantumCircuit?
| @@ -495,7 +495,8 @@ def _latex_circuit_drawer( | |||
| image = trim_image(image) | |||
| if filename: | |||
| if filename.endswith(".pdf"): | |||
| os.rename(base + ".pdf", filename) | |||
| import shutil | |||
There was a problem hiding this comment.
Super minor: can we put shutil up at the top of the file with the other imports? It's in the standard library, so no need to protect it.
There was a problem hiding this comment.
Done! I've created the release note and moved shutil to the top.
mtreinish
added
stable backport potential
Pull Request Test Coverage Report for Build 5189877371
💛 - Coveralls |
* Fix QuantumCircuit.draw() not outputting pdf in latex mode * Added bugfix release note; moved import to the top * Fixup release note --------- Co-authored-by: Jake Lishman <[email protected]> (cherry picked from commit 84d13d7)
…10217) * Fix QuantumCircuit.draw() not outputting pdf in latex mode * Added bugfix release note; moved import to the top * Fixup release note --------- Co-authored-by: Jake Lishman <[email protected]> (cherry picked from commit 84d13d7) Co-authored-by: Mu-Te Joshua Lau <[email protected]>
Summary
Per the discussion in #10211 I've filed this quick fix.
When calling
QuantumCircuit.draw('latex', out.pdf), the program breaking when qiskit tries to move the compiled pdf from the tmp folder to the target directory. The generated pdf is then deleted alongside the tmp folder.The bug is due to 'os.rename(...)' not working properly across filesystems.
Resorting to
shutil.move(...)solved the problem.Details and comments
I'm afraid there isn't a test I can add for the bug since it is device-dependent.