Skip to content

User Utilities User Manual

The cloudmesh.ai.common.user module provides cross-platform utilities for managing and identifying user-related system information. It ensures that identity and permission checks work consistently across Windows, macOS, and Linux.

Overview

This module is used to determine the current user's identity, check for administrative or root privileges, and resolve system-specific paths like the user's home directory.

Key Features

  • Privilege Detection: A unified is_root() function that works on both Unix-like systems (checking EUID) and Windows (checking administrative elevation).
  • Identity Retrieval: Reliable methods to get the current login name across different operating systems.
  • Home Directory Resolution: Cross-platform access to the user's home directory.
  • User Verification: Tools to check if a specific username exists on the local system.

Usage Guide

Checking for Administrative Privileges

Use is_root() to determine if the current process has the necessary permissions to perform system-level operations.

from cloudmesh.ai.common.user import is_root

if is_root():
    print("Running with administrative privileges.")
else:
    print("Running as a standard user. Some features may be disabled.")

Identifying the Current User

Retrieve the current username and home directory for personalized configuration or data storage.

from cloudmesh.ai.common.user import get, home

username = get()
user_home = home()

print(f"User: {username}")
print(f"Home Directory: {user_home}")

Verifying User Existence

Check if a specific user exists on the system before attempting to assign permissions or ownership.

from cloudmesh.ai.common.user import exists

if exists("admin_user"):
    print("Admin user found.")
else:
    print("Admin user does not exist on this system.")

API Reference

Refer to the auto-generated API documentation for detailed function signatures.