From 8b1daf1ad0cdc5462723f25540b66e940605127d Mon Sep 17 00:00:00 2001 From: Jakub Kuczys Date: Mon, 27 Jan 2025 00:49:03 +0100 Subject: [PATCH] Move private things in modlog and `redbot.core.errors` (#6020) --- redbot/core/_drivers/_mongo.py | 4 ++-- redbot/core/_drivers/base.py | 6 +++++- redbot/core/_drivers/postgres/postgres.py | 4 ++-- redbot/core/core_commands.py | 2 +- redbot/core/errors.py | 4 ---- redbot/core/modlog.py | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/redbot/core/_drivers/_mongo.py b/redbot/core/_drivers/_mongo.py index a628c1669..8ff9bb790 100644 --- a/redbot/core/_drivers/_mongo.py +++ b/redbot/core/_drivers/_mongo.py @@ -18,7 +18,7 @@ except ModuleNotFoundError: pymongo = None from .. import errors -from .base import BaseDriver, IdentifierData +from .base import BaseDriver, IdentifierData, MissingExtraRequirements __all__ = ["MongoDriver"] @@ -33,7 +33,7 @@ class MongoDriver(BaseDriver): @classmethod async def initialize(cls, **storage_details) -> None: if motor is None: - raise errors.MissingExtraRequirements( + raise MissingExtraRequirements( "Red must be installed with the [mongo] extra to use the MongoDB driver" ) uri = storage_details.get("URI", "mongodb") diff --git a/redbot/core/_drivers/base.py b/redbot/core/_drivers/base.py index 8ca710e35..654b9a447 100644 --- a/redbot/core/_drivers/base.py +++ b/redbot/core/_drivers/base.py @@ -6,7 +6,11 @@ import rich.progress from redbot.core.utils._internal_utils import RichIndefiniteBarColumn -__all__ = ["BaseDriver", "IdentifierData", "ConfigCategory"] +__all__ = ("BaseDriver", "IdentifierData", "ConfigCategory", "MissingExtraRequirements") + + +class MissingExtraRequirements(Exception): + """Raised when an extra requirement is missing but required.""" class ConfigCategory(str, enum.Enum): diff --git a/redbot/core/_drivers/postgres/postgres.py b/redbot/core/_drivers/postgres/postgres.py index 5e77c0819..2d90b8a55 100644 --- a/redbot/core/_drivers/postgres/postgres.py +++ b/redbot/core/_drivers/postgres/postgres.py @@ -11,7 +11,7 @@ except ModuleNotFoundError: asyncpg = None from ... import data_manager, errors -from ..base import BaseDriver, IdentifierData, ConfigCategory +from ..base import BaseDriver, IdentifierData, ConfigCategory, MissingExtraRequirements from ..log import log __all__ = ["PostgresDriver"] @@ -41,7 +41,7 @@ class PostgresDriver(BaseDriver): @classmethod async def initialize(cls, **storage_details) -> None: if asyncpg is None: - raise errors.MissingExtraRequirements( + raise MissingExtraRequirements( "Red must be installed with the [postgres] extra to use the PostgreSQL driver" ) cls._pool = await asyncpg.create_pool(**storage_details) diff --git a/redbot/core/core_commands.py b/redbot/core/core_commands.py index 82c73dfae..d3acfa3c8 100644 --- a/redbot/core/core_commands.py +++ b/redbot/core/core_commands.py @@ -2757,7 +2757,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic): @modlogset.command(hidden=True, name="fixcasetypes") async def modlogset_fixcasetypes(self, ctx: commands.Context): """Command to fix misbehaving casetypes.""" - await modlog.handle_auditype_key() + await modlog._handle_audit_type_key() await ctx.tick() @modlogset.command(aliases=["channel"], name="modlog") diff --git a/redbot/core/errors.py b/redbot/core/errors.py index c3e6da8c9..8f7a7eb8e 100644 --- a/redbot/core/errors.py +++ b/redbot/core/errors.py @@ -67,10 +67,6 @@ class BankPruneError(BankError): """Raised when trying to prune a local bank and no server is specified.""" -class MissingExtraRequirements(RedError): - """Raised when an extra requirement is missing but required.""" - - class ConfigError(RedError): """Error in a Config operation.""" diff --git a/redbot/core/modlog.py b/redbot/core/modlog.py index bd0a2fea8..8db04215f 100644 --- a/redbot/core/modlog.py +++ b/redbot/core/modlog.py @@ -120,7 +120,7 @@ async def _init(bot: Red): bot.add_listener(on_audit_log_entry_create) -async def handle_auditype_key(): +async def _handle_audit_type_key(): all_casetypes = { casetype_name: { inner_key: inner_value @@ -162,7 +162,7 @@ async def _migrate_config(from_version: int, to_version: int): ) if from_version < 3 <= to_version: - await handle_auditype_key() + await _handle_audit_type_key() await _config.schema_version.set(3) if from_version < 4 <= to_version: