Python API: Method DownloadCallbacks.add_new_download can return None
#1929
Conversation
This file contains 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
It's a backwards compatibility API. Originally, return value support was not implemented in SWIG bindings for the `add_new_download` method and the method only accepted `None` as a return value. Later, support was implemented for returning an integer, which is then passed in subsequent callbacks (`progress`, `end`, ...) as the `user_cb_data` argument. By expecting an integer instead of `None`, existing programs returning None are broken. This PR adds the ability for Python programs to return None (it has the same meaning as returning the integer 0 in this case).
|
That could work. |
evan-goode
approved these changes
Dec 5, 2024
There was a problem hiding this comment.
I confirm this fixes the Lorax bug: https://bodhi.fedoraproject.org/updates/FEDORA-2024-de59b25ef6.
|
This fixes a backwards-incompatibility introduced in #1849. |
Merged
via the queue into
rpm-software-management:main
with commit Dec 5, 2024
c05791a
15 of 17 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It's a backwards compatibility API.
Originally, return value support was not implemented in SWIG bindings for the
add_new_downloadmethod and the method only acceptedNoneas a return value.Later, support was implemented for returning an integer, which is then passed in subsequent callbacks (
progress,end, ...) as theuser_cb_dataargument. By expecting an integer instead ofNone, existing programs returning None are broken.This PR adds the ability for Python programs to return None (it has the same meaning as returning the integer 0 in this case).