Skip to main content

A module which implements various new decorators to check for certain conditions in your discord commands

Project description

discord-ext-check is a module which implements various decorator functions, to be used on discord command functions for your DiscordPY bot

Installation:

Installation is done using pip:

Usage:

Starting off, import discord.ext.check and then you can use its various decorator functions.

Examples:

from discord.ext import check

#.. Creating your Discord Bot ...

"""Checking if the author is the Server Owner"""
@bot.command()
@check.is_guild_owner()
async def foo(ctx):
    await ctx.send(f"{ctx.author.mention} is the Server Owner!")

"""Checking if 3 arguments were passed into the function"""
@bot.command()
@check.has_args(3)
async def bar(ctx, x, y):
    await ctx.send(f"The result is {x + y}")

"""Error Handling"""
@bar.error
async def bar_error(ctx, error):
    if isinstance(error, check.NotEnoughArgs):
        await ctx.send("You have to Enter 3 Arguments (ctx, x, and y) for the command to work")
    else:
        raise error

"""Checking if the author's id is in the list of Authorized Members"""
authorized_members = [394320584089010179, 446670262440820746, 449864700306522112]

@bot.command()
@check.has_user_id_in(authorized_members)
async def baz(ctx):
    await ctx.send("You are an Authorized Member.")

"""Error Handling"""
@baz.error
async def baz_error(ctx, error):
    if isinstance(error, check.MissingID):
        await ctx.send("You are not Authorized.")
    else:
        raise error

bot.run(token)

Notes:

  • A Documentation for this module will be coming soon..

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

discord-ext-check-0.1.tar.gz (3.4 kB view details)

Uploaded Source

File details

Details for the file discord-ext-check-0.1.tar.gz.

File metadata

  • Download URL: discord-ext-check-0.1.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for discord-ext-check-0.1.tar.gz
Algorithm Hash digest
SHA256 1fb4f2d9e7b504a812d09d7e301b8cd9b6de57e4c8371bed2481cb001bb39e5f
MD5 beba47a03dce310d2de161e352058296
BLAKE2b-256 416891b5045c5f6f9c43e547b5d2b02905d448ecb4d14201eeb9c13c70c38593

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page