Classes | Functions | Variables
rosclean Namespace Reference

Classes

class  CleanupException

Functions

def _ask_and_call
def _call
def _get_check_dirs
def _rosclean_cmd_check
def _rosclean_cmd_purge
def _usage
def get_disk_usage
def get_human_readable_disk_usage
def rosclean_main

Variables

string __version__ = '1.7.0'

Function Documentation

def rosclean._ask_and_call (   cmds,
  cwd = None 
) [private]
Pretty print cmds, ask if they should be run, and if so, runs
them using _call().

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

Definition at line 47 of file src/rosclean/__init__.py.

def rosclean._call (   cmds,
  cwd = None 
) [private]
Runs cmds using subprocess.check_call.

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

Definition at line 69 of file src/rosclean/__init__.py.

def rosclean._get_check_dirs ( ) [private]

Definition at line 91 of file src/rosclean/__init__.py.

def rosclean._rosclean_cmd_check (   args) [private]

Definition at line 98 of file src/rosclean/__init__.py.

def rosclean._rosclean_cmd_purge (   args) [private]

Definition at line 141 of file src/rosclean/__init__.py.

def rosclean._usage ( ) [private]

Definition at line 82 of file src/rosclean/__init__.py.

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: :exc:`CleanupException` If get_disk_usage() cannot be used on this platform

Definition at line 120 of file src/rosclean/__init__.py.

Get human-readable disk usage for directory

:param d: directory path, ``str`
:returns: human-readable disk usage (du -h), ``str``

Definition at line 104 of file src/rosclean/__init__.py.

def rosclean.rosclean_main (   argv = None)

Definition at line 156 of file src/rosclean/__init__.py.


Variable Documentation

string rosclean::__version__ = '1.7.0'

Definition at line 35 of file src/rosclean/__init__.py.



rosclean
Author(s): Ken Conley
autogenerated on Thu Aug 27 2015 14:46:44