Skip to content

feat: add iterator function for search capsule API #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zvikagart merged 3 commits into from
Feb 21, 2025
Merged

feat: add iterator function for search capsule API #33

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db4b0a5
add iterator function for search capsule API
jake-valsamis Feb 20, 2025
31efe47
fix whitespaces
jake-valsamis Feb 20, 2025
14a1ccb
fix more whitespaces
jake-valsamis Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion src/codeocean/capsule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from dataclasses import dataclass
from dataclasses_json import dataclass_json
from typing import Optional
from typing import Optional, Iterator
from requests_toolbelt.sessions import BaseUrlSession

from codeocean.components import Ownership, SortOrder, SearchFilter
Expand Down Expand Up @@ -113,3 +113,18 @@ def search_capsules(self, search_params: CapsuleSearchParams) -> CapsuleSearchRe
res = self.client.post("capsules/search", json=search_params.to_dict())

return CapsuleSearchResults.from_dict(res.json())

def search_capsules_iterator(self, search_params: CapsuleSearchParams) -> Iterator[Capsules]:
params = search_params.to_dict()
while True:
response = self.search_capsules(
search_params=CapsuleSearchParams(**params)
)

for result in response.results:
yield result

if not response.has_more:
return

params["next_token"] = response.next_token