- IpumsApiClient.wait_for_extract(extract, collection=None, inital_wait_time=1, max_wait_time=300, timeout=10800)#
Convenience function to wait for an extract to complete. Will sleep until the IPUMS API returns a “completed” status for the extract.
int]) – The extract to download. This extract must have been submitted. Alternatively, can be an extract id. If an extract id is provided, you must supply the collection name
initial_wait_time – How long in seconds to initially wait between pings to the IPUMS API. Future pings will be spaced by exponential backoff
float) – Pings will always occur at least once every
float) – If this many seconds passes, an
IpumsTimeoutExceptionwill be raised.
IpumsTimemoutException – If
timeoutseconds pass before a “completed” status is returned.