Remove return bool from Channel.close() #3403
Merged
+9
−19
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
Theres was defined meaning to the return bool either in the code or in the human text: - no code calls close to give an example of interpretation - it's not success/fail because local channel returns False to indicate that it didn't need to do anything, not that there was a failure. Other .close() style methods return None and raise an exception if there is a problem. This PR pushes Channel.close() in this direction. A separate PR will actually invoke this .close() method.
khk-globus
approved these changes
May 7, 2024
|
@khk-globus the argument isn't that it isn't used - it's that it has no defined meaning if you try to use it for ... something? |
benclifford
added a commit
that referenced
this pull request
Jul 2, 2024
Following on from #3403, which tightens the type signal of Channel.close(), this PR makes the DFK actually call Channel.close() when it shuts down an executor. On the LocalChannel, this has no effect. On the SSH Channels, this shuts down the SSH connection and removes a running thread.
benclifford
added a commit
that referenced
this pull request
Jul 11, 2024
Following on from #3403, which tightens the type signature of unused Channel.close(), this PR makes the DFK actually call Channel.close() when it shuts down an executor. At startup, the DFK chooses whether to manage things with channels by checking for the presence of a script_dir attribute on the relevant provider (!) and this PR sticks with that same informal protocol. On the LocalChannel, this has no effect. On the SSH Channels, this shuts down the SSH connection and removes an otherwise-abandoned thread.
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.
Theres was no defined meaning to the return bool either in the code or in the human text:
no code calls close to give an example of interpretation
it's not success/fail because local channel returns False to indicate that it didn't need to do anything, not that there was a failure.
Other .close() style methods return None and raise an exception if there is a problem. This PR pushes Channel.close() in this direction.
A separate PR will actually invoke this .close() method.
Changed Behaviour
This is an apparently unused return value so should not affect anything.
Type of change