Source code for aiida.tools.query.formatting

###########################################################################
# Copyright (c), The AiiDA team. All rights reserved.                     #
# This file is part of the AiiDA code.                                    #
#                                                                         #
# The code is hosted on GitHub at https://github.com/aiidateam/aiida-core #
# For further information on the license, see the LICENSE.txt file        #
# For further information please visit http://www.aiida.net               #
###########################################################################
"""Utility module with simple functions to format variables into strings for outputting as text."""

from __future__ import annotations

from datetime import datetime

from aiida.common import timezone
from aiida.common.utils import str_timedelta




def format_relative_time(value: datetime) -> str:
    """Return a string formatted timedelta of the given datetime with respect to the current datetime.

    :param value: The datetime to format.
    :return: String representation of the relative time since the given datetime.
    """
    return str_timedelta(timezone.delta(value), negative_to_zero=True, max_num_fields=1)





def format_state(process_state: str, paused: bool | None = None, exit_status: int | None = None) -> str:
    """Return a string formatted representation of a process' state which consists of its process state and exit status.

    :param process_state: The process state.
    :param pause: Whether the process is paused.
    :param exit_status: The process' exit status.
    :return: String representation of the process' state.
    """
    if process_state in ['excepted']:
        symbol = '\u2a2f'
    elif process_state in ['killed']:
        symbol = '\u2620'
    elif process_state in ['created', 'finished']:
        symbol = '\u23f9'
    elif process_state in ['running', 'waiting']:
        if paused is True:
            symbol = '\u23f8'
        else:
            symbol = '\u23f5'
    else:
        # Unknown process state, use invisible separator
        symbol = '\u00b7'  # middle dot

    if process_state == 'finished' and exit_status is not None:
        return f'{symbol} {format_process_state(process_state)} [{exit_status}]'

    return f'{symbol} {format_process_state(process_state)}'





def format_process_state(process_state: str) -> str:
    """Return a string formatted representation of the given process state.

    :param process_state: The process state.
    :return: String representation of process state.
    """
    return f'{process_state.capitalize() if process_state else None}'





def format_sealed(sealed: bool) -> str:
    """Return a string formatted representation of a node's sealed status.

    :param sealed: The value for the sealed attribute of the node.
    :return: String representation of seal status.
    """
    return 'True' if sealed == 1 else 'False'