diff --git a/cogs/ae7qcog.py b/cogs/ae7qcog.py index c4d67e8..4304895 100644 --- a/cogs/ae7qcog.py +++ b/cogs/ae7qcog.py @@ -13,28 +13,29 @@ KE8FGB: assigned once, no restrictions NA2AAA: unassigned, no records """ +from datetime import datetime + import discord import discord.ext.commands as commands -from datetime import datetime from bs4 import BeautifulSoup import aiohttp class AE7QCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") @commands.group(name="ae7q", aliases=["ae"]) - async def _ae7q_lookup(self, ctx): + async def _ae7q_lookup(self, ctx: commands.Context): '''Look up a callsign, FRN, or Licensee ID on ae7q.com''' if ctx.invoked_subcommand is None: await ctx.send('Invalid ae7q command passed\nPossible commands:' + '`call`, `frn`, `lic` or `licensee`.') @_ae7q_lookup.command(name="call") - async def _ae7q_call(self, ctx, callsign: str): + async def _ae7q_call(self, ctx: commands.Context, callsign: str): callsign = callsign.upper() desc = '' base_url = "http://ae7q.com/query/data/CallHistory.php?CALL=" @@ -52,7 +53,7 @@ class AE7QCog(commands.Cog): rows = table.find_all("tr") if len(rows) > 1 and len(rows[0]) > 1: break - elif desc == '': + if desc == '': for row in rows: desc += " ".join(row.getText().split()) desc += '\n' @@ -75,19 +76,18 @@ class AE7QCog(commands.Cog): for tr in rows: if rows.index(tr) == 0: continue - else: - row_cells = [] - for td in tr.find_all('td'): - if td.getText().strip() != '': - row_cells.append(td.getText().strip()) - else: - row_cells.append('-') - if 'colspan' in td.attrs and int(td.attrs['colspan']) > 1: - for i in range(int(td.attrs['colspan']) - 1): - row_cells.append(row_cells[-1]) - for i in range(len(row_cells)): - if row_cells[i] == '"': - row_cells[i] = table_contents[-1][i] + row_cells = [] + for td in tr.find_all('td'): + if td.getText().strip() != '': + row_cells.append(td.getText().strip()) + else: + row_cells.append('-') + if 'colspan' in td.attrs and int(td.attrs['colspan']) > 1: + for i in range(int(td.attrs['colspan']) - 1): + row_cells.append(row_cells[-1]) + for i, cell in enumerate(row_cells): + if cell == '"': + cell = table_contents[-1][i] if len(row_cells) > 1: table_contents += [row_cells] @@ -137,5 +137,5 @@ class AE7QCog(commands.Cog): # pass -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(AE7QCog(bot)) diff --git a/cogs/basecog.py b/cogs/basecog.py index 79dc20a..5556ff9 100644 --- a/cogs/basecog.py +++ b/cogs/basecog.py @@ -7,14 +7,14 @@ This file is part of discord-qrmbot and is released under the terms of the GNU General Public License, version 2. """ +from datetime import datetime + import discord import discord.ext.commands as commands -from datetime import datetime - class BaseCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") @@ -33,7 +33,8 @@ class BaseCog(commands.Cog): await ctx.send(embed=embed) @commands.command(name="ping") - async def _ping(self, ctx): + async def _ping(self, ctx: commands.Context): + """Show the current latency to the discord endpoint.""" embed = discord.Embed(title="**Pong!**", description=f'Current ping is {self.bot.latency*1000:.1f} ms', colour=self.gs.colours.neutral, @@ -43,5 +44,5 @@ class BaseCog(commands.Cog): await ctx.send(embed=embed) -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(BaseCog(bot)) diff --git a/cogs/funcog.py b/cogs/funcog.py index 3ff3238..8045c54 100644 --- a/cogs/funcog.py +++ b/cogs/funcog.py @@ -7,30 +7,29 @@ This file is part of discord-qrmbot and is released under the terms of the GNU General Public License, version 2. """ -import discord import discord.ext.commands as commands class FunCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") @commands.command(name="xkcd", aliases=['x']) - async def _xkcd(self, ctx, num : str): + async def _xkcd(self, ctx: commands.Context, num: str): '''Look up an xkcd by number.''' await ctx.send('http://xkcd.com/' + num) @commands.command(name="tar") - async def _tar(self, ctx): + async def _tar(self, ctx: commands.Context): '''Returns an xkcd about tar.''' await ctx.send('http://xkcd.com/1168') @commands.command(name="xd") - async def _xd(self, ctx): + async def _xd(self, ctx: commands.Context): '''ecks dee''' await ctx.send('ECKS DEE :smirk:') -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(FunCog(bot)) diff --git a/cogs/gridcog.py b/cogs/gridcog.py index 03f1d9a..f86b02a 100644 --- a/cogs/gridcog.py +++ b/cogs/gridcog.py @@ -7,20 +7,20 @@ This file is part of discord-qrmbot and is released under the terms of the GNU General Public License, version 2. """ -import discord -import discord.ext.commands as commands - import math from datetime import datetime +import discord +import discord.ext.commands as commands + class GridCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") @commands.command(name="grid") - async def _grid_sq_lookup(self, ctx, lat : str, lon : str): + async def _grid_sq_lookup(self, ctx: commands.Context, lat: str, lon: str): '''Calculates the grid square for latitude and longitude coordinates. Usage: `?grid ` `lat` and `lon` are decimal coordinates, with negative being latitude South and longitude West.''' @@ -45,9 +45,9 @@ class GridCog(commands.Cog): icon_url=str(ctx.author.avatar_url)) else: raise ValueError('Out of range.') - except Exception as e: + except ValueError as err: msg = f'Error generating grid square for {lat}, {lon}.' - embed = discord.Embed(title=msg, description=str(e), + embed = discord.Embed(title=msg, description=str(err), colour=self.gs.colours.bad, timestamp=datetime.utcnow()) embed.set_footer(text=ctx.author.name, @@ -55,24 +55,26 @@ class GridCog(commands.Cog): await ctx.send(embed=embed) @commands.command(name="ungrid", aliases=['loc']) - async def _location_lookup(self, ctx, grid : str, grid2 : str = None): + async def _location_lookup(self, ctx: commands.Context, grid: str, grid2: str = None): '''Calculates the latitude and longitude for the center of a grid square. If two grid squares are given, the distance and azimuth between them is calculated.''' with ctx.typing(): if grid2 is None or grid2 == '': try: grid = grid.upper() - loc = self.getCoords(grid) + loc = get_coords(grid) if len(grid) >= 6: embed = discord.Embed(title=f'Latitude and Longitude for {grid}', - description=f'**{loc[0]:.5f}, {loc[1]:.5f}**', colour=self.gs.colours.good, + description=f'**{loc[0]:.5f}, {loc[1]:.5f}**', + colour=self.gs.colours.good, url=f'https://www.openstreetmap.org/#map=13/{loc[0]:.5f}/{loc[1]:.5f}', timestamp=datetime.utcnow()) else: embed = discord.Embed(title=f'Latitude and Longitude for {grid}', - description=f'**{loc[0]:.1f}, {loc[1]:.1f}**', colour=self.gs.colours.good, + description=f'**{loc[0]:.1f}, {loc[1]:.1f}**', + colour=self.gs.colours.good, url=f'https://www.openstreetmap.org/#map=10/{loc[0]:.1f}/{loc[1]:.1f}', timestamp=datetime.utcnow()) embed.set_footer(text=ctx.author.name, @@ -85,28 +87,28 @@ class GridCog(commands.Cog): embed.set_footer(text=ctx.author.name, icon_url=str(ctx.author.avatar_url)) else: - R = 6371 + radius = 6371 try: grid = grid.upper() grid2 = grid2.upper() - loc = self.getCoords(grid) - loc2 = self.getCoords(grid2) + loc = get_coords(grid) + loc2 = get_coords(grid2) # Haversine formula - dLat = math.radians(loc2[0] - loc[0]) - dLon = math.radians(loc2[1] - loc[1]) - a = math.sin(dLat/2) ** 2 +\ + d_lat = math.radians(loc2[0] - loc[0]) + d_lon = math.radians(loc2[1] - loc[1]) + a = math.sin(d_lat/2) ** 2 +\ math.cos(math.radians(loc[0])) * math.cos(math.radians(loc2[0])) *\ - math.sin(dLon/2) ** 2 + math.sin(d_lon/2) ** 2 c = 2 * math.atan2(math.sqrt(a), math.sqrt(1-a)) - d = R * c + d = radius * c d_mi = 0.6213712 * d # Bearing - y = math.sin(math.radians(loc2[1]-loc[1])) * math.cos(math.radians(loc2[0])) - x = math.cos(math.radians(loc[0])) * math.sin(math.radians(loc2[0])) -\ + y_dist = math.sin(math.radians(loc2[1]-loc[1])) * math.cos(math.radians(loc2[0])) + x_dist = math.cos(math.radians(loc[0])) * math.sin(math.radians(loc2[0])) -\ math.sin(math.radians(loc[0])) * math.cos(math.radians(loc2[0])) *\ math.cos(math.radians(loc2[1] - loc[1])) - bearing = ( math.degrees(math.atan2(y, x)) + 360 ) % 360 + bearing = (math.degrees(math.atan2(y_dist, x_dist)) + 360) % 360 des = f'**Distance:** {d:.1f} km ({d_mi:.1f} mi)\n**Bearing:** {bearing:.1f}°' embed = discord.Embed(title=f'Great Circle Distance and Bearing from {grid} to {grid2}', @@ -124,35 +126,35 @@ class GridCog(commands.Cog): icon_url=str(ctx.author.avatar_url)) await ctx.send(embed=embed) - def getCoords(self, grid: str): - if len(grid) < 3: - raise ValueError('The grid locator must be at least 4 characters long.') - if not grid[0:2].isalpha() or not grid[2:4].isdigit(): - if len(grid) <= 4: - raise ValueError('The grid locator must be of the form AA##.') - elif len(grid) >= 6 and not grid[5:7].isalpha(): - raise ValueError('The grid locator must be of the form AA##AA.') +def get_coords(grid: str): + if len(grid) < 3: + raise ValueError('The grid locator must be at least 4 characters long.') - lon = ((ord(grid[0]) - ord('A')) * 20) - 180; - lat = ((ord(grid[1]) - ord('A')) * 10) - 90; - lon += ((ord(grid[2]) - ord('0')) * 2); - lat += ((ord(grid[3]) - ord('0')) * 1); + if not grid[0:2].isalpha() or not grid[2:4].isdigit(): + if len(grid) <= 4: + raise ValueError('The grid locator must be of the form AA##.') + if len(grid) >= 6 and not grid[5:7].isalpha(): + raise ValueError('The grid locator must be of the form AA##AA.') - if len(grid) >= 6: - # have subsquares - lon += ((ord(grid[4])) - ord('A')) * (5/60); - lat += ((ord(grid[5])) - ord('A')) * (2.5/60); - # move to center of subsquare - lon += (2.5/60); - lat += (1.25/60); - return (lat, lon) - else: - # move to center of square - lon += 1; - lat += 0.5; - return (lat, lon) + lon = ((ord(grid[0]) - ord('A')) * 20) - 180 + lat = ((ord(grid[1]) - ord('A')) * 10) - 90 + lon += ((ord(grid[2]) - ord('0')) * 2) + lat += ((ord(grid[3]) - ord('0')) * 1) + + if len(grid) >= 6: + # have subsquares + lon += ((ord(grid[4])) - ord('A')) * (5/60) + lat += ((ord(grid[5])) - ord('A')) * (2.5/60) + # move to center of subsquare + lon += (2.5/60) + lat += (1.25/60) + return (lat, lon) + # move to center of square + lon += 1 + lat += 0.5 + return (lat, lon) -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(GridCog(bot)) diff --git a/cogs/hamcog.py b/cogs/hamcog.py index f8d79b4..7c04950 100644 --- a/cogs/hamcog.py +++ b/cogs/hamcog.py @@ -6,34 +6,34 @@ Copyright (C) 2019 Abigail Gold, 0x5c This file is part of discord-qrmbot and is released under the terms of the GNU General Public License, version 2. """ - -import discord -import discord.ext.commands as commands - import json import random from datetime import datetime +import discord +import discord.ext.commands as commands + + class HamCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") with open('resources/qcodes.json') as qcode_file: self.qcodes = json.load(qcode_file) with open('resources/words') as words_file: - self.WORDS = words_file.read().lower().splitlines() + self.words = words_file.read().lower().splitlines() @commands.command(name="qcode", aliases=['q']) - async def _qcode_lookup(self, ctx, q : str): + async def _qcode_lookup(self, ctx: commands.Context, qcode: str): '''Look up a Q Code.''' with ctx.typing(): - q = q.upper() - if q in self.qcodes: - embed = discord.Embed(title=q, description=self.qcodes[q], + qcode = qcode.upper() + if qcode in self.qcodes: + embed = discord.Embed(title=qcode, description=self.qcodes[qcode], colour=self.gs.colours.good, timestamp=datetime.utcnow()) else: - embed = discord.Embed(title=f'Q Code {q} not found', + embed = discord.Embed(title=f'Q Code {qcode} not found', colour=self.gs.colours.bad, timestamp=datetime.utcnow()) embed.set_footer(text=ctx.author.name, @@ -41,14 +41,13 @@ class HamCog(commands.Cog): await ctx.send(embed=embed) @commands.command(name="phonetics", aliases=['ph', 'phoneticize', 'phoneticise', 'phone']) - async def _phonetics_lookup(self, ctx, *, msg: str): + async def _phonetics_lookup(self, ctx: commands.Context, *, msg: str): '''Get phonetics for a word or phrase.''' with ctx.typing(): result = '' for char in msg.lower(): if char.isalpha(): - w = [word for word in self.WORDS if (word[0] == char)] - result += random.choice(w) + result += random.choice([word for word in self.words if word[0] == char]) else: result += char result += ' ' @@ -61,11 +60,11 @@ class HamCog(commands.Cog): await ctx.send(embed=embed) @commands.command(name="utc", aliases=['z']) - async def _utc_lookup(self, ctx): + async def _utc_lookup(self, ctx: commands.Context): '''Gets the current time in UTC.''' with ctx.typing(): - d = datetime.utcnow() - result = '**' + d.strftime('%Y-%m-%d %H:%M') + 'Z**' + now = datetime.utcnow() + result = '**' + now.strftime('%Y-%m-%d %H:%M') + 'Z**' embed = discord.Embed(title='The current time is:', description=result, colour=self.gs.colours.good, @@ -75,5 +74,5 @@ class HamCog(commands.Cog): await ctx.send(embed=embed) -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(HamCog(bot)) diff --git a/cogs/imagecog.py b/cogs/imagecog.py index 149d6e1..60a9a6c 100644 --- a/cogs/imagecog.py +++ b/cogs/imagecog.py @@ -7,21 +7,22 @@ This file is part of discord-qrmbot and is released under the terms of the GNU General Public License, version 2. """ +import io +from datetime import datetime + import discord import discord.ext.commands as commands import aiohttp -import io -from datetime import datetime class ImageCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") @commands.command(name="plan", aliases=['bands']) - async def _bandplan(self, ctx, msg: str = ''): + async def _bandplan(self, ctx: commands.Context, msg: str = ''): '''Posts an image of Frequency Allocations. Optional argument: `cn`, `ca`, `nl`, `us`, `mx`.''' name = {'cn': 'Chinese', @@ -46,41 +47,47 @@ class ImageCog(commands.Cog): await ctx.send(embed=embed, file=img) @commands.command(name="cond", aliases=['condx']) - async def _band_conditions(self, ctx, msg: str = ''): + async def _band_conditions(self, ctx: commands.Context): '''Posts an image of HF Band Conditions.''' with ctx.typing(): - async with aiohttp.ClientSession() as session: - async with session.get('http://www.hamqsl.com/solarsun.php') as resp: - if resp.status != 200: - return await ctx.send('Could not download file...') - data = io.BytesIO(await resp.read()) embed = discord.Embed(title='Current Solar Conditions', colour=self.gs.colours.good, timestamp=datetime.utcnow()) - embed.set_image(url=f'attachment://condx.png') + async with aiohttp.ClientSession() as session: + async with session.get('http://www.hamqsl.com/solarsun.php') as resp: + if resp.status != 200: + embed.description = 'Could not download file...' + embed.colour = self.gs.colours.bad + else: + data = io.BytesIO(await resp.read()) + embed.set_image(url=f'attachment://condx.png') embed.set_footer(text=ctx.author.name, icon_url=str(ctx.author.avatar_url)) await ctx.send(embed=embed, file=discord.File(data, 'condx.png')) @commands.command(name="grayline", aliases=['greyline', 'grey', 'gray', 'gl']) - async def _grayline(self, ctx, msg: str = ''): + async def _grayline(self, ctx: commands.Context): '''Posts a map of the current greyline, where HF propagation is the best.''' + gl_url = ('http://www.fourmilab.ch/cgi-bin/uncgi/Earth?img=NOAAtopo.evif' + '&imgsize=320&dynimg=y&opt=-p&lat=&lon=&alt=&tle=&date=0&utc=&jd=') with ctx.typing(): - async with aiohttp.ClientSession() as session: - async with session.get('http://www.fourmilab.ch/cgi-bin/uncgi/Earth?img=NOAAtopo.evif&imgsize=320&dynimg=y&opt=-p&lat=&lon=&alt=&tle=&date=0&utc=&jd=') as resp: - if resp.status != 200: - return await ctx.send('Could not download file...') - data = io.BytesIO(await resp.read()) embed = discord.Embed(title='Current Greyline Conditions', colour=self.gs.colours.good, timestamp=datetime.utcnow()) - embed.set_image(url=f'attachment://greyline.jpg') + async with aiohttp.ClientSession() as session: + async with session.get(gl_url) as resp: + if resp.status != 200: + embed.description = 'Could not download file...' + embed.colour = self.gs.colours.bad + else: + data = io.BytesIO(await resp.read()) + embed.set_image(url=f'attachment://greyline.jpg') embed.set_footer(text=ctx.author.name, icon_url=str(ctx.author.avatar_url)) await ctx.send(embed=embed, file=discord.File(data, 'greyline.jpg')) @commands.command(name="map") - async def _map(self, ctx, msg: str = ''): + async def _map(self, ctx: commands.Context, msg: str = ''): '''Posts an image of Frequency Allocations. Optional argument:`cq` = CQ Zones, `itu` = ITU Zones, `arrl` or `rac` = ARRL/RAC sections, `cn` = Chinese Callsign Areas, `us` = US Callsign Areas.''' @@ -107,5 +114,5 @@ class ImageCog(commands.Cog): await ctx.send(embed=embed, file=img) -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(ImageCog(bot)) diff --git a/cogs/morsecog.py b/cogs/morsecog.py index 35c1b29..9b8f9e7 100644 --- a/cogs/morsecog.py +++ b/cogs/morsecog.py @@ -7,15 +7,15 @@ This file is part of discord-qrmbot and is released under the terms of the GNU General Public License, version 2. """ -import discord -import discord.ext.commands as commands - import json from datetime import datetime +import discord +import discord.ext.commands as commands + class MorseCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") with open('resources/morse.json') as morse_file: @@ -23,7 +23,7 @@ class MorseCog(commands.Cog): self.morse2ascii = {v: k for k, v in self.ascii2morse.items()} @commands.command(name="morse", aliases=['cw']) - async def _morse(self, ctx, *, msg: str): + async def _morse(self, ctx: commands.Context, *, msg: str): """Converts ASCII to international morse code.""" with ctx.typing(): result = '' @@ -42,7 +42,7 @@ class MorseCog(commands.Cog): await ctx.send(embed=embed) @commands.command(name="unmorse", aliases=['demorse', 'uncw', 'decw']) - async def _unmorse(self, ctx, *, msg: str): + async def _unmorse(self, ctx: commands.Context, *, msg: str): '''Converts international morse code to ASCII.''' with ctx.typing(): result = '' @@ -65,15 +65,15 @@ class MorseCog(commands.Cog): await ctx.send(embed=embed) @commands.command(name="weight", aliases=["cwweight", 'cww']) - async def _weight(self, ctx, msg: str): + async def _weight(self, ctx: commands.Context, msg: str): '''Calculates the CW Weight of a callsign.''' with ctx.typing(): msg = msg.upper() weight = 0 for char in msg: try: - cwChar = self.ascii2morse[char].replace('-', '==') - weight += len(cwChar) * 2 + 2 + cw_char = self.ascii2morse[char].replace('-', '==') + weight += len(cw_char) * 2 + 2 except KeyError: res = f'Unknown character {char} in callsign' await ctx.send(res) @@ -88,5 +88,5 @@ class MorseCog(commands.Cog): await ctx.send(embed=embed) -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(MorseCog(bot)) diff --git a/cogs/studycog.py b/cogs/studycog.py index a76deb7..4c80103 100644 --- a/cogs/studycog.py +++ b/cogs/studycog.py @@ -7,23 +7,24 @@ This file is part of discord-qrmbot and is released under the terms of the GNU General Public License, version 2. """ +import random +import json +from datetime import datetime + import discord import discord.ext.commands as commands -import random -import json import aiohttp -from datetime import datetime class StudyCog(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.gs = bot.get_cog("GlobalSettings") self.lastq = dict() @commands.command(name="rq", aliases=['randomq']) - async def _random_question(self, ctx, level: str = None): + async def _random_question(self, ctx: commands.Context, level: str = None): '''Gets a random question from the Technician, General, and/or Extra question pools.''' tech_pool = 'E2_2018' gen_pool = 'E3_2019' @@ -45,12 +46,12 @@ class StudyCog(commands.Cog): if level in ['e', 'ae', 'extra']: selected_pool = extra_pool - if (level is None) or (level == 'all'): # no pool given or user wants all, so pick a random pool and use that + if (level is None) or (level == 'all'): # no pool given or user wants all, so pick a random pool selected_pool = random.choice([tech_pool, gen_pool, extra_pool]) if (level is not None) and (selected_pool is None): # unrecognized pool given by user await ctx.send('The question pool you gave was unrecognized. ' + - 'There are many ways to call up certain question pools - try ?rq t, g, or e. ' + - '(Note that only the US question pools are available).') + 'There are many ways to call up certain question pools - try ?rq t, g, or e. ' + + '(Note that only the US question pools are available).') return async with aiohttp.ClientSession() as session: @@ -70,11 +71,11 @@ class StudyCog(commands.Cog): embed.set_footer(text=ctx.author.name, icon_url=str(ctx.author.avatar_url)) embed = embed.add_field(name='Question:', value=question['text'], inline=False) - embed = embed.add_field(name='Answers:', value= - '**A:** ' + question['answers']['A'] + + embed = embed.add_field(name='Answers:', value='**A:** ' + question['answers']['A'] + '\n**B:** ' + question['answers']['B'] + '\n**C:** ' + question['answers']['C'] + - '\n**D:** ' + question['answers']['D'], inline=False) + '\n**D:** ' + question['answers']['D'], + inline=False) embed = embed.add_field(name='Answer:', value='Type _?rqa_ for answer', inline=False) if 'image' in question: image_url = f'https://hamstudy.org/_1330011/images/{selected_pool.split("_",1)[1]}/{question["image"]}' @@ -83,7 +84,7 @@ class StudyCog(commands.Cog): await ctx.send(embed=embed) @commands.command(name="rqa") - async def _q_answer(self, ctx, ans: str = None): + async def _q_answer(self, ctx: commands.Context, ans: str = None): '''Returns the answer to question last asked (Optional argument: your answer).''' with ctx.typing(): correct_ans = self.lastq[ctx.message.channel.id][1] @@ -114,5 +115,5 @@ class StudyCog(commands.Cog): await ctx.send(embed=embed) -def setup(bot): +def setup(bot: commands.Bot): bot.add_cog(StudyCog(bot)) diff --git a/info.py b/info.py index 26955d3..6ba9033 100644 --- a/info.py +++ b/info.py @@ -19,7 +19,7 @@ General Public License, version 2. """ authors = ("@ClassAbbyAmplifier#2229", "@0x5c") -description = """A description goes here.""" -license = "A license goes here." -contributing = "Info on contributing goes here." +description = """A bot with various useful ham radio-related functions, written in Python.""" +license = "Released under the GNU General Public License v2" +contributing = "Check out the source on GitHub, contributions welcome: https://github.com/classabbyamp/discord-qrm-bot" release_timestamp = "not yet :P" diff --git a/main.py b/main.py index e9177b7..911307e 100644 --- a/main.py +++ b/main.py @@ -27,7 +27,7 @@ debug_mode = opt.debug # Separate assignement in-case we define an override (te class GlobalSettings(commands.Cog): - def __init__(self, bot): + def __init__(self, bot: commands.Bot): self.bot = bot self.opt = opt @@ -46,6 +46,7 @@ bot = commands.Bot(command_prefix=opt.prefix, description=info.description, help_command=commands.MinimalHelpCommand()) + # --- Helper functions --- async def add_react(msg: discord.Message, react: str): @@ -60,16 +61,15 @@ async def add_react(msg: discord.Message, react: str): async def check_if_owner(ctx: commands.Context): if ctx.author.id in opt.owners_uids: return True - else: - await add_react(ctx.message, "❌") - return False + await add_react(ctx.message, "❌") + return False # --- Commands --- @bot.command(name="restart") @commands.check(check_if_owner) -async def _restart_bot(ctx): +async def _restart_bot(ctx: commands.Context): """Restarts the bot.""" global exit_code await add_react(ctx.message, "✅") @@ -79,7 +79,7 @@ async def _restart_bot(ctx): @bot.command(name="shutdown") @commands.check(check_if_owner) -async def _shutdown_bot(ctx): +async def _shutdown_bot(ctx: commands.Context): """Shuts down the bot.""" global exit_code await add_react(ctx.message, "✅")