ipumspy.api.IpumsApiClient.extract_is_expired#

IpumsApiClient.extract_is_expired(extract, collection=None)[source]#

Returns True if the IPUMS extract’s files have been expired from the cache.

Parameters:

  • extract (Union[BaseExtract, int]) – An extract object. This extract must have been submitted. Alternatively, can be an extract id. If an extract id is provided, you must supply the collection name.

  • collection (Optional[str]) – The name of the collection to pull the extract from. If None, then extract must be a BaseExtract.

Return type:

bool