Linted pyi files

Author: Avasam

.flake8

@@ -8,8 +8,20 @@ exclude=src/gen/
 ; Allow imports at the bottom of file
 ignore=W503,Y015,E402
 per-file-ignores=
+    ; Uses "pass" for empty body
+    ; Default arguments
+    ; Doesn't work when using /** below for some reasons
+    ; win32typing.pyi:  Y010,Y011,
+    ; win32gui.pyi:     Y010,Y011,
+    ;
     ; Quotes
-    __init__.pyi:Q000
+    ; undefined name 'Unknown'
+    ; allow ... on same line as def
+    ; Naming stuff
+    ;
+    ; Q002 quote docstring for cv2-stubs
+    typings/**:       Q000,F821,E704,N8,E501,Y010,Y011,Q002
+
 ; PyQt methods
 ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent
 ; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there

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

@@ -64,7 +64,7 @@ jobs:
           pip install -r "scripts/requirements.txt"
       - run: scripts/compile_resources.bat
       - name: Analysing the code with ${{ job.name }}
-        run: pylint --reports=y --output-format=colorized $(git ls-files '**/*.py*')
+        run: pylint --reports=y --output-format=colorized $(git ls-files '**/*.py')
   Flake8:
     runs-on: windows-latest
     strategy:

PyInstaller/hooks/hook-cv2.py

@@ -1,15 +1,16 @@
-# ------------------------------------------------------------------
-# Copyright (c) 2020 PyInstaller Development Team.
-#
-# This file is distributed under the terms of the GNU General Public
-# License (version 2.0 or later).
-#
-# The full license is available in LICENSE.GPL.txt, distributed with
-# this software.
-#
-# SPDX-License-Identifier: GPL-2.0-or-later
-# ------------------------------------------------------------------
-# https://github.com/pyinstaller/pyinstaller-hooks-contrib/blob/master/src/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-cv2.py
+"""
+Copyright (c) 2020 PyInstaller Development Team.
+
+This file is distributed under the terms of the GNU General Public
+License (version 2.0 or later).
+
+The full license is available in LICENSE.GPL.txt, distributed with
+this software.
+
+SPDX-License-Identifier: GPL-2.0-or-later
+
+https://github.com/pyinstaller/pyinstaller-hooks-contrib/blob/master/src/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-cv2.py
+"""
 
 from PyInstaller.utils.hooks import collect_dynamic_libs, collect_data_files
 

README.md

@@ -67,10 +67,10 @@ This program can be used to automatically start, split, and reset your preferred
 
 ### Comparison Method
 
-- There are three comparison methods to choose from: L2 Norm, Histograms, and pHash.
+- There are three comparison methods to choose from: L2 Norm, Histograms, and Perceptual Hash (or pHash).
   - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, and sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different.
   - Histograms: An explanation on Histograms comparison can be found [here](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html). This is a great method to use if you are using several masked images.
-  - pHash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate.
+  - Perceptual Hash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate.
 
 ### Full Content Rendering
 

pyproject.toml

@@ -23,7 +23,7 @@ reportImplicitStringConcatenation=true
 ignore = [
   # Auto generated
   "src/gen/",
-  # We expect stub files to be incomplete or contain useless statements as they're external
+  # We expect stub files to be incomplete or contain useless statements
   "typings/",
 ]
 reportMissingTypeStubs = "information"
@@ -42,7 +42,7 @@ reportUnknownMemberType = "none"
 # https://pylint.pycqa.org/en/latest/technical_reference/features.html
 [tool.pylint.REPORTS]
 # Just like default but any error will make drop to 9 or less
-evaluation = "10.0 - error - ((float(warning * 10 + refactor + convention) / statement) * 10)"
+evaluation = "10.0 - error - ((float((warning + convention) * 10 + refactor ) / statement) * 10)"
 [tool.pylint.MASTER]
 fail-under = 9.0
 # https://pylint.pycqa.org/en/latest/technical_reference/extensions.html
@@ -73,8 +73,8 @@ load-plugins = [
 ignore-paths = [
   # Auto generated
   "^src/gen/.*$",
-  # We expect stub files to be incomplete or contain useless statements as they're external
-  "^typings/.*$",
+  # We expect stub files to be incomplete or contain useless statements
+  "^.*\\.pyi$",
 ]
 # No need to mention the fixmes
 disable = ["fixme"]

res/settings.ui

@@ -192,7 +192,7 @@
     </item>
     <item>
      <property name="text">
-      <string>pHash</string>
+      <string>Perceptual Hash</string>
      </property>
     </item>
    </widget>

scripts/lint.ps1

@@ -13,7 +13,7 @@ if ($LastExitCode -gt 0) {
 }
 
 Write-Host "`nRunning Pylint..."
-pylint --score=n --output-format=colorized $(git ls-files '**/*.py*')
+pylint --score=n --output-format=colorized $(git ls-files '**/*.py')
 $exitCodes += $LastExitCode
 if ($LastExitCode -gt 0) {
   Write-Host "`Pylint failed ($LastExitCode)" -ForegroundColor Red

scripts/requirements.txt

@@ -25,6 +25,7 @@ requests
 # Linting and Types
 bandit
 flake8
+flake8-pyi
 flake8-quotes
 pylint
 pywin32-stubs

src/AutoSplit.py

@@ -398,7 +398,7 @@ def __take_screenshot(self):
 
         # save and open image
         cv2.imwrite(screenshot_path, capture)
-        os.startfile(screenshot_path)
+        os.startfile(screenshot_path)  # nosec
 
     def __check_fps(self):
         self.fps_value_label.clear()

src/compare.py

@@ -80,7 +80,7 @@ def compare_template(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[c
 
 def compare_phash(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None):
     """
-    Compares the pHash of the two given images and returns the similarity between the two.
+    Compares the Perceptual Hash of the two given images and returns the similarity between the two.
 
     @param source: Image of any given shape as a numpy array
     @param capture: Image of any given shape as a numpy array

typings/cv2-stubs/__init__.pyi

@@ -1,11 +1,10 @@
 """
 This type stub file was generated by pyright.
 """
-from __future__ import absolute_import, division, print_function, annotations
-from PIL import Image, ImageFilter
-import numpy
+from __future__ import absolute_import, division, print_function
+from PIL import Image
 
-__version__ = ...
+__version__: str = ...
 
 
 class ImageHash: