Platform

provide.foundation.errors.platform

TODO: Add module docstring.

Classes

PlatformError

PlatformError(
    message: str,
    *,
    platform: str | None = None,
    operation: str | None = None,
    **kwargs: Any
)

Bases: FoundationError

Raised when platform detection or system operations fail.

Parameters:

Name	Type	Description	Default
message	str	Error message describing the platform issue.	required
platform	str | None	Optional platform identifier.	None
operation	str | None	Optional operation that failed.	None
**kwargs	Any	Additional context passed to FoundationError.	{}

Examples:

>>> raise PlatformError("Failed to detect OS")
>>> raise PlatformError("Unsupported platform", platform="freebsd")

Source code in provide/foundation/errors/platform.py

def __init__(
    self,
    message: str,
    *,
    platform: str | None = None,
    operation: str | None = None,
    **kwargs: Any,
) -> None:
    if platform:
        kwargs.setdefault("context", {})["platform.name"] = platform
    if operation:
        kwargs.setdefault("context", {})["platform.operation"] = operation
    super().__init__(message, **kwargs)