Document methods that return None #1504
Merged
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
If a valid broker in the cluster has no partitions, it will return None rather than an empty set. Similarly updated a few other methods.
jeffwidman
commented
May 22, 2018
| @@ -119,6 +120,7 @@ def partitions_for_broker(self, broker_id): | |||
|
|
|||
| Returns: | |||
| set: {TopicPartition, ...} | |||
| None if the broker either has no partitions or does not exist. | |||
| """ | |||
| return self._broker_partitions.get(broker_id) | |||
There was a problem hiding this comment.
This is where the None comes from if a broker exists but has no partitions. Alternatively, could instead change this to get(broker_id, set()), although this would make non-existent brokers return an empty set rather than None.
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.
If a valid broker in the cluster has no partitions, it will return
Nonerather than an empty set.This was surprising behavior to me, I expected a broker that exists but has no partitions would return an empty set. So I'm not sure if it's better to document the current behavior, or change this to
get(broker_id, set()).Similarly documented a few other methods that sometimes can return
None.