Exceptions

exception PatcherError(message: str = None, **kwargs)

Base exception class for exceptions with automatic traceback logging and concise error display.

Parameters:

message (str)

log_traceback()

Log the traceback of the exception. See handle_traceback().

display_message()

Display the error message to the console.

format_message() → str

Format exception message properly.

Return type:

str

exception DataframeError(reason: str | None = None)

Raised when there is an issue reading or writing data to the pandas dataframe.

Parameters:

reason (str | None)

exception InstallomatorError(reason: str | None = None)

Raised when there is an issue retrieving installomator labels or fragments.

Parameters:

reason (str | None)

exception TokenFetchError(reason: str | None = None)

Raised when there is an error fetching a bearer token from Jamf API.

Parameters:

reason (str | None)

exception TokenLifetimeError(lifetime: int | None = None)

Raised when the token lifetime is too short.

Parameters:

lifetime (int | None)

exception DirectoryCreationError(path: str | None = None)

Raised when there is an error creating directories.

Parameters:

path (str | None)

exception PlistError(path: str | None = None)

Raised when there is an error interacting with plist.

Parameters:

path (str | None)

exception ExportError(file_path: str | None = None)

Raised when encountering error(s) exporting data to files.

Parameters:

file_path (str | None)

exception PolicyFetchError(url: str | None = None)

Raised when unable to fetch policy IDs from the Jamf instance.

Parameters:

url (str | None)

exception SummaryFetchError(url: str | None = None)

Raised when there is an error fetching summaries.

Parameters:

url (str | None)

exception DeviceIDFetchError(reason: str | None = None)

Raised when there is an error fetching device IDs from the Jamf instance.

Parameters:

reason (str | None)

exception DeviceOSFetchError(reason: str | None = None)

Raised when there is an error fetching device OS information from the Jamf instance.

Parameters:

reason (str | None)

exception SortError(column: str | None = None)

Raised when there is an error sorting columns.

Parameters:

column (str | None)

exception SofaFeedError(reason: str | None = None, url: str = 'https://sofa.macadmins.io/v1/ios_data_feed.json')

Raised when there is an error fetching SOFA feed data.

Parameters:

• reason (str | None)

• url (str)

exception APIResponseError(reason: str | None = None)

Raised when an API call receives an unsuccessful status code.

Parameters:

reason (str | None)

exception ShellCommandError(reason: str | None = None)

Raised when the return code of a subprocess exec call is non-zero.

Parameters:

reason (str | None)

exception SetupError(reason: str | None = None)

Raised if any errors occur during automatic setup (Creating API Role/Integration).

Parameters:

reason (str | None)