Source code for launcher_menus.errors

#!/usr/bin/env python3
# -*- coding: utf-8; mode: python; -*-
#
# Copyright 2021 Pradyumna Paranjape
# This file is part of launcher-menus.
#
# launcher-menus is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# launcher-menus is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with launcher-menus.  If not, see <https://www.gnu.org/licenses/>.
#
'''
Menu errors
'''

from .checks import MENUS


class MenuError(Exception):
    '''
    <MENU> errors Base.
    '''


class FlagNameNotFoundError(MenuError):
    '''
    Flag not found for <menu> in menu-cfgs/<menu>.yml,
    nor provided via ``**flags`` or ``config_yml``.

    Args:
        command: command that was unsed as <menu>.
        flag: flag that was not identified from yml file.

    '''
    def __init__(self, command: str, flag: str) -> None:
        super().__init__(f'''
            flag name for '{flag}' of {command} was not found
            in '**flags'
            nor in the supplied 'config_yml' (if any)
            nor in default configuration file {command}.yml (if any)
            ''')


class CommandError(MenuError):
    '''
    <MENU> command failed.

    Args:
        args: args called with <menu> command.
        err: error raised by <menu> command.

    '''
    def __init__(self, args: list, err: str) -> None:
        super().__init__(f'''
            Bad menu command {args}:

            {err}

            Menus available:
            {MENUS.keys()}
        ''')


class UsageError(MenuError):
    '''
    Usage error described by <menu> command.

    Args:
        args: args called with <menu> command.
        err: error raised by <menu> command.
    '''
    def __init__(self, args: list, err: str) -> None:
        super().__init__(f'''
            Bad menu usage {args}:

            {err}
            ''')