kwutil.util_hardware module

Helpers to get information about the available hardware. Request info about things like cpus, gpus, memory, and disk.

Backed by external modules:

• cpuinfo.

• psutil.

• and various linux cli calls via ubelt.cmd().

kwutil.util_hardware.get_cpu_mem_info()

kwutil.util_hardware.get_cpu_info()

kwutil.util_hardware.get_mem_info(with_units=False)

Memory info is returned in bytes.

Todo

• [ ] Should we use pint to give these numbers units?

References

https://psutil.readthedocs.io/en/latest/#psutil.virtual_memory

Example

>>> # xdoctest: +REQUIRES(module:psutil)
>>> from kwutil import util_hardware
>>> import ubelt as ub
>>> mem_info = util_hardware.get_mem_info(with_units=1)
>>> print(f'mem_info = {ub.urepr(mem_info, nl=1)}')

total = mem_info[‘used’] tmp = (

# mem_info[‘cached’] + # mem_info[‘buffers’] + # mem_info[‘inactive’] + mem_info[‘slab’])

green = total - tmp print(f’green={green}’) percent = ((green / mem_info[‘total’]) * 100).m print(f’percent={percent}’)

kwutil.util_hardware.disk_info_of_path(path)

Get disk info wrt where a file lives

WIP - needs more work

CommandLine

xdoctest -m kwutil.util_hardware disk_info_of_path

Returns:

dict - dictionary of information

Example

>>> from kwutil.util_hardware import *  # NOQA
>>> path = '.'
>>> x = disk_info_of_path(path)
>>> import ubelt as ub
>>> print(ub.urepr(x))

Todo

• [ ] Handle btrfs

• [ ] Handle whatever AWS uses

• [ ] Use udisksctl or udevadm

References

https://askubuntu.com/questions/609708/how-to-find-hard-drive-brand-name-or-model https://stackoverflow.com/questions/38615464/how-to-get-device-name-on-which-a-file-is-located-from-its-path-in-c

kwutil.util_hardware._device_is_hdd(path)

kwutil.util_hardware._zfs_status(pool, verbose=0)

Semi-parsable zfs status output. This is a proof-of-concept and needs some work to handle the nested pool structure.

kwutil.util_hardware._torch_device_info(device)

class kwutil.util_hardware._HardwareComponent

Bases: NiceRepr

summary()

Concise summary of most important information.

class kwutil.util_hardware.CPUs

Bases: _HardwareComponent

Storage container for info about system CPUs.

summary()

classmethod _discover_v1()

class kwutil.util_hardware.Memory

Bases: _HardwareComponent

Storage container for info about system RAM.

summary()

classmethod _discover_v1()

class kwutil.util_hardware.GPUs

Bases: _HardwareComponent

Storage container for info about system GPUS.

summary()

classmethod _discover_v1()

class kwutil.util_hardware.Motherboard

Bases: _HardwareComponent

Storage container for info about system motherboard.

References

https://askubuntu.com/questions/179958/how-do-i-find-out-my-motherboard-model

summary()

classmethod _discover_v1()

_discover_dmi_info_linux_non_admin()

class kwutil.util_hardware.Disks

Bases: _HardwareComponent

Storage container for info about system storage disks.

Todo

Find all mounted filesystems that correspond with physical disks via cat /proc/mounts or mount -l

References

https://unix.stackexchange.com/questions/24182/how-to-get-the-complete-and-exact-list-of-mounted-filesystems-in-linux

summary()

classmethod _discover_v1()

class kwutil.util_hardware.Networking

Bases: _HardwareComponent

Storage container for info about system networking devices.

summary()

classmethod _discover_v1()

class kwutil.util_hardware.Peripherals

Bases: _HardwareComponent

Storage container for info about system peripherals.

classmethod _discover_v1()

kwutil.util_hardware._hardware_nested_system_info()

kwutil.util_hardware._tup_to_nested(tuples)

class kwutil.util_hardware.Hardware

Bases: object

TODO: class level namespace

References

https://pypi.org/project/hardware/

Example

>>> # xdoctest: +SKIP
>>> import kwutil
>>> kwutil.Hardware.report()

static report()

Build a high level hardware report

static cpus()

static memory()

static gpus()

static disks()

static motherboard()

static networking()

static peripherals()