idmtools_platform_comps.utils.download.download module

class idmtools_platform_comps.utils.download.download.CompressType(value)

Bases: enum.Enum

An enumeration.

lzma = 'lzma'

deflate = 'deflate'

bz = 'bz'

class idmtools_platform_comps.utils.download.download.DownloadWorkItem(_uid: uuid.UUID = None, _IItem__pre_creation_hooks: List[Callable[[ForwardRef('IItem'), ForwardRef('IPlatform')], NoneType]] = <factory>, _IItem__post_creation_hooks: List[Callable[[ForwardRef('IItem'), ForwardRef('IPlatform')], NoneType]] = <factory>, platform_id: uuid.UUID = None, _platform: 'IPlatform' = None, parent_id: uuid.UUID = None, _parent: 'IEntity' = None, status: idmtools.core.enums.EntityStatus = None, tags: Dict[str, Any] = <factory>, _platform_object: Any = None, _IRunnableEntity__pre_run_hooks: List[Callable[[ForwardRef('IRunnableEntity'), ForwardRef('IPlatform')], NoneType]] = <factory>, _IRunnableEntity__post_run_hooks: List[Callable[[ForwardRef('IRunnableEntity'), ForwardRef('IPlatform')], NoneType]] = <factory>, name: str = 'idmtools workflow item', assets: idmtools.assets.asset_collection.AssetCollection = <factory>, item_name: dataclasses.InitVar = <property object at 0x7f7634030cb0>, asset_collection_id: dataclasses.InitVar = <property object at 0x7f7634030d70>, transient_assets: idmtools.assets.asset_collection.AssetCollection = <factory>, asset_files: dataclasses.InitVar = <property object at 0x7f7634030d10>, user_files: dataclasses.InitVar = <property object at 0x7f7634030e30>, task: idmtools.entities.itask.ITask = None, related_experiments: list = <factory>, related_simulations: list = <factory>, related_suites: list = <factory>, related_work_items: list = <factory>, related_asset_collections: list = <factory>, work_item_type: str = None, work_order: dict = <factory>, plugin_key: str = '1.0.0.0_RELEASE', docker_image: str = None, command: dataclasses.InitVar = <property object at 0x7f761dfcda70>, file_patterns: List[str] = <factory>, exclude_patterns: List[str] = <factory>, include_assets: bool = False, simulation_prefix_format_str: str = '{simulation.id}', work_item_prefix_format_str: str = None, no_simulation_prefix: bool = False, verbose: bool = False, pre_run_functions: List[Callable] = <factory>, entity_filter_function: Callable[[COMPS.Data.CommissionableEntity.CommissionableEntity], bool] = None, filename_format_function: Callable[[str], str] = None, dry_run: bool = False, _ssmt_script: str = None, _ssmt_depends: List[str] = <factory>, output_path: str = <factory>, extract_after_download: bool = True, delete_after_download: bool = True, zip_name: str = 'output.zip', compress_type: idmtools_platform_comps.utils.download.download.CompressType = None)

Bases: idmtools_platform_comps.utils.file_filter_workitem.FileFilterWorkItem

output_path: str

extract_after_download: bool = True

delete_after_download: bool = True

zip_name: str = 'output.zip'

compress_type: idmtools_platform_comps.utils.download.download.CompressType = None

wait(wait_on_done_progress: bool = True, timeout: int = None, refresh_interval=None, platform: Optional[idmtools.entities.iplatform.IPlatform] = None) → None

Waits on Download WorkItem to finish. This first waits on any dependent items to finish(Experiment/Simulation/WorkItems)

Parameters

• wait_on_done_progress – When set to true, a progress bar will be shown from the item

• timeout – Timeout for waiting on item. If none, wait will be forever

• refresh_interval – How often to refresh progress

• platform – Platform

Returns

AssetCollection created if item succeeds