Fix BoboTiG#5: add a shortcut to take automatically use the proper MSS class

BoboTiG · BoboTiG · commit a766225283bd · 2015-04-15T17:24:42.000+02:00
diff --git a/doc/CHANGELOG b/doc/CHANGELOG
@@ -6,6 +6,7 @@ devel   201y/mm/dd
       - Python 2.6 to 3.5 ready
       - code purgation and review, more debug informations
       - delete --debug argument
+      - fix #5: add a shortcut to take automatically use the proper MSS class
       - MSS: few optimizations into save_img()
       - MSSMac: remove rotation from informations returned by enum_display_monitors()
       - MSSLinux: fix object has no attribute 'display' into __del__
diff --git a/mss.py b/mss.py
@@ -25,7 +25,7 @@
     in supporting documentation or portions thereof, including
     modifications, that you make.
 '''
-__all__ = ['MSSLinux', 'MSSMac', 'MSSWindows', 'ScreenshotError']
+__all__ = ['mss', 'MSSLinux', 'MSSMac', 'MSSWindows', 'ScreenshotError']
 
 from struct import pack
 from platform import system
@@ -588,12 +588,29 @@ def get_pixels(self, monitor):
         return self.image
 
 
+def mss(*args, **kwargs):
+    ''' Factory returning a proper MSS class instance.
+
+        It detects the plateform we are running on
+        and choose the most adapted mss_class to take
+        screenshots.
+
+        It then proxies its arguments to the class for
+        instantiation.
+    '''
+
+    mss_class = {
+        'Darwin': MSSMac,
+        'Linux': MSSLinux,
+        'Windows': MSSWindows
+    }[system()]
+
+    return mss_class(*args, **kwargs)
+
+
 def main():
     ''' Usage example. '''
 
-    systems = {'Darwin': MSSMac, 'Linux': MSSLinux, 'Windows': MSSWindows}
-    mss = systems[system()]()
-
     def on_exists(fname):
         ''' Callback example when we try to overwrite an existing
             screenshot.
@@ -607,22 +624,24 @@ def on_exists(fname):
         return True
 
     try:
-        print('One screen shot per monitor')
-        for filename in mss.save():
+        screenshotter = mss()
+
+        print('One screenshot per monitor')
+        for filename in screenshotter.save():
             print(filename)
 
-        print("\nScreen shot of the monitor 1")
-        for filename in mss.save(output='monitor-%d.png', screen=1):
+        print("\nScreenshot of the monitor 1")
+        for filename in screenshotter.save(output='monitor-%d.png', screen=1):
             print(filename)
 
-        print("\nA shot to grab them all")
-        for filename in mss.save(output='full-screenshot.png', screen=-1):
+        print("\nA screenshot to grab them all")
+        for filename in screenshotter.save(output='full-screenshot.png', screen=-1):
             print(filename)
 
-        print("\nScreen shot of the monitor 1, with callback")
-        for filename in mss.save(output='mon-%d.png',
-                                 screen=1,
-                                 callback=on_exists):
+        print("\nScreenshot of the monitor 1, with callback")
+        for filename in screenshotter.save(output='mon-%d.png',
+                                              screen=1,
+                                              callback=on_exists):
             print(filename)
     except ScreenshotError as ex:
         print(ex)
