diff options
| author | 2021-05-14 12:34:30 -0400 | |
|---|---|---|
| committer | 2021-05-14 12:34:30 -0400 | |
| commit | 92c33d625068b9b39564dbf4fb9f6c1102711955 (patch) | |
| tree | 40ce3e18ff8df18cb09ca2c3b2c7f00fa7e5811a /bot/utils | |
| parent | chore: Break up the HelpSession.build_pages method (diff) | |
chore: Refactor more code to follow our style guide
Diffstat (limited to 'bot/utils')
| -rw-r--r-- | bot/utils/__init__.py | 11 | ||||
| -rw-r--r-- | bot/utils/checks.py | 30 | 
2 files changed, 28 insertions, 13 deletions
| diff --git a/bot/utils/__init__.py b/bot/utils/__init__.py index 09a4dfc3..a1985019 100644 --- a/bot/utils/__init__.py +++ b/bot/utils/__init__.py @@ -3,7 +3,7 @@ import contextlib  import re  import string  from datetime import datetime -from typing import Iterable, List +from typing import Iterable, List, Optional  import discord  from discord.ext.commands import BadArgument, Context @@ -31,8 +31,13 @@ def resolve_current_month() -> Month:  async def disambiguate( -        ctx: Context, entries: List[str], *, timeout: float = 30, -        entries_per_page: int = 20, empty: bool = False, embed: discord.Embed = None +    ctx: Context, +    entries: List[str], +    *, +    timeout: float = 30, +    entries_per_page: int = 20, +    empty: bool = False, +    embed: Optional[discord.Embed] = None  ) -> str:      """      Has the user choose between multiple entries in case one could not be chosen automatically. diff --git a/bot/utils/checks.py b/bot/utils/checks.py index 3783dd38..c06b6870 100644 --- a/bot/utils/checks.py +++ b/bot/utils/checks.py @@ -92,8 +92,10 @@ def in_whitelist_check(  def with_role_check(ctx: Context, *role_ids: int) -> bool:      """Returns True if the user has any one of the roles in role_ids."""      if not ctx.guild:  # Return False in a DM -        log.trace(f"{ctx.author} tried to use the '{ctx.command.name}'command from a DM. " -                  "This command is restricted by the with_role decorator. Rejecting request.") +        log.trace( +            f"{ctx.author} tried to use the '{ctx.command.name}'command from a DM. " +            "This command is restricted by the with_role decorator. Rejecting request." +        )          return False      for role in ctx.author.roles: @@ -101,22 +103,28 @@ def with_role_check(ctx: Context, *role_ids: int) -> bool:              log.trace(f"{ctx.author} has the '{role.name}' role, and passes the check.")              return True -    log.trace(f"{ctx.author} does not have the required role to use " -              f"the '{ctx.command.name}' command, so the request is rejected.") +    log.trace( +        f"{ctx.author} does not have the required role to use " +        f"the '{ctx.command.name}' command, so the request is rejected." +    )      return False  def without_role_check(ctx: Context, *role_ids: int) -> bool:      """Returns True if the user does not have any of the roles in role_ids."""      if not ctx.guild:  # Return False in a DM -        log.trace(f"{ctx.author} tried to use the '{ctx.command.name}' command from a DM. " -                  "This command is restricted by the without_role decorator. Rejecting request.") +        log.trace( +            f"{ctx.author} tried to use the '{ctx.command.name}' command from a DM. " +            "This command is restricted by the without_role decorator. Rejecting request." +        )          return False      author_roles = [role.id for role in ctx.author.roles]      check = all(role not in author_roles for role in role_ids) -    log.trace(f"{ctx.author} tried to call the '{ctx.command.name}' command. " -              f"The result of the without_role check was {check}.") +    log.trace( +        f"{ctx.author} tried to call the '{ctx.command.name}' command. " +        f"The result of the without_role check was {check}." +    )      return check @@ -154,8 +162,10 @@ def cooldown_with_role_bypass(rate: int, per: float, type: BucketType = BucketTy          #          # If the `before_invoke` detail is ever a problem then I can quickly just swap over.          if not isinstance(command, Command): -            raise TypeError("Decorator `cooldown_with_role_bypass` must be applied after the command decorator. " -                            "This means it has to be above the command decorator in the code.") +            raise TypeError( +                "Decorator `cooldown_with_role_bypass` must be applied after the command decorator. " +                "This means it has to be above the command decorator in the code." +            )          command._before_invoke = predicate | 
