nicetoolbox.utils.system

Helper functions for system-related operations.

Functions

check_long_path_support	Check if Windows long path support is enabled and warn if not.
detect_os_type	Detects the underlying operating system.
normalize_ffmpeg_filter_path_in_windows
system_capability_check	Checks current system-specific capabilities (i.e.

nicetoolbox.utils.system.check_long_path_support() → None

Check if Windows long path support is enabled and warn if not.

On Windows, the default MAX_PATH limit is 260 characters. This can cause failures when dataset/session names produce long folder paths. Enabling long path support removes this limit.

On Linux, this check is a no-op (no 260-char restriction).

nicetoolbox.utils.system.detect_os_type() → str

Detects the underlying operating system.

Returns:

A string representing the operating system type.

It can be either ‘windows’ or ‘linux’.

Return type:

str

Notes

This function uses the platform module to determine the operating system. It checks the platform.system() function’s return value and returns ‘windows’ if it’s ‘Windows’, and ‘linux’ if it’s either ‘Linux’ or ‘Darwin’.

nicetoolbox.utils.system.system_capability_check() → None

Checks current system-specific capabilities (i.e. max path length)