Skip to content

listdir

Source

Hook for listdir. Lists the contents of a directory.

Inputs

Name Type Default Required Description
path str . True Path to directory to list contents.
sort bool False True Boolean to sort the output
ignore_hidden bool False True Boolean to ignore hidden files or directories
ignore_hidden_files bool False True Boolean to ignore hidden files
ignore_hidden_directories bool False True Boolean to ignore hidden directories
only_files bool False True Only return files.
only_directories bool False True Only return directories.
exclude Union[str, list] None False A list or string of regexes to ignore.

Arguments

Position Argument Type
1 path str

Returns

list