protoerror 3.20.2__py3-none-any.whl

protoerror/question.py

@@ -0,0 +1,138 @@
+# =============================================================================
+# 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.
+# =============================================================================
+
+import dataclasses
+import enum
+import re
+
+import iamraw
+import utilo
+
+import protoerror
+
+QUESTION_PATTERN = r'^QUESTION_(?P<number>\d{2,5})$'
+
+
+class Answer(enum.Enum):
+    OPEN = enum.auto()
+    YES = enum.auto()
+    NO = enum.auto()
+    UNDECIDED = enum.auto()
+
+
+class Action(enum.Enum):
+    PAGE = enum.auto()
+    DOCU = enum.auto()
+
+
+@dataclasses.dataclass(unsafe_hash=True)
+class Question(iamraw.Solution):
+    msgid: str = None
+    title: str = None
+    description: str = None
+    status: Answer = Answer.OPEN
+
+    action: Action = None
+    finding: int = None
+    yes: callable = None
+    no: callable = None
+
+
+Questions = list[Question]
+
+
+def parse_questions(module) -> Questions:
+    if isinstance(module, str):
+        module = protoerror.utils.module_fromname(module)
+    enabler = parse_enabler(module)
+    result = []
+    for name, value in vars(module).items():
+        matched = re.match(QUESTION_PATTERN, name)
+        if not matched:
+            continue
+        number = matched['number']
+        try:
+            title, message = value.split('\n\n', maxsplit=1)
+        except ValueError:
+            title, message = value.strip(), ''
+        item = protoerror.Question(
+            title=title,
+            msgid=number,
+            description=message,
+        )
+        try:
+            selected = enabler[number]
+        except KeyError:
+            pass
+        else:
+            item.action = selected[0]
+            item.finding = selected[1]
+            item.yes = selected[2]
+            item.no = selected[3]  # pylint:disable=C0103
+
+        result.append(item)
+    # sort ascending
+    result.sort(key=lambda x: x.msgid)
+    return result
+
+
+ENABLE_PATTERN = r'^QUESTION_(?P<number>\d{2,5})_ENABLE$'
+
+
+def parse_enabler(module) -> int:
+    result = {}
+    for name, value in vars(module).items():
+        matched = re.match(ENABLE_PATTERN, name)
+        if not matched:
+            continue
+        number = matched['number']
+        result[number] = value
+    return result
+
+
+def pagemore(finding_count: int, yes: callable = None, no: callable = None):
+    return (Action.PAGE, finding_count, yes, no)
+
+
+def documore(finding_count: int, yes: callable = None, no: callable = None):
+    return (Action.DOCU, finding_count, yes, no)
+
+
+def answer_questions(path: str, questions: Questions) -> iamraw.Findings:
+    findings = [item.content for item in protoerror.findings_from_path(path)]
+    findings = utilo.flat(findings)
+    grouped = protoerror.byid(findings)
+    result = []
+    for question in questions:
+        try:
+            selected = grouped[question.msgid]
+        except KeyError:
+            # no potential message available
+            continue
+        if question.action == Action.PAGE:
+            bypage = protoerror.bypage(selected)
+            for paged in bypage:
+                if len(paged.content) < question.finding:
+                    continue
+                solution = iamraw.Finding(
+                    location=iamraw.Location.from_page(paged.page),
+                    msgid=question.msgid,
+                    solution=question,
+                )
+                result.append(solution)
+        elif question.action == Action.DOCU:
+            if len(selected) < question.finding:
+                continue
+            solution = iamraw.Finding(
+                location=protoerror.OVERVIEW,
+                msgid=question.msgid,
+                solution=question,
+            )
+            result.append(solution)
+    return result

protoerror/report.py

@@ -0,0 +1,210 @@
+# =============================================================================
+# 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.
+# =============================================================================
+"""Report Solution
+===============
+
+example
+-------
+
+.. code-block::none
+
+    <<titlepage>>
+    ~7777:headline~
+    ...
+    ...
+    ...
+    ~7779:next headline~
+    ...
+    ...
+    ...
+    <<bibliography>>
+
+cli
+---
+
+decider show list [--short]
+        show titlepage
+        show 7777
+
+"""
+
+import functools
+import importlib
+import os
+import sys
+import textwrap
+
+import utilo
+
+import protoerror
+
+
+def integrate(root: str, features: str):
+    hook = integrate_cli
+    run_ = functools.partial(run, root=root, features=features)
+    return hook, run_
+
+
+def show_list(root, features, short: bool = False):
+    print_features(root, features, choice=None, short=short)
+
+
+def show_feature(root, features, choice, short: bool = False):
+    print_features(root, features, choice, short)
+
+
+def show_solution(root, features, choice, short: bool = False):
+    parsed = parse_features(root, features)
+    if not parsed:
+        return
+    parsed = [(checkers, solutions) for (_, (checkers, solutions)) in parsed]
+    for checkers, solutions in parsed:
+        for check in sorted(checkers):
+            if check != choice:
+                continue
+            print_solution(check, solutions, short=short, single=True)
+            return
+    utilo.error(f'could not find solution: {choice}')
+
+
+def print_features(root, features, choice, short: bool = False):
+    parsed = parse_features(root, features)
+    if not parsed:
+        return
+    hit = False
+    for title, (checkers, solutions) in parsed:
+        if choice and title != choice:
+            continue
+        hit = True
+        utilo.log(f'<<{title}>>')
+        for check in sorted(checkers):
+            print_solution(check, solutions, short=short)
+        utilo.log()
+    if not hit:
+        utilo.error(f'could not find feature: {choice}')
+        sys.exit(utilo.FAILURE)
+
+
+def print_solution(
+    check,
+    solutions,
+    *,
+    short: bool = False,
+    single: bool = False,
+):
+    indent = '\t' if short and not single else ''
+    try:
+        title, description = solutions[check]
+    except KeyError:
+        utilo.log(f'{indent}~{check}:NO_SOLUTION~')
+        return
+    if single:
+        utilo.log(title)
+    else:
+        utilo.log(f'{indent}~{check}:{title}~')
+    if single:
+        utilo.log()
+    if not short:
+        prefix = '\t' if not single else ''
+        utilo.log(textwrap.indent(description.strip(), prefix))
+        utilo.log()
+
+
+def run(args, root, features):
+    if 'show' not in args:
+        return
+    assert os.path.exists(root), str(root)
+    choice = args['show']
+    short = args.get('short', False)
+    if 'list' in choice:
+        show_list(root, features, short=short)
+    elif utilo.isnumber(choice):
+        choice = int(choice)
+        show_solution(root, features, choice, short=short)
+    else:
+        show_feature(root, features, choice)
+    sys.exit(utilo.SUCCESS)
+
+
+def integrate_cli(parser):
+    sub = parser.add_subparsers(help='show additional linter information')
+    show = sub.add_parser('show')
+    show.add_argument('show', nargs='?', default='list')
+    show.add_argument('--short', action='store_true', help='display fewer content') # yapf:disable
+
+
+def parse_features(root: str, features: str):
+    if isinstance(features, str):
+        features = [features]
+    collected = [parse_python(root, feature) for feature in features]
+    result = []
+    for collect in collected:
+        for (name, item) in collect:
+            parsed = parse_feature(item.__name__)
+            if parsed is None:
+                continue
+            result.append((name, parsed))
+    result = sorted(result, key=lambda x: x[0])
+    if not result:
+        return result
+    # merge duplicated groups to single group
+    grouped = [result[0]]
+    for name, data in result[1:]:
+        before = grouped[-1]
+        if name == before[0]:
+            # add before
+            before[1][0].extend(data[0])
+            before[1][1].update(data[1])
+        else:
+            # new group
+            grouped.append((name, data))
+    return grouped
+
+
+def parse_python(root: str, feature: str) -> list:
+    """Load python code from path."""
+    # TODO: THERE MUST BE A BETTER WAY
+    collected = [
+        item.replace('.py', '')
+        for item in os.listdir(os.path.join(root, feature.replace('.', '/')))
+        if '__init__' not in item and item.endswith('.py')
+    ]
+    result = []
+    for item in collected:
+        current = importlib.import_module(
+            feature + '.' + item,
+            feature,
+        )
+        result.append((item, current))
+    return result
+
+
+def parse_feature(path: str):
+    # assert os.path.exists(path), str(path)
+    checkers = protoerror.parse_checkers(path)
+    checkers = [item.msgid for item in checkers]
+    solutions = protoerror.parse_solutions(path)
+    solutions = {
+        msgid(item.msgid): (item.title, item.description) for item in solutions
+    }
+    if not checkers and not solutions:
+        return None
+    return checkers, solutions
+
+
+def msgid(item: str) -> int:
+    """\
+    >>> msgid('W1020')
+    1020
+    >>> msgid('333')
+    333
+    """
+    if item[0].isalpha():
+        return int(item[1:])
+    return int(item)

protoerror/report_parser.py

@@ -0,0 +1,58 @@
+# =============================================================================
+# 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 collections
+import re
+
+Step = collections.namedtuple('Step', 'msgid title description')
+Steps = list[Step]
+Feature = collections.namedtuple('Feature', 'title solutions')
+Report = collections.namedtuple('Report', 'name features')
+Reports = list[Report]
+
+TITLE = re.compile(r'^<<(?P<title>.+)>>\n', re.MULTILINE)
+HEADLINE = re.compile(r'~(?P<id>\d{2,6}):(?P<headline>.+?)~\n')
+
+
+def parses(content: str, name: str = '', active: set = None) -> Report:
+    splitted = TITLE.split(content)
+    splitted = [item for item in splitted if item]
+    features = []
+    for title, area in xsome(splitted, count=2):
+        solutions = parse_steps(area.strip(), active=active)
+        if not solutions:
+            continue
+        features.append(Feature(title=title, solutions=solutions))
+    result = Report(name=name, features=features)
+    return result
+
+
+def parse_steps(content: str, active: set = None) -> Steps:
+    splitted = HEADLINE.split(content)
+    splitted = [item for item in splitted if item]
+    result = []
+    for msgid, headline, description in xsome(splitted, count=3):
+        msgid = int(msgid)
+        if active and msgid not in active:
+            # skip solution if solution is not selected
+            continue
+        description = description.strip()
+        result.append(Step(msgid, headline, description))
+    return result
+
+
+def xsome(items, count: 1):
+    # TODO: MOVE TO UTILA
+    collected = []
+    for item in items:
+        collected.append(item)
+        if len(collected) != count:
+            continue
+        yield collected
+        collected = []

protoerror/simple.py

@@ -0,0 +1,85 @@
+# =============================================================================
+# 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.
+# =============================================================================
+
+import functools
+
+import iamraw
+import utilo
+
+import protoerror
+
+ResultType = tuple[str, str]
+ResultDefault = ('user', 'developer')  # pylint:disable=C0103
+
+
+def run(
+    modulename,
+    driver=None,
+    location: iamraw.Location = None,
+    document: iamraw.DocInfo = None,
+    findings_merge: bool = True,
+    before_dump: callable = None,
+):
+    if not location:
+        location = protoerror.OVERVIEW
+    # create linter
+    linter = protoerror.from_modules(
+        modules=modulename,
+        document=document,
+    )
+    # run linter
+    result = linting(
+        linter=linter,
+        checkers=linter.checkers,
+        driver=driver,
+        location=location,
+    )
+    if findings_merge:
+        result = protoerror.merge_findings(result)
+    if before_dump:
+        result = utilo.pass_required(
+            before_dump,
+            result=result,
+            driver=driver,
+            linter=linter,
+        )
+    # dump results
+    user, developer = protoerror.dump_result(
+        result,
+        checkers=linter.checkers,
+    )
+    return user, developer
+
+
+def linting(
+    linter: protoerror.Linter,
+    checkers: 'protoerror.Validators',
+    driver,
+    location: iamraw.Location,
+):
+    failure = []
+    for checker in checkers:
+        utilo.debug(checker.__name__)
+        call = functools.partial(
+            linter.add_finding,
+            msgid=checker.msgid,
+            location=location,
+        )
+        try:
+            checker(call, driver)
+        except Exception as error:  # pylint:disable=broad-except
+            utilo.error(error)
+            failure.append(error)
+        else:
+            utilo.debug('done')
+    if failure:
+        first_failure = failure[0]
+        raise RuntimeError('linter step error') from first_failure
+    result = linter.result(unique=True)
+    return result