idmtools.assets.file_list module

class idmtools.assets.file_list.FileList(root=None, files_in_root=None, recursive=False, ignore_missing=False, relative_path=None, max_depth=3)

Bases: object

Special utility class to help handling user files

add_asset_file(af)

method used to add asset file :param af: asset file to add

Returns: None

add_file(path, relative_path='')

method used to add a file :param path: file oath :param relative_path: file relative path

Returns: None

add_path(path, files_in_dir=None, relative_path=None, recursive=False)

Add a path to the file list. :param path: The path to add (needs to be a dictionary) :param files_in_dir: If we want to only retrieve certain files in this path :param relative_path: relative_path: The relative path prefixed to each added files :param recursive: Do we want to browse recursively

Returns: None

to_asset_collection()

static from_asset_collection(asset_collection: idmtools.assets.asset_collection.AssetCollection) → distutils.filelist.FileList