0LL13 / person

personroles/resources/helpers.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Helper functions: exceptions, print style, Party, ..."""

import random
from dataclasses import dataclass, field
from typing import List

from .constants import GERMAN_PARTIES  # type: ignore  # noqa


class NotInRange(Exception):
    """For state NRW only terms 14 to currently term 17 are accepted."""


class NotGermanParty(Exception):
    """Only German parties, this will most likely not change."""


class TooManyFirstNames(Exception):
    """
    Currently only one first name and two middle names are supported.
    Example: Tom H. Paul last_name
    """

    def __init__(self, message):
        """Usage: raise TooManyFirstNames ("message")."""
        Exception.__init__(self)
        print(message)


class AttrDisplay:
    """
    Mark Lutz, Programming Python
    Provides an inheritable display overload method that shows instances
    with their class names and a name=value pair for each attribute stored
    on the instance itself (but not attrs inherited from its classes). Can
    be mixed into any class, and will work on any instance.
    """

    def gather_attrs(self) -> list:
        """
        Check if attributes have content and add them to a list called attrs.
        """
        attrs = []
        for key in sorted(self.__dict__):
            if self.__dict__[key] and self.__dict__[key] not in [
                "unknown",

Wrong hanging indentation before block (add 4 spaces).

                "ew",

Wrong hanging indentation before block (add 4 spaces).

                None,

Wrong hanging indentation before block (add 4 spaces).

            ]:
                attrs.append(f"{key}={getattr(self, key)}")
        return attrs

    def __str__(self) -> str:
        """
        Instances will printed like this:
            class name
            attr1=value1
            attr2=value2
            ...
        """
        comp_repr = (
            f"{self.__class__.__name__}:\n"
            + "\n".join(str(attr) for attr in self.gather_attrs())
            + "\n"
        )
        return comp_repr


@dataclass

Class name "_Party_base" doesn't conform to PascalCase naming style ('[^\\W\\da-z][^\\W_]+$' pattern)

class _Party_base:
    """Name of party is required, surprisingly."""
    party_name: str  # type: ignore  # noqa


@dataclass

Class name "_Party_default" doesn't conform to PascalCase naming style ('[^\\W\\da-z][^\\W_]+$' pattern)

class _Party_default:
    """Party entry and exit are possible additions, if known."""
    party_entry: str = field(default="unknown")
    party_exit: str = field(default="unknown")


@dataclass
class Party(_Party_default, _Party_base, AttrDisplay):
    """Collect party name and entry/exit data."""
    def __post_init__(self):
        """Checking for German parties."""
        if self.party_name not in GERMAN_PARTIES:
            raise NotGermanParty


# https://codereview.stackexchange.com/questions/200355/generating-a-unique-key
def generate_unique_key():

Missing function or method docstring

    lst = list()
    for letter in range(97, 123):
        lst.append(chr(letter))
    for letter in range(65, 91):
        lst.append(chr(letter))
    for number in range(1, 10):
        lst.append(number)

    random_values = random.sample(lst, 5)
    print(random_values)
    random_values = map(lambda x: str(x), random_values)

This lambda might be unnecessary.

    return "".join(random_values)


@dataclass

Class name "_Session_base" doesn't conform to PascalCase naming style ('[^\\W\\da-z][^\\W_]+$' pattern)

class _Session_base:
    """Session minimum informations."""
    state: str
    term: str
    date: str
    protocol_nr: str


@dataclass

Class name "_Session_default" doesn't conform to PascalCase naming style ('[^\\W\\da-z][^\\W_]+$' pattern)

Too many instance attributes (9/7)

class _Session_default:
    """Session additional informations."""
    page_from: str = field(default="unknown")
    page_to: str = field(default="unknown")
    expletive: str = field(default="unknown")
    kind: str = field(default="unknown")
    result: str = field(default="unknown")
    classification: str = field(default="unknown")
    tags: List[str] = field(
        default_factory=lambda: []
    )  # noqa
    region: str = field(default="unknown")
    speakers: List[str] = field(
        default_factory=lambda: []
    )  # noqa


@dataclass
class Session(_Session_default, _Session_base, AttrDisplay):
    """A session's details."""


@dataclass

Class name "_Input_base" doesn't conform to PascalCase naming style ('[^\\W\\da-z][^\\W_]+$' pattern)

class _Input_base:
    """A member of parliament's contribution."""
    key: str