PEP8, cleanup

Author: Mickaël Schoentgen

.gitignore

@@ -2,6 +2,7 @@ build/
 .cache/
 dist/
 *.egg-info/
+.idea/
 MANIFEST*
 .DS_Store
 *.orig

.travis.yml

@@ -5,7 +5,7 @@ python:
   - 3.4
   - 3.5
   - 3.6
-  - nightly # currently points to 3.7-dev
+#  - nightly # currently points to 3.7-dev
 
 addons:
   apt:

CHANGELOG

@@ -2,10 +2,12 @@ History:
 
 <see Git checkin messages for history>
 
-dev
+2.0.22  2017/04/29
+      - new contributors: David Becker, redodo
       - add an example to capture only a part of the screen
       - 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)
 
 2.0.18  2016/12/03
       - change license to MIT

CONTRIBUTORS

@@ -15,6 +15,9 @@ bubulle [http://indexerror.net/user/bubulle]
 Condé 'Eownis' Titouan <[email protected]> <[email protected]> [https://titouan.co]
     - MacOS X tester
 
+David Becker [https://davide.me] and redodo [https://github.com/redodo]
+    - Mac: Take into account extra black pixels added when screen with is not divisible by 16
+
 Jochen 'cycomanic' Schroeder [https://github.com/cycomanic]
     - GNU/Linux: use errcheck instead of deprecated restype with callable, for enum_display_monitors()
 

examples/callback.py

@@ -1,8 +1,7 @@
-#!/usr/bin/env python
 # coding: utf-8
-''' This is part of the MSS Python's module.
+""" This is part of the MSS Python's module.
     Source: https://github.com/BoboTiG/python-mss
-'''
+"""
 
 from os import rename
 from os.path import isfile
@@ -13,13 +12,13 @@
 
 def main():
     # type: () -> int
-    ''' Usage example. '''
+    """ Usage example. """
 
     def on_exists(fname):
         # type: (str) -> None
-        ''' Callback example when we try to overwrite an existing
+        """ Callback example when we try to overwrite an existing
             screenshot.
-        '''
+        """
 
         if isfile(fname):
             newfile = fname + '.old'

examples/linux-display_keyword.py

@@ -1,16 +1,15 @@
-#!/usr/bin/env python
 # coding: utf-8
-''' This is part of the MSS Python's module.
+""" This is part of the MSS Python's module.
     Source: https://github.com/BoboTiG/python-mss
-'''
+"""
 
 from mss.exception import ScreenshotError
 from mss.linux import MSS
 
 
 def main():
     # type: () -> int
-    ''' Usage example with a specific display. '''
+    """ Usage example with a specific display. """
 
     display = ':0.0'
     print('Screenshot of display "{0}"'.format(display))

examples/part-of-screen.py

@@ -1,16 +1,15 @@
-#!/usr/bin/env python
 # coding: utf-8
-''' This is part of the MSS Python's module.
+""" This is part of the MSS Python's module.
     Source: https://github.com/BoboTiG/python-mss
-'''
+"""
 
 from mss.exception import ScreenshotError
 from mss import mss
 
 
 def main():
     # type: () -> int
-    ''' Example to capture part of the screen. '''
+    """ Example to capture part of the screen. """
 
     try:
         with mss() as sct:

examples/pil.py

@@ -1,8 +1,7 @@
-#!/usr/bin/env python
 # coding: utf-8
-''' This is part of the MSS Python's module.
+""" This is part of the MSS Python's module.
     Source: https://github.com/BoboTiG/python-mss
-'''
+"""
 
 from mss.exception import ScreenshotError
 from mss.factory import mss
@@ -11,7 +10,7 @@
 
 def main():
     # type: () -> int
-    ''' PIL example using frombytes(). '''
+    """ PIL example using frombytes(). """
 
     try:
         with mss() as sct:

mss/__init__.py

@@ -1,21 +1,20 @@
-#!/usr/bin/env python
 # coding: utf-8
-''' An ultra fast cross-platform multiple screenshots module in pure python
+""" An ultra fast cross-platform multiple screenshots module in pure python
     using ctypes.
 
     This module is maintained by Mickaël Schoentgen <[email protected]>.
 
     You can always get the latest version of this module at:
         https://github.com/BoboTiG/python-mss
     If that URL should fail, try contacting the author.
-'''
+"""
 
 from .exception import ScreenshotError
 from .factory import mss
 
-__version__ = '2.0.21'
+__version__ = '2.0.22'
 __author__ = "Mickaël 'Tiger-222' Schoentgen"
-__copyright__ = '''
+__copyright__ = """
     Copyright (c) 2013-2017, Mickaël 'Tiger-222' Schoentgen
 
     Permission to use, copy, modify, and distribute this software and its
@@ -24,5 +23,5 @@
     and that both that copyright notice and this permission notice appear
     in supporting documentation or portions thereof, including
     modifications, that you make.
-'''
+"""
 __all__ = ['ScreenshotError', 'mss']

mss/__main__.py

@@ -0,0 +1,20 @@
+# coding: utf-8
+""" This is part of the MSS Python's module.
+    Source: https://github.com/BoboTiG/python-mss
+"""
+
+from __future__ import print_function
+
+from .factory import mss
+
+
+def main():
+    """ Main logic. """
+
+    with mss() as sct:
+        for file_name in sct.save():
+            print(file_name)
+
+
+if __name__ == '__main__':
+    exit(main())

mss/base.py

@@ -1,8 +1,7 @@
-#!/usr/bin/env python
 # coding: utf-8
-''' This is part of the MSS Python's module.
+""" This is part of the MSS Python's module.
     Source: https://github.com/BoboTiG/python-mss
-'''
+"""
 
 from struct import pack
 from zlib import compress, crc32
@@ -12,30 +11,30 @@
 
 # C'est parti mon kiki !
 class MSSBase(object):
-    ''' This class will be overloaded by a system specific one. '''
+    """ This class will be overloaded by a system specific one. """
 
     monitors = []
     image = None
     width = 0
     height = 0
 
     def __enter__(self):
-        ''' For the cool call `with MSS() as mss:`. '''
+        """ For the cool call `with MSS() as mss:`. """
 
         return self
 
     def __exit__(self, *_):
-        ''' For the cool call `with MSS() as mss:`. '''
+        """ For the cool call `with MSS() as mss:`. """
 
     def bgra_to_rgb(self, raw):
-        ''' Converts pixels values from BGRA to RGB. '''
+        """ Converts pixels values from BGRA to RGB. """
 
         image = bytearray(self.height * self.width * 3)
         image[0::3], image[1::3], image[2::3] = raw[2::4], raw[1::4], raw[0::4]
         return bytes(image)
 
     def enum_display_monitors(self, force=False):
-        ''' Get positions of one or more monitors.
+        """ Get positions of one or more monitors.
             If the monitor has rotation, you have to deal with it
             inside this method.
 
@@ -51,12 +50,12 @@ def enum_display_monitors(self, force=False):
                 'width':  the width,
                 'height': the height
             }
-        '''
+        """
 
         raise NotImplementedError('Subclasses need to implement this!')
 
     def get_pixels(self, monitor):
-        ''' Retrieve screen pixels for a given monitor.
+        """ Retrieve screen pixels for a given monitor.
 
             This method has to define self.width and self.height.
 
@@ -67,12 +66,12 @@ def get_pixels(self, monitor):
                 'width':  the width,
                 'heigth': the height
             }
-        '''
+        """
 
         raise NotImplementedError('Subclasses need to implement this!')
 
     def save(self, mon=0, output='monitor-%d.png', callback=None):
-        ''' Grab a screenshot and save it to a file.
+        """ Grab a screenshot and save it to a file.
 
             mon (integer, default: 0)
                 -1: grab one screenshot of all monitors
@@ -88,7 +87,7 @@ def save(self, mon=0, output='monitor-%d.png', callback=None):
                 Take the 'output' argument as parameter.
 
             This is a generator which returns created files.
-        '''
+        """
 
         self.enum_display_monitors()
         if not self.monitors:
@@ -121,10 +120,10 @@ def save(self, mon=0, output='monitor-%d.png', callback=None):
             yield output
 
     def to_png(self, data, output):
-        ''' Dump data to the image file. Data is bytes(RGBRGB...RGB).
+        """ Dump data to the image file. Data is bytes(RGBRGB...RGB).
             Pure python PNG implementation.
             http://inaps.org/journal/comment-fonctionne-le-png
-        '''
+        """
 
         p__ = pack
         line = self.width * 3