cornsnake.util_os

  1"""
  2Functions for checking the operating system and logging OS information. The functions determine if the OS is Windows, Mac, or Unix, and log relevant OS details.
  3
  4[Documentation](http://docs.mrseanryan.cornsnake.s3-website-eu-west-1.amazonaws.com/cornsnake/util_os.html)
  5"""
  6
  7import os
  8import platform
  9
 10from . import util_log
 11from . import util_object
 12
 13logger = util_log.getLogger(__name__)
 14
 15
 16def is_windows():
 17    """
 18    Check if the current OS is Windows.
 19
 20    Returns:
 21    bool: True if the OS is Windows, False otherwise.
 22    """
 23    return os.name == "nt"
 24
 25
 26def is_mac():
 27    """
 28    Check if the current OS is Mac.
 29
 30    Returns:
 31    bool: True if the OS is Mac, False otherwise.
 32    """
 33    return platform.system() == "Darwin"
 34
 35
 36def is_unix():
 37    """
 38    Check if the current OS is Unix.
 39
 40    Returns:
 41    bool: True if the OS is Unix, False otherwise.
 42    """
 43    return not is_windows() and not is_mac() and util_object.has_attribute(os, "uname")
 44
 45
 46if is_windows():
 47    import winreg
 48
 49    def get_registry_key(top_key, reg_path, name):
 50        """
 51        Get a value from Windows registry.
 52
 53        Args:
 54        top_key: The top level key in the registry.
 55        reg_path: The path in the registry.
 56        name: The name of the registry key.
 57
 58        Returns:
 59        str: The value of the registry key, or None if not found.
 60        """
 61        try:
 62            registry_key = winreg.OpenKey(top_key, reg_path, 0, winreg.KEY_READ)
 63            value, _regtype = winreg.QueryValueEx(registry_key, name)
 64            winreg.CloseKey(registry_key)
 65            return value
 66        except WindowsError:
 67            return None
 68
 69    def is_windows_max_path_setting_on():
 70        """
 71        Check if the Windows max path setting is enabled.
 72
 73        Returns:
 74        bool: True if the max path setting is enabled, False otherwise.
 75        """
 76        path = r"SYSTEM\CurrentControlSet\Control\FileSystem"  # HKEY_LOCAL_MACHINE is implied
 77        key = "LongPathsEnabled"
 78        value = get_registry_key(winreg.HKEY_LOCAL_MACHINE, path, key)
 79        if value is None:
 80            return False
 81        return str(value) == "1"
 82
 83
 84def log_os():
 85    """
 86    Log OS information including platform, system, name, and release.
 87    """
 88    logger.info("=== OS ===")
 89    logger.info(f"OS: {_os_platform()}")
 90    logger.info(f"DETAILS: {platform.system()} - {os.name} - {platform.release()}")
 91
 92
 93def _os_platform():
 94    """
 95    Determine the platform of the OS.
 96
 97    Returns:
 98    str: The platform of the OS (Windows, Mac, Unix, or unknown).
 99    """
100    if is_windows():
101        return "Windows"
102    if is_mac():
103        return "Mac"
104    if is_unix():
105        return "Unix"
106    return "(unknown)"