Source code for jentry.entry.cli.order

from enum import IntEnum, unique

import enum_tools
from hbutils.model import int_enum_loads


@enum_tools.documentation.document_enum
@int_enum_loads(enable_int=False, name_preprocess=str.upper)
@unique
class SortOrder(IntEnum):
    FILE = 1  # doc: Order by filename
    PACKAGE = 2  # doc: Order by package
    CLASS = 3  # doc: Order by class
    ENTRY = 4  # doc: Order by the full entry string

    @property
    def order_func(self):
        """
        Get the order function of this order object.
        This result can be used in the ``key`` option in ``sorted`` function.

        :raises ValueError: Raise :class:`ValueError` when self is invalid.
        """
        if self == SortOrder.FILE:
            return lambda x: x.filename or ''
        elif self == SortOrder.PACKAGE:
            return lambda x: x.package or ''
        elif self == SortOrder.CLASS:
            return lambda x: x.clazz
        elif self == SortOrder.ENTRY:
            return lambda x: x.full_name
        else:
            raise ValueError(f'Unknown sort order - {repr(self)}.')  # pragma: no cover


DEFAULT_SORT_ORDER = SortOrder.FILE