Pillow/src/PIL/ImageShow.py

238 lines
6.2 KiB
Python
Raw Normal View History

2010-07-31 06:52:47 +04:00
#
# The Python Imaging Library.
# $Id$
#
# im.show() drivers
#
# History:
# 2008-04-06 fl Created
#
# Copyright (c) Secret Labs AB 2008.
#
# See the README file for information on usage and redistribution.
#
2014-08-26 17:47:10 +04:00
import os
import shutil
import subprocess
import sys
import tempfile
2019-09-26 15:12:28 +03:00
from shlex import quote
2010-07-31 06:52:47 +04:00
from PIL import Image
2010-07-31 06:52:47 +04:00
_viewers = []
2014-08-26 17:47:10 +04:00
2010-07-31 06:52:47 +04:00
def register(viewer, order=1):
2020-06-14 13:00:23 +03:00
"""
The :py:func:`register` function is used to register additional viewers.
:param viewer: The viewer to be registered.
:param order:
2020-06-20 14:10:10 +03:00
Zero or a negative integer to prepend this viewer to the list,
a positive integer to append it.
2020-06-14 13:00:23 +03:00
"""
2010-07-31 06:52:47 +04:00
try:
if issubclass(viewer, Viewer):
viewer = viewer()
except TypeError:
2014-08-26 17:47:10 +04:00
pass # raised if viewer wasn't a class
2010-07-31 06:52:47 +04:00
if order > 0:
_viewers.append(viewer)
else:
2010-07-31 06:52:47 +04:00
_viewers.insert(0, viewer)
2014-08-26 17:47:10 +04:00
2010-07-31 06:52:47 +04:00
def show(image, title=None, **options):
r"""
2016-05-24 10:36:14 +03:00
Display a given image.
:param image: An image object.
2020-06-14 13:00:23 +03:00
:param title: Optional title. Not all viewers can display the title.
:param \**options: Additional viewer options.
2020-06-14 13:00:23 +03:00
:returns: ``True`` if a suitable viewer was found, ``False`` otherwise.
2016-05-24 10:36:14 +03:00
"""
2010-07-31 06:52:47 +04:00
for viewer in _viewers:
if viewer.show(image, title=title, **options):
return 1
return 0
2014-08-26 17:47:10 +04:00
class Viewer:
2016-05-24 10:36:14 +03:00
"""Base class for viewers."""
2010-07-31 06:52:47 +04:00
# main api
def show(self, image, **options):
2020-06-14 13:00:23 +03:00
"""
The main function for displaying an image.
Converts the given image to the target format and displays it.
"""
2010-07-31 06:52:47 +04:00
# save temporary image to disk
if not (
image.mode in ("1", "RGBA") or (self.format == "PNG" and image.mode == "LA")
):
2010-07-31 06:52:47 +04:00
base = Image.getmodebase(image.mode)
if image.mode != base:
image = image.convert(base)
2010-07-31 06:52:47 +04:00
return self.show_image(image, **options)
2010-07-31 06:52:47 +04:00
# hook methods
format = None
2020-06-14 13:00:23 +03:00
"""The format to convert the image into."""
2017-05-13 16:08:08 +03:00
options = {}
2020-06-14 13:00:23 +03:00
"""Additional options used to convert the image."""
2010-07-31 06:52:47 +04:00
def get_format(self, image):
2020-06-14 13:00:23 +03:00
"""Return format name, or ``None`` to save as PGM/PPM."""
2010-07-31 06:52:47 +04:00
return self.format
def get_command(self, file, **options):
2020-06-14 13:00:23 +03:00
"""
Returns the command used to display the file.
Not implemented in the base class.
"""
2010-07-31 06:52:47 +04:00
raise NotImplementedError
def save_image(self, image):
2020-06-14 13:00:23 +03:00
"""Save to temporary file and return filename."""
2017-05-13 16:08:08 +03:00
return image._dump(format=self.get_format(image), **self.options)
2010-07-31 06:52:47 +04:00
def show_image(self, image, **options):
2020-06-14 13:00:23 +03:00
"""Display the given image."""
2010-07-31 06:52:47 +04:00
return self.show_file(self.save_image(image), **options)
def show_file(self, file, **options):
2020-06-14 13:00:23 +03:00
"""Display the given file."""
2010-07-31 06:52:47 +04:00
os.system(self.get_command(file, **options))
return 1
2019-03-21 16:28:20 +03:00
2010-07-31 06:52:47 +04:00
# --------------------------------------------------------------------
2017-11-22 13:13:13 +03:00
2020-06-14 13:00:23 +03:00
class WindowsViewer(Viewer):
"""The default viewer on Windows is the default system application for PNG files."""
2010-07-31 06:52:47 +04:00
2020-06-14 13:00:23 +03:00
format = "PNG"
options = {"compress_level": 1}
def get_command(self, file, **options):
return (
'start "Pillow" /WAIT "%s" '
"&& ping -n 2 127.0.0.1 >NUL "
'&& del /f "%s"' % (file, file)
)
2014-08-26 17:47:10 +04:00
2010-07-31 06:52:47 +04:00
2020-06-14 13:00:23 +03:00
if sys.platform == "win32":
2010-07-31 06:52:47 +04:00
register(WindowsViewer)
2020-06-14 13:00:23 +03:00
class MacViewer(Viewer):
"""The default viewer on MacOS using ``Preview.app``."""
format = "PNG"
options = {"compress_level": 1}
2014-08-26 17:47:10 +04:00
2020-06-14 13:00:23 +03:00
def get_command(self, file, **options):
# on darwin open returns immediately resulting in the temp
# file removal while app is opening
command = "open -a Preview.app"
command = "({} {}; sleep 20; rm -f {})&".format(
command, quote(file), quote(file)
)
return command
def show_file(self, file, **options):
"""Display given file"""
fd, path = tempfile.mkstemp()
with os.fdopen(fd, "w") as f:
f.write(file)
with open(path, "r") as f:
subprocess.Popen(
["im=$(cat); open -a Preview.app $im; sleep 20; rm -f $im"],
shell=True,
stdin=f,
2019-03-21 16:28:20 +03:00
)
2020-06-14 13:00:23 +03:00
os.remove(path)
return 1
2020-06-14 13:00:23 +03:00
if sys.platform == "darwin":
2010-07-31 06:52:47 +04:00
register(MacViewer)
2020-06-14 13:00:23 +03:00
class UnixViewer(Viewer):
format = "PNG"
options = {"compress_level": 1}
2010-07-31 06:52:47 +04:00
2020-06-14 13:00:23 +03:00
def get_command(self, file, **options):
command = self.get_command_ex(file, **options)[0]
return "({} {}; rm -f {})&".format(command, quote(file), quote(file))
2020-06-14 13:00:23 +03:00
def show_file(self, file, **options):
"""Display given file"""
fd, path = tempfile.mkstemp()
with os.fdopen(fd, "w") as f:
f.write(file)
with open(path, "r") as f:
2018-11-03 05:13:04 +03:00
command = self.get_command_ex(file, **options)[0]
2020-06-14 13:00:23 +03:00
subprocess.Popen(
["im=$(cat);" + command + " $im; rm -f $im"], shell=True, stdin=f
)
os.remove(path)
return 1
2010-07-31 06:52:47 +04:00
2020-06-14 13:00:23 +03:00
class DisplayViewer(UnixViewer):
"""The ImageMagick ``display`` command."""
2010-07-31 06:52:47 +04:00
2020-06-14 13:00:23 +03:00
def get_command_ex(self, file, **options):
command = executable = "display"
return command, executable
2017-11-22 13:13:13 +03:00
2020-06-14 13:00:23 +03:00
class EogViewer(UnixViewer):
"""The GNOME Image Viewer ``eog`` command."""
def get_command_ex(self, file, **options):
command = executable = "eog"
return command, executable
2010-07-31 06:52:47 +04:00
2020-06-14 13:00:23 +03:00
class XVViewer(UnixViewer):
"""
The X Viewer ``xv`` command.
This viewer supports the ``title`` parameter.
"""
def get_command_ex(self, file, title=None, **options):
# note: xv is pretty outdated. most modern systems have
# imagemagick's display command instead.
command = executable = "xv"
if title:
command += " -name %s" % quote(title)
return command, executable
if sys.platform not in ("win32", "darwin"): # unixoids
if shutil.which("display"):
register(DisplayViewer)
if shutil.which("eog"):
register(EogViewer)
if shutil.which("xv"):
2010-07-31 06:52:47 +04:00
register(XVViewer)
if __name__ == "__main__":
2018-01-06 13:51:45 +03:00
if len(sys.argv) < 2:
print("Syntax: python ImageShow.py imagefile [title]")
sys.exit()
2020-02-18 12:49:05 +03:00
with Image.open(sys.argv[1]) as im:
print(show(im, *sys.argv[2:]))