aboutsummaryrefslogtreecommitdiffstats
path: root/bot/utils/__init__.py
blob: 8184be824c8ab115df791fe5a3867371fd71c89c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
from abc import ABCMeta
from typing import Any, Generator, Hashable, Iterable

from discord.ext.commands import CogMeta


class CogABCMeta(CogMeta, ABCMeta):
    """Metaclass for ABCs meant to be implemented as Cogs."""

    pass


class CaseInsensitiveDict(dict):
    """
    We found this class on StackOverflow. Thanks to m000 for writing it!

    https://stackoverflow.com/a/32888599/4022104
    """

    @classmethod
    def _k(cls, key: Hashable) -> Hashable:
        """Return lowered key if a string-like is passed, otherwise pass key straight through."""
        return key.lower() if isinstance(key, str) else key

    def __init__(self, *args, **kwargs):
        super(CaseInsensitiveDict, self).__init__(*args, **kwargs)
        self._convert_keys()

    def __getitem__(self, key: Hashable) -> Any:
        """Case insensitive __setitem__."""
        return super(CaseInsensitiveDict, self).__getitem__(self.__class__._k(key))

    def __setitem__(self, key: Hashable, value: Any):
        """Case insensitive __setitem__."""
        super(CaseInsensitiveDict, self).__setitem__(self.__class__._k(key), value)

    def __delitem__(self, key: Hashable) -> Any:
        """Case insensitive __delitem__."""
        return super(CaseInsensitiveDict, self).__delitem__(self.__class__._k(key))

    def __contains__(self, key: Hashable) -> bool:
        """Case insensitive __contains__."""
        return super(CaseInsensitiveDict, self).__contains__(self.__class__._k(key))

    def pop(self, key: Hashable, *args, **kwargs) -> Any:
        """Case insensitive pop."""
        return super(CaseInsensitiveDict, self).pop(self.__class__._k(key), *args, **kwargs)

    def get(self, key: Hashable, *args, **kwargs) -> Any:
        """Case insensitive get."""
        return super(CaseInsensitiveDict, self).get(self.__class__._k(key), *args, **kwargs)

    def setdefault(self, key: Hashable, *args, **kwargs) -> Any:
        """Case insensitive setdefault."""
        return super(CaseInsensitiveDict, self).setdefault(self.__class__._k(key), *args, **kwargs)

    def update(self, E: Any = None, **F) -> None:
        """Case insensitive update."""
        super(CaseInsensitiveDict, self).update(self.__class__(E))
        super(CaseInsensitiveDict, self).update(self.__class__(**F))

    def _convert_keys(self) -> None:
        """Helper method to lowercase all existing string-like keys."""
        for k in list(self.keys()):
            v = super(CaseInsensitiveDict, self).pop(k)
            self.__setitem__(k, v)


def chunks(iterable: Iterable, size: int) -> Generator[Any, None, None]:
    """
    Generator that allows you to iterate over any indexable collection in `size`-length chunks.

    Found: https://stackoverflow.com/a/312464/4022104
    """
    for i in range(0, len(iterable), size):
        yield iterable[i:i + size]