download_specs_construct

Define constructor for downloader.DownloadSpecs objects.

Functions

construct(files, filing, to_dir, ...[, ...])

Construct a list of downloader.DownloadSpecs objects.
xbrl_filings_api.download_specs_construct.construct(files, filing, to_dir, stem_pattern, *, check_corruption, isfilingset=False)

Construct a list of downloader.DownloadSpecs objects.

This function is used by methods download and download_aiter of objects Filing and FilingSet to get a list of DownloadSpecs objects for calls to downloader subpackage functions.

Returns:

Instructions for a concrete download.

Return type:

downloader.DownloadSpecs

Parameters:

  • files (Union[FileStringType, Iterable[FileStringType], Mapping[FileStringType, DownloadItem]])

  • filing (Filing)

  • to_dir (Union[str, PurePath, None])

  • stem_pattern (Union[str, None])

  • check_corruption (bool)

  • isfilingset (bool)