-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Address BackendV1 deprecation warning oversights #13868
Conversation
2b271b7
to
8e64ea0
Compare
…ng a Result object." This reverts commit 8e64ea0.
…normally instantiated using from_dict so all arguments are already treated as kwargs. Additionally, warn about qobj_id going away also as a kwarg in 2.0
…into deprecate-more
One or more of the following people are relevant to this code:
|
job_id, | ||
success, | ||
results, | ||
*args, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This might be confusing for people because the signature went from saying backend_name
, backend_version
, qobj_id
, job_id
, success
, and results
were all required arguments to no longer specifying that anywhere. The condition hasn't changed, but nothing is indicating that anymore.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know it's worse, but it's the only path I found to be able to inspect the args for what I needed. I can add a better description of what is requried in the docstring...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's also important to note that 2.0 will get back the named arguments, this is really just necessary to be able to raise the deprecation warning.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I would add it to the docstring, I think that's all we can do in this situation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small question about the docs updates. But I think otherwise it looks good after the merge conflict is resolved.
qobj_id (str): user-generated Qobj id. | ||
job_id (str): unique execution id from the backend. | ||
success (bool): True if complete input qobj executed correctly. (Implies | ||
backend_name (str): (REQUIRED) backend name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if we want this under Args
instead of attributes? They're both really because the constructor just does self.backend_name = backend_name
. But right now this is under attributes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, args would help covey the message that... well, these are the args. Will do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done b9d9fee
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the updates
Summary
This PR takes care of some oversights in the BackendV1 deprecation.
Details and comments