Merge branch 'main' into swfarnsworth/tag-updates

Author: wookie184

.github/workflows/lint-test.yml

@@ -72,7 +72,7 @@ jobs:
       - name: Upload a Build Artifact
         if: always() && steps.prepare-artifact.outcome == 'success'
         continue-on-error: true
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pull-request-payload
           path: pull_request_payload.json

.github/workflows/status_embed.yaml

@@ -43,7 +43,7 @@ jobs:
           curl -s -H "Authorization: token $GITHUB_TOKEN" ${{ github.event.workflow_run.artifacts_url }} > artifacts.json
           DOWNLOAD_URL=$(cat artifacts.json | jq -r '.artifacts[] | select(.name == "pull-request-payload") | .archive_download_url')
           [ -z "$DOWNLOAD_URL" ] && exit 1
-          wget --quiet --header="Authorization: token $GITHUB_TOKEN" -O pull_request_payload.zip $DOWNLOAD_URL || exit 2
+          curl -sSL -H "Authorization: token $GITHUB_TOKEN" -o pull_request_payload.zip $DOWNLOAD_URL || exit 2
           unzip -p pull_request_payload.zip > pull_request_payload.json
           [ -s pull_request_payload.json ] || exit 3
           echo "::set-output name=pr_author_login::$(jq -r '.user.login // empty' pull_request_payload.json)"

bot/exts/backend/branding/_cog.py

@@ -7,7 +7,6 @@
 from enum import Enum
 from operator import attrgetter
 
-import async_timeout
 import discord
 from arrow import Arrow
 from async_rediscache import RedisCache
@@ -158,7 +157,7 @@ async def apply_asset(self, asset_type: AssetType, download_url: str) -> bool:
 
         timeout = 10  # Seconds.
         try:
-            with async_timeout.timeout(timeout):  # Raise after `timeout` seconds.
+            async with asyncio.timeout(timeout):  # Raise after `timeout` seconds.
                 await pydis.edit(**{asset_type.value: file})
         except discord.HTTPException:
             log.exception("Asset upload to Discord failed.")

bot/exts/filtering/_ui/ui.py

@@ -155,13 +155,13 @@ def format_response_error(e: ResponseCodeError) -> Embed:
     """Format the response error into an embed."""
     description = ""
     if isinstance(e.response_json, list):
-        description = "\n".join(f"• {error}" for error in e.response_json)
+        description = "\n".join(f"- {error}" for error in e.response_json)
     elif isinstance(e.response_json, dict):
         if "non_field_errors" in e.response_json:
             non_field_errors = e.response_json.pop("non_field_errors")
-            description += "\n".join(f"• {error}" for error in non_field_errors) + "\n"
+            description += "\n".join(f"- {error}" for error in non_field_errors) + "\n"
         for field, errors in e.response_json.items():
-            description += "\n".join(f"• {field} - {error}" for error in errors) + "\n"
+            description += "\n".join(f"- {field} - {error}" for error in errors) + "\n"
 
     description = description.strip()
     if len(description) > MAX_EMBED_DESCRIPTION:

bot/exts/filtering/_utils.py

@@ -5,6 +5,7 @@
 import inspect
 import pkgutil
 import types
+import warnings
 from abc import ABC, abstractmethod
 from collections import defaultdict
 from collections.abc import Callable, Iterable
@@ -15,6 +16,7 @@
 import discord
 import regex
 from discord.ext.commands import Command
+from pydantic import PydanticDeprecatedSince20
 from pydantic_core import core_schema
 
 import bot
@@ -181,11 +183,16 @@ def inherited(attr: str) -> bool:
 
         # If a new attribute with the value MUST_SET_UNIQUE was defined in an abstract class, record it.
         if inspect.isabstract(cls):
-            for attribute in dir(cls):
-                if getattr(cls, attribute, None) is FieldRequiring.MUST_SET_UNIQUE:
-                    if not inherited(attribute):
-                        # A new attribute with the value MUST_SET_UNIQUE.
-                        FieldRequiring.__unique_attributes[cls][attribute] = set()
+            with warnings.catch_warnings():
+                # The code below will raise a warning about the use the __fields__ attr on a pydantic model
+                # This will continue to be warned about until removed in pydantic 3.0
+                # This warning is a false-positive as only the custom MUST_SET_UNIQUE attr is used here
+                warnings.simplefilter("ignore", category=PydanticDeprecatedSince20)
+                for attribute in dir(cls):
+                    if getattr(cls, attribute, None) is FieldRequiring.MUST_SET_UNIQUE:
+                        if not inherited(attribute):
+                            # A new attribute with the value MUST_SET_UNIQUE.
+                            FieldRequiring.__unique_attributes[cls][attribute] = set()
             return
 
         for attribute in dir(cls):

bot/exts/fun/off_topic_names.py

@@ -81,7 +81,7 @@ async def toggle_ot_name_activity(self, ctx: Context, name: str, active: bool) -
     async def list_ot_names(self, ctx: Context, active: bool = True) -> None:
         """Send an embed containing active/deactivated off-topic channel names."""
         result = await self.bot.api_client.get("bot/off-topic-channel-names", params={"active": json.dumps(active)})
-        lines = sorted(f"• {name}" for name in result)
+        lines = sorted(f"- {name}" for name in result)
         embed = Embed(
             title=f"{'Active' if active else 'Deactivated'} off-topic names (`{len(result)}` total)",
             colour=Colour.blue()
@@ -286,7 +286,7 @@ async def search_command(self, ctx: Context, *, query: OffTopicName) -> None:
         close_matches = difflib.get_close_matches(query, result.keys(), n=10, cutoff=0.70)
 
         # Send Results
-        lines = sorted(f"• {result[name]}" for name in in_matches.union(close_matches))
+        lines = sorted(f"- {result[name]}" for name in in_matches.union(close_matches))
         embed = Embed(
             title="Query results",
             colour=Colour.blue()

bot/exts/help_channels/_channel.py

@@ -19,9 +19,9 @@
 
 NEW_POST_MSG = """
 **Remember to:**
-• **Ask** your Python question, not if you can ask or if there's an expert who can help.
-• **Show** a code sample as text (rather than a screenshot) and the error message, if you've got one.
-• **Explain** what you expect to happen and what actually happens.
+- **Ask** your Python question, not if you can ask or if there's an expert who can help.
+- **Show** a code sample as text (rather than a screenshot) and the error message, if you've got one.
+- **Explain** what you expect to happen and what actually happens.
 
 :warning: Do not pip install anything that isn't related to your question, especially if asked to over DMs.
 """

bot/exts/info/code_snippets.py

@@ -210,6 +210,9 @@ def _snippet_to_codeblock(self, file_contents: str, file_path: str, start_line:
         if not is_valid_language:
             language = ""
 
+        if language == "pyi":
+            language = "py"
+
         # Adds a label showing the file path to the snippet
         if start_line == end_line:
             ret = f"`{file_path}` line {start_line}\n"

bot/exts/info/doc/_cog.py

@@ -325,7 +325,7 @@ async def get_command(self, ctx: commands.Context, *, symbol_name: str | None) -
                 colour=discord.Colour.blue()
             )
 
-            lines = sorted(f"• [`{name}`]({url})" for name, url in self.base_urls.items())
+            lines = sorted(f"- [`{name}`]({url})" for name, url in self.base_urls.items())
             if self.base_urls:
                 await LinePaginator.paginate(lines, ctx, inventory_embed, max_size=400, empty=False)
 

bot/exts/info/patreon.py

@@ -77,7 +77,7 @@ async def send_current_supporters(self, channel: discord.abc.Messageable, automa
 
             # Filter out any members where this is not their highest tier.
             patrons = [member for member in role.members if get_patreon_tier(member) == tier]
-            patron_names = [f"• {patron}" for patron in patrons]
+            patron_names = [f"- {patron}" for patron in patrons]
 
             embed = discord.Embed(
                 title=role.name,

bot/exts/info/source.py

@@ -69,7 +69,7 @@ def get_source_link(self, source_item: SourceType) -> tuple[str, str, int | None
 
         # Handle tag file location differently than others to avoid errors in some cases
         if not first_line_no:
-            file_location = Path(filename).relative_to("bot/")
+            file_location = Path(filename)
         else:
             file_location = Path(filename).relative_to(Path.cwd()).as_posix()
 

bot/exts/moderation/infraction/management.py

@@ -299,8 +299,8 @@ async def search_user(self, ctx: Context, user: MemberOrUser | discord.Object) -
             user_str = escape_markdown(str(user))
         else:
             if infraction_list:
-                user = infraction_list[0]["user"]
-                user_str = escape_markdown(user["name"]) + f"#{user['discriminator']:04}"
+                user_data = infraction_list[0]["user"]
+                user_str = escape_markdown(user_data["name"]) + f"#{user_data['discriminator']:04}"
             else:
                 user_str = str(user.id)
 

bot/exts/moderation/voice_gate.py

@@ -181,7 +181,7 @@ async def voice_verify(self, ctx: Context, *_) -> None:
         if failed:
             embed = discord.Embed(
                 title="Voice Gate failed",
-                description=FAILED_MESSAGE.format(reasons="\n".join(f"• You {reason}." for reason in failed_reasons)),
+                description=FAILED_MESSAGE.format(reasons="\n".join(f"- You {reason}." for reason in failed_reasons)),
                 color=Colour.red()
             )
             try:

bot/exts/moderation/watchchannels/_watchchannel.py

@@ -12,14 +12,15 @@
 from pydis_core.site_api import ResponseCodeError
 from pydis_core.utils import scheduling
 from pydis_core.utils.channel import get_or_fetch_channel
+from pydis_core.utils.logging import CustomLogger
 from pydis_core.utils.members import get_or_fetch_member
 
 from bot.bot import Bot
 from bot.constants import BigBrother as BigBrotherConfig, Guild as GuildConfig, Icons
 from bot.exts.filtering._filters.unique.discord_token import DiscordTokenFilter
 from bot.exts.filtering._filters.unique.webhook import WEBHOOK_URL_RE
 from bot.exts.moderation.modlog import ModLog
-from bot.log import CustomLogger, get_logger
+from bot.log import get_logger
 from bot.pagination import LinePaginator
 from bot.utils import CogABCMeta, messages, time
 
@@ -352,7 +353,7 @@ async def prepare_watched_users_data(
         list_data["info"] = {}
         for user_id, user_data in watched_iter:
             member = await get_or_fetch_member(ctx.guild, user_id)
-            line = f"• `{user_id}`"
+            line = f"- `{user_id}`"
             if member:
                 line += f" ({member.name}#{member.discriminator})"
             inserted_at = user_data["inserted_at"]

bot/exts/recruitment/talentpool/_cog.py

@@ -279,7 +279,7 @@ async def list_nominations(
             return ["*None*"]
 
         for nomination in nominations:
-            line = f"• `{nomination.user_id}`"
+            line = f"- `{nomination.user_id}`"
 
             member = await get_or_fetch_member(ctx.guild, nomination.user_id)
             if member:

bot/log.py

@@ -1,63 +1,29 @@
 import logging
 import os
 import sys
-from logging import Logger, handlers
+from logging import handlers
 from pathlib import Path
-from typing import TYPE_CHECKING, cast
 
 import coloredlogs
 import sentry_sdk
+from pydis_core.utils import logging as core_logging
 from sentry_sdk.integrations.logging import LoggingIntegration
 from sentry_sdk.integrations.redis import RedisIntegration
 
 from bot import constants
 
-TRACE_LEVEL = 5
-
-
-if TYPE_CHECKING:
-    LoggerClass = Logger
-else:
-    LoggerClass = logging.getLoggerClass()
-
-
-class CustomLogger(LoggerClass):
-    """Custom implementation of the `Logger` class with an added `trace` method."""
-
-    def trace(self, msg: str, *args, **kwargs) -> None:
-        """
-        Log 'msg % args' with severity 'TRACE'.
-
-        To pass exception information, use the keyword argument exc_info with
-        a true value, e.g.
-
-        logger.trace("Houston, we have an %s", "interesting problem", exc_info=1)
-        """
-        if self.isEnabledFor(TRACE_LEVEL):
-            self.log(TRACE_LEVEL, msg, *args, **kwargs)
-
-
-def get_logger(name: str | None = None) -> CustomLogger:
-    """Utility to make mypy recognise that logger is of type `CustomLogger`."""
-    return cast(CustomLogger, logging.getLogger(name))
+get_logger = core_logging.get_logger
 
 
 def setup() -> None:
     """Set up loggers."""
-    logging.TRACE = TRACE_LEVEL
-    logging.addLevelName(TRACE_LEVEL, "TRACE")
-    logging.setLoggerClass(CustomLogger)
-
     root_log = get_logger()
 
-    format_string = "%(asctime)s | %(name)s | %(levelname)s | %(message)s"
-    log_format = logging.Formatter(format_string)
-
     if constants.FILE_LOGS:
         log_file = Path("logs", "bot.log")
         log_file.parent.mkdir(exist_ok=True)
         file_handler = handlers.RotatingFileHandler(log_file, maxBytes=5242880, backupCount=7, encoding="utf8")
-        file_handler.setFormatter(log_format)
+        file_handler.setFormatter(core_logging.log_format)
         root_log.addHandler(file_handler)
 
     if "COLOREDLOGS_LEVEL_STYLES" not in os.environ:
@@ -69,18 +35,11 @@ def setup() -> None:
         }
 
     if "COLOREDLOGS_LOG_FORMAT" not in os.environ:
-        coloredlogs.DEFAULT_LOG_FORMAT = format_string
+        coloredlogs.DEFAULT_LOG_FORMAT = core_logging.log_format._fmt
 
-    coloredlogs.install(level=TRACE_LEVEL, logger=root_log, stream=sys.stdout)
+    coloredlogs.install(level=core_logging.TRACE_LEVEL, logger=root_log, stream=sys.stdout)
 
     root_log.setLevel(logging.DEBUG if constants.DEBUG_MODE else logging.INFO)
-    get_logger("discord").setLevel(logging.WARNING)
-    get_logger("websockets").setLevel(logging.WARNING)
-    get_logger("chardet").setLevel(logging.WARNING)
-    get_logger("async_rediscache").setLevel(logging.WARNING)
-
-    # Set back to the default of INFO even if asyncio's debug mode is enabled.
-    get_logger("asyncio").setLevel(logging.INFO)
 
     _set_trace_loggers()
 
@@ -121,13 +80,13 @@ def _set_trace_loggers() -> None:
     level_filter = constants.Bot.trace_loggers
     if level_filter:
         if level_filter.startswith("*"):
-            get_logger().setLevel(TRACE_LEVEL)
+            get_logger().setLevel(core_logging.TRACE_LEVEL)
 
         elif level_filter.startswith("!"):
-            get_logger().setLevel(TRACE_LEVEL)
+            get_logger().setLevel(core_logging.TRACE_LEVEL)
             for logger_name in level_filter.strip("!,").split(","):
                 get_logger(logger_name).setLevel(logging.DEBUG)
 
         else:
             for logger_name in level_filter.strip(",").split(","):
-                get_logger(logger_name).setLevel(TRACE_LEVEL)
+                get_logger(logger_name).setLevel(core_logging.TRACE_LEVEL)

bot/resources/tags/args-kwargs.md

@@ -11,9 +11,9 @@ These special parameters allow functions to take arbitrary amounts of positional
 `**kwargs` will ingest an arbitrary amount of **keyword arguments**, and store it in a dictionary. There can be **no** additional parameters **after** `**kwargs` in the parameter list.
 
 **Use cases**  
-• **Decorators** (see `/tag decorators`)  
-• **Inheritance** (overriding methods)  
-• **Future proofing** (in the case of the first two bullet points, if the parameters change, your code won't break)  
-• **Flexibility** (writing functions that behave like `dict()` or `print()`)  
+- **Decorators** (see `/tag decorators`)  
+- **Inheritance** (overriding methods)  
+- **Future proofing** (in the case of the first two bullet points, if the parameters change, your code won't break)  
+- **Flexibility** (writing functions that behave like `dict()` or `print()`)  
 
 *See* `/tag positional-keyword` *for information about positional and keyword arguments*

bot/resources/tags/blocking.md

@@ -19,8 +19,8 @@ async def ping(ctx):
 A blocking operation is wherever you do something without `await`ing it. This tells Python that this step must be completed before it can do anything else. Common examples of blocking operations, as simple as they may seem, include: outputting text, adding two numbers and appending an item onto a list. Most common Python libraries have an asynchronous version available to use in asynchronous contexts.
 
 **`async` libraries**
-The standard async library - `asyncio`
-Asynchronous web requests - `aiohttp`
-Talking to PostgreSQL asynchronously - `asyncpg`
-MongoDB interactions asynchronously - `motor`
-Check out [this](https://github.com/timofurrer/awesome-asyncio) list for even more!
+- The standard async library - `asyncio`
+- Asynchronous web requests - `aiohttp`
+- Talking to PostgreSQL asynchronously - `asyncpg`
+- MongoDB interactions asynchronously - `motor`
+- Check out [this](https://github.com/timofurrer/awesome-asyncio) list for even more!

bot/resources/tags/contribute.md

@@ -5,9 +5,9 @@ embed:
 Looking to contribute to Open Source Projects for the first time? Want to add a feature or fix a bug on the bots on this server? We have on-going projects that people can contribute to, even if you've never contributed to open source before!
 
 **Projects to Contribute to**
-• [Sir Lancebot](https://github.com/python-discord/sir-lancebot) - our fun, beginner-friendly bot
-• [Python](https://github.com/python-discord/bot) - our utility & moderation bot
-• [Site](https://github.com/python-discord/site) - resources, guides, and more
+- [Sir Lancebot](https://github.com/python-discord/sir-lancebot) - our fun, beginner-friendly bot
+- [Python](https://github.com/python-discord/bot) - our utility & moderation bot
+- [Site](https://github.com/python-discord/site) - resources, guides, and more
 
 **Where to start**
 1. Read our [contribution guide](https://pythondiscord.com/pages/guides/pydis-guides/contributing/)

bot/resources/tags/decorators.md

@@ -29,5 +29,5 @@ Finished!
 ```
 
 More information:  
-• [Corey Schafer's video on decorators](https://youtu.be/FsAPt_9Bf3U)  
-• [Real python article](https://realpython.com/primer-on-python-decorators/)  
+- [Corey Schafer's video on decorators](https://youtu.be/FsAPt_9Bf3U)  
+- [Real python article](https://realpython.com/primer-on-python-decorators/)  

bot/resources/tags/environments.md

@@ -18,12 +18,12 @@ If Python's `sys.executable` doesn't match pip's, then they are currently using
 
 **Why use a virtual environment?**
 
-• Resolve dependency issues by allowing the use of different versions of a package for different projects. For example, you could use Package A v2.7 for Project X and Package A v1.3 for Project Y.  
-• Make your project self-contained and reproducible by capturing all package dependencies in a requirements file. Try running `pip freeze` to see what you currently have installed!  
-• Keep your global `site-packages/` directory tidy by removing the need to install packages system-wide which you might only need for one project.
+- Resolve dependency issues by allowing the use of different versions of a package for different projects. For example, you could use Package A v2.7 for Project X and Package A v1.3 for Project Y.  
+- Make your project self-contained and reproducible by capturing all package dependencies in a requirements file. Try running `pip freeze` to see what you currently have installed!  
+- Keep your global `site-packages/` directory tidy by removing the need to install packages system-wide which you might only need for one project.
 
 
 **Further reading:**
 
-• [Python Virtual Environments: A Primer](https://realpython.com/python-virtual-environments-a-primer)  
-• [pyenv: Simple Python Version Management](https://github.com/pyenv/pyenv)
+- [Python Virtual Environments: A Primer](https://realpython.com/python-virtual-environments-a-primer)  
+- [pyenv: Simple Python Version Management](https://github.com/pyenv/pyenv)

bot/resources/tags/foo.md

@@ -8,5 +8,5 @@ Common examples include `foobar`, `foo`, `bar`, `baz`, and `qux`.
 Python has its own metasyntactic variables, namely `spam`, `eggs`, and `bacon`. This is a reference to a [Monty Python](https://en.wikipedia.org/wiki/Monty_Python) sketch (the eponym of the language).
 
 More information:  
-• [History of foobar](https://en.wikipedia.org/wiki/Foobar)  
-• [Monty Python sketch](https://en.wikipedia.org/wiki/Spam_%28Monty_Python%29)
+- [History of foobar](https://en.wikipedia.org/wiki/Foobar)  
+- [Monty Python sketch](https://en.wikipedia.org/wiki/Spam_%28Monty_Python%29)