Skip to content

Check: is_admin #103

Description

@PenguinBoi12

Users have to implement manually a check to verify if a user performing a command is an admin. Since it's a common pattern, we should implement a check for that in checks.py.

Proposed API

def is_admin() -> Callable:
    async def _is_admin(ctx: Context) -> bool:
        ...

    def wrapper(cmd: Command) -> Command:
        cmd.check(_is_admin)

Example

from matrix.checks import is_admin

@is_admin()
@bot.command()
async def kick(ctx, user: str) -> None:

Before opening a PR

  • Write unit tests
  • Run mypy
  • Run pytest tests/
  • Run black .

Metadata

Metadata

Assignees

No one assigned

    Labels

    Fields

    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions