You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+71Lines changed: 71 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,6 +79,77 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
79
79
80
80
Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
81
81
82
+
## Pagination
83
+
84
+
List methods in the Hyperspell API are paginated.
85
+
86
+
This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
87
+
88
+
```python
89
+
from hyperspell import Hyperspell
90
+
91
+
client = Hyperspell()
92
+
93
+
all_documents = []
94
+
# Automatically fetches more pages as needed.
95
+
for document in client.documents.list(
96
+
collection="REPLACE_ME",
97
+
):
98
+
# Do something with document here
99
+
all_documents.append(document)
100
+
print(all_documents)
101
+
```
102
+
103
+
Or, asynchronously:
104
+
105
+
```python
106
+
import asyncio
107
+
from hyperspell import AsyncHyperspell
108
+
109
+
client = AsyncHyperspell()
110
+
111
+
112
+
asyncdefmain() -> None:
113
+
all_documents = []
114
+
# Iterate through items across all pages, issuing requests as needed.
115
+
asyncfor document in client.documents.list(
116
+
collection="REPLACE_ME",
117
+
):
118
+
all_documents.append(document)
119
+
print(all_documents)
120
+
121
+
122
+
asyncio.run(main())
123
+
```
124
+
125
+
Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
126
+
127
+
```python
128
+
first_page =await client.documents.list(
129
+
collection="REPLACE_ME",
130
+
)
131
+
if first_page.has_next_page():
132
+
print(f"will fetch next page using these details: {first_page.next_page_info()}")
133
+
next_page =await first_page.get_next_page()
134
+
print(f"number of items we just fetched: {len(next_page.items)}")
When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `hyperspell.APIConnectionError` is raised.
![stainless-app[bot]](https://avatars.githubusercontent.com/in/378072?v=4&size=40){kind=avatar}
0 commit comments