Ctrl+K

pyslk.list_raw

Contents

pyslk.list_raw#

pyslk.list_raw(path_or_id: str | int | Path, show_hidden: bool = False, numeric_ids: bool = False, recursive: bool = False, text: bool = False, print_bytes: bool = False, return_type: int = 0) → str | int | CompletedProcess#

List results from search id or GNS path

Parameters:

  • path_or_id (str or int or Path) – search id or gns path

  • show_hidden (bool) – show ‘.’ files, default: False (don’t show these files)

  • numeric_ids (bool) – show numeric values for user and group, default: False (show user and group names)

  • recursive (bool) – use the -R flag to list recursively, default: False

  • text (bool) – print result to file ‘slk_${USER}_list.txt’, default: False (print to command line / print non-empty return string)

  • print_bytes (bool) – use the -b to show sizes in bytes, default: False

  • return_type (int) – select between 0 (== str output), 1 (== exit code), 2 (subprocess output)

Returns:

stdout of the slk call

Return type:

Union[str, int, subprocess.CompletedProcess]

Contents