Introduce pre-commit with some built-in rules

Author: em92

.github/workflows/pre-commit.yml

@@ -0,0 +1,26 @@
+name: pre-commit
+
+on:
+  pull_request:
+    branches:
+      - "master"
+  push:
+    branches:
+      - "master"
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v2
+      - name: Get python version
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run pre-commit
+        run: pre-commit run --all-files --show-diff-on-failure --color=always

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace

LICENSE

@@ -672,4 +672,3 @@ may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
-

balance.py

@@ -82,7 +82,7 @@ def handle_round_countdown(self, *args, **kwargs):
             def f():
                 self.execute_suggestion()
             f()
-        
+
         self.in_countdown = True
 
     def handle_round_start(self, *args, **kwargs):
@@ -100,7 +100,7 @@ def f():
                 if len(players["red"] + players["blue"]) % 2 != 0:
                     self.msg("Teams were ^6NOT^7 balanced due to the total number of players being an odd number.")
                     return
-                
+
                 players = dict([(p.steam_id, gt) for p in players["red"] + players["blue"]])
                 self.add_request(players, self.callback_balance, minqlx.CHAT_CHANNEL)
             f()
@@ -166,7 +166,7 @@ def fetch_ratings(self, players, request_id):
             last_status = res.status_code
             if res.status_code != requests.codes.ok:
                 continue
-            
+
             js = res.json()
             if "players" not in js:
                 last_status = -1
@@ -181,14 +181,14 @@ def fetch_ratings(self, players, request_id):
                 with self.ratings_lock:
                     if sid not in self.ratings:
                         self.ratings[sid] = {}
-                    
+
                     for gt in p:
                         p[gt]["time"] = t
                         p[gt]["local"] = False
                         self.ratings[sid][gt] = p[gt]
                         if self.ratings[sid][gt]["elo"] == 0 and self.ratings[sid][gt]["games"] == 0:
                             self.ratings[sid][gt]["elo"] = DEFAULT_RATING
-                        
+
                         if sid in players and gt == players[sid]:
                             # The API gave us the game type we wanted, so we remove it.
                             del players[sid]
@@ -304,13 +304,13 @@ def callback_getrating(self, players, channel, gametype):
             name = player.name
         else:
             name = sid
-        
+
         channel.reply("{} has a rating of ^6{}^7 in {}.".format(name, self.ratings[sid][gametype]["elo"], gametype.upper()))
 
     def cmd_setrating(self, player, msg, channel):
         if len(msg) < 3:
             return minqlx.RET_USAGE
-        
+
         try:
             sid = int(msg[1])
             target_player = None
@@ -323,7 +323,7 @@ def cmd_setrating(self, player, msg, channel):
         except minqlx.NonexistentPlayerError:
             player.tell("Invalid client ID. Use either a client ID or a SteamID64.")
             return minqlx.RET_STOP_ALL
-        
+
         try:
             rating = int(msg[2])
         except ValueError:
@@ -334,7 +334,7 @@ def cmd_setrating(self, player, msg, channel):
             name = target_player.name
         else:
             name = sid
-        
+
         gt = self.game.type_short
         self.db[RATING_KEY.format(sid, gt)] = rating
 
@@ -350,7 +350,7 @@ def cmd_setrating(self, player, msg, channel):
     def cmd_remrating(self, player, msg, channel):
         if len(msg) < 2:
             return minqlx.RET_USAGE
-        
+
         try:
             sid = int(msg[1])
             target_player = None
@@ -363,12 +363,12 @@ def cmd_remrating(self, player, msg, channel):
         except minqlx.NonexistentPlayerError:
             player.tell("Invalid client ID. Use either a client ID or a SteamID64.")
             return minqlx.RET_STOP_ALL
-        
+
         if target_player:
             name = target_player.name
         else:
             name = sid
-        
+
         gt = self.game.type_short
         del self.db[RATING_KEY.format(sid, gt)]
 
@@ -389,7 +389,7 @@ def cmd_balance(self, player, msg, channel):
         if len(teams["red"] + teams["blue"]) % 2 != 0:
             player.tell("The total number of players should be an even number.")
             return minqlx.RET_STOP_ALL
-        
+
         players = dict([(p.steam_id, gt) for p in teams["red"] + teams["blue"]])
         self.add_request(players, self.callback_balance, minqlx.CHAT_CHANNEL)
 
@@ -453,12 +453,12 @@ def cmd_teams(self, player, msg, channel):
         if gt not in SUPPORTED_GAMETYPES:
             player.tell("This game mode is not supported by the balance plugin.")
             return minqlx.RET_STOP_ALL
-        
+
         teams = self.teams()
         if len(teams["red"]) != len(teams["blue"]):
             player.tell("Both teams should have the same number of players.")
             return minqlx.RET_STOP_ALL
-        
+
         teams = dict([(p.steam_id, gt) for p in teams["red"] + teams["blue"]])
         self.add_request(teams, self.callback_teams, channel)
 
@@ -514,7 +514,7 @@ def cmd_agree(self, player, msg, channel):
         """After the bot suggests a switch, players in question can use this to agree to the switch."""
         if self.suggested_pair and not all(self.suggested_agree):
             p1, p2 = self.suggested_pair
-            
+
             if p1 == player:
                 self.suggested_agree[0] = True
             elif p2 == player:
@@ -534,7 +534,7 @@ def cmd_ratings(self, player, msg, channel):
         if gt not in EXT_SUPPORTED_GAMETYPES:
             player.tell("This game mode is not supported by the balance plugin.")
             return minqlx.RET_STOP_ALL
-        
+
         players = dict([(p.steam_id, gt) for p in self.players()])
         self.add_request(players, self.callback_ratings, channel)
 
@@ -612,9 +612,9 @@ def execute_suggestion(self):
             p2.update()
         except minqlx.NonexistentPlayerError:
             return
-        
+
         if p1.team != "spectator" and p2.team != "spectator":
             self.switch(self.suggested_pair[0], self.suggested_pair[1])
-        
+
         self.suggested_pair = None
         self.suggested_agree = [False, False]

ban.py

@@ -49,7 +49,7 @@ def __init__(self):
         # List of players playing that could potentially be considered leavers.
         self.players_start = []
         self.pending_warnings = {}
-    
+
     def handle_player_connect(self, player):
         status = self.leave_status(player.steam_id)
         # Check if a player has been banned for leaving, if we're doing that.
@@ -58,7 +58,7 @@ def handle_player_connect(self, player):
         # Check if player needs to be warned.
         elif status and status[0] == "warn":
             self.pending_warnings[player.steam_id] = status[1]
-        
+
         # Check if a player has been banned manually.
         banned = self.is_banned(player.steam_id)
         if banned:
@@ -156,7 +156,7 @@ def cmd_ban(self, player, msg, channel):
         except minqlx.NonexistentPlayerError:
             channel.reply("Invalid client ID. Use either a client ID or a SteamID64.")
             return
-        
+
         if target_player:
             name = target_player.name
         else:
@@ -171,14 +171,14 @@ def cmd_ban(self, player, msg, channel):
             reason = " ".join(msg[4:])
         else:
             reason = ""
-        
+
         r = LENGTH_REGEX.match(" ".join(msg[2:4]).lower())
         if r:
             number = float(r.group("number"))
             if number <= 0: return
             scale = r.group("scale").rstrip("s")
             td = None
-            
+
             if scale == "second":
                 td = datetime.timedelta(seconds=number)
             elif scale == "minute":
@@ -193,7 +193,7 @@ def cmd_ban(self, player, msg, channel):
                 td = datetime.timedelta(days=number * 30)
             elif scale == "year":
                 td = datetime.timedelta(weeks=number * 52)
-            
+
             now = datetime.datetime.now().strftime(TIME_FORMAT)
             expires = (datetime.datetime.now() + td).strftime(TIME_FORMAT)
             base_key = PLAYER_KEY.format(ident) + ":bans"
@@ -203,7 +203,7 @@ def cmd_ban(self, player, msg, channel):
             ban = {"expires": expires, "reason": reason, "issued": now, "issued_by": player.steam_id}
             db.hmset(base_key + ":{}".format(ban_id), ban)
             db.execute()
-            
+
             try:
                 self.kick(ident, "has been banned until ^6{}^7: {}".format(expires, reason))
             except ValueError:
@@ -226,7 +226,7 @@ def cmd_unban(self, player, msg, channel):
         except minqlx.NonexistentPlayerError:
             channel.reply("Invalid client ID. Use either a client ID or a SteamID64.")
             return
-        
+
         if target_player:
             name = target_player.name
         else:
@@ -260,7 +260,7 @@ def cmd_checkban(self, player, msg, channel):
         except minqlx.NonexistentPlayerError:
             channel.reply("Invalid client ID. Use either a client ID or a SteamID64.")
             return
-        
+
         if target_player:
             name = target_player.name
         else:
@@ -280,7 +280,7 @@ def cmd_checkban(self, player, msg, channel):
             if status and status[0] == "ban":
                 channel.reply("^6{} ^7is banned for having left too many games.".format(name))
                 return
-        
+
         channel.reply("^6{} ^7is not banned.".format(name))
 
     def cmd_forgive(self, player, msg, channel):
@@ -300,7 +300,7 @@ def cmd_forgive(self, player, msg, channel):
         except minqlx.NonexistentPlayerError:
             channel.reply("Invalid client ID. Use either a client ID or a SteamID64.")
             return
-        
+
         if target_player:
             name = target_player.name
         else:
@@ -310,12 +310,12 @@ def cmd_forgive(self, player, msg, channel):
         if base_key not in self.db:
             channel.reply("I do not know ^6{}^7.".format(name))
             return
-        
+
         try:
             leaves = int(self.db[base_key + ":games_left"])
         except KeyError:
             leaves = 0
-        
+
         if leaves <= 0:
             channel.reply("^6{}^7's leaves are already at ^6{}^7.".format(name, leaves))
             return
@@ -353,7 +353,7 @@ def is_banned(self, steam_id):
         expires = datetime.datetime.strptime(longest_ban["expires"], TIME_FORMAT)
         if (expires - datetime.datetime.now()).total_seconds() > 0:
             return expires, longest_ban["reason"]
-        
+
         return None
 
     def leave_status(self, steam_id):
@@ -368,7 +368,7 @@ def leave_status(self, steam_id):
             left = self.db[PLAYER_KEY.format(steam_id) + ":games_left"]
         except KeyError:
             return None
-        
+
         completed = int(completed)
         left = int(left)
 
@@ -386,7 +386,7 @@ def leave_status(self, steam_id):
             ratio = (completed + (min_games_completed - total)) / min_games_completed
         else:
             ratio = completed / total
-            
+
         if ratio <= warn_threshold and (ratio > ban_threshold or total < min_games_completed):
             action = "warn"
         elif ratio <= ban_threshold and total >= min_games_completed:

clan.py

@@ -47,7 +47,7 @@ def handle_set_configstring(self, index, value):
     def cmd_clan(self, player, msg, channel):
         index = 529 + player.id
         tag_key = _tag_key.format(player.steam_id)
-        
+
         if len(msg) < 2:
             if tag_key in self.db:
                 del self.db[tag_key]
@@ -64,7 +64,7 @@ def cmd_clan(self, player, msg, channel):
         if len(self.clean_text(msg[1])) > 5:
             player.tell("The clan tag can only be at most 5 characters long, excluding colors.")
             return minqlx.RET_STOP_EVENT
-        
+
         # If the player already has a clan, we need to edit the current
         # configstring. We can't just append cn and xcn.
         tag = self.clean_tag(msg[1])
@@ -83,4 +83,3 @@ def sub_func(match):
             return match.group(1)
 
         return _re_remove_excessive_colors.sub(sub_func, tag)
-

docs.py

@@ -49,7 +49,7 @@ def cmd_gencmd(self, players, msg, channel):
             "below. A level **2** player can execute level **2**, **1** and **0** commands, and so on.\n"
             "\n\n"
             )
-        
+
         for perm in sorted(cmds.keys()):
             out += "*   Permission level **{}**\n\n".format(perm)
             for cmd in sorted(cmds[perm], key=lambda x: x.plugin.__class__.__name__):
@@ -62,7 +62,7 @@ def cmd_gencmd(self, players, msg, channel):
                         out += "`{}`, ".format(name_alias)
                     out = out[:-2] + ")"
                 out += " from *{}*\n\n".format(cmd.plugin.__class__.__name__)
-                
+
                 # Docstring.
                 if cmd.handler.__doc__:
                     out += "        {}\n\n".format(cmd.handler.__doc__)
@@ -71,7 +71,7 @@ def cmd_gencmd(self, players, msg, channel):
                 if cmd.usage:
                     out += "        *Usage*: `{} {}`\n\n" \
                         .format(name, cmd.usage)
-        
+
         out += "*Automatically generated by [minqlx {} (with plugins {})](https://github.com/MinoMino/minqlx)*" \
             .format(minqlx.__version__, minqlx.__plugins_version__)