Skip to content

Commit 62fe3ed

Browse files
committed
clarify docs and changelog
1 parent 91fc4a6 commit 62fe3ed

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
## 4.1.0
44

5+
- The SDK version is available via `ipinfo.version` as `SDK_VERSION`.
56
- Most private functions on all handlers (i.e. those that start with `_`) are
67
now moved to `ipinfo.handler_utils`.
78
- All constants that existed on handlers (i.e. `REQUEST_TIMEOUT_DEFAULT`) are
89
now moved to `ipinfo.handler_utils`.
10+
- Cache behavior for the synchronous handler is a bit different now; the item
11+
actually cached is the item _after_ formatting is complete, rather than
12+
before.
913
- Both the sync and async handlers have the following improvements:
1014
- `timeout` can be specified as a keyword-arg to getDetails to optionally
1115
override the client-level timeout.

ipinfo/handler.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,9 @@ def getBatchDetails(
116116
input list).
117117
118118
The input list is broken up into batches to abide by API requirements.
119-
The batch size can be adjusted with `batch_size` but is clipped to (and
120-
also defaults to) `BATCH_MAX_SIZE`.
119+
The batch size can be adjusted with `batch_size` but is clipped to
120+
`BATCH_MAX_SIZE`.
121+
Defaults to `BATCH_MAX_SIZE`.
121122
122123
For each batch, `timeout_per_batch` indicates the maximum seconds to
123124
spend waiting for the HTTP request to complete. If any batch fails with
@@ -127,11 +128,13 @@ def getBatchDetails(
127128
`timeout_total` is a seconds-denominated hard-timeout for the time
128129
spent in HTTP operations; regardless of whether all batches have
129130
succeeded so far, if `timeout_total` is reached, the whole operation
130-
will fail. Defaults to being turned off.
131+
will fail by raising `TimeoutExceededError`.
132+
Defaults to being turned off.
131133
132134
`raise_on_fail`, if turned off, will return any result retrieved so far
133135
rather than raise an exception when errors occur, including timeout and
134-
quota errors. Defaults to on.
136+
quota errors.
137+
Defaults to on.
135138
"""
136139
if batch_size == None:
137140
batch_size = BATCH_MAX_SIZE

0 commit comments

Comments
 (0)