Stage 10.0.0 - DO NOT MERGE

.deepsource.toml

@@ -0,0 +1,18 @@
+version = 1
+
+test_patterns = ["MirahezeBots/tests/*.py"]
+
+[[analyzers]]
+name = "python"
+enabled = true
+
+  [analyzers.meta]
+  runtime_version = "3.x.x"
+
+[[transformers]]
+name = "autopep8"
+enabled = false
+
+[[transformers]]
+name = "isort"
+enabled = false

.flake8

@@ -1,6 +1,6 @@
 [flake8]
-max-line-length = 265
+max-line-length = 125
 exclude = */__init__.py, dist/*, build/*
-extend-ignore = SFS301
+extend-ignore = SFS301, SIM114
 per-file-ignores = 
     MirahezeBots/utils/phabapi.py:SFS201

.github/workflows/codeql-analysis.yml

@@ -14,7 +14,10 @@ name: "CodeQL"
 
 on:
   push:
-  pull_request:
+    branches:
+      - dev
+      - release
+  pull_request_target:
   schedule:
     - cron: '25 22 * * 6'
 
@@ -32,15 +35,20 @@ jobs:
         # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 
     steps:
+    - name: Cancel Previous Runs
+      uses: styfle/cancel-workflow-action@0.10.0
+      with:
+        all_but_latest: true
+        access_token: ${{ github.token }}
     - name: Checkout repository
-      uses: actions/checkout@v2.3.4
+      uses: actions/checkout@v3
     - name: Setup python 3.9
-      uses: actions/setup-python@v2.2.2
+      uses: actions/setup-python@v4
       with:
         python-version: 3.9
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -51,7 +59,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -65,4 +73,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/dependabot-merge.yml

@@ -0,0 +1,22 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/workflow.yml

@@ -2,27 +2,28 @@ name: 'Main CI Build'
 on: [push, pull_request_target]
 
 jobs:
-  build:
+  test:
+    name: Test Build (Python ${{ matrix.python }} on ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python: ['3.7', '3.8', '3.9', '3.9-dev', '3.10-dev']
+        python: ['3.8', '3.9', '3.9-dev', '3.10-dev']
         os: ['ubuntu-latest', 'macos-latest']
     steps:
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.9.0
+        uses: styfle/cancel-workflow-action@0.10.0
         with:
           access_token: ${{ github.token }}
-      - uses: actions/checkout@v2.3.4
+      - uses: actions/checkout@v3
         with:
           submodules: true
       - name: Setup Python ${{ matrix.python }} on ${{ matrix.os }}
-        uses: actions/setup-python@v2.2.2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }} 
       - name: Install packages
         run: |
-          python -m pip install --upgrade pip wheel
+          python -m pip install --upgrade pip==21.3.1 wheel
           pip install -r dev-requirements.txt
           pyproject-build --wheel --outdir dist .
           find dist -name "*.whl" | xargs pip3 install
@@ -35,30 +36,32 @@ jobs:
         run: |
           flake8 .
           pytest --pyargs MirahezeBots.tests
-          pip-missing-reqs --ignore-file=setup.py --ignore-module=pytest --ignore-module=MirahezeBots.* . --ignore-file=MirahezeBots/tests/* --ignore-file=build/*
+          bandit MirahezeBots -r -x MirahezeBots/test
+          mypy -p MirahezeBots --exclude=build --ignore-missing-imports  --disallow-untyped-defs
+          pip install -r compatibility.txt
           pip check
       - name: Run pip freeze and pipdeptree
         run: |
           pip freeze
           pipdeptree
+      - name: Show outdated packages
+        run: pip list --outdated
   deploy:
     runs-on: ubuntu-latest
     steps:
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.9.0
+        uses: styfle/cancel-workflow-action@0.10.0
         with:
           access_token: ${{ github.token }}
-      - uses: actions/checkout@v2.3.4
+      - uses: actions/checkout@v3
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2.2.2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.9
       - name: Install pypa/build
-        run: >-
-          python -m
-          pip install
-          build
-          --user
+        run: |
+          python -m pip install --upgrade pip==21.1.0
+          pip install -r dev-requirements.txt
       - name: Build a binary wheel
         run: pyproject-build --wheel --outdir dist .
       - name: Publish to PyPi
@@ -71,10 +74,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Cancel Previous Runs
-        uses: styfle/cancel-workflow-action@0.9.0
+        uses: styfle/cancel-workflow-action@0.10.0
         with:
           access_token: ${{ github.token }}
-      - uses: actions/checkout@v2.3.4
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
       - name: SonarCloud Scan

.gitignore

@@ -1,4 +1,6 @@
 dist/*
+build/*
+build
 dist
 __pycache__
 __pycache__/*

MirahezeBots/dbclean.py

@@ -1,12 +1,14 @@
-import sqlite3
+"""Remove a list of users from sopel database."""
+from sqlite3 import connect
 
 
-def main():
-    file = input("Full path to the deletion list: ")
+def rundel() -> None:
+    """Attempt the actual function for the cli script."""
+    file = input('Full path to the deletion list: ')
     with open(file, 'r') as f:  # ensure the file is open and closed properly
         users = f.readlines()
-    database = input("Full path to database: ")
-    with sqlite3.connect(database) as conn:
+    database = input('Full path to database: ')
+    with connect(database) as conn:
         curs = conn.cursor()
         for user in users:
             curs.execute('DELETE FROM nick_values WHERE nick_id = ?', (user,))
@@ -15,4 +17,5 @@ def main():
         conn.commit()
 
 
-main()
+if __name__ == '__main__':
+    rundel()

MirahezeBots/plugins/goofy.py

@@ -1,63 +1,57 @@
-""" Some commands for just goofing around and having fun """
+"""Some commands for just goofing around and having fun."""
 
-from sopel.module import commands, example
+from sopel.plugin import commands, example
+from sopel import bot, trigger
 
 
 @example('.coffee MirahezeBot')
 @commands('coffee')
-def coffee(bot, trigger):
-    """
-    Makes me give the specified nick a coffee.
-    """
-    if trigger.group(2) is None:
-        bot.reply("To whom should I give this cup of coffee?")
+def coffee(instance: bot, message: trigger) -> None:
+    """Make me give the specified nick a coffee."""
+    if message.group(2) is None:
+        instance.reply('To whom should I give this cup of coffee?')
     else:
-        bot.action("gives %s a nice warm cup of coffee." % (trigger.group(2)), trigger.sender)
+        instance.action(f'gives {message.group(2)} a nice warm cup of coffee.', message.sender)
 
 
 @example('.hug MirahezeBot')
 @commands('hug')
-def hug(bot, trigger):
-    """
-    Makes me give the specified nick a hug.
-    """
-    if trigger.group(2) is None:
-        bot.reply("To whom should I give this hug?")
+def hug(instance: bot, message: trigger) -> None:
+    """Make me give the specified nick a hug."""
+    if message.group(2) is None:
+        instance.reply('To whom should I give this hug?')
     else:
-        bot.action("gives %s a great big bear hug." % (trigger.group(2)), trigger.sender)
+        instance.action(f'gives {message.group(2)} a great big bear hug.', message.sender)
 
 
 @example('.burger MirahezeBot')
 @commands('burger')
-def burger(bot, trigger):
-    """
-    Makes me give the specified nick a burger.
-    """
-    if trigger.group(2) is None:
-        bot.reply("To whom should I give this cheeseburger?")
+def burger(instance: bot, message: trigger) -> None:
+    """Make me give the specified nick a burger."""
+    if message.group(2) is None:
+        instance.reply('To whom should I give this cheeseburger?')
     else:
-        bot.action("gives %s a freshly cooked cheeseburger." % (trigger.group(2)), trigger.sender)
+        instance.action(f'gives {message.group(2)} a freshly cooked cheeseburger.', message.sender)
 
 
 @example('.present MirahezeBot')
 @commands('present')
-def present(bot, trigger):
-    """
-    Makes me give the specified nick a present.
-    """
-    if trigger.group(2) is None:
-        bot.reply("To whom should I give this present?")
+def present(instance: bot, message: trigger) -> None:
+    """Make me give the specified nick a present."""
+    if message.group(2) is None:
+        instance.reply('To whom should I give this present?')
     else:
-        bot.action("gives %s a present." % (trigger.group(2)), trigger.sender)
+        instance.action(f'gives {message.group(2)} a present.', message.sender)
 
 
 @example('.hotchoc MirahezeBot')
 @commands('hotchoc', 'hotchocolate')
-def hotchoc(bot, trigger):
-    """
-    Makes me give the specified nick a hot chocolate.
-    """
-    if trigger.group(2) is None:
-        bot.reply("To whom should I give this hot chocolate?")
+def hotchoc(instance: bot, message: trigger) -> None:
+    """Make me give the specified nick a hot chocolate."""
+    if message.group(2) is None:
+        instance.reply('To whom should I give this hot chocolate?')
     else:
-        bot.action("gives %s a warm, velvety salted caramel hot chocolate with cream and marhsmellows." % (trigger.group(2)), trigger.sender)
+        instance.action(
+            f'gives {message.group(2)} a warm, velvety salted caramel hot chocolate with cream and marhsmellows.',
+            message.sender,
+        )

MirahezeBots/plugins/miraheze.py

@@ -1,5 +1,6 @@
 """This plugin contains miraheze specific commands."""
-from sopel.module import commands, example, rule
+from sopel.plugin import commands, example, rule
+from sopel import bot, trigger
 
 MIRAHEZE_ABOUT_MIRAHEZE_CHANNEL = (
     'Miraheze is a non-profit wikifarm running MediaWiki. If you would like '
@@ -16,31 +17,28 @@
 @commands('miraheze')
 @rule('.*[w-wW-W]hat (even is [m-mM-M]iraheze|is [m-mM-M]iraheze|does [m-mM-M]iraheze do).*')
 @example('.miraheze')
-def miraheze(bot, trigger):
-    """
-    Miraheze about command.
-
-    This command will tell you about Miraheze and where to learn more.
-    """
-    if trigger.sender == '#miraheze':
-        bot.reply(MIRAHEZE_ABOUT_MIRAHEZE_CHANNEL)
+def miraheze(instance: bot, message: trigger) -> None:
+    """Tells you about Miraheze and where to learn more."""
+    if message.sender == '#miraheze':
+        instance.reply(MIRAHEZE_ABOUT_MIRAHEZE_CHANNEL)
     else:
-        bot.reply(MIRAHEZE_ABOUT_OTHER_CHANNELS)
+        instance.reply(MIRAHEZE_ABOUT_OTHER_CHANNELS)
 
 
 @commands('gethelp')
 @rule("([i-iI-I] need help|[c-cC-C]an someone help me|[i-iI-I] can(t|'t) login).*")
 @example('.gethelp I cannot access https://meta.miraheze.org')
-def miraheze_gethelp(bot, trigger):
+def miraheze_gethelp(instance: bot, message: trigger) -> None:
     """Reply to help requests."""
-    if trigger.sender == '#miraheze':
-        bot.reply('Pinging dmehus, JohnLewis, paladox, PuppyKun, Reception123, RhinosF1, SPF|Cloud, Universal_Omega, and Voidwalker,'
-                  'who might be able to help you. Other users in this channel also see this and may be able to assist you.')
+    if message.sender == '#miraheze':
+        instance.reply(
+            'Pinging Agent, CosmicAlpha, dmehus, JohnLewis, paladox, Reception123, RhinosF1 and Voidwalker,'
+            'who might be able to help you. Other users in this channel also see this and may be able to assist you.')
     else:
-        bot.reply('If you need Miraheze releated help, please join #miraheze')
+        instance.reply('If you need Miraheze releated help, please join #miraheze')
 
 
 @commands('discord')
-def miraheze_discord(bot, trigger):
-    """Displays discord information for Miraheze."""
-    bot.reply('You can join discord by going to, https://discord.is/miraheze!')
+def miraheze_discord(instance: bot, message: trigger) -> None:  # noqa: U100
+    """Display discord information for Miraheze."""
+    instance.reply('You can join discord by going to, https://miraheze.org/discord!')