idmtools.analysis.analyze_manager module

idmtools.analysis.analyze_manager.pool_worker_initializer(func, analyzers, cache, platform: IPlatform) → NoReturn

Initialize the pool worker, which allows the process pool to associate the analyzers, cache, and path mapping to the function executed to retrieve data. Using an initializer improves performance.

Parameters

• func – The function that the pool will call.

• analyzers – The list of all analyzers to run.

• cache – The cache object.

• platform – The platform to communicate with to retrieve files from.

Returns

None

class idmtools.analysis.analyze_manager.AnalyzeManager(platform: IPlatform = None, configuration: dict = None, ids: List[Tuple[Union[str, uuid.UUID], idmtools.core.enums.ItemType]] = None, analyzers: List[idmtools.entities.ianalyzer.IAnalyzer] = None, working_dir: str = '/home/runner/work/idmtools/idmtools/idmtools/docs', partial_analyze_ok: bool = False, max_items: Optional[int] = None, verbose: bool = True, force_manager_working_directory: bool = False, exclude_ids: List[Union[str, uuid.UUID]] = None, analyze_failed_items: bool = False)

Bases: idmtools.core.cache_enabled.CacheEnabled

ANALYZE_TIMEOUT = 28800

WAIT_TIME = 1.15

EXCEPTION_KEY = '__EXCEPTION__'

exception TimeOutException

Bases: Exception

exception ItemsNotReady

Bases: Exception

add_item(item: idmtools.core.interfaces.ientity.IEntity) → NoReturn

Add an additional item for analysis.

Parameters

item – The new item to add for analysis.

Returns

None

add_analyzer(analyzer: idmtools.entities.ianalyzer.IAnalyzer) → NoReturn

Add another analyzer to use on the items to be analyzed.

Parameters

analyzer – An analyzer object (IAnalyzer).

Returns:

analyze() → bool

Process the provided items with the provided analyzers. This is the main driver method of AnalyzeManager.

Returns

True on success; False on failure/exception.