pyuutils.base.platform

MemInfo

class pyuutils.base.platform.MemInfo(phys_total: int = 0, phys_avail: int = 0, phys_cache: int = 0, swap_total: int = 0, swap_avail: int = 0, virt_total: int = 0, virt_avail: int = 0)[source]

Class representing system memory information.

All values are in kilobytes (kB).

ProcInfo

class pyuutils.base.platform.ProcInfo(mem_virt: int = 0, mem_work: int = 0, mem_swap: int = 0, time_user: int = 0, time_sys: int = 0, time_real: int = 0)[source]

Class representing process resource usage information.

Memory values are in kilobytes (kB). Time values are in milliseconds.

get_os_error

pyuutils.base.platform.get_os_error(error_code: int) → str[source]

Get OS-specific error description for given error code.

Parameters:: error_code (int) – The error code to get description for
Returns:: Error description string
Return type:: str

get_memory_info

pyuutils.base.platform.get_memory_info() → MemInfo[source]

Get hosting machine memory information.

Returns:: Memory information object
Return type:: MemInfo

init_process_info

pyuutils.base.platform.init_process_info() → None[source]: Initialize the process information gathering.

get_process_info

pyuutils.base.platform.get_process_info() → ProcInfo[source]

Get current process memory and time consumption sample.

Returns:: Process information object
Return type:: ProcInfo

get_process_info_max

pyuutils.base.platform.get_process_info_max() → ProcInfo[source]

Get current process memory and time consumption sample and store maximum values.

Returns:: Process information object with maximum values
Return type:: ProcInfo