(Backport 51973) partially unify public functions signature for pkg and lowpkg #54999
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
The virtual module 'pkg' is heavily used by other states, like the 'pkg' state, so differences in the signature of public functions can generate errors like: TypeError: xxx() got an unexpected keyword argument 'yyy' The fix is to add the parameter 'yyy' into all versions of the function 'xxx()' in all the 'pkg' virtual modules, but this approach is cumbersome and not very resilient, as any refactoring on the public interface or in the pkg state module will break again the already agreed contract. This patch append **kwarg in most of the public methods on virtual module pkg where it is missing, fixing the described issue and making more easy the refactoring of the code. (cherry picked from commit fbb8a29)
In the same way that the previous commit for pkg, add **kwargs into the public function signature for lowpkg virtual module, to unify the different signatures. (cherry picked from commit c9473a0)
|
After a second I think that is better to close this and add it into #54954 |
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.
What does this PR do?
The virtual module 'pkg' is heavily used by other states, like the
'pkg' state, so differences in the signature of public functions
can generate errors like:
TypeError: xxx() got an unexpected keyword argument 'yyy'
The fix is to add the parameter 'yyy' into all versions of the
function 'xxx()' in all the 'pkg' virtual modules, but this
approach is cumbersome and not very resilient, as any refactoring
on the public interface or in the pkg state module will break
again the already agreed contract.
This patch append **kwarg in most of the public methods on virtual
module pkg where it is missing, fixing the described issue and
making more easy the refactoring of the code.
Also do the same for 'lowpkg'
Tests written?
No, no change in behavior. Current tests are covering the refactoring.
(backport #51973, already merged in develop)