Add mypy config for optional support.

Author: Avasam

.github/workflows/lint-and-build.yml

@@ -48,9 +48,7 @@ jobs:
           cache-dependency-path: "scripts/requirements*.txt"
       - run: scripts/install.ps1
         shell: pwsh
-      - run: (Get-Command pyuic6).Source
-        shell: pwsh
-      - name: Analysing the code with add-trailing-comma
+      - name: Analysing the code with isort
         run: isort src/ typings/ --check-only
   add-trailing-comma:
     runs-on: windows-latest

.vscode/settings.json

@@ -43,9 +43,7 @@
     ]
   },
   "files.associations": {
-    "*.json": "json",
-    "extensions.json": "jsonc",
-    "settings.json": "jsonc",
+    ".flake8": "properties",
     "*.qrc": "xml",
     "*.ui": "xml"
   },
@@ -57,11 +55,10 @@
     "**/.DS_Store": true,
     "**/Thumbs.db": true,
     "build": true,
-    ".mypy_cache": true,
+    "**/.mypy_cache": true,
     "**/__pycache__": true,
   },
   "search.exclude": {
-    "**/bower_components": true,
     "**/*.code-search": true,
     "*.lock": true,
   },
@@ -77,8 +74,10 @@
       120, // Our hard rule
     ],
   },
-  "python.formatting.provider": "autopep8",
+  // Important to follow the config in pyrightconfig.json
+  "python.analysis.useLibraryCodeForTypes": false,
   "python.analysis.diagnosticMode": "workspace",
+  "python.formatting.provider": "autopep8",
   "isort.check": true,
   "isort.importStrategy": "fromEnvironment",
   "python.linting.enabled": true,

mypy.ini

@@ -0,0 +1,21 @@
+; We don't run mypy in the CI. This is just to help anyone who would like to use it manually.
+; Namely, the mypy_primer tool.
+[mypy]
+strict=true
+; Implicit return types !
+disallow_untyped_calls=false
+disallow_untyped_defs=false
+disallow_incomplete_defs=false
+
+; Of course my stubs are going to be incomplete. Otherwise they'd be on typeshed!
+; Mypy becomes really whack with its errors inside these stubs though
+mypy_path=typings,src
+; exclude doesn't work with strict=true Why?
+exclude=.*(typings|gen)/.*
+
+[mypy-gen.*,cv2.*,]
+; strict=false ; Doesn't work in overrides
+follow_imports=skip
+implicit_reexport=true
+strict_optional=false
+disable_error_code=attr-defined, misc, name-defined

pyproject.toml

@@ -105,8 +105,6 @@ max-branches = 15
 # https://github.com/PyCQA/pep8-naming/issues/164
 # OR doesn't fit CaptureMethodMeta
 valid-classmethod-first-arg = "self"
-# https://pylint.pycqa.org/en/latest/user_guide/options.html#naming-styles
-module-naming-style = "any"
 disable = [
   # No need to mention the fixmes
   "fixme",
@@ -122,8 +120,6 @@ disable = [
   "unused-argument",
   # Only reports a single instance. Pyright does a better job anyway
   "cyclic-import",
-  # Doesn't work with local imports
-  "import-error",
   # Similar lines in 2 files, doesn't really work
   "R0801",
 ]

scripts/requirements-dev.txt

@@ -30,6 +30,11 @@ qt6-applications
 # Types
 types-d3dshot
 types-keyboard
+types-Pillow
+types-psutil
+types-PyAutoGUI
 types-pyinstaller
 types-pywin32
+types-requests
+types-toml
 typing-extensions

src/utils.py

@@ -81,7 +81,7 @@ def get_window_bounds(hwnd: int) -> tuple[int, int, int, int]:
     return window_left_bounds, window_top_bounds, window_width, window_height
 
 
-def open_file(file_path: str):
+def open_file(file_path: str | bytes | os.PathLike[str] | os.PathLike[bytes]):
     os.startfile(file_path)  # nosec B606
 
 

typings/cv2/gapi/streaming.pyi

@@ -0,0 +1,15 @@
+from cv2.cv2 import GMat, GOpaqueT, gapi_streaming_queue_capacity
+
+SYNC_POLICY_DONT_SYNC: int
+SYNC_POLICY_DROP: int
+sync_policy_dont_sync: int
+sync_policy_drop: int
+
+queue_capacity = gapi_streaming_queue_capacity
+
+
+def desync(g: GMat) -> GMat: ...
+def seqNo(arg1: GMat) -> GOpaqueT: ...
+def seq_id(arg1: GMat) -> GOpaqueT: ...
+def size(src: GMat) -> GOpaqueT: ...
+def timestamp(arg1: GMat) -> GOpaqueT: ...