toil.utils.toilStats

Reports statistical data about a given Toil workflow.

Module Contents

Classes

ColumnWidths

Convenience object that stores the width of columns for printing. Helps make things pretty.

Functions

padStr(s[, field])	Pad the beginning of a string with spaces, if necessary.
prettyMemory(k[, field, isBytes])	Given input k as kilobytes, return a nicely formatted string.
prettyTime(t[, field])	Given input t as seconds, return a nicely formatted string.
reportTime(t, options[, field])	Given t seconds, report back the correct format as string.
reportMemory(k, options[, field, isBytes])	Given k kilobytes, report back the correct format as string.
reportNumber(n[, field])	Given n an integer, report back the correct format as string.
sprintTag(key, tag, options[, columnWidths])	Generate a pretty-print ready string from a JTTag().
decorateTitle(title, options)	Add a marker to TITLE if the TITLE is sorted on.
decorateSubHeader(title, columnWidths, options)	Add a marker to the correct field if the TITLE is sorted on.
get(tree, name)	Return a float value attribute NAME from TREE.
sortJobs(jobTypes, options)	Return a jobTypes all sorted.
reportPrettyData(root, worker, job, job_types, options)	Print the important bits out.
computeColumnWidths(job_types, worker, job, options)	Return a ColumnWidths() object with the correct max widths.
updateColumnWidths(tag, cw, options)	Update the column width attributes for this tag's fields.
buildElement(element, items, itemName)	Create an element for output.
createSummary(element, containingItems, ...)
getStats(jobStore)	Collect and return the stats and config data.
processData(config, stats)	Collate the stats and report
reportData(tree, options)
add_stats_options(parser)
main()	Reports stats on the workflow, use with --stats option to toil.

Attributes

logger
category_choices
sort_category_choices
sort_field_choices

toil.utils.toilStats.logger

class toil.utils.toilStats.ColumnWidths

Convenience object that stores the width of columns for printing. Helps make things pretty.

title(category)

Return the total printed length of this category item.

Parameters

category (str) –

Return type

int

getWidth(category, field)

Parameters

• category (str) –

• field (str) –

Return type

int

setWidth(category, field, width)

Parameters

• category (str) –

• field (str) –

• width (int) –

Return type

None

report()

Return type

None

toil.utils.toilStats.padStr(s, field=None)

Pad the beginning of a string with spaces, if necessary.

Parameters

• s (str) –

• field (Optional[int]) –

Return type

str

toil.utils.toilStats.prettyMemory(k, field=None, isBytes=False)

Given input k as kilobytes, return a nicely formatted string.

Parameters

• k (float) –

• field (Optional[int]) –

• isBytes (bool) –

Return type

str

toil.utils.toilStats.prettyTime(t, field=None)

Given input t as seconds, return a nicely formatted string.

Parameters

• t (float) –

• field (Optional[int]) –

Return type

str

toil.utils.toilStats.reportTime(t, options, field=None)

Given t seconds, report back the correct format as string.

Parameters

• t (float) –

• options (argparse.Namespace) –

• field (Optional[int]) –

Return type

str

toil.utils.toilStats.reportMemory(k, options, field=None, isBytes=False)

Given k kilobytes, report back the correct format as string.

Parameters

• k (float) –

• options (argparse.Namespace) –

• field (Optional[int]) –

• isBytes (bool) –

Return type

str

toil.utils.toilStats.reportNumber(n, field=None)

Given n an integer, report back the correct format as string.

Parameters

• n (float) –

• field (Optional[int]) –

Return type

str

toil.utils.toilStats.sprintTag(key, tag, options, columnWidths=None)

Generate a pretty-print ready string from a JTTag().

Parameters

• key (str) –

• tag (toil.lib.expando.Expando) –

• options (argparse.Namespace) –

• columnWidths (Optional[ColumnWidths]) –

Return type

str

toil.utils.toilStats.decorateTitle(title, options)

Add a marker to TITLE if the TITLE is sorted on.

Parameters

• title (str) –

• options (argparse.Namespace) –

Return type

str

toil.utils.toilStats.decorateSubHeader(title, columnWidths, options)

Add a marker to the correct field if the TITLE is sorted on.

Parameters

• title (str) –

• columnWidths (ColumnWidths) –

• options (argparse.Namespace) –

Return type

str

toil.utils.toilStats.get(tree, name)

Return a float value attribute NAME from TREE.

Parameters

• tree (toil.lib.expando.Expando) –

• name (str) –

Return type

float

toil.utils.toilStats.sortJobs(jobTypes, options)

Return a jobTypes all sorted.

Parameters

• jobTypes (List[Any]) –

• options (argparse.Namespace) –

Return type

List[Any]

toil.utils.toilStats.reportPrettyData(root, worker, job, job_types, options)

Print the important bits out.

Parameters

• root (toil.lib.expando.Expando) –

• worker (List[toil.job.Job]) –

• job (List[toil.job.Job]) –

• job_types (List[Any]) –

• options (argparse.Namespace) –

Return type

str

toil.utils.toilStats.computeColumnWidths(job_types, worker, job, options)

Return a ColumnWidths() object with the correct max widths.

Parameters

• job_types (List[Any]) –

• worker (List[toil.job.Job]) –

• job (List[toil.job.Job]) –

• options (toil.lib.expando.Expando) –

Return type

ColumnWidths

toil.utils.toilStats.updateColumnWidths(tag, cw, options)

Update the column width attributes for this tag’s fields.

Parameters

• tag (toil.lib.expando.Expando) –

• cw (ColumnWidths) –

• options (toil.lib.expando.Expando) –

Return type

None

toil.utils.toilStats.buildElement(element, items, itemName)

Create an element for output.

Parameters

• element (toil.lib.expando.Expando) –

• items (List[toil.job.Job]) –

• itemName (str) –

Return type

toil.lib.expando.Expando

toil.utils.toilStats.createSummary(element, containingItems, containingItemName, getFn)

Parameters

• element (toil.lib.expando.Expando) –

• containingItems (List[toil.job.Job]) –

• containingItemName (str) –

• getFn (Callable[[toil.job.Job], List[Optional[toil.job.Job]]]) –

Return type

None

toil.utils.toilStats.getStats(jobStore)

Collect and return the stats and config data.

Parameters

jobStore (toil.jobStores.abstractJobStore.AbstractJobStore) –

Return type

toil.lib.expando.Expando

toil.utils.toilStats.processData(config, stats)

Collate the stats and report

Parameters

• config (toil.common.Config) –

• stats (toil.lib.expando.Expando) –

Return type

toil.lib.expando.Expando

toil.utils.toilStats.reportData(tree, options)

Parameters

• tree (toil.lib.expando.Expando) –

• options (argparse.Namespace) –

Return type

None

toil.utils.toilStats.category_choices = ['time', 'clock', 'wait', 'memory']

toil.utils.toilStats.sort_category_choices = ['time', 'clock', 'wait', 'memory', 'alpha', 'count']

toil.utils.toilStats.sort_field_choices = ['min', 'med', 'ave', 'max', 'total']

toil.utils.toilStats.add_stats_options(parser)

Parameters

parser (argparse.ArgumentParser) –

Return type

None

toil.utils.toilStats.main()

Reports stats on the workflow, use with –stats option to toil.

Return type

None