Pure Pulsars by janine9vn · Pull Request #7 · python-discord/code-jam-11

janine9vn · 2024-08-15T18:49:09Z

No description provided.

ruff check

…to main

This just send a message with the answer when the give up button is pressed, it doesn't actually perform any necessary cleanup.

This modifies the original message to not have the buttons when the user gives up the game.

Allows using the `logging` module to pass log messages to discord's default logger. ALSO adds using the environment variable `LOG_LEVEL` to set the logging level, with the current default being INFO. So you can run `LOG_LEVEL=DEBUG python src/main.py` to get a DEBUG-level logging experience.

…r log message.

DEBUG is very messy, and this info is slightly more useful to maintenance than the common DEBUG output

(wiki-guesser) "Give Up" button, logging update

Added commands.bot.tree instead of Client and added a sync command under the prefix of /

Added it for more readable timestamps for the User info command

added it to the user info for an easier piece of info.

made things work. added the on_join event for syncing on join, and also updated the /sync command so we can run it.

Jayy001 · 2024-08-21T19:04:20Z

+        -----
+        Another command, ``/reset-scores``, can be used to  reset the scores of
+        all users in a server.
+        :w


What does :w represent here?

Jayy001 · 2024-08-21T19:04:44Z

+
+        Notes:
+        -----
+        Another command, ``/reset-scores``, can be used to  reset the scores of


Is it supposed to have three backticks instead?

Jayy001 · 2024-08-21T19:05:05Z

+
+            await interaction.followup.send(embed=embed)
+        except CommandInvokeError as e:
+            logging.info("Leaderboard:\nException: %s", e)


I think this should be logging.error instead, also could utilise an f-string

Jayy001 · 2024-08-21T19:12:26Z

+            await interaction.response.defer(thinking=True)
+            board = await DATA.get_server(ser_id)
+            lead = list(board.values())
+            lead.sort(key=_sort_leaders, reverse=True)


I think a lambda would be cleaner, lead.sort(key=lambda user: user.score()) as the function is only being used here.

Jayy001 · 2024-08-21T19:12:59Z

+            board = await DATA.get_server(ser_id)
+            lead = list(board.values())
+            lead.sort(key=_sort_leaders, reverse=True)
+            lead = lead[0:10]


Could we get a comment to explain where 10 comes from?

Jayy001 · 2024-08-22T11:32:35Z

+
+COPY . .
+
+RUN "ls"


Is ls needed here?

Jayy001 · 2024-08-22T11:32:52Z

+
+WORKDIR /app
+
+COPY requirements.txt requirements.txt


Can we move the COPY . . part here and remove this line?

Ah, this seems to be the correct approach due to how the layers work with building a container.

Jayy001 · 2024-08-22T11:33:52Z

What are these cache files needed for?

Jayy001 · 2024-08-22T11:34:09Z

I like these meeting notes

Jayy001 · 2024-08-22T11:36:45Z

I'm not going to review this because its not been implemented

Jayy001 · 2024-08-22T11:42:08Z

+    discord.Embed: The embed message.
+
+    """
+    embed_msg = Embed(title=summary["Title"], description=summary["Intro"], url=summary["URL"], color=0xFFFFFF)


Could we add a comment of what the colour is?

Jayy001 · 2024-08-22T11:50:54Z

+    try:
+        # Generate a summary and return an embed message
+        text = article.extract(intro=False)
+        response = model.generate_content(text)


This is an interesting way of getting the response from the AI, good catch on the try/except. However, I think there should be a note/warning to the user about the potential miss-information from using a LLM.

Jayy001 · 2024-08-22T12:03:39Z

+                    value=user_data["score"],
+                    inline=False,
+                )
+                try:


Could we pre-generate the value variable first, instead of using another nested try/except?

value = (user_data["wins"] / user_data["failure"]) if user_data["failure"] > 0 else user_data["wins"]

Jayy001 · 2024-08-22T12:04:27Z

+    """Determine animal's weight ranges based on article text."""
+    api_url = f"https://api.api-ninjas.com/v1/animals?name={animal_name}"
+    async with (
+        aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=20)) as session,


This is quite a long timeout, won't the discord interaction timeout by then? Is it worth reducing it?

Jayy001 · 2024-08-22T12:10:49Z

+    try:
+        api_url = "https://en.wikipedia.org/wiki/Special:RandomInCategory?wpcategory=Mammals of the United States"
+        async with (
+            aiohttp.ClientSession(headers={"UserAgent": UA}, timeout=aiohttp.ClientTimeout(total=20)) as session,


Same long timeout here

Jayy001 · 2024-08-22T12:11:16Z

+    if weight_phrases:
+        weight_ranges = [UREG.Quantity(weight) for weight in weight_phrases]
+        if len(weight_ranges) % 2 == 0:
+            return [weight_ranges[0], weight_ranges[1]]


I don't understand the point of this code, why are we checking if its even/odd? Could we adda comment

Jayy001 · 2024-08-22T12:11:43Z

+                loc = str(response.real_url)
+                title = loc.split("=")[1].split("&")[0]
+        article = await search_wikipedia(title)
+        animal_name = article.title().split(" ")[-1]


This can error if search_wikipedia doesn't return anything.

Jayy001 · 2024-08-22T12:13:53Z

+from button_class import ExcerptButton, GiveUpButton, GuessButton, LinkListButton, _Button, _Ranked
+from wikiutils import make_embed, rand_wiki, win_update
+
+ACCURACY_THRESHOLD = 0.8


What do these constants represent?

Jayy001 · 2024-08-22T12:14:51Z

+        await interaction.followup.send(content=msg, embed=embed)
+        if ranked:
+            user = interaction.user
+            for i in [interaction.guild_id, 0]:


Why do we go in 0 element as well?

Jayy001 · 2024-08-22T12:17:52Z

+
+            excerpt = article.extract(chars=1200)
+
+            for i in article.title().split():


Will this censor the word if its in FULL UPPERCASE?

Jayy001 · 2024-08-22T12:18:20Z

+                excerpt = excerpt.replace(i, "~~CENSORED~~")
+                excerpt = excerpt.replace(i.lower(), "~~CENSORED~~")
+
+            sentances = [i for i in excerpt.strip("\n").split(".") if i]


*sentences, I think we could have a better variable name than i - and a comment?

Jayy001 · 2024-08-22T12:23:11Z

+        self._default_app = firebase_admin.initialize_app(
+            cred_obj,
+            {
+                "databaseURL": "https://pure-pulsars-default-rtdb.firebaseio.com/",


Need's to be taken from user input!

Jayy001 · 2024-08-22T12:23:33Z

+        NullUserError: If the user doesn't exist.
+
+        """
+        """self._ref = db.reference("/users")"""


What's this for?

Jayy001 · 2024-08-22T12:24:52Z

+
+
+# activates the commands
+sync.main(client.tree)


Is there a better way to do this then all these lines?

Jayy001 · 2024-08-22T12:26:21Z

+    """
+    result = Page(site, title=query)
+
+    if not result.exists() or result.isRedirectPage():


Does the redirect page take you to to article?

Jayy001 · 2024-08-22T12:26:54Z

+        return get_best_result(results, query)
+
+    try:
+        return result


How would this error?

Jayy001 · 2024-08-22T12:28:48Z

+        await DATA.add_user(uid, new_user, guild)
+
+
+async def win_update(guild: int, user: User, score: int) -> None:


Would it be better to have a single update function which you can the pass in in the win/loss argument instead of having two functions?

Jayy001 · 2024-08-22T12:30:25Z

+        articles = [article for article in articles if self.article_has_categories(article)]
+
+        try:
+            return articles


How would this error?

Jayy001 · 2024-08-22T12:31:28Z

+            articles = {a for articles in title_articles.values() for a in articles}
+
+            if any(article is None for article in title_articles.values()):
+                titles_not_found = [title for title, article in title_articles.items() if article is None]
+                message = f"No articles found for the following titles: {titles_not_found}"
+
+                raise ArticleGeneratorError(message)


Could we get some comments here?

Jayy001 · 2024-08-22T15:50:21Z

Hey everyone, fantastic project! The logo and website added a great personalised touch, and setting up the bot was a breeze. I've done a review of the codebase, and had a play around with the features - here are my thoughts on what I liked and what could be improved on.

Project overview

Well structured project, with the modules in their appropriate place. Using different folders to keep the discord interface and database access separate makes the codebase easy to use.
Each command is its own module, which makes organisation much easier, and each function can be worked on separately.
Consistent use of docstrings — simple to get a high level overview of what each function does
README.md documentation is very detailed, made running the bot a breeze. The meeting notes, are also quite insightful. Although there are quite a lot of external services to sign up to...
Commands work as expected and give a clear response, bar a few small bugs
Abided to the “Information overload” brief well.

Commit overview

Started strong with most commit messages clearly showing what had been worked on
Few inconsistencies towards the end with a few default messages (e.g. update file) without explaining what it added
Small changes instead of large PRs. 👍🏻

Codebase overview

Docstrings are included everywhere, some functions could do with a bit more explanation to the docstring
Typehints are inconsistent — some files have them while others don't. I can understand for variables which purpose is obvious, but in quite a few cases, it would benefit from having them.
Well structured and modular, utils module is especially great.
Needs some comments on code that operation isn't entirely obvious (or with magic numbers). Same with constants at the top!
Some variable names aren't named well. See my review.
I think there's too much of logging.info being used instead of logging.error, especially for when the program catches an error.

Usage overview

Help command could do with being more detailed, including the parameters needed.
I had no troubles with running guessr, random , search, reset-score, never, rabbit-hole and user-info.
Timeout for commands was OK, could be a bit longer, but not sure if thats a discord limitation.
NSFW Content! There are no restrictions on the articles given, so I did have a couple of instances where NSFW articles were being used (from the random or guess command). Something to check against this would be a great improvement!
wiki-animal: Sometimes errored for no apparent reason. When entering the weight, the threshold for accepted answer seems to be pretty high (i.e I guessed 1kg for a moose which was accepted)

discord.app_commands.errors.CommandInvokeError: Command 'wiki-animal' raised an exception: AttributeError: 'NoneType' object has no attribute 'title'

leaderboard: Command errors if no games has been played yet

discord.app_commands.errors.CommandInvokeError: Command 'leaderboard' raised an exception: AttributeError: 'NoneType' object has no attribute 'values

rabbit-hole: I like the idea of this command using a LLM to sum it up. However, I think a warning should be given as they are well known to hallucinate information which could potentially miss-inform the user.
random: I think an idea of not using the popular articles would be good as an optional parameter.

Other

Thank you for using Docker!! Makes running it easy.
I'm not quite sure what the cache files are used for
Neither what the never command does
I had to change the firebase URL in the python file, something that wasn't mentioned in the README

Koisu-unavailable and others added 30 commits July 21, 2024 14:47

Change User: has not been added to User: has not played any games

63676ba

feat(pure-pulsers): 🐛 Added Error catching to the commands

d34a693

Merge branch 'main' of https://github.com/DannyTheHeretic/pure-pulsars

0e19269

h

99b5e0e

refactor: ♻️ made never commadn nicer

0e49671

changed h to never

ac3bd94

Merge branch 'main' of https://github.com/DannyTheHeretic/pure-pulsars

aa6abd7

chore: ♻️ ruff check

1b0fb41

ruff check

feat(pure-pulsers): ✨ Added the help command

dbd3a64

feat(wiki-guesser): 🚧 Initial commit of GiveUpButton

210e480

feat(wiki-guesser): 🚧 Return explicityly in GiveUpbutton, add button …

3acfc44

…to main

chore: 🔒 Add secrets dir to .gitignore

c4bf2d9

feat(wiki-guesser): 🚧 Send message with answer when giving up

f401760

This just send a message with the answer when the give up button is pressed, it doesn't actually perform any necessary cleanup.

feat(wiki-guesser): ✨ Removes buttons when "give up button" pressed

d55453e

This modifies the original message to not have the buttons when the user gives up the game.

perf(wiki-guesser): 🎨 Change wording to match a list comprehension fo…

ddc543c

…r log message.

chore(wiki-guesser): 💡 Removing completed TODO

a7e115f

chore(wiki-guesser): 💡 Update TODO

0ac5ef9

chore(wiki-guesser): 🔊 Change exit log from DEBUG to INFO level message

d9f109b

DEBUG is very messy, and this info is slightly more useful to maintenance than the common DEBUG output

Merge pull request #1 from DannyTheHeretic/feature/give_up_button

903c602

(wiki-guesser) "Give Up" button, logging update

Switched to logging instead of print.

fe6898c

feat(pure-pulsers): ✨ Added commands.bot and sync

e9171c6

Added commands.bot.tree instead of Client and added a sync command under the prefix of /

Added embed to skip, removed sync

7b04fdf

Remove the noqa from most of the file

37b24d7

feat(pure-pulsers): ✨ Added back sync

b547974

added a one run sync

eee427c

fix(pure-pulsers): ⚡ Added sync on guild join. as well as some logging

4528a63

feat(pure-pulsers): ➕ Added humanize requirment

e797161

Added it for more readable timestamps for the User info command

refactor(pure-pulsers): 🎨 Added the Humanize function.

09d8bd0

added it to the user info for an easier piece of info.

feat(pure-pulsers): 🎨 Sync is working and also on_join.

6d935c2

made things work. added the on_join event for syncing on join, and also updated the /sync command so we can run it.

Jayy001 reviewed Aug 21, 2024

View reviewed changes