protoerror 3.20.2__tar.gz

protoerror-3.20.2/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: protoerror
+Version: 3.20.2
+Author-email: Helmut Konrad Schewe <helmutus@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/anaticulae/protoerro
+Project-URL: Repository, https://github.com/anaticulae/protoerro
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: utilo<3.0.0,>=2.107.4
+Requires-Dist: iamraw<5.0.0,>=4.91.4
+Requires-Dist: configos<2.0.0,>=1.0.4
+Requires-Dist: Jinja2<4.0.0,>=3.1.6
+Provides-Extra: dev
+Requires-Dist: utilotest<2.0.0,>=1.0.2; extra == "dev"
+Requires-Dist: utilosafe<2.0.0,>=1.0.0; extra == "dev"
+
+# protoerror

protoerror-3.20.2/README

@@ -0,0 +1 @@
+# protoerror

protoerror-3.20.2/protoerror/__init__.py

@@ -0,0 +1,133 @@
+#==============================================================================
+# C O P Y R I G H T
+#------------------------------------------------------------------------------
+# Copyright (c) 2019-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+#==============================================================================
+"""Protocol
+========
+
+The `protoerror` library supports logging errors and giving advices how
+to solve this errors.
+"""
+
+import os
+
+import iamraw
+
+import protoerror.__patch__
+# checker
+from protoerror.checker import Checker
+from protoerror.checker import check_messages
+# config
+from protoerror.config import MessageStatus
+from protoerror.config import load
+from protoerror.config import save
+# control
+from protoerror.control import DOCINFO
+from protoerror.control import bachelor
+from protoerror.control import book
+from protoerror.control import decorators
+from protoerror.control import disable_perpage
+from protoerror.control import diss
+from protoerror.control import dissertation
+from protoerror.control import enable_perpage
+from protoerror.control import english
+from protoerror.control import filter_checkers
+from protoerror.control import german
+from protoerror.control import homework
+from protoerror.control import integrate_docinfo
+from protoerror.control import is_disabled_perpage
+from protoerror.control import master
+from protoerror.control import nobachelor
+from protoerror.control import nobook
+from protoerror.control import nodiss
+from protoerror.control import nohome
+from protoerror.control import nolarge
+from protoerror.control import nomaster
+from protoerror.control import nomedium
+from protoerror.control import nopaper
+from protoerror.control import nosmall
+from protoerror.control import parse_docinfo
+from protoerror.control import section_only
+from protoerror.control import section_skip
+# finding
+from protoerror.finding import finding_status
+from protoerror.finding import finding_status_update
+from protoerror.finding import findings_from_path
+from protoerror.finding import hash_finding
+from protoerror.finding import make_finding_number_unique
+# group
+from protoerror.group import byid
+from protoerror.group import bypage
+from protoerror.group import count_findings
+from protoerror.group import filter_mark
+from protoerror.group import flat
+from protoerror.group import lines
+from protoerror.group import ranged
+from protoerror.group import select
+from protoerror.group import select_findings
+from protoerror.group import select_pages
+from protoerror.group import sentences
+from protoerror.group import words
+# linter
+from protoerror.linter import DEVELOPER_FILE
+from protoerror.linter import USER_FILE
+from protoerror.linter import DumpedLinterResult
+from protoerror.linter import Linter
+from protoerror.linter import dump_result
+from protoerror.linter import from_file
+from protoerror.linter import from_module
+from protoerror.linter import from_modules
+from protoerror.linter import from_solution
+from protoerror.linter import write_result
+# merge
+from protoerror.merger import merge_findings
+# messages
+from protoerror.messages import TYPE_DEFAULT
+# paged
+from protoerror.paged import load_grouped
+from protoerror.paged import write_grouped
+# question
+from protoerror.question import Answer
+from protoerror.question import Question
+from protoerror.question import Questions
+from protoerror.question import answer_questions
+from protoerror.question import documore
+from protoerror.question import pagemore
+from protoerror.question import parse_questions
+# report
+from protoerror.report import integrate
+# report parser
+from protoerror.report_parser import Feature
+from protoerror.report_parser import Report
+from protoerror.report_parser import Reports
+from protoerror.report_parser import Step
+from protoerror.report_parser import Steps
+from protoerror.report_parser import parses
+# run
+from protoerror.simple import ResultDefault
+from protoerror.simple import ResultType
+from protoerror.simple import run
+# solution
+from protoerror.solution import Solver
+from protoerror.solution import Validators
+from protoerror.solution import confidence
+from protoerror.solution import parse_checkers
+from protoerror.solution import parse_msgid
+from protoerror.solution import parse_solutions
+# utils
+from protoerror.utils import RESULT_EMPTY
+from protoerror.utils import driver
+from protoerror.utils import skip_method
+
+__version__ = '3.20.1'
+
+ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+
+OVERVIEW = iamraw.Location.from_page(-1)
+
+skip_check = skip_method
+skip = skip_method

protoerror-3.20.2/protoerror/__patch__.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================

protoerror-3.20.2/protoerror/checker.py

@@ -0,0 +1,78 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2019-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+"""Checker
+=======
+
+How does the Checker work
+-------------------------
+
+Extracted data of different sources -> Checker[Judegement] -> Problem
+                                                        with possible solution
+
+    Base id of standard checkers (used in msg and report ids):
+    01: base
+    02: classes
+    03: format
+    04: import
+    05: misc
+    06: variables
+    07: exceptions
+    08: similar
+    09: design_analysis
+    10: newstyle
+    11: typecheck
+    12: logging
+    13: string_format
+    14: string_constant
+    15: stdlib
+    16: python3
+    17: refactoring
+    18-50: not yet used: reserved for future internal checkers.
+    51-99: perhaps used: reserved for external checkers
+"""
+
+import collections.abc
+
+import iamraw
+
+
+class Checker:
+
+    def __init__(self, linter):
+        self.linter = linter
+
+    def problems(self) -> list[str]:
+        """Return list of implemented problems"""
+
+    def add_finding(
+        self,
+        location: iamraw.Location = None,
+        msgid: str = None,
+        confidence: float = None,
+    ):
+        self.linter.add_finding(location, msgid, confidence)
+
+    def open(self):
+        pass
+
+    def judge(self, *args) -> iamraw.Findings:
+        pass
+
+    def close(self):
+        pass
+
+
+def check_messages(*messages: str) -> collections.abc.Callable:
+    """decorator to store messages that are handled by a checker method"""
+
+    def store_messages(func):
+        func.checks_msgs = messages
+        return func
+
+    return store_messages

protoerror-3.20.2/protoerror/cli.py

@@ -0,0 +1,88 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2021-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import os
+import sys
+
+import serializeraw
+import utilo
+
+import protoerror
+
+
+@utilo.saveme
+def main():
+    inpath, outpath, pages, action = evaluate()
+    for path in inpath:
+        if not utilo.exists(path):
+            utilo.error(f'input does not exists: {path}')
+            return utilo.FAILURE
+    if not utilo.exists(outpath):
+        utilo.error(f'output does not exists: {outpath}')
+        return utilo.FAILURE
+    if action == 'optimize':
+        optimize(srcs=inpath, dest=outpath, pages=pages)
+        return utilo.SUCCESS
+    return utilo.INVALID_COMMAND
+
+
+def optimize(srcs: str, dest: str, pages: tuple = None, msgid: set = None):
+    findings = []
+    for src in srcs:
+        utilo.log(f'load findings from: {src}', preserve_newlines=False)
+    findings = serializeraw.findings_from_path(
+        path=srcs,
+        msgid=msgid,
+        pages=pages,
+    )
+    findings = utilo.flatten_content(findings)
+    dest = os.path.join(dest, '__optimized__')
+    os.makedirs(dest, exist_ok=True)
+    utilo.log(
+        f'write optimized findings to: {dest}',
+        preserve_newlines=False,
+    )
+    serializeraw.write_grouped(findings, dest=dest)
+
+
+def evaluate() -> tuple:
+    parser = utilo.cli.create_parser(
+        todo=[
+            utilo.cli.Flag(
+                longcut='optimize',
+                message='read findings and write to page dependent structure',
+            ),
+        ],
+        config=utilo.ParserConfiguration(
+            inputparameter=True,
+            outputparameter=True,
+            multiprocessed=False,
+            pages=True,
+            prefix=False,
+            verboseflag=True,
+            waitingflag=False,
+            cacheflag=False,
+        ),
+        version=protoerror.__version__,
+        prog='findings',
+    )
+    args = utilo.parse(parser)
+    action = ''
+    if args['optimize']:
+        action = 'optimize'
+    if not action:
+        utilo.error('nothing todo')
+        sys.exit(utilo.INVALID_COMMAND)
+    choice = (
+        args['input'],
+        args['output'],
+        utilo.parse_pages(','.join(args['pages'])),  # DIRTY
+        action,
+    )
+    return choice

protoerror-3.20.2/protoerror/config.py

@@ -0,0 +1,78 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2019-2022 by Helmut Konrad Fahrendholz. All rights reserved.
+# This file is property of Helmut Konrad Fahrendholz. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+"""Configuration
+=============
+
+.. code-block:: none
+
+    message:
+        id: str
+        active : bool
+        min_confidence: float
+
+example:
+
+
+"""
+
+import dataclasses
+
+import utilo
+
+
+@dataclasses.dataclass  # pylint:disable=R0903
+class MessageStatus:
+    """Configurate how and if the user see the message or it will
+    support the development only.
+
+    Example:
+        MessageStatus('F0000', True, 1.0)
+
+    The example above describe the pdf-read-error-message which is
+    raised if there is a problem with reading the document.
+    """
+    msgid: str
+    # The MessageStatus is active, so it will be provided to the user if
+    # it occurs
+    active: bool = False
+    # The `confidence` of 1.0 means that the message always is displayed
+    # if it occurs.
+    confidence: float = 1.0
+
+
+MessageStatusList = list[MessageStatus]
+
+
+def load(path: str) -> MessageStatusList:
+    loaded = utilo.yaml_load(path)
+    result = []
+    for item in loaded:
+        msgid = item.get('msgid')
+        active = item.get('active', False)
+        confidence = item.get('confidence', 0.0)
+        result.append(
+            MessageStatus(
+                msgid=msgid,
+                active=active,
+                confidence=confidence,
+            ))
+    return result
+
+
+def save(messages: MessageStatusList, path: str):
+    result = []
+    for item in messages:
+        raw = {'msgid': item.msgid}
+        if item.active:
+            raw['active'] = True
+        if item.confidence:
+            raw['confidence'] = item.confidence
+        result.append(raw)
+    dumped = utilo.yaml_dump(result)
+    utilo.file_create(path, dumped)