Platform

The rite.system.platform submodule exposes helpers for detecting platform and runtime characteristics.

Platform Module

Platform and OS detection utilities.

This submodule provides utilities for detecting the operating system, architecture, and platform information.

Examples

from rite.system.platform import platform_name, platform_is_linux platform_name() 'Linux' platform_is_linux() True

Modules

platform_architecture

Platform Architecture

Get system architecture.

Examples

from rite.system.platform import platform_architecture platform_architecture() 'x86_64'

Functions

platform_architecture() -> str

Get system architecture.

Returns:

Type	Description
str	Architecture string (x86_64, arm64, etc).

Examples:

>>> platform_architecture()
'x86_64'
>>> platform_architecture()
'arm64'

Notes

Returns machine type from platform.machine().

platform_is_linux

Platform Is Linux

Check if running on Linux.

Examples

from rite.system.platform import platform_is_linux platform_is_linux() True

Functions

platform_is_linux() -> bool

Check if running on Linux.

Returns:

Type	Description
bool	True if Linux, False otherwise.

Examples:

>>> platform_is_linux()
True
>>> platform_is_linux()
False

Notes

Checks if platform.system() is 'Linux'.

platform_is_macos

Platform Is MacOS

Check if running on macOS.

Examples

from rite.system.platform import platform_is_macos platform_is_macos() True

Functions

platform_is_macos() -> bool

Check if running on macOS.

Returns:

Type	Description
bool	True if macOS, False otherwise.

Examples:

>>> platform_is_macos()
True
>>> platform_is_macos()
False

Notes

Checks if platform.system() is 'Darwin'.

platform_is_windows

Platform Is Windows

Check if running on Windows.

Examples

from rite.system.platform import platform_is_windows platform_is_windows() False

Functions

platform_is_windows() -> bool

Check if running on Windows.

Returns:

Type	Description
bool	True if Windows, False otherwise.

Examples:

>>> platform_is_windows()
False
>>> platform_is_windows()
True

Notes

Checks if platform.system() is 'Windows'.

platform_name

Platform Name

Get operating system name.

Examples

from rite.system.platform import platform_name platform_name() 'Linux'

Functions

platform_name() -> str

Get operating system name.

Returns:

Type	Description
str	OS name (Linux, Darwin, Windows, etc).

Examples:

>>> platform_name()
'Linux'
>>> platform_name()
'Darwin'

Notes

Returns system name from platform.system().

platform_python_version

Platform Python Version

Get Python version information.

Examples

from rite.system.platform import platform_python_version platform_python_version() '3.10.5'

Functions

platform_python_version() -> str

Get Python version string.

Returns:

Type	Description
str	Python version (e.g., '3.10.5').

Examples:

>>> platform_python_version()
'3.10.5'
>>> platform_python_version()
'3.11.2'

Notes

Returns version from platform.python_version().

options: show_root_heading: true show_source: false heading_level: 2