Coverage report: - 95% -
- - -- Files - Functions - Classes -
-- coverage.py v7.6.10, - created at 2025-11-26 00:34 +0100 -
-Source code for gen_efi_app
-# -*- coding: UTF-8 -*-
-
-'''
-Module
- __init__.py
-Copyright
- Copyright (C) 2020 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com>
- gen_efi_app 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.
- gen_efi_app 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 this program. If not, see <http://www.gnu.org/licenses/>.
-Info
- Defines class GenEfiApp with attribute(s) and method(s).
- Loads a base info, creates a CLI interface and runs operations.
-'''
-
-import sys
-from typing import List, Dict, Optional
-from os.path import exists, dirname, realpath
-from os import getcwd
-from argparse import Namespace
-
-try:
- from ats_utilities.splash import Splash
- from ats_utilities.cli import ATSCli
- from ats_utilities.logging import ATSLogger
- from ats_utilities.console_io.error import error_message
- from ats_utilities.console_io.verbose import verbose_message
- from ats_utilities.console_io.success import success_message
- from ats_utilities.exceptions.ats_type_error import ATSTypeError
- from ats_utilities.exceptions.ats_value_error import ATSValueError
- from gen_efi_app.pro import GenEfi
-except ImportError as ats_error_message: # pragma: no cover
- # Force exit python #######################################################
- sys.exit(f'\n{__file__}\n{ats_error_message}\n') # pragma: no cover
-
-__author__: str = 'Vladimir Roncevic'
-__copyright__: str = '(C) 2026, https://electux.github.io/gen_efi_app'
-__credits__: List[str] = ['Vladimir Roncevic', 'Python Software Foundation']
-__license__: str = 'https://github.com/electux/gen_efi_app/blob/dev/LICENSE'
-__version__: str = '1.3.6'
-__maintainer__: str = 'Vladimir Roncevic'
-__email__: str = 'elektron.ronca@gmail.com'
-__status__: str = 'Updated'
-
-
-
-[docs]
-class GenEfiApp(ATSCli):
- '''
- Defines class GenEfiApp with attribute(s) and method(s).
- Loads a base info, creates a CLI interface and runs operations.
-
- It defines:
-
- :attributes:
- | _GEN_VERBOSE - Console text indicator for process-phase.
- | _CONFIG - Tool info file path.
- | _LOG - Tool log file path.
- | _LOGO - Logo for splash screen.
- | _OPS - List of tool options.
- | _logger - Logger object API.
- :methods:
- | __init__ - Initials GenEfiApp constructor.
- | process - Processes and runs operations.
- '''
-
- _GEN_VERBOSE: str = 'GEN_EFI_APP'
- _CONFIG: str = '/conf/gen_efi_app.cfg'
- _LOG: str = '/log/gen_efi_app.log'
- _LOGO: str = '/conf/gen_efi_app.logo'
- _OPS: List[str] = ['-n', '--name', '-v', '--verbose']
-
- def __init__(self, verbose: bool = False) -> None:
- '''
- Initials GenEfiApp constructor.
-
- :param verbose: Enable/Disable verbose option
- :type verbose: <bool>
- :exceptions: None
- '''
- current_dir: str = dirname(realpath(__file__))
- gen_efi_app_property: Dict[str, str | bool] = {
- 'ats_organization': 'electux',
- 'ats_repository': f'{self._GEN_VERBOSE.lower()}',
- 'ats_name': f'{self._GEN_VERBOSE.lower()}',
- 'ats_logo_path': f'{current_dir}{self._LOGO}',
- 'ats_use_github_infrastructure': True
- }
- Splash(gen_efi_app_property, verbose)
- base_info: str = f'{current_dir}{self._CONFIG}'
- super().__init__(base_info, verbose)
- verbose_message(
- verbose, [f'{self._GEN_VERBOSE.lower()} init tool info']
- )
- self._logger: ATSLogger = ATSLogger(
- self._GEN_VERBOSE.lower(), True, None, True, verbose
- )
- if self.is_operational():
- self.add_new_option(
- self._OPS[0], self._OPS[1], dest='name',
- help='generate project (provide name)'
- )
- self.add_new_option(
- self._OPS[2], self._OPS[3],
- action='store_true', default=False,
- help='activate verbose mode for generation'
- )
-
-
-[docs]
- def process(self, verbose: bool = False) -> bool:
- '''
- Processes and runs operations.
-
- :param verbose: Enable/Disable verbose option
- :type verbose: <bool>
- :return: True (success operation) | False
- :rtype: <bool>
- :exceptions: None
- '''
- status: bool = False
- if self.is_operational():
- try:
- args: Optional[Namespace] = self.parse_args(sys.argv)
- if not bool(getattr(args, 'name')):
- error_message(
- [f'{self._GEN_VERBOSE.lower()} missing name argument']
- )
- return status
- if exists(f'{getcwd()}/{str(getattr(args, "name"))}'):
- error_message([
- f'{self._GEN_VERBOSE.lower()}',
- f'project with name [{getattr(args, "name")}] exists'
- ])
- return status
- gen: GenEfi = GenEfi(getattr(args, 'verbose') or verbose)
- try:
- print(
- " ".join([
- f'[{self._GEN_VERBOSE.lower()}]',
- 'gen autoconf project skeleton',
- str(getattr(args, 'name'))
- ])
- )
- status = gen.gen_project(
- f'{getattr(args, "name")}',
- getattr(args, 'verbose') or verbose
- )
- except (ATSTypeError, ATSValueError) as e:
- error_message([f'{self._GEN_VERBOSE.lower()} {str(e)}'])
- self._logger.write_log(f'{str(e)}', self._logger.ATS_ERROR)
- if status:
- success_message([f'{self._GEN_VERBOSE.lower()} done\n'])
- self._logger.write_log(
- f'generation {getattr(args, "name")} done',
- self._logger.ATS_INFO
- )
- else:
- error_message([f'{self._GEN_VERBOSE.lower()} failed'])
- self._logger.write_log(
- 'generation failed', self._logger.ATS_ERROR
- )
- except SystemExit:
- error_message(
- [f'{self._GEN_VERBOSE.lower()} expected argument name']
- )
- return status
- else:
- error_message(
- [f'{self._GEN_VERBOSE.lower()} tool is not operational']
- )
- self._logger.write_log(
- 'tool is not operational', self._logger.ATS_ERROR
- )
- return status
-
-
-