Python库 | musamusa_errors-0.9.4.tar.gz

#!/usr/bin/env python3 # -*- coding: utf-8 -*- ################################################################################ # MusaMusa-Errors Copyright (C) 2021 suizokukan # Contact: suizokukan _A.T._ orange dot fr # # This file is part of MusaMusa-Errors. # MusaMusa-Errors 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. # # MusaMusa-Errors 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 MusaMusa-Errors. If not, see <http://www.gnu.org/licenses/>. ################################################################################ """ MusaMusa-Errors project : musamusa_errors/error_messages.py A convenient way to store and display error messages. Please notice that this code uses the `rich` package. Classes: Iaswn Iaswn + list | | MusaMusaEW ListOfErrorMessages | +-----------+------+-------------+ | | | MusaMusaWarning MusaMusaError MusTextFileEW | +---------+--------------+ | | MusTextFileWarning MusTextFileError ____________________________________________________________________________ o ListOfErrorMessages class o MusaMusaEW class o MusaMusaWarning class o MusaMusaError class o MusTextFileError class o MusTextFileWarning class """ from dataclasses import dataclass, field from iaswn.iaswn import Iaswn # https://docs.python.org/3/library/logging.html#logging-levels LEVEL_ERROR = 40 LEVEL_WARNING = 30 class ListOfErrorMessages(Iaswn, list): """ ListOfErrorMessages class Just a wrapper around a <list> of MusaMusaError and similar objects. _______________________________________________________________________ METHODS: o __str__(self) o first_msgid_is(self, msgid: str) o improved_str() o last_msgid_is(self, msgid: str) o zero_error(self) o zero_error_or_warning(self) o zero_warning(self) """ def __init__(self): """ ListOfErrorMessages.__init__() This method is necessary to ignore the parameters required by the list type (namely args, **kwargs): indeed the Iaswn class requires no parameter without default value. """ list.__init__(self) Iaswn.__init__(self) def __str__(self): """ ListOfErrorMessages.__str__() """ if self.zero_error(): return "No error or warning" res = ["*** Errors/Warnings ***", ] # ew_object : MusaMusaEW_like object for index, ew_object in enumerate(self): _line = "* #{index:0>5d} " \ ": {ew_object}".format( index=index, ew_object=str(ew_object)) res.append(_line) return "\n".join(res) def first_msgid_is(self, msgid: str): """ ListOfErrorMessages.first_msgid_is() Return True if the first *Error object stored in self has .msgid equal to <msgid>. __________________________________________________________________ RETURNED VALUE : (bool) """ if len(self) == 0: return False return self[0].msgid == msgid def improved_str(self): """ ListOfErrorMessages.improved_str() Return a nice representation of <self>, using colorized output. This functions should be used with the `rich` package : BE CAREFUL WHEN USING THESE CHARACTERS in the result string, since they have a special meaning for the `rich` package. __________________________________________________________________ RETURNED VALUE : (str)a nice representation of <self>. """ if self.zero_error_or_warning(): return "[yellow]*** No error or warning***[/yellow]" res = ["[yellow]*** Errors/Warnings ***[/yellow]", ] # ew_object : MusaMusaEW_like object for index, ew_object in enumerate(self): _line = "* [white]#{index:0>5d}[/white] " \ ": {ew_object}".format( index=index, ew_object=ew_object.improved_str()) res.append(_line) return "\n".join(res) def last_msgid_is(self, msgid: str): """ ListOfErrorMessages.last_msgid_is() Return True if the last *Error object stored in self has .msgid equal to <msgid>. __________________________________________________________________ RETURNED VALUE : (bool) """ if len(self) == 0: return False return self[-1].msgid == msgid def zero_error(self): """ ListOfErrorMessages.zero_error() Return True if <self> doesn't contain any error. __________________________________________________________________ RETURNED VALUE : (bool) """ # ew_object : MusaMusaEW_like object for ew_object in self: if ew_object.level == LEVEL_ERROR: return False return True def zero_error_or_warning(self): """ ListOfErrorMessages.zero_error_or_warning() Return True if <self> is empty. __________________________________________________________________ RETURNED VALUE : (bool) """ return len(self) == 0 def zero_warning(self): """ ListOfErrorMessages.zero_warning() Return True if <self> doesn't contain any error. __________________________________________________________________ RETURNED VALUE : (bool) """ # ew_object : MusaMusaEW_like object for ew_object in self: if ew_object.level == LEVEL_WARNING: return False return True @dataclass class MusaMusaEW(Iaswn): """ MusaMusaEW class (internal class) mother-class of all error classes The user doesn't normally has to create MusaMusaEW objects. _______________________________________________________________________ ATTRIBUTES: o (str)msgid o (str)msg o (int)level o (None or list)suberrors METHODS: o __str__(self, depth=0) o improved_str(self, depth=0) o str_word_suberrors(suberrors_nbr) """ msgid: str = "" msg: str = "" level: int = LEVEL_ERROR suberrors: list = field(default_factory=list) def __str__(self, depth=0): """ MusaMusaEW.__str__() ___________________________________________________________________ ARGUMENT: o depth: (int)level of depth for suberrors 0 is the first level (no suberrors) 1 is the second level (suberrors of an error) 2 is the third level (suberrors of suberrors of an error)