compass.services.threaded.CleanedFileWriter#

class CleanedFileWriter(out_dir, tpe_kwargs=None)[source]#

Service that writes cleaned text to a file

Parameters:

out_dir (path-like) – Path to output directory where file should be stored.
tpe_kwargs (dict, optional) – Keyword-value argument pairs to pass to concurrent.futures.ThreadPoolExecutor. By default, None.

Methods

`acquire_resources`()	Open thread pool and temp directory
`call`(args, *kwargs)	Call the service
`process`(doc)	Store file in out directory
`process_using_futures`(fut, args, *kwargs)	Process a call to the service
`release_resources`()	Shutdown thread pool and cleanup temp directory

Attributes

`MAX_CONCURRENT_JOBS`	Max number of concurrent job submissions.
`can_process`	Always `True` (limiting is handled by asyncio)
`name`	Service name used to pull the correct queue object

async classmethod call(*args, **kwargs)#

Call the service

Parameters:: *args, **kwargs – Positional and keyword arguments to be passed to the underlying service processing function.
Returns:: obj – A response object from the underlying service.

property can_process#

Always True (limiting is handled by asyncio)

property name#

Service name used to pull the correct queue object

async process(doc)#

Store file in out directory

Parameters:: doc (elm.web.document.Document) – Document containing meta information about the file. Must have relevant processing keys in the attrs dict, otherwise the file may not be stored in the output directory.
Returns:: Path or None – Path to output file, or None if no file was stored.

async process_using_futures(fut, *args, **kwargs)#

Process a call to the service

Parameters:

fut (asyncio.Future) – A future object that should get the result of the processing operation. If the processing function returns answer, this method should call fut.set_result(answer).
**kwargs – Keyword arguments to be passed to the underlying processing function.