pincer.commands.groups

Complexity

Total Complexity

4

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	Group.__init__()	0	3	1
A	SubGroup.__hash__()	0	2	1
A	SubGroup.__init__()	0	4	1
A	Group.__hash__()	0	2	1

# Copyright Pincer 2021-Present

Missing module docstring

# Full MIT License can be found in `LICENSE` at the project root.

from typing import Optional


class Group:
    """
    The group object represents a group that commands can be in. This is always a top
    level command.

    .. code-block:: python

        class Bot:

            group = Group("cool_commands")

            @command(parent=group)
            def a_very_cool_command():
                pass

    This code creates a command called ``cool_commands`` with the subcommand
    ``a_very_cool_command``

    Parameters
    ----------
    name : str
        The name of the command group.
    description : Optional[str]
        The description of the command. This has to be sent to Discord but it does
        nothing so it is optional.
    """

    def __init__(self, name: str, description: Optional[str] = None):
        self.name = name
        self.description = description

    def __hash__(self):
        return hash(self.name)


class SubGroup:
    """
    A sub group of commands. This allows you to create subcommands inside of a
    subcommand-group.

    .. code-block:: python

        class Bot:

            group = Group("cool_commands")
            sub_group = SubGroup("group_of_cool_commands")

            @command(parent=sub_group)
            def a_very_cool_command():
                pass

    This code creates a command called ``cool_commands`` with the subcommand-group
    ``group_of_cool_commands`` that has the subcommand ``a_very_cool_command``.

    Parameters
    ----------
    name : str
        The name of the command sub-group.
    parent : :class:`~pincer.commands.groups.Group`
        The parent group of this command.
    description : Optional[str]
        The description of the command. This has to be sent to Discord but it does
        nothing so it is optional.
    """

    def __init__(self, name: str, parent: Group, description: Optional[str] = None):
        self.name = name
        self.parent = parent
        self.description = description

    def __hash__(self):
        return hash(self.name)