Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrap io::Error in QASM2ParseError on failed file read #9958

Merged
merged 1 commit into from
Apr 13, 2023

Conversation

jakelishman
Copy link
Member

Summary

Previously, if Python thought the target file for qasm2.load existed, but Rust was unable to open it, the result io:Error would be propagated up to Python space verbatim, and these situations usually have confusing error messages. This could happen, for example, if the target was a directory on Windows.

Details and comments

Detected while doing #9955 preparing for 0.25. This PR is a bugfix for #9784, though, so wants to be in 0.24.

Previously, if Python thought the target file for `qasm2.load` existed,
but Rust was unable to open it, the result `io:Error` would be
propagated up to Python space verbatim, and these situations usually
have confusing error messages.  This could happen, for example, if the
target was a directory on Windows.
@jakelishman jakelishman added mod: qasm2 Relating to OpenQASM 2 import or export Changelog: None Do not include in changelog Rust This PR or issue is related to Rust code in the repository labels Apr 13, 2023
@jakelishman jakelishman added this to the 0.24.0 milestone Apr 13, 2023
@jakelishman jakelishman requested a review from a team as a code owner April 13, 2023 11:59
@qiskit-bot
Copy link
Collaborator

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:

@coveralls
Copy link

Pull Request Test Coverage Report for Build 4688938813

  • 3 of 9 (33.33%) changed or added relevant lines in 1 file are covered.
  • 8 unchanged lines in 4 files lost coverage.
  • Overall coverage increased (+0.08%) to 85.725%

Changes Missing Coverage Covered Lines Changed/Added Lines %
crates/qasm2/src/lib.rs 3 9 33.33%
Files with Coverage Reduction New Missed Lines %
qiskit/circuit/tools/pi_check.py 1 91.23%
crates/accelerate/src/sabre_swap/mod.rs 2 99.53%
crates/qasm2/src/lex.rs 2 91.39%
qiskit/pulse/library/waveform.py 3 91.67%
Totals Coverage Status
Change from base Build 4688469821: 0.08%
Covered Lines: 70050
Relevant Lines: 81715

💛 - Coveralls

Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, but just one super minor question inline. I don't really care, so feel free to enqueue for merging if it doesn't bother you.

lex::TokenStream::from_path(path, strict)?,
lex::TokenStream::from_path(&path, strict).map_err(|err| {
let exc = QASM2ParseError::new_err(format!(
"failed to read a token stream from file '{}'",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super minor nitpick, you don't want to start this with a capital f?

Suggested change
"failed to read a token stream from file '{}'",
"Failed to read a token stream from file '{}'",

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's actually what I originally typed, but it turns out that I started all my other error messages with lower-case letters, which matches Python's built-in style.

@jakelishman jakelishman added this pull request to the merge queue Apr 13, 2023
Merged via the queue into Qiskit:main with commit dec20b0 Apr 13, 2023
@jakelishman jakelishman deleted the qasm2/io-error branch April 13, 2023 16:02
giacomoRanieri pushed a commit to giacomoRanieri/qiskit-terra that referenced this pull request Apr 16, 2023
Previously, if Python thought the target file for `qasm2.load` existed,
but Rust was unable to open it, the result `io:Error` would be
propagated up to Python space verbatim, and these situations usually
have confusing error messages.  This could happen, for example, if the
target was a directory on Windows.
king-p3nguin pushed a commit to king-p3nguin/qiskit-terra that referenced this pull request May 22, 2023
Previously, if Python thought the target file for `qasm2.load` existed,
but Rust was unable to open it, the result `io:Error` would be
propagated up to Python space verbatim, and these situations usually
have confusing error messages.  This could happen, for example, if the
target was a directory on Windows.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog mod: qasm2 Relating to OpenQASM 2 import or export Rust This PR or issue is related to Rust code in the repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants