MSS: Add the 'mss' entry point

Author: BoboTiG

CHANGELOG

@@ -6,11 +6,11 @@ dev     2017/xx/xx
       - add the 'Say Thanks' button
       - doc: several fixes (fix #22)
       - tests: a lot of tests added for better coverage
+      - MSS: add the 'mss' entry point
       - MSS: add more way of customization to the output argument of save()
       - MSS: possibility to use custom class to handle screen shot data
-      - Mac: handle screenshot's width not divisible by 16 (fix #14, #19, #21)
-      - Mac: properly support all display scaling and resolutions (fix #23)
-      - Mac: fix memory leak (fix #24)
+      - Mac: properly support all display scaling and resolutions (fix #14, #19, #21, #23)
+      - Mac: fix memory leaks (fix #24)
       - Linux: handle bad display value
       - Windows: Take into account zoom factor for high-DPI displays (fix #20)
 

docs/source/usage.rst

@@ -47,3 +47,15 @@ A more specific example to only target GNU/Linux:
 
 .. literalinclude:: examples/linux_display_keyword.py
     :lines: 9-
+
+
+Command line
+============
+
+Since 3.1.0, an entry point was added and so you can use ``mss`` via the CLI:
+
+    mss --help
+
+Or via direct call from Python:
+
+    python -m mss --help

mss/__init__.py

@@ -25,4 +25,4 @@
     in supporting documentation or portions thereof, including
     modifications, that you make.
 """
-__all__ = ['ScreenShotError', 'mss']
+__all__ = ('ScreenShotError', 'mss')

mss/__main__.py

@@ -6,22 +6,70 @@
 
 from __future__ import print_function
 
+import os.path
+import sys
+from argparse import ArgumentParser
+
+from . import __version__
 from .exception import ScreenShotError
 from .factory import mss
+from .tools import to_png
 
 
-def main():
-    # type: () -> int
+def main(args=None):
+    # type: (Optional[List[str]]) -> int
     """ Main logic. """
 
+    cli_args = ArgumentParser()
+    cli_args.add_argument('-c', '--coordinates', default='', type=str,
+                          help='the part of the screen to capture:'
+                               ' top, left, width, height')
+    cli_args.add_argument('-m', '--monitor', default=0, type=int,
+                          help='the monitor to screen shot')
+    cli_args.add_argument('-o', '--output', default='monitor-{mon}.png',
+                          help='the output file name')
+    cli_args.add_argument('-q', '--quiet', default=False, action='store_true',
+                          help='do not print created files')
+    cli_args.add_argument('-v', '--version', action='version',
+                          version=__version__)
+
+    options = cli_args.parse_args(args)
+    kwargs = {
+        'mon': options.monitor,
+        'output': options.output,
+    }
+    if options.coordinates:
+        try:
+            top, left, width, height = map(int, options.coordinates.split(','))
+        except ValueError:
+            print('Coordinates syntax: top, left, width, height')
+            return 2
+
+        kwargs['mon'] = {
+            'top': top,
+            'left': left,
+            'width': width,
+            'height': height,
+        }
+        if options.output == 'monitor-{mon}.png':
+            kwargs['output'] = 'sct-{top}x{left}_{width}x{height}.png'
+
     try:
         with mss() as sct:
-            for file_name in sct.save():
-                print(file_name)
+            if options.coordinates:
+                output = kwargs['output'].format(**kwargs['mon'])
+                sct_img = sct.grab(kwargs['mon'])
+                to_png(sct_img.rgb, sct_img.size, output)
+                if not options.quiet:
+                    print(os.path.realpath(output))
+            else:
+                for file_name in sct.save(**kwargs):
+                    if not options.quiet:
+                        print(os.path.realpath(file_name))
             return 0
     except ScreenShotError:
         return 1
 
 
 if __name__ == '__main__':
-    exit(main())
+    exit(main(sys.argv[1:]))

setup.py

@@ -53,6 +53,7 @@
     'classifiers': classifiers,
     'platforms': ['Darwin', 'Linux', 'Windows'],
     'packages': ['mss'],
+    'entry_points': {'console_scripts': ['mss=mss.__main__:main']},
     'license': 'MIT',
 }
 

tests/conftest.py

@@ -19,11 +19,11 @@ def purge_files():
     """ Remove all generated files from previous runs. """
 
     for fname in glob.glob('*.png'):
-        print('Deleting {0} ...'.format(fname))
+        print('Deleting {0!r} ...'.format(fname))
         os.unlink(fname)
 
     for fname in glob.glob('*.png.old'):
-        print('Deleting {0} ...'.format(fname))
+        print('Deleting {0!r} ...'.format(fname))
         os.unlink(fname)
 
 

tests/test_implementation.py

@@ -82,18 +82,56 @@ def test_factory(monkeypatch):
     assert error == 'System not (yet?) implemented.'
 
 
-def test_python_call(monkeypatch):
-    import mss.__main__
-    mss.__main__.main()
-
-    def raise_():
-        raise ScreenShotError()
-
-    pytest.skip('Not working for now.')
-    monkeypatch.setattr(mss.mss, '__init__', raise_)
-    with pytest.raises(ScreenShotError):
-        mss.mss()
-    monkeypatch.undo()
+def test_entry_point(capsys, sct):
+    from mss.__main__ import main
+    from datetime import datetime
+
+    for opt in ('-m', '--monitor'):
+        main([opt, '1'])
+        out, _ = capsys.readouterr()
+        assert out.endswith('monitor-1.png\n')
+        assert os.path.isfile('monitor-1.png')
+        os.remove('monitor-1.png')
+
+    for opt in zip(('-m 1', '--monitor=1'), ('-q', '--quiet')):
+        main(opt)
+        out, _ = capsys.readouterr()
+        assert not out
+        assert os.path.isfile('monitor-1.png')
+        os.remove('monitor-1.png')
+
+    fmt = 'sct-{width}x{height}.png'
+    for opt in ('-o', '--out'):
+        main([opt, fmt])
+        filename = fmt.format(**sct.monitors[1])
+        out, _ = capsys.readouterr()
+        assert out.endswith(filename + '\n')
+        assert os.path.isfile(filename)
+        os.remove(filename)
+
+    fmt = 'sct_{mon}-{date:%Y-%m-%d}.png'
+    for opt in ('-o', '--out'):
+        main([opt, fmt])
+        filename = fmt.format(mon=1, date=datetime.now())
+        out, _ = capsys.readouterr()
+        assert out.endswith(filename + '\n')
+        assert os.path.isfile(filename)
+        os.remove(filename)
+
+    coordinates = '2,12,40,67'
+    for opt in ('-c', '--coordinates'):
+        main([opt, coordinates])
+        filename = 'sct-2x12_40x67.png'
+        out, _ = capsys.readouterr()
+        assert out.endswith(filename + '\n')
+        assert os.path.isfile(filename)
+        os.remove(filename)
+
+    coordinates = '2,12,40'
+    for opt in ('-c', '--coordinates'):
+        main([opt, coordinates])
+        out, _ = capsys.readouterr()
+        assert out == 'Coordinates syntax: top, left, width, height\n'
 
 
 def test_grab_with_tuple(sct):