compass.utilities.io.load_local_docs#

async load_local_docs(fps, **kwargs)[source]#

Load local documents into elm document instances

Parameters:

  • fps (Iterable) – Iterable of paths referencing local files to load.

  • **kwargs – Additional keyword arguments forwarded to elm.web.file_loader.AsyncLocalFileLoader for configuration such as loader, caching, or parsing options.

Returns:

list of elm.web.document.BaseDocument – Non-empty loaded documents corresponding to the supplied filepaths. Empty results (e.g., unreadable files) are filtered out of the returned list.

Raises:

elm.exceptions.ELMError – Propagated when the underlying loader fails to read one of the provided files and is configured to raise on errors.

Notes

Detailed debug information about loaded page counts is emitted via the compass.utilities.io logger at TRACE level to assist with troubleshooting ingestion runs.

On this page