hpcflow.sdk.compact_errors.FormatMixin#

class hpcflow.sdk.compact_errors.FormatMixin#

Bases: object

A mixin for CompactException and CompactWarning that provides a default format method.

Methods

format

get_formatted_problem

Default formatter for rendering a CompactException or CompactWarning using Rich.
format(title, subtitle, colour, filename, lineno, console=None)#
Parameters:

  • title (str)

  • subtitle (str)

  • colour (str)

  • filename (str)

  • lineno (int)

  • console (Console | None)

classmethod get_formatted_problem(obj, title, subtitle, colour, filename, lineno, console=None)#

Default formatter for rendering a CompactException or CompactWarning using Rich.

This will also render any Exception or Warning object, but we don’t use it to do that. To use a custom formatter, define a format method on the CompactException or CompactWarning sub-class.

Parameters:

  • obj (Self)

  • title (str)

  • subtitle (str)

  • colour (str)

  • filename (str)

  • lineno (int)

  • console (Console | None)

Return type:

tuple[Text, Group]