MSS: renamed MSSBase to MSSMixin in base.py

BoboTiG · BoboTiG · commit 3bc0921dd0b4 · 2018-12-26T22:22:23.000+01:00
diff --git a/CHANGELOG b/CHANGELOG
@@ -2,6 +2,9 @@ History:
 
 <see Git checking messages for history>
 
+4.0.0   2018/12/23
+      - MSS: renamed MSSBase to MSSMixin in base.py
+
 3.3.2   2018/11/20
       - new contributors: hugovk, Andreas Buhr
       - MSS: do monitor detection in MSS constructor (fixes #79)
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,3 +1,11 @@
+4.0.0 (201x-xx-xx)
+==================
+
+base.py
+-------
+- Renamed ``MSSBase`` class to ``MSSMixin``.
+
+
 3.3.0 (2018-09-04)
 ==================
 
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -24,7 +24,7 @@ GNU/Linux
         :rtype: :class:`mss.base.ScreenShot`
         :raises ScreenShotError: When color depth is not 32 (rare).
 
-        See :meth:`mss.base.MSSBase.grab()` for details.
+        See :meth:`mss.base.MSSMixin.grab()` for details.
 
 .. function:: error_handler(display, event)
 
@@ -46,10 +46,12 @@ Methods
 
 .. module:: mss.base
 
-.. class:: MSSBase
+.. class:: MSSMixin
 
     The parent's class for every OS implementation.
 
+    .. versionchanged:: 4.0.0
+
     .. method:: grab(region)
 
         :param dict monitor: region's coordinates.
@@ -146,7 +148,7 @@ Methods
 Properties
 ==========
 
-.. class:: MSSBase
+.. class:: MSSMixin
 
     .. attribute:: monitors
 
@@ -266,4 +268,4 @@ Factory
 
     Factory function to instance the appropriate MSS class.
 
-    :rtype: :class:`mss.base.MSSBase`
+    :rtype: :class:`mss.base.MSSMixin`
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,7 +29,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = "3.3.2"
+version = "4.0.0"
 
 # The full version, including alpha/beta/rc tags.
 release = "latest"
diff --git a/mss/__init__.py b/mss/__init__.py
@@ -13,7 +13,7 @@
 from .exception import ScreenShotError
 from .factory import mss
 
-__version__ = "3.3.2"
+__version__ = "4.0.0"
 __author__ = "Mickaël 'Tiger-222' Schoentgen"
 __copyright__ = """
     Copyright (c) 2013-2018, Mickaël 'Tiger-222' Schoentgen
diff --git a/mss/base.py b/mss/base.py
@@ -11,14 +11,14 @@
 from .tools import to_png
 
 
-class MSSBase(object):
+class MSSMixin(object):
     """ This class will be overloaded by a system specific one. """
 
     cls_image = ScreenShot  # type: object
     compression_level = 6  # type: int
 
     def __enter__(self):
-        # type: () -> MSSBase
+        # type: () -> MSSMixin
         """ For the cool call `with MSS() as mss:`. """
 
         return self
diff --git a/mss/darwin.py b/mss/darwin.py
@@ -12,7 +12,7 @@
 import ctypes.util
 import sys
 
-from .base import MSSBase
+from .base import MSSMixin
 from .exception import ScreenShotError
 from .screenshot import Size
 
@@ -55,7 +55,7 @@ def __repr__(self):
         return "{}<{} {}>".format(type(self).__name__, self.origin, self.size)
 
 
-class MSS(MSSBase):
+class MSS(MSSMixin):
     """
     Multiple ScreenShots implementation for macOS.
     It uses intensively the CoreGraphics library.
@@ -180,7 +180,7 @@ def monitors(self):
     def grab(self, monitor):
         # type: (Dict[str, int]) -> ScreenShot
         """
-        See :meth:`MSSBase.grab <mss.base.MSSBase.grab>` for full details.
+        See :meth:`MSSMixin.grab <mss.base.MSSMixin.grab>` for full details.
         """
 
         # Convert PIL bbox style
diff --git a/mss/linux.py b/mss/linux.py
@@ -8,7 +8,7 @@
 import ctypes.util
 import os
 
-from .base import MSSBase
+from .base import MSSMixin
 from .exception import ScreenShotError
 
 __all__ = ("MSS",)
@@ -138,7 +138,7 @@ class XRRCrtcInfo(ctypes.Structure):
     ]
 
 
-class MSS(MSSBase):
+class MSS(MSSMixin):
     """
     Multiple ScreenShots implementation for GNU/Linux.
     It uses intensively the Xlib and its Xrandr extension.
diff --git a/mss/windows.py b/mss/windows.py
@@ -9,7 +9,7 @@
 import ctypes
 import ctypes.wintypes
 
-from .base import MSSBase
+from .base import MSSMixin
 from .exception import ScreenShotError
 
 __all__ = ("MSS",)
@@ -49,7 +49,7 @@ class BITMAPINFO(ctypes.Structure):
     ]
 
 
-class MSS(MSSBase):
+class MSS(MSSMixin):
     """ Multiple ScreenShots implementation for Microsoft Windows. """
 
     _bbox = {"height": 0, "width": 0}
diff --git a/tests/test_gnu_linux.py b/tests/test_gnu_linux.py
@@ -7,7 +7,7 @@
 import pytest
 
 import mss
-from mss.base import MSSBase
+from mss.base import MSSMixin
 from mss.exception import ScreenShotError
 
 
@@ -33,7 +33,7 @@ def test_factory_systems(monkeypatch):
     # GNU/Linux
     monkeypatch.setattr(platform, "system", lambda: "LINUX")
     with mss.mss() as sct:
-        assert isinstance(sct, MSSBase)
+        assert isinstance(sct, MSSMixin)
     monkeypatch.undo()
 
     # macOS
diff --git a/tests/test_implementation.py b/tests/test_implementation.py
@@ -9,29 +9,29 @@
 
 import mss
 import mss.tools
-from mss.base import MSSBase
+from mss.base import MSSMixin
 from mss.exception import ScreenShotError
 from mss.screenshot import ScreenShot
 
 
 PY3 = sys.version[0] > "2"
 
 
-class MSS0(MSSBase):
+class MSS0(MSSMixin):
     """ Nothing implemented. """
 
     pass
 
 
-class MSS1(MSSBase):
+class MSS1(MSSMixin):
     """ Emulate no monitors. """
 
     @property
     def monitors(self):
         return []
 
 
-class MSS2(MSSBase):
+class MSS2(MSSMixin):
     """ Emulate one monitor. """
 
     @property
@@ -70,7 +70,7 @@ def test_repr(sct):
 def test_factory(monkeypatch):
     # Current system
     with mss.mss() as sct:
-        assert isinstance(sct, MSSBase)
+        assert isinstance(sct, MSSMixin)
 
     # Unknown
     monkeypatch.setattr(platform, "system", lambda: "Chuck Norris")

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`# built documents.`
`30`	`30`	`#`
`31`	`31`	`# The short X.Y version.`
`32`		`-version = "3.3.2"`
	`32`	`+version = "4.0.0"`
`33`	`33`
`34`	`34`	`# The full version, including alpha/beta/rc tags.`
`35`	`35`	`release = "latest"`