Version 7.0.0

Author: BoboTiG

CHANGELOG

@@ -2,6 +2,15 @@ History:
 
 <see Git checking messages for history>
 
+7.0.0   2022/10/27
+      - added support for Python 3.11
+      - added support for Python 3.10
+      - removed support for Python 3.5
+      - MSS: modernized the code base (types, f-string, ran isort & black)
+      - MSS: fixed several Sourcery issues
+      - MSS: fixed typos here, and there
+      - doc: fixed an error when building with shpinx
+
 6.1.0   2020/10/31
       - MSS: reworked how C functions are initialised
       - Mac: reduce the number of function calls
@@ -119,14 +128,14 @@ History:
 3.0.0   2017/07/06
       - big refactor, introducing the ScreenShot class
       - MSS: add Numpy array interface support to the Screenshot class
-      - docs: add OpenCV/Numpy, PIL pixels, FPS
+      - doc: add OpenCV/Numpy, PIL pixels, FPS
 
 2.0.22  2017/04/29
       - new contributors: David Becker, redodo
       - MSS: better use of exception mechanism
       - Linux: use of hasattr to prevent Exception on early exit
       - Mac: take into account extra black pixels added when screen with is not divisible by 16 (fix #14)
-      - docs: add an example to capture only a part of the screen
+      - doc: add an example to capture only a part of the screen
 
 2.0.18  2016/12/03
       - change license to MIT
@@ -138,7 +147,7 @@ History:
       - Linux: skip unused monitors
       - Linux: use errcheck instead of deprecated restype with callable (fix #11)
       - Linux: fix security issue (reported by Bandit)
-      - docs: add documentation (fix #10)
+      - doc: add documentation (fix #10)
       - tests: add tests and use Travis CI (fix #9)
 
 2.0.0   2016/06/04
@@ -175,14 +184,14 @@ History:
       - MSS: little code review
       - Linux: fix monitor count
       - tests: remove test-linux binary
-      - docs: add doc/TESTING
-      - docs: remove Bonus section from README.rst
+      - doc: add doc/TESTING
+      - doc: remove Bonus section from README.rst
 
 0.1.0   2015/04/10
       - MSS: fix code with YAPF tool
       - Linux: fully functional using Xrandr library
       - Linux: code purgation (no more XML files to parse)
-      - docs: better tests and examples
+      - doc: better tests and examples
 
 0.0.8   2015/02/04
       - new contributors: sergey-vin, Alexander 'thehesiod' Mohr

LICENSE

@@ -1,5 +1,5 @@
 MIT License
-Copyright (c) 2016-2020, Mickaël 'Tiger-222' Schoentgen
+Copyright (c) 2016-2022, Mickaël 'Tiger-222' Schoentgen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

appveyor.yml

@@ -10,17 +10,12 @@ platform:
 environment:
   fast_finish: true
   matrix:
+    - PYTHON_VERSION: 3.11
     - PYTHON_VERSION: 3.10
     - PYTHON_VERSION: 3.9
     - PYTHON_VERSION: 3.8
     - PYTHON_VERSION: 3.7
     - PYTHON_VERSION: 3.6
-    - PYTHON_VERSION: 3.5
-
-matrix:
-  allow_failures:
-    - PYTHON_VERSION: 3.10
-    - PYTHON_VERSION: 3.9
 
 init:
   # Update Environment Variables based on matrix/platform

docs/source/conf.py

@@ -19,15 +19,15 @@
 
 # General information about the project.
 project = "Python MSS"
-copyright = "2013-2021, Mickaël 'Tiger-222' Schoentgen & contributors"
+copyright = "2013-2022, Mickaël 'Tiger-222' Schoentgen & contributors"
 author = "Tiger-222"
 
 # 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 = "6.1.0"
+version = "7.0.0"
 
 # The full version, including alpha/beta/rc tags.
 release = "latest"
@@ -37,7 +37,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/source/examples/callback.py

@@ -4,22 +4,20 @@
 
 Screenshot of the monitor 1, with callback.
 """
-
 import os
 import os.path
 
 import mss
 
 
-def on_exists(fname):
-    # type: (str) -> None
+def on_exists(fname: str) -> None:
     """
     Callback example when we try to overwrite an existing screenshot.
     """
 
     if os.path.isfile(fname):
-        newfile = fname + ".old"
-        print("{} -> {}".format(fname, newfile))
+        newfile = f"{fname}.old"
+        print(f"{fname} -> {newfile}")
         os.rename(fname, newfile)
 
 

docs/source/examples/custom_cls_image.py

@@ -4,23 +4,26 @@
 
 Screenshot of the monitor 1, using a custom class to handle the data.
 """
+from typing import Any
 
 import mss
+from mss.models import Monitor
+from mss.screenshot import ScreenShot
 
 
-class SimpleScreenShot:
+class SimpleScreenShot(ScreenShot):
     """
     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.
     """
 
-    def __init__(self, data, monitor, **kwargs):
+    def __init__(self, data: bytearray, monitor: Monitor, **_: Any) -> None:
         self.data = data
         self.monitor = monitor
 
 
 with mss.mss() as sct:
-    sct.cls_image = SimpleScreenShot  # type: ignore
+    sct.cls_image = SimpleScreenShot
     image = sct.grab(sct.monitors[1])
     # ...

docs/source/examples/fps.py

@@ -5,15 +5,15 @@
 Simple naive benchmark to compare with:
     https://pythonprogramming.net/game-frames-open-cv-python-plays-gta-v/
 """
-
 import time
 
 import cv2
-import mss
 import numpy
 
+import mss
+
 
-def screen_record():
+def screen_record() -> int:
     try:
         from PIL import ImageGrab
     except ImportError:
@@ -38,7 +38,7 @@ def screen_record():
     return fps
 
 
-def screen_record_efficient():
+def screen_record_efficient() -> int:
     # 800x600 windowed mode
     mon = {"top": 40, "left": 0, "width": 800, "height": 640}
 

docs/source/examples/fps_multiprocessing.py

@@ -5,16 +5,13 @@
 Example using the multiprocessing module to speed-up screen capture.
     https://github.com/pythonlessons/TensorFlow-object-detection-tutorial
 """
-
 from multiprocessing import Process, Queue
 
 import mss
 import mss.tools
 
 
-def grab(queue):
-    # type: (Queue) -> None
-
+def grab(queue: Queue) -> None:
     rect = {"top": 0, "left": 0, "width": 600, "height": 800}
 
     with mss.mss() as sct:
@@ -25,9 +22,7 @@ def grab(queue):
     queue.put(None)
 
 
-def save(queue):
-    # type: (Queue) -> None
-
+def save(queue: Queue) -> None:
     number = 0
     output = "screenshots/file_{}.png"
     to_png = mss.tools.to_png
@@ -43,7 +38,7 @@ def save(queue):
 
 if __name__ == "__main__":
     # The screenshots queue
-    queue = Queue()  # type: Queue
+    queue: Queue = Queue()
 
     # 2 processes: one for grabing and one for saving PNG files
     Process(target=grab, args=(queue,)).start()

docs/source/examples/from_pil_tuple.py

@@ -4,11 +4,9 @@
 
 Use PIL bbox style and percent values.
 """
-
 import mss
 import mss.tools
 
-
 with mss.mss() as sct:
     # Use the 1st monitor
     monitor = sct.monitors[1]
@@ -23,7 +21,7 @@
     # Grab the picture
     # Using PIL would be something like:
     # im = ImageGrab(bbox=bbox)
-    im = sct.grab(bbox)  # type: ignore
+    im = sct.grab(bbox)
 
     # Save it!
     mss.tools.to_png(im.rgb, im.size, output="screenshot.png")

docs/source/examples/linux_display_keyword.py

@@ -4,10 +4,8 @@
 
 Usage example with a specific display.
 """
-
 import mss
 
-
 with mss.mss(display=":0.0") as sct:
     for filename in sct.save():
         print(filename)