niryo_libraries.rosclean

package documentation

Undocumented

From __init__.py:

Exception	`CleanupException`	Undocumented
Function	`get_disk_usage`	Get disk usage in bytes for directory :param d: directory path, `str` :returns: disk usage in bytes (du -b) or (du -A) * 1024, `int` :raises: `CleanupException` If get_disk_usage() cannot be used on this platform...
Function	`get_human_readable_disk_usage`	Get human-readable disk usage for directory
Function	`rosclean_main`	Undocumented
Variable	`__version__`	Undocumented
Function	`_ask`	ask user with provided comment. If user responds with y, return True
Function	`_ask_and_call`	Pretty print cmds, ask if they should be run, and if so, runs them using _call().
Function	`_call`	Runs cmds using subprocess.check_call.
Function	`_get_check_dirs`	Undocumented
Function	`_get_disk_usage_by_walking_tree`	Undocumented
Function	`_rosclean_cmd_check`	Undocumented
Function	`_rosclean_cmd_purge`	Undocumented
Function	`_sort_file_by_oldest`	Get files and directories in specified path sorted by last modified time :param d: directory path, `str` :return: a list of files and directories sorted by last modified time (old first), `list`
Function	`_usage`	Undocumented

__version__: str = ¶

Undocumented

def _ask_and_call(cmds, cwd=None): ¶

Pretty print cmds, ask if they should be run, and if so, runs them using _call().

Parameters
cmds	a list of commands executed one after another, `list`
cwd	(optional) set cwd of command that is executed, `str`
Returns
`True` if cmds were run.

def _ask(comment): ¶

ask user with provided comment. If user responds with y, return True

Parameters
comment	comment, `str`
Returns
`True` if user responds with y

def _call(cmds, cwd=None): ¶

Runs cmds using subprocess.check_call.

Parameters
cmds	a list of commands executed one after another, `list`
cwd	(optional) set cwd of command that is executed, `str`

def _usage(): ¶

Undocumented

def _get_check_dirs(): ¶

Undocumented

def _rosclean_cmd_check(args): ¶

Undocumented

def _get_disk_usage_by_walking_tree(d): ¶

Undocumented

def get_human_readable_disk_usage(d): ¶

Get human-readable disk usage for directory

Parameters
d	directory path, ``str`
Returns
human-readable disk usage (du -h), `str`

def get_disk_usage(d): ¶

Get disk usage in bytes for directory :param d: directory path, str :returns: disk usage in bytes (du -b) or (du -A) * 1024, int :raises: CleanupException If get_disk_usage() cannot be used on this platform

def _sort_file_by_oldest(d): ¶

Get files and directories in specified path sorted by last modified time :param d: directory path, `str` :return: a list of files and directories sorted by last modified time (old first), `list`

def _rosclean_cmd_purge(args): ¶

Undocumented

def rosclean_main(argv=None): ¶

Undocumented