pyguymer3.return_file_list

pyguymer3.return_file_list(path, /, *, allowHidden=False, debug=True, ensureNFC=True, follow_symlinks=True, return_dsstore=True, return_symlinks=True)[source]

Return a recursive list of file names in a directory.

This function returns a sorted list of file names recursively in a directory.

Parameters:

  • path (str) – the directory to search

  • allowHidden (bool, optional) – allow hidden files

  • debug (bool, optional) – print debug messages

  • ensureNFC (bool, optional) – ensure that the Unicode encoding is NFC

  • follow_symlinks (bool, optional) – follow symbolic links

  • return_dsstore (bool, optional) – include “.DS_Store” files in the returned list

  • return_symlinks (bool, optional) – include symbolic links in the returned list

Returns:

ans – the sorted list of file names

Return type:

list of str

Notes

Copyright 2017 Thomas Guymer [1]

References