piper.io.list_files¶
-
piper.io.list_files(source='inputs/', glob_pattern='*.xls*', recurse=False, as_posix=False, regex='')[source]¶ return a list of files.
Criteria parameter allows one to focus on one or a group of files.
Examples
List ALL files in /inputs directory, returning a list of paths:
list_files(glob_pattern = ‘*’, regex=’Test’, as_posix=True)
- Parameters
source – source folder, default - ‘inputs/’
glob_pattern – file extension filter (str), default - ‘.xls’
regex –
if specified, allows regular expression to further filter the file selection. Default is ‘’
example
list_files(glob_pattern = '*.tsv', regex='Test', as_posix=True) >['inputs/Test XL WorkBook.tsv']
recurse – recurse directory (boolean), default False
as_posix – If True, return list of files strings, default False