codey/discord-havoc
1
0
Fork 0
Code Issues Pull Requests Wiki Activity

clean docstrings for commands, resolves #1

Browse Source
This commit is contained in:
codey
2025-04-10 11:17:32 -04:00
parent 11ff1d6447
commit c7db52efde
5 changed files with 1 additions and 297 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
cogs/lovehate.py
View File

@@ -29,12 +29,6 @@ class LoveHate(commands.Cog):
async def loves(self, ctx, user: Optional[str] = None) -> None: async def loves(self, ctx, user: Optional[str] = None) -> None:
""" """
If keyword isn't provided, returns the things YOU love; specify a user to find what THEY love. If keyword isn't provided, returns the things YOU love; specify a user to find what THEY love.
Args:
ctx (Any)
user (Optional[str])
Returns:
None
""" """
try: try:
if not user: if not user:
@@ -68,12 +62,6 @@ class LoveHate(commands.Cog):
async def wholoves(self, ctx, *, thing: Optional[str] = None) -> None: async def wholoves(self, ctx, *, thing: Optional[str] = None) -> None:
""" """
Check who loves <thing> Check who loves <thing>
Args:
ctx (Any)
thing (Optional[str])
Returns:
None
""" """
try: try:
if not thing: if not thing:
@@ -118,12 +106,6 @@ class LoveHate(commands.Cog):
async def whohates(self, ctx, *, thing: Optional[str] = None) -> None: async def whohates(self, ctx, *, thing: Optional[str] = None) -> None:
""" """
Check who hates <thing> Check who hates <thing>
Args:
ctx (Any)
thing (Optional[str])
Returns:
None
""" """
try: try:
if not thing: if not thing:
@@ -167,12 +149,6 @@ class LoveHate(commands.Cog):
async def dontcare(self, ctx, thing: str) -> None: async def dontcare(self, ctx, thing: str) -> None:
""" """
Make me forget your opinion on <thing> Make me forget your opinion on <thing>
Args:
ctx (Any)
thing (str)
Returns:
None
""" """
try: try:
stop_caring: str = await self.db.update(ctx.author.display_name, stop_caring: str = await self.db.update(ctx.author.display_name,
@@ -186,12 +162,6 @@ class LoveHate(commands.Cog):
async def hates(self, ctx, user: Optional[str] = None) -> None: async def hates(self, ctx, user: Optional[str] = None) -> None:
""" """
If keyword isn't provided, returns the things YOU hate; specify a user to find what THEY hate. If keyword isn't provided, returns the things YOU hate; specify a user to find what THEY hate.
Args:
ctx (Any)
user (Optional[str])
Returns:
None
""" """
try: try:
if not user: if not user:
@@ -222,12 +192,6 @@ class LoveHate(commands.Cog):
async def love(self, ctx, *, thing: str) -> None: async def love(self, ctx, *, thing: str) -> None:
""" """
Love <thing> Love <thing>
Args:
ctx (Any)
thing (str)
Returns:
None
""" """
try: try:
if discord.utils.raw_mentions(thing): if discord.utils.raw_mentions(thing):
@@ -252,12 +216,6 @@ class LoveHate(commands.Cog):
async def hate(self, ctx, *, thing: str) -> None: async def hate(self, ctx, *, thing: str) -> None:
""" """
Hate <thing> Hate <thing>
Args:
ctx (Any)
thing (str)
Returns:
None
""" """
try: try:
if discord.utils.raw_mentions(thing): if discord.utils.raw_mentions(thing):

211
cogs/misc.py
View File

@@ -109,11 +109,6 @@ class Misc(commands.Cog):
async def stats(self, ctx) -> None: async def stats(self, ctx) -> None:
""" """
Get Stats Get Stats
Args:
ctx (Any)
Returns:
None
""" """
try: try:
stats_embed: Optional[discord.Embed] = await self.util.get_stats_embed() stats_embed: Optional[discord.Embed] = await self.util.get_stats_embed()
@@ -129,11 +124,6 @@ class Misc(commands.Cog):
async def listcoffees(self, ctx) -> None: async def listcoffees(self, ctx) -> None:
""" """
List Available Coffees List Available Coffees
Args:
ctx (Any)
Returns:
None
""" """
coffees: str = "" coffees: str = ""
try: try:
@@ -151,11 +141,6 @@ class Misc(commands.Cog):
async def listshoves(self, ctx) -> None: async def listshoves(self, ctx) -> None:
""" """
List Available Fates for shove command List Available Fates for shove command
Args:
ctx (Any)
Returns:
None
""" """
fates: str = "" fates: str = ""
try: try:
@@ -173,11 +158,6 @@ class Misc(commands.Cog):
async def xmas(self, ctx) -> None: async def xmas(self, ctx) -> None:
""" """
Countdown til xmas! Countdown til xmas!
Args:
ctx (Any)
Returns:
None
""" """
try: try:
emojis: dict = { emojis: dict = {
@@ -218,11 +198,6 @@ class Misc(commands.Cog):
async def randfact(self, ctx) -> None: async def randfact(self, ctx) -> None:
""" """
Get a random (useless) fact! Get a random (useless) fact!
Args:
ctx (Any)
Returns:
None
""" """
try: try:
with ctx.channel.typing(): with ctx.channel.typing():
@@ -238,12 +213,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Insult Someone (or yourself) Insult Someone (or yourself)
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
try: try:
guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id) guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id)
@@ -279,13 +248,6 @@ class Misc(commands.Cog):
language: Optional[str] = 'en') -> None: language: Optional[str] = 'en') -> None:
""" """
Compliment someone (or yourself) Compliment someone (or yourself)
Args:
ctx (Any)
recipient (Optional[str])
language (Optional[str]) (default: 'en')
Returns:
None
""" """
try: try:
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
@@ -320,12 +282,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Get a whisky for yourself or a friend! Get a whisky for yourself or a friend!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
try: try:
if not recipient: if not recipient:
@@ -364,12 +320,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Get a cocktail for yourself or a friend! Get a cocktail for yourself or a friend!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
try: try:
if not recipient: if not recipient:
@@ -412,12 +362,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Spray someone with water! Spray someone with water!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -452,12 +396,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Pass someone (or yourself) a barf bag! Pass someone (or yourself) a barf bag!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -492,11 +430,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Tea! Tea!
Args:
recipient (Optional[str])
Returns:
None
""" """
tea: str = "a cup of tea" tea: str = "a cup of tea"
@@ -548,12 +481,6 @@ class Misc(commands.Cog):
message: str) -> None: message: str) -> None:
""" """
Cowsay! Cowsay!
Args:
ctx (Any)
message (str)
Returns:
None
""" """
try: try:
cowfile: str = random.choice(self.COWS).replace(".cow", "") cowfile: str = random.choice(self.COWS).replace(".cow", "")
@@ -571,11 +498,6 @@ class Misc(commands.Cog):
cowfile: Optional[str] = None) -> None: cowfile: Optional[str] = None) -> None:
""" """
Fortune | Cowsay! Fortune | Cowsay!
Args:
cowfile (Optional[str])
Returns:
None
""" """
try: try:
if not cowfile: if not cowfile:
@@ -597,11 +519,6 @@ class Misc(commands.Cog):
async def listcows(self, ctx) -> None: async def listcows(self, ctx) -> None:
""" """
List available .cow files (for cowsay) List available .cow files (for cowsay)
Args:
ctx (Any)
Returns:
None
""" """
cow_list: str = "" cow_list: str = ""
try: try:
@@ -621,12 +538,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Cyanide! Cyanide!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -667,12 +578,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
School gravy! (It's deadly) School gravy! (It's deadly)
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -713,12 +618,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Cold water! Drink up. Cold water! Drink up.
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -758,12 +657,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Shove someone! (Or yourself) Shove someone! (Or yourself)
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
chosen_fate: str = random.choice(self.FATES) chosen_fate: str = random.choice(self.FATES)
@@ -800,12 +693,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Coffee! Coffee!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
recipient_allergic: bool = False recipient_allergic: bool = False
@@ -853,12 +740,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Cookies! Cookies!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -898,12 +779,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Hashbrowns! Hashbrowns!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -938,12 +813,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Ritalini! Ritalini!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -980,12 +849,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Grilled Cheese! Grilled Cheese!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -1020,12 +883,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Soup! Soup!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -1060,12 +917,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Muffins! Muffins!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -1105,12 +956,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Bacon! Bacon!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -1150,12 +995,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Hang someone! Hang someone!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -1196,12 +1035,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Touch someone! Touch someone!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id) guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id)
if not guild: if not guild:
@@ -1249,11 +1082,6 @@ class Misc(commands.Cog):
async def qajoke(self, ctx) -> None: async def qajoke(self, ctx) -> None:
""" """
Get a joke in Q/A Form! Get a joke in Q/A Form!
Args:
ctx (Any)
Returns:
None
""" """
try: try:
qajoke: Optional[tuple] = await self.util.get_qajoke() qajoke: Optional[tuple] = await self.util.get_qajoke()
@@ -1273,11 +1101,6 @@ class Misc(commands.Cog):
async def rjoke(self, ctx) -> None: async def rjoke(self, ctx) -> None:
""" """
Get a joke! (from r/jokes scrape) Get a joke! (from r/jokes scrape)
Args:
ctx (Any)
Returns;
None
""" """
try: try:
rjoke: Optional[tuple] = await self.util.get_rjoke() rjoke: Optional[tuple] = await self.util.get_rjoke()
@@ -1300,12 +1123,6 @@ class Misc(commands.Cog):
recipient: Optional[str] = None) -> None: recipient: Optional[str] = None) -> None:
""" """
Joints! Joints!
Args:
ctx (Any)
recipient (Optional[str])
Returns:
None
""" """
authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\ authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
else ctx.message.author.display_name else ctx.message.author.display_name
@@ -1348,11 +1165,6 @@ class Misc(commands.Cog):
async def isitfriday(self, ctx) -> None: async def isitfriday(self, ctx) -> None:
""" """
IS IT FRIDAY!? IS IT FRIDAY!?
Args:
ctx (Any)
Returns:
None
""" """
try: try:
today: datetime.datetime = datetime.datetime.today() today: datetime.datetime = datetime.datetime.today()
@@ -1369,11 +1181,6 @@ class Misc(commands.Cog):
async def isitflyday(self, ctx) -> None: async def isitflyday(self, ctx) -> None:
""" """
IS IT FLYDAY!? IS IT FLYDAY!?
Args:
ctx (Any)
Returns:
None
""" """
try: try:
today: datetime.datetime = datetime.datetime.today() today: datetime.datetime = datetime.datetime.today()
@@ -1395,12 +1202,6 @@ class Misc(commands.Cog):
term: str) -> None: term: str) -> None:
""" """
Not sure what that term means? UD prolly knows. Not sure what that term means? UD prolly knows.
Args:
ctx (Any)
term (str)
Returns:
None
""" """
try: try:
with ctx.channel.typing(): with ctx.channel.typing():
@@ -1421,12 +1222,6 @@ class Misc(commands.Cog):
async def joint_context_menu(self, ctx, member: discord.Member) -> None: async def joint_context_menu(self, ctx, member: discord.Member) -> None:
""" """
Joint Context Menu Joint Context Menu
Args:
ctx (Any)
member (discord.Member)
Returns:
None
""" """
strain: Optional[tuple] = await self.util.get_strain() strain: Optional[tuple] = await self.util.get_strain()
if not strain: if not strain:
@@ -1443,12 +1238,6 @@ class Misc(commands.Cog):
async def coffee_context_menu(self, ctx, member: discord.Member) -> None: async def coffee_context_menu(self, ctx, member: discord.Member) -> None:
""" """
Coffee Context Menu Coffee Context Menu
Args:
ctx (Any)
member (discord.Member)
Returns:
None
""" """
recipient_allergic: bool = False recipient_allergic: bool = False
if member.id in [898332028007751741]: if member.id in [898332028007751741]:

28
cogs/owner.py
View File

@@ -20,12 +20,6 @@ class Owner(commands.Cog):
async def temperature(self, ctx, temp: Optional[int|str] = None) -> None: async def temperature(self, ctx, temp: Optional[int|str] = None) -> None:
""" """
Set Temperature Set Temperature
Args:
ctx (Any): Discord context
temperature (Optional[int|str]): New temperature
Returns:
None
""" """
if not temp: if not temp:
return await ctx.respond(f"The current temperature is: {self._temperature} °C") return await ctx.respond(f"The current temperature is: {self._temperature} °C")
@@ -52,11 +46,6 @@ class Owner(commands.Cog):
) -> None: ) -> None:
""" """
Edit a message previously sent by the bot Edit a message previously sent by the bot
Args:
ctx (Any): Discord context
msgid (str): Should be an int, the message id to edit
newcontent (str): Content to replace message with
""" """
try: try:
@@ -76,11 +65,6 @@ class Owner(commands.Cog):
async def reload(self, ctx) -> None: async def reload(self, ctx) -> None:
""" """
Reload Cogs Reload Cogs
Args:
ctx (Any): Discord context
Returns:
None
""" """
self.bot.load_exts(False) self.bot.load_exts(False)
@@ -93,12 +77,6 @@ class Owner(commands.Cog):
parameters: str) -> None: parameters: str) -> None:
""" """
Make me say something in a channel Make me say something in a channel
Args:
ctx (Any): Discord context
parameters (str): Channel <space> Message
Returns:
None
""" """
_parameters: list[str] = parameters.split(" ") _parameters: list[str] = parameters.split(" ")
@@ -120,12 +98,6 @@ class Owner(commands.Cog):
status: Optional[str] = None) -> None: status: Optional[str] = None) -> None:
""" """
Change bots status Change bots status
Args:
ctx (Any): Discord context
status (Optional[str]): The new status to set
Returns:
None
""" """
if not status: if not status:
return await ctx.respond("ERR: No status provided to change to!", return await ctx.respond("ERR: No status provided to change to!",

9
cogs/radio.py
View File

@@ -41,11 +41,6 @@ class Radio(commands.Cog):
async def reinitradio(self, ctx) -> None: async def reinitradio(self, ctx) -> None:
""" """
Reinitialize serious.FM Reinitialize serious.FM
Args:
ctx (Any): Discord context
Returns:
None
""" """
loop: discord.asyncio.AbstractEventLoop = self.bot.loop loop: discord.asyncio.AbstractEventLoop = self.bot.loop
loop.create_task(self.radio_init()) loop.create_task(self.radio_init())
@@ -121,10 +116,6 @@ class Radio(commands.Cog):
async def skip(self, ctx) -> None: async def skip(self, ctx) -> None:
""" """
Skip - Convenience Command Skip - Convenience Command
Args:
ctx (Any)
Returns:
None
""" """
await skip() await skip()

6
cogs/sing.py
View File

@@ -38,12 +38,6 @@ class Sing(commands.Cog):
song: Optional[str] = None) -> None: song: Optional[str] = None) -> None:
""" """
Search for lyrics, format is artist : song. Also reads activity. Search for lyrics, format is artist : song. Also reads activity.
Args:
ctx (Any): Discord context
song (Optional[str]): Song to search
Returns:
None
""" """
try: try:
with ctx.channel.typing(): with ctx.channel.typing():