pcdsutils.import_timer.ModuleStatsSummary

class pcdsutils.import_timer.ModuleStatsSummary(root_module: str, self_time_raw: int, self_time: float, cumulative_time_raw: int, cumulative_time: float, submodule_stats: tuple[ImportTimeStats, ...])[source]

For a top-level module, the total time spent on all the submodules.

Attributes:
root_modulestr

The source module, e.g. pcdsdevices

self_time_rawint

The time it took to import this module in microseconds, not counting the time it took to import other modules.

self_timefloat

The time it took to import this module in seconds, not counting the time it took to import other modules.

cumulative_time_rawint

The time it took to import this module in microseconds, including the time it took to import other modules.

cumulative_timefloat

The time it took to import this module in seconds, including the time it took to import other modules.

submodule_statstuple of ImportTimeStats

The stats that were used to generate this stats summary.

Methods

from_stats(stats)

Create a ModuleStatsSummary from a list of ImportTimeStats.

show_detailed_summary([sort_key])

For this module, explain the situation to stdout.

__init__(root_module: str, self_time_raw: int, self_time: float, cumulative_time_raw: int, cumulative_time: float, submodule_stats: tuple[ImportTimeStats, ...]) None

Methods

__init__(root_module, self_time_raw, ...)

from_stats(stats)

Create a ModuleStatsSummary from a list of ImportTimeStats.

show_detailed_summary([sort_key])

For this module, explain the situation to stdout.

Attributes

root_module

self_time_raw

self_time

cumulative_time_raw

cumulative_time

submodule_stats