mandos.entries.abstract_entries

Complexity

Total Complexity

15

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	Entry._get_searcher()	0	8	1
A	Entry.cmd()	0	8	4
A	Entry._run()	0	20	2
A	Entry.describe()	0	4	1
A	Entry.run()	0	3	1
A	Entry._get_default_key()	0	8	2
A	Entry.get_search_type()	0	4	1
A	Entry.test()	0	3	1
A	Entry.default_param_values()	0	6	2

import abc

Missing module docstring

from pathlib import Path
from typing import Generic, Type, Optional, Mapping, Union

import typer

Unable to import 'typer'

from typer.models import OptionInfo

Unable to import 'typer.models'

from mandos import MANDOS_SETUP, logger
from mandos.entries.entries import S
from mandos.entries.searcher import Searcher
from mandos.model.searches import Search
from mandos.model.utils import ReflectionUtils


class Entry(Generic[S], metaclass=abc.ABCMeta):

Missing class docstring

    @classmethod
    def cmd(cls) -> str:

Missing function or method docstring

        key = cls._get_default_key()
        if isinstance(key, typer.models.OptionInfo):
            key = key.default
        if key is None or not isinstance(key, str):
            raise AssertionError(f"Key for {cls.__name__} is {key}")
        return key

    @classmethod
    def describe(cls) -> str:

Missing function or method docstring

        lines = [line.strip() for line in cls.run.__doc__.splitlines() if line.strip() != ""]
        return lines[0]

    @classmethod
    def run(cls, path: Path, **params) -> None:

Missing function or method docstring

        raise NotImplementedError()

    @classmethod
    def get_search_type(cls) -> Type[S]:

Missing function or method docstring

        # noinspection PyTypeChecker
        return ReflectionUtils.get_generic_arg(cls, Search)

    # noinspection PyUnusedLocal
    @classmethod
    def test(cls, path: Path, **params) -> None:

Missing function or method docstring

        cls.run(path, **{**params, **dict(check=True)})

    @classmethod
    def _run(

Too many arguments (9/5)

Argument name "to" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        cls,

Wrong hanging indentation before block (add 4 spaces).

        built: S,

Wrong hanging indentation before block (add 4 spaces).

        path: Path,

Wrong hanging indentation before block (add 4 spaces).

        to: Optional[Path],

Wrong hanging indentation before block (add 4 spaces).

        check: bool,

Wrong hanging indentation before block (add 4 spaces).

        log: Optional[Path],

Wrong hanging indentation before block (add 4 spaces).

        quiet: bool,

Wrong hanging indentation before block (add 4 spaces).

        verbose: bool,

Wrong hanging indentation before block (add 4 spaces).

        no_setup: bool,

Wrong hanging indentation before block (add 4 spaces).

    ):
        MANDOS_SETUP(verbose, quiet, log, no_setup)
        searcher = cls._get_searcher(built, path, to)
        logger.notice(f"Searching {built.key} [{built.search_class}] on {path}")
        out = searcher.output_paths[built.key]
        if not check:
            searcher.search()
        logger.notice(f"Done! Wrote to {out}")
        return searcher

    @classmethod
    def _get_searcher(

Argument name "to" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        cls,

Wrong hanging indentation before block (add 4 spaces).

        built: S,

Wrong hanging indentation before block (add 4 spaces).

        path: Path,

Wrong hanging indentation before block (add 4 spaces).

        to: Optional[Path],

Wrong hanging indentation before block (add 4 spaces).

    ):
        return Searcher([built], [to], path)

    @classmethod
    def default_param_values(cls) -> Mapping[str, Union[str, float, int, Path]]:

Missing function or method docstring

        return {
            param: (value.default if isinstance(value, OptionInfo) else value)
            for param, value in ReflectionUtils.default_arg_values(cls.run).items()
            if param not in {"key", "path"}
        }

    @classmethod
    def _get_default_key(cls) -> str:
        vals = ReflectionUtils.default_arg_values(cls.run)
        try:
            return vals["key"]
        except KeyError:
            logger.error(f"key not in {vals.keys()} for {cls.__name__}")
            raise


__all__ = ["Entry"]