feat: use ruff (#275)

Author: BoboTiG

check.sh

@@ -2,9 +2,10 @@
 #
 # Small script to ensure quality checks pass before submitting a commit/PR.
 #
-python -m isort docs src
-python -m black --line-length=120 docs src
-python -m flake8 docs src
-python -m pylint src/mss
+set -eu
+
+python -m ruff --fix docs src
+python -m ruff format docs src
+
 # "--platform win32" to not fail on ctypes.windll (it does not affect the overall check on other OSes)
-python -m mypy --platform win32 --exclude src/tests src docs/source/examples
+python -m mypy --platform win32 src docs/source/examples

docs/source/conf.py

@@ -6,67 +6,29 @@
 
 sys.path.insert(0, str(Path(__file__).parent.parent.parent / "src"))
 
-from mss import __author__, __date__, __version__  # noqa
+import mss
 
 # -- General configuration ------------------------------------------------
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = ["sphinx.ext.intersphinx"]
-
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
 source_suffix = ".rst"
-
-# The master toctree document.
 master_doc = "index"
 
 # General information about the project.
 project = "Python MSS"
-copyright = f"{__date__}, {__author__} & contributors"
-author = "Tiger-222"
+copyright = f"{mss.__date__}, {mss.__author__} & contributors"  # noqa:A001
+author = mss.__author__
+version = mss.__version__
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = __version__
-
-# The full version, including alpha/beta/rc tags.
 release = "latest"
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
 language = "en"
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = []
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
 todo_include_todos = True
 
 
 # -- Options for HTML output ----------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
 html_theme = "default"
-
-# Output file base name for HTML help builder.
 htmlhelp_basename = "PythonMSSdoc"
 
 

docs/source/examples/callback.py

@@ -1,6 +1,5 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 Screenshot of the monitor 1, with callback.
 """
@@ -11,10 +10,7 @@
 
 
 def on_exists(fname: str) -> None:
-    """
-    Callback example when we try to overwrite an existing screenshot.
-    """
-
+    """Callback example when we try to overwrite an existing screenshot."""
     if os.path.isfile(fname):
         newfile = f"{fname}.old"
         print(f"{fname} -> {newfile}")

docs/source/examples/custom_cls_image.py

@@ -1,6 +1,5 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 Screenshot of the monitor 1, using a custom class to handle the data.
 """
@@ -12,8 +11,7 @@
 
 
 class SimpleScreenShot(ScreenShot):
-    """
-    Define your own custom method to deal with screen shot raw data.
+    """Define your own custom method to deal with screen shot raw data.
     Of course, you can inherit from the ScreenShot class and change
     or add new methods.
     """

docs/source/examples/fps.py

@@ -1,16 +1,14 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 Simple naive benchmark to compare with:
     https://pythonprogramming.net/game-frames-open-cv-python-plays-gta-v/
 """
 import time
 
 import cv2
-import numpy
-
 import mss
+import numpy as np
 
 
 def screen_record() -> int:
@@ -27,7 +25,7 @@ def screen_record() -> int:
     last_time = time.time()
 
     while time.time() - last_time < 1:
-        img = numpy.asarray(ImageGrab.grab(bbox=mon))
+        img = np.asarray(ImageGrab.grab(bbox=mon))
         fps += 1
 
         cv2.imshow(title, cv2.cvtColor(img, cv2.COLOR_BGR2RGB))
@@ -48,7 +46,7 @@ def screen_record_efficient() -> int:
     last_time = time.time()
 
     while time.time() - last_time < 1:
-        img = numpy.asarray(sct.grab(mon))
+        img = np.asarray(sct.grab(mon))
         fps += 1
 
         cv2.imshow(title, img)

docs/source/examples/fps_multiprocessing.py

@@ -1,6 +1,5 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 Example using the multiprocessing module to speed-up screen capture.
     https://github.com/pythonlessons/TensorFlow-object-detection-tutorial

docs/source/examples/from_pil_tuple.py

@@ -1,6 +1,5 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 Use PIL bbox style and percent values.
 """

docs/source/examples/linux_display_keyword.py

@@ -1,6 +1,5 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 Usage example with a specific display.
 """

docs/source/examples/opencv_numpy.py

@@ -1,15 +1,13 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 OpenCV/Numpy example.
 """
 import time
 
 import cv2
-import numpy
-
 import mss
+import numpy as np
 
 with mss.mss() as sct:
     # Part of the screen to capture
@@ -19,7 +17,7 @@
         last_time = time.time()
 
         # Get raw pixels from the screen, save it to a Numpy array
-        img = numpy.array(sct.grab(monitor))
+        img = np.array(sct.grab(monitor))
 
         # Display the picture
         cv2.imshow("OpenCV/Numpy normal", img)

docs/source/examples/part_of_screen.py

@@ -1,6 +1,5 @@
-"""
-This is part of the MSS Python's module.
-Source: https://github.com/BoboTiG/python-mss
+"""This is part of the MSS Python's module.
+Source: https://github.com/BoboTiG/python-mss.
 
 Example to capture part of the screen.
 """