Add comments to clarify queryset iteration #1004
Merged
Conversation
This file contains hidden or 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
jacalata
reviewed
Mar 16, 2022
| @@ -31,12 +35,16 @@ def __getitem__(self, k): | |||
| page = self.page_number | |||
| size = self.page_size | |||
|
|
|||
| # Create a range object for quick checking if k is in the cached result. | |||
| page_range = range((page - 1) * size, page * size) | |||
|
|
|||
| if isinstance(k, slice): | |||
There was a problem hiding this comment.
k can either be an int or a slice object.
It could be a slice if it was called in the following manner:
server.workbooks.all()[10:40:3]There was a problem hiding this comment.
In that example, if the client code calls
server.workbooks.all()[10:40:3]Then __getitem__ receives k=slice(start=10, stop=40, step=3). Any of the typical slicing syntax will work. For server.workbooks.all()[:50] then k=slice(start=None, stop=50, step=None), then the None's get replaced with sensible defaults so that it acts the way that slicing would on a list.
If start is None, it becomes 0
If stop is None, it becomes the total number available
If step is None, it becomes 1
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.
@jacalata Hope that is clearer.