Merge pull request #424 from TotallyNotRobots/add-pylint-mypy-actions

Add mypy and pylint workflows

Author: linuxdaemon

.github/workflows/codeql-analysis.yml

@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
-    - cron: '17 23 * * 6'
+  - cron: '17 23 * * 6'
 
 jobs:
   analyze:
@@ -32,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'python' ]
+        language: ['python']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

.github/workflows/mypy.yml

@@ -0,0 +1,31 @@
+name: Mypy type checking
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/[email protected]
+      with:
+        fetch-depth: 0
+    - name: Set up Python 3.8
+      uses: actions/[email protected]
+      with:
+        python-version: 3.8
+    - uses: actions/[email protected]
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install apt deps
+      run: sudo apt-get update && sudo apt-get install -qq -y libenchant-dev libxml2-dev libxslt1-dev
+    - name: Install dependencies
+      run: pip install -Ur requirements-dev.txt
+    - name: Test with mypy
+      run: pre-commit run mypy --all

.github/workflows/pylint.yml

@@ -0,0 +1,31 @@
+name: Pylint analysis
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/[email protected]
+      with:
+        fetch-depth: 0
+    - name: Set up Python 3.8
+      uses: actions/[email protected]
+      with:
+        python-version: 3.8
+    - uses: actions/[email protected]
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install apt deps
+      run: sudo apt-get update && sudo apt-get install -qq -y libenchant-dev libxml2-dev libxslt1-dev
+    - name: Install dependencies
+      run: pip install -Ur requirements-dev.txt
+    - name: Run pylint
+      run: pre-commit run pylint --all

.mypy.ini

@@ -7,3 +7,6 @@ strict_optional = False
 ignore_missing_imports = True
 check_untyped_defs = True
 show_error_codes = True
+warn_unused_ignores = True
+warn_redundant_casts = True
+;strict_equality = True

.pylintrc

@@ -62,6 +62,13 @@ confidence=
 # --disable=W".
 disable=invalid-name,
         missing-docstring,
+        consider-using-f-string,
+        consider-using-dict-items,
+        consider-using-with,
+        consider-using-min-builtin,
+        arguments-renamed,
+        use-maxsplit-arg,
+        consider-iterating-dictionary,
         redefined-outer-name,
         unused-argument,
         broad-except,
@@ -87,7 +94,7 @@ disable=invalid-name,
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time (only on the command line, not in the configuration file where
 # it should appear only once). See also the "--disable" option for examples.
-enable=
+enable=c-extension-no-member
 
 
 [REPORTS]

plugins/tvdb.py

@@ -245,7 +245,7 @@ def get(self) -> T:
         if not self._set:
             raise MissingItem()
 
-        return cast(T, self._item)
+        return self._item
 
 
 class LazyCollection(Sized, Iterable[T], Container[T]):

requirements-dev.txt

@@ -1,6 +1,7 @@
 coverage == 6.0.1
 freezegun == 1.1.0
 mypy == 0.910
+pre-commit == 2.15.0
 pylint == 2.11.1
 pytest == 6.2.5
 pytest-asyncio == 0.15.1

tests/conftest.py

@@ -92,6 +92,7 @@ def mock_api_keys():
     mock_bot = MagicMock()
     try:
         bot.set(mock_bot)
+        # pylint: disable=no-member
         mock_bot.config.get_api_key.return_value = "APIKEY"
         yield mock_bot
     finally:

tests/core_tests/irc_client_test.py

@@ -6,8 +6,8 @@
 
 import pytest
 
-import cloudbot.clients.irc as irc
 from cloudbot.client import ClientConnectError
+from cloudbot.clients import irc
 from cloudbot.event import Event, EventType
 from cloudbot.util import async_util
 from tests.util.async_mock import AsyncMock