1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
import logging
from html import unescape
from typing import Optional
from urllib.parse import quote_plus
from discord import Embed
from discord.ext import commands
from bot.bot import Bot
from bot.constants import Colours
logger = logging.getLogger(__name__)
API_ROOT = "https://realpython.com/search/api/v1/"
ARTICLE_URL = "https://realpython.com{article_url}"
SEARCH_URL = "https://realpython.com/search?q={user_search}"
HOME_URL = "https://realpython.com/"
ERROR_EMBED = Embed(
title="Error while searching Real Python",
description="There was an error while trying to reach Real Python. Please try again shortly.",
color=Colours.soft_red,
)
class RealPython(commands.Cog):
"""User initiated command to search for a Real Python article."""
def __init__(self, bot: Bot):
self.bot = bot
@commands.command(aliases=["rp"])
@commands.cooldown(1, 10, commands.cooldowns.BucketType.user)
async def realpython(self, ctx: commands.Context, amount: Optional[int] = 5, *,
user_search: Optional[str] = None) -> None:
"""
Send some articles from RealPython that match the search terms.
By default, the top 5 matches are sent. This can be overwritten to
a number between 1 and 5 by specifying an amount before the search query.
If no search query is specified by the user, the home page is sent.
"""
if user_search is None:
home_page_embed = Embed(title="Real Python Home Page", url=HOME_URL, colour=Colours.orange)
await ctx.send(embed=home_page_embed)
return
if not 1 <= amount <= 5:
await ctx.send("`amount` must be between 1 and 5 (inclusive).")
return
params = {"q": user_search, "limit": amount, "kind": "article"}
async with self.bot.http_session.get(url=API_ROOT, params=params) as response:
if response.status != 200:
logger.error(
f"Unexpected status code {response.status} from Real Python"
)
await ctx.send(embed=ERROR_EMBED)
return
data = await response.json()
articles = data["results"]
if len(articles) == 0:
no_articles = Embed(
title=f"No articles found for '{user_search}'", color=Colours.soft_red
)
await ctx.send(embed=no_articles)
return
if len(articles) == 1:
article_description = "Here is the result:"
else:
article_description = f"Here are the top {len(articles)} results:"
article_embed = Embed(
title="Search results - Real Python",
url=SEARCH_URL.format(user_search=quote_plus(user_search)),
description=article_description,
color=Colours.orange,
)
for article in articles:
article_embed.add_field(
name=unescape(article["title"]),
value=ARTICLE_URL.format(article_url=article["url"]),
inline=False,
)
article_embed.set_footer(text="Click the links to go to the articles.")
await ctx.send(embed=article_embed)
async def setup(bot: Bot) -> None:
"""Load the Real Python Cog."""
await bot.add_cog(RealPython(bot))
|
