Spunky Sputniks by janine9vn · Pull Request #9 · python-discord/code-jam-11

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

No description provided.

This project contains documentation and recommended tooling configuration for projects to be submitted during a Python Discord Code Jam. Co-authored-by: Akarys42 <matteobertucci2004@gmail.com> Co-authored-by: ChrisLovering <chris.lovering.95@gmail.com> Co-authored-by: mbaruh <8bee278@gmail.com> Co-authored-by: fisher60 <39353605+fisher60@users.noreply.github.com>

Changes the local pre-commit hooks out for remote ones, as well as changes the action to use the pre-commit action, so pre-commit will no longer depend on your project manager's settings.

Global Actions

Renames workflow to Lint

Signed-off-by: GitHub <noreply@github.com>

- Use Python 3.10 instead of 3.9 - Update action versions to the newest major versions - Remove caching configuration since it's not doing anything useful (and we would rather not have teams deal with caching issues)

Signed-off-by: GitHub <noreply@github.com>

*although I added '.0' at the end of flake8-docstrings's requirement since it's present in the bot repository (where Kat got her versions anyway).

Update packaging and CI config for CJ9

Unfortunately installing isort from source errors out due to a poetry bug(?). Since isort 5.x has a stability policy active, let's just bump this so the template is usable (and upgrade the template properly later).

The screenshot is my own as I couldn't find a GitHub provided one that works unfortunately. Admittedly ugly.

Co-authored-by: Gimpy3887 <gimpy2345@gmail.com> Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

Demobot is complete

Co-authored-by: enskyeing <skyetsatsis@gmail.com>

…f2b4a3f' git-subtree-dir: spunky-sputniks git-subtree-mainline: 196cae3 git-subtree-split: e38c275

mbaruh

It's clear a lot of effort went into this project, well done. You wrote a library, gave it proper documentation, and prepared a demo all in the span of the code jam.

It's clear some things had to be rushed for it to be ready in time, but all the same I wrote comments below for your consideration. Hopefully you enjoyed building the project :)

mbaruh · 2024-08-31T18:52:25Z

+description = "Database library using nothing but Discord. PyDis Codejam 2024."
+readme = "README.md"
+license = "MIT"
+dependencies = ["discord.py", "pydantic", "typing_extensions", "loguru", "aiocache"]


Should lock the dependencies to specific versions like you did in hatch.toml

mbaruh · 2024-08-31T19:18:06Z

+        except Exception as e:
+            print(f"{e.__class__.__name__}: {e}")


I have a few issues with this:

It's better to print the full traceback in such cases, rather than just the error message.

discord.py states which exceptions can be raised from tree.sync, so catching a base Exception is not justified here.

Why not logger.exception?

If syncing fails, your bot is left in an odd state that isn't handled here.

mbaruh · 2024-08-31T19:20:00Z

+    async def on_error(self, event_method: str, /, *args: asyncio.Any, **kwargs: asyncio.Any) -> None:
+        return await super().on_error(event_method, *args, **kwargs)


What does overriding the method do here, if you're just calling the super method as-is?

mbaruh · 2024-08-31T19:20:37Z

+        async with db.conn(os.getenv("DB_BOT_TOKEN")):
+            try:
+                await bot.start(os.getenv("BOOKMARK_BOT_TOKEN"))
+            finally:
+                await bot.close()


Too indented

mbaruh · 2024-08-31T20:25:57Z

+def build_bookmark_embed(record: models.BookmarkedMessage):
+        embed = discord.Embed(title=record.title, description=record.message_content, colour=0x68C290)
+        embed.set_author(
+            name=record.author_name,
+            icon_url=record.author_avatar_url
+        )
+        return embed
+
+def build_embeds_list(records: list[models.BookmarkedMessage]) -> list[discord.Embed]:
+        embeds: list[discord.Embed] = []
+        for record in records:
+            embed = build_bookmark_embed(record)
+            embeds.append(embed)
+        return embeds


I won't mark it everywhere, but you have several places with weird indentation.

mbaruh · 2024-09-01T00:43:38Z

+        self,
+        interaction: discord.Interaction,
+        table: discord.TextChannel,
+        record: str,


It would be nicer if you could specify a record ID instead.

mbaruh · 2024-09-01T00:45:37Z

+            await interaction.edit_original_response(
+                content=f"Table `{table_name}` found! Gathering data..."
+            )
+        except IndexError as e:


KeyError?

mbaruh · 2024-09-01T00:47:30Z

+        await interaction.response.send_message(
+            content=f"Searching for table `{name}`..."
+        )
+        table_name = name.name.replace("-", " ").lower()
+
+        try:
+            table = self.db.tables[table_name]


A table resolution helper function would be useful here as well. A lot of code that repeats itself with small variations.

mbaruh · 2024-09-01T00:49:13Z

+        for game in table_values:
+            for col in table_columns:
+                data[col].append(getattr(game, col))


mbaruh · 2024-09-01T00:51:21Z

+        table_info: list | None = None
+        table_schema: dict | None = None
+        schemas: list[dict] | None = None
+        embed_gen: discord.Embed | None = None


"declaring" these ahead of time isn't necessary

jb3 and others added 30 commits July 9, 2021 19:19

Makes Precommit Manager Independent

d0762d4

Changes the local pre-commit hooks out for remote ones, as well as changes the action to use the pre-commit action, so pre-commit will no longer depend on your project manager's settings.

Adds Project Manager Samples

c04c75f

Merge pull request #2 from python-discord/global-actions

3d5f617

Global Actions

Renames workflow to Lint

17c5f86

Merge pull request #3 from onerandomusername/patch-1

bb83538

Renames workflow to Lint

remove flake8 plugins

63bbaa0

Signed-off-by: GitHub <noreply@github.com>

update Python version to 3.10

d0c694a

Signed-off-by: GitHub <noreply@github.com>

update flake8 ignores

4b993de

Signed-off-by: GitHub <noreply@github.com>

remove unused flake8 plugins from documentation

1c9a4d0

Signed-off-by: GitHub <noreply@github.com>

remove removed flake8 codes from sample output

432b93a

Signed-off-by: GitHub <noreply@github.com>

Update lint CI configuration for CJ9

e5d557a

- Use Python 3.10 instead of 3.9 - Update action versions to the newest major versions - Remove caching configuration since it's not doing anything useful (and we would rather not have teams deal with caching issues)

only run workflow on commit to main branch

d1c92f6

Signed-off-by: GitHub <noreply@github.com>

Bump linting tools as Kat suggested

f1e9289

*although I added '.0' at the end of flake8-docstrings's requirement since it's present in the bot repository (where Kat got her versions anyway).

Remove D100 from README since we're ignoring it anyway

c49d624

Merge pull request #5 from python-discord/update-ci

1ced0aa

Update packaging and CI config for CJ9

Hotfix: bump isort (5.10.1 -> 5.12.0)

a926999

Unfortunately installing isort from source errors out due to a poetry bug(?). Since isort 5.x has a stability policy active, let's just bump this so the template is usable (and upgrade the template properly later).

Replace (and remove) broken images in README

3e38115

The screenshot is my own as I couldn't find a GitHub provided one that works unfortunately. Admittedly ugly.

Update pre-commit-hooks version

17c8122

Replace flake8 and isort with ruff

5b70abb

Update Python version to 3.12

6467281

Update CI github actions

95f2aa4

Clean up comments

7b0b37c

Rename LICENSE to LICENSE.txt

057f4d2

Bump dependency versions

bf560ad

Update README

a3b49ac

Ignore redundant docstring lint rule

c45ca52

Bump Ruff to v0.5.0

298dfde

Add note about Poetry config

7c1b9c4

Merge pull request #8 from lemonyte/update-2024

d5fd7be

Rubiks14 and others added 29 commits July 28, 2024 01:36

Add test for update() (#79)

fdd73ec

Partial implementation of caching and structured concurrency (#81)

9167fe0

Final(ish) Interface Bot (#82)

0a7e3b0

Co-authored-by: Gimpy3887 <gimpy2345@gmail.com> Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

New demobot (#80)

a837954

Demobot is complete

Remove usage of free-flying tasks. (#83)

0334cc0

Improve error message for delete() on a deleted record. (#85)

b5f5446

Add description to pyproject.toml (#87)

41cb641

Hotfix for cog loading. (#88)

f1e75d7

Hotfix for cog loading (again). (#89)

65f1d49

Use if instead of match. (#90)

e760467

Fix 3.8 support. (#91)

c636804

Bump the version number. (#92)

19ea769

Documentation for the Discord interface. (#94)

f7e787d

Co-authored-by: enskyeing <skyetsatsis@gmail.com>

Update documentation and add logo to README. (#96)

3d1b59a

Fix bold in README and make logo larger. (#97)

cd742e3

Discord interface docs re do (#95)

64a5144

Co-authored-by: enskyeing <skyetsatsis@gmail.com>

Center the README text and enlarge the logo. (#98)

f58633c

Touch ups for the docs (#99)

b816fa2

Demonstration Documentation (#100)

254f076

Remove colons from section names. (#101)

e69d2a6

Fix docs (#102)

fc575e2

Add the contributions section. (#104)

9f39c04

Remove the picture tag in the README (#105)

f568465

Add links to GitHub accounts in the contributions section (#106)

b4b6de0

Fix last minute typos. (#107)

1a43c99

Add spaces around dashes. (#108)

acd1807

Add the logo to the documentation index. (#109)

9ae2596

Last minute typo fix. (#110)

e38c275

Add 'spunky-sputniks/' from commit 'e38c275f240aabc5a022ec83f48e50d2a…

6a23d59

…f2b4a3f' git-subtree-dir: spunky-sputniks git-subtree-mainline: 196cae3 git-subtree-split: e38c275

mbaruh reviewed Sep 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Spunky Sputniks#9

Spunky Sputniks#9
janine9vn wants to merge 88 commits into
mainfrom
spunky-sputniks

janine9vn commented Aug 15, 2024

Uh oh!

mbaruh left a comment

Uh oh!

mbaruh Aug 31, 2024

Uh oh!

mbaruh Aug 31, 2024

Uh oh!

mbaruh Aug 31, 2024

Uh oh!

mbaruh Aug 31, 2024

Uh oh!

mbaruh Aug 31, 2024

Uh oh!

mbaruh Sep 1, 2024

Uh oh!

mbaruh Sep 1, 2024

Uh oh!

mbaruh Sep 1, 2024

Uh oh!

mbaruh Sep 1, 2024

Uh oh!

mbaruh Sep 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

		async def on_error(self, event_method: str, /, args: asyncio.Any, *kwargs: asyncio.Any) -> None:
		return await super().on_error(event_method, args, *kwargs)

Uh oh!

Conversation

janine9vn commented Aug 15, 2024

Uh oh!

mbaruh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants