mafw.ui.console_user_interface

The console user interface.

The module provides a simple, still efficient user interface ideal for code execution of a headless system where it is not possible to observe the output in real-time. Nevertheless, important messages are logged via the logging library and thus it is also possible to save them to a file, if a proper logging handler is set up.

Classes

ConsoleInterface()

A console user interface.
class mafw.ui.console_user_interface.ConsoleInterface[source]

Bases: UserInterfaceBase

A console user interface.

Ideal for execution in a headless environment.

Messages are sent via the logging system, so they can also be saved to a file is a logging handler is properly set up in the execution framework.

create_task(task_name: str, task_description: str = '', completed: int = 0, increment: int | None = None, total: int | None = None, **kwargs: Any) → None[source]

Create a new task.

Parameters:

  • task_name (str) – A unique identifier for the task. You cannot have more than 1 task with the same name in the whole execution. If you want to use the processor name, it is recommended to use the unique_name.

  • task_description (str, Optional) – A short description for the task. Defaults to None.

  • completed (int, Optional) – The amount of task already completed. Defaults to None.

  • increment (int, Optional) – How much of the task has been done since last update. Defaults to None.

  • total (int, Optional) – The total amount of task. Defaults to None.

display_progress_message(message: str, i_item: int, n_item: int | None, frequency: float) → None[source]

Display a message during the process execution.

Parameters:

  • message (str) – The message to be displayed.

  • i_item (int) – The current item enumerator.

  • n_item (int | None) – The total number of items or None for an indeterminate progress (while loop).

  • frequency (float) – How often (in percentage of n_item) to display the message.

update_task(task_name: str, completed: int | None = None, increment: int | None = None, total: int | None = None, **kwargs: Any) → None[source]

Update an existing task.

Parameters:

  • task_name (str) – A unique identifier for the task. You cannot have more than one task with the same name in the whole execution. If you want to use the processor name, it is recommended to use the unique_name.

  • completed (int, Optional) – The amount of task already completed. Defaults to None.

  • increment (int, Optional) – How much of the task has been done since last update. Defaults to None.

  • total (int, Optional) – The total amount of task. Defaults to None.

name = 'console'

The name of the interface