Image.__init__() - Code Metrics - Inspection of "Merge pull request #393 from jacebrowning/include-..." - jacebrowning/memegen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 69cfd2...2dc0e9 )

by Jace

created 2017-07-02 23:59 UTC

Image.init() A

↳ Parent: Image

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
dl	0
loc	10
ccs	9
cts	9
cp	1
crap	3
rs	9.4285
c	0
b	0
f	0

import os
import hashlib
import logging

from PIL import Image as ImageFile, ImageFont, ImageDraw, ImageFilter
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

FINGERPRINT_WATERMARK = True

log = logging.getLogger(__name__)


class Image(object):
    """JPEG generated by applying text to a template."""

    def __init__(self, template, text, root=None,
                 style=None, font=None, size=None, watermark=""):
        self.root = root
        self.template = template
        self.style = style
        self.text = text
        self.font = font
        self.width = size.get('width') if size else None
        self.height = size.get('height') if size else None
        self.watermark = watermark

    @property
    def path(self):
        if not self.root:
            return None

        base = os.path.join(self.root, self.template.key, self.text.path)
        custom = [self.style, self.font, self.width, self.height]
        if FINGERPRINT_WATERMARK:
            custom.append(self.watermark)

        if any(custom):
            slug = self.hash(custom)
            return "{}#{}.img".format(base, slug)
        else:
            return base + ".img"

    @staticmethod
    def hash(values):
        sha = hashlib.md5()
        for index, value in enumerate(values):
            sha.update("{}:{}".format(index, value or "").encode('utf-8'))
        return sha.hexdigest()

    def save(self):
        data = _generate(
            top=self.text.top, bottom=self.text.bottom,
            font=self.font.path,
            background=self.template.get_path(self.style),
            width=self.width, height=self.height,
            watermark=self.watermark,
        )

        directory = os.path.dirname(self.path)
        if not os.path.isdir(directory):
            os.makedirs(directory)

        log.info("Saving image: %s", self.path)
        path = data.save(self.path, format=data.format)

        return path


def _generate(top, bottom, font, background, width, height, watermark):
    """Add text to an image and save it."""
    log.info("Loading background: %s", background)
    background_image = ImageFile.open(background)
    if background_image.mode not in ('RGB', 'RGBA'):
        if background_image.format == 'JPEG':
            background_image = background_image.convert('RGB')
            background_image.format = 'JPEG'
        else:
            background_image = background_image.convert('RGBA')
            background_image.format = 'PNG'

    # Resize to a maximum height and width
    ratio = background_image.size[0] / background_image.size[1]
    if width and height:
        if width < height * ratio:
            dimensions = width, int(width / ratio)
        else:
            dimensions = int(height * ratio), height
    elif width:
        dimensions = width, int(width / ratio)
    elif height:
        dimensions = int(height * ratio), height
    else:
        dimensions = 600, int(600 / ratio)
    image = background_image.resize(dimensions, ImageFile.LANCZOS)
    image.format = 'PNG'

    # Draw image
    draw = ImageDraw.Draw(image)

    max_font_size = int(image.size[1] / 5)
    min_font_size_single_line = int(image.size[1] / 12)
    max_text_len = image.size[0] - 20
    top_font_size, top = _optimize_font_size(font, top, max_font_size,
                                             min_font_size_single_line,
                                             max_text_len)
    bottom_font_size, bottom = _optimize_font_size(font, bottom, max_font_size,
                                                   min_font_size_single_line,
                                                   max_text_len)

    top_font = ImageFont.truetype(font, top_font_size)
    bottom_font = ImageFont.truetype(font, bottom_font_size)

    top_text_size = draw.multiline_textsize(top, top_font)
    bottom_text_size = draw.multiline_textsize(bottom, bottom_font)

    # Find top centered position for top text
    top_text_position_x = (image.size[0] / 2) - (top_text_size[0] / 2)
    top_text_position_y = 0
    top_text_position = (top_text_position_x, top_text_position_y)

    # Find bottom centered position for bottom text
    bottom_text_size_x = (image.size[0] / 2) - (bottom_text_size[0] / 2)
    bottom_text_size_y = image.size[1] - bottom_text_size[1] * (7 / 6)
    if watermark:
        bottom_text_size_y = bottom_text_size_y - 5
    bottom_text_position = (bottom_text_size_x, bottom_text_size_y)

    _draw_outlined_text(draw, top_text_position,
                        top, top_font, top_font_size)
    _draw_outlined_text(draw, bottom_text_position,
                        bottom, bottom_font, bottom_font_size)

    # Pad image if a specific dimension is requested
    if width and height:
        image = _add_blurred_background(image, background_image, width, height)

    # Add watermark
    if watermark:
        draw = ImageDraw.Draw(image)
        watermark_font = ImageFont.truetype(font, 15)
        _draw_outlined_text(draw, (3, image.size[1] - 20),
                            watermark, watermark_font, 15)

    return image


def _optimize_font_size(font, text, max_font_size, min_font_size,
                        max_text_len):
    """Calculate the optimal font size to fit text in a given size."""

    # Check size when using smallest single line font size
    fontobj = ImageFont.truetype(font, min_font_size)
    text_size = fontobj.getsize(text)

    # Calculate font size for text, split if necessary
    if text_size[0] > max_text_len:
        phrases = _split(text)
    else:
        phrases = (text,)
    font_size = max_font_size // len(phrases)
    for phrase in phrases:
        font_size = min(_maximize_font_size(font, phrase, max_text_len),
                        font_size)

    # Rebuild text with new lines
    text = '\n'.join(phrases)

    return font_size, text


def _draw_outlined_text(draw_image, text_position, text, font, font_size):
    """Draw white text with black outline on an image."""

    # Draw black text outlines
    outline_range = max(1, font_size // 25)
    for x in range(-outline_range, outline_range + 1):
        for y in range(-outline_range, outline_range + 1):
            pos = (text_position[0] + x, text_position[1] + y)
            draw_image.multiline_text(pos, text, (0, 0, 0),
                                      font=font, align='center')

    # Draw inner white text
    draw_image.multiline_text(text_position, text, (255, 255, 255),
                              font=font, align='center')


def _add_blurred_background(foreground, background, width, height):
    """Add a blurred background to match the requested dimensions."""
    base_width, base_height = foreground.size

    border_width = min(width, base_width + 2)
    border_height = min(height, base_height + 2)
    border_dimensions = border_width, border_height
    border = ImageFile.new('RGB', border_dimensions)
    border.paste(foreground, ((border_width - base_width) // 2,
                              (border_height - base_height) // 2))

    padded_dimensions = (width, height)
    padded = background.resize(padded_dimensions, ImageFile.LANCZOS)

    darkened = padded.point(lambda p: p * 0.4)

    blurred = darkened.filter(ImageFilter.GaussianBlur(5))
    blurred.format = 'PNG'

    blurred_width, blurred_height = blurred.size
    offset = ((blurred_width - border_width) // 2,
              (blurred_height - border_height) // 2)
    blurred.paste(border, offset)

    return blurred


def _maximize_font_size(font, text, max_size):
    """Find the biggest font size that will fit."""
    font_size = max_size

    fontobj = ImageFont.truetype(font, font_size)
    text_size = fontobj.getsize(text)
    while text_size[0] > max_size and font_size > 1:
        font_size = font_size - 1
        fontobj = ImageFont.truetype(font, font_size)
        text_size = fontobj.getsize(text)

    return font_size


def _split(text):
    """Split a line of text into two similarly sized pieces.

    >>> _split("Hello, world!")
    ('Hello,', 'world!')

    >>> _split("This is a phrase that can be split.")
    ('This is a phrase', 'that can be split.')

    >>> _split("This_is_a_phrase_that_can_not_be_split.")
    ('This_is_a_phrase_that_can_not_be_split.',)

    """
    result = (text,)

    if len(text) >= 3 and ' ' in text[1:-1]:  # can split this string
        space_indices = [i for i in range(len(text)) if text[i] == ' ']
        space_proximities = [abs(i - len(text) // 2) for i in space_indices]
        for i, j in zip(space_proximities, space_indices):
            if i == min(space_proximities):
                result = (text[:j], text[j + 1:])
                break

    return result


Push — master ( 69cfd2...2dc0e9 )

Image.init() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1	1	import os
2	1	import hashlib
3	1	import logging
4
5	1	from PIL import Image as ImageFile, ImageFont, ImageDraw, ImageFilter
		0 ignored issues – show Configuration introduced 2015-11-29 01:37 UTC by Report Bug Copy Issue Report The import `PIL` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
6
7	1	FINGERPRINT_WATERMARK = True
8
9	1	log = logging.getLogger(__name__)
10
11
12	1	class Image(object):
13		"""JPEG generated by applying text to a template."""
14
15	1	def __init__(self, template, text, root=None,
16		style=None, font=None, size=None, watermark=""):
17	1	self.root = root
18	1	self.template = template
19	1	self.style = style
20	1	self.text = text
21	1	self.font = font
22	1	self.width = size.get('width') if size else None
23	1	self.height = size.get('height') if size else None
24	1	self.watermark = watermark
25
26	1	@property
27		def path(self):
28	1	if not self.root:
29		return None
30
31	1	base = os.path.join(self.root, self.template.key, self.text.path)
32	1	custom = [self.style, self.font, self.width, self.height]
33	1	if FINGERPRINT_WATERMARK:
34	1	custom.append(self.watermark)
35
36	1	if any(custom):
37	1	slug = self.hash(custom)
38	1	return "{}#{}.img".format(base, slug)
39		else:
40	1	return base + ".img"
41
42	1	@staticmethod
43		def hash(values):
44	1	sha = hashlib.md5()
45	1	for index, value in enumerate(values):
46	1	sha.update("{}:{}".format(index, value or "").encode('utf-8'))
47	1	return sha.hexdigest()
48
49	1	def save(self):
50	1	data = _generate(
51		top=self.text.top, bottom=self.text.bottom,
52		font=self.font.path,
53		background=self.template.get_path(self.style),
54		width=self.width, height=self.height,
55		watermark=self.watermark,
56		)
57
58	1	directory = os.path.dirname(self.path)
59	1	if not os.path.isdir(directory):
60	1	os.makedirs(directory)
61
62	1	log.info("Saving image: %s", self.path)
63	1	path = data.save(self.path, format=data.format)
64
65	1	return path
66
67
68	1	def _generate(top, bottom, font, background, width, height, watermark):
69		"""Add text to an image and save it."""
70	1	log.info("Loading background: %s", background)
71	1	background_image = ImageFile.open(background)
72	1	if background_image.mode not in ('RGB', 'RGBA'):
73	1	if background_image.format == 'JPEG':
74	1	background_image = background_image.convert('RGB')
75	1	background_image.format = 'JPEG'
76		else:
77	1	background_image = background_image.convert('RGBA')
78	1	background_image.format = 'PNG'
79
80		# Resize to a maximum height and width
81	1	ratio = background_image.size[0] / background_image.size[1]
82	1	if width and height:
83	1	if width < height * ratio:
84	1	dimensions = width, int(width / ratio)
85		else:
86	1	dimensions = int(height * ratio), height
87	1	elif width:
88	1	dimensions = width, int(width / ratio)
89	1	elif height:
90	1	dimensions = int(height * ratio), height
91		else:
92	1	dimensions = 600, int(600 / ratio)
93	1	image = background_image.resize(dimensions, ImageFile.LANCZOS)
94	1	image.format = 'PNG'
95
96		# Draw image
97	1	draw = ImageDraw.Draw(image)
98
99	1	max_font_size = int(image.size[1] / 5)
100	1	min_font_size_single_line = int(image.size[1] / 12)
101	1	max_text_len = image.size[0] - 20
102	1	top_font_size, top = _optimize_font_size(font, top, max_font_size,
103		min_font_size_single_line,
104		max_text_len)
105	1	bottom_font_size, bottom = _optimize_font_size(font, bottom, max_font_size,
106		min_font_size_single_line,
107		max_text_len)
108
109	1	top_font = ImageFont.truetype(font, top_font_size)
110	1	bottom_font = ImageFont.truetype(font, bottom_font_size)
111
112	1	top_text_size = draw.multiline_textsize(top, top_font)
113	1	bottom_text_size = draw.multiline_textsize(bottom, bottom_font)
114
115		# Find top centered position for top text
116	1	top_text_position_x = (image.size[0] / 2) - (top_text_size[0] / 2)
117	1	top_text_position_y = 0
118	1	top_text_position = (top_text_position_x, top_text_position_y)
119
120		# Find bottom centered position for bottom text
121	1	bottom_text_size_x = (image.size[0] / 2) - (bottom_text_size[0] / 2)
122	1	bottom_text_size_y = image.size[1] - bottom_text_size[1] * (7 / 6)
123	1	if watermark:
124	1	bottom_text_size_y = bottom_text_size_y - 5
125	1	bottom_text_position = (bottom_text_size_x, bottom_text_size_y)
126
127	1	_draw_outlined_text(draw, top_text_position,
128		top, top_font, top_font_size)
129	1	_draw_outlined_text(draw, bottom_text_position,
130		bottom, bottom_font, bottom_font_size)
131
132		# Pad image if a specific dimension is requested
133	1	if width and height:
134	1	image = _add_blurred_background(image, background_image, width, height)
135
136		# Add watermark
137	1	if watermark:
138	1	draw = ImageDraw.Draw(image)
139	1	watermark_font = ImageFont.truetype(font, 15)
140	1	_draw_outlined_text(draw, (3, image.size[1] - 20),
141		watermark, watermark_font, 15)
142
143	1	return image
144
145
146	1	def _optimize_font_size(font, text, max_font_size, min_font_size,
147		max_text_len):
148		"""Calculate the optimal font size to fit text in a given size."""
149
150		# Check size when using smallest single line font size
151	1	fontobj = ImageFont.truetype(font, min_font_size)
152	1	text_size = fontobj.getsize(text)
153
154		# Calculate font size for text, split if necessary
155	1	if text_size[0] > max_text_len:
156	1	phrases = _split(text)
157		else:
158	1	phrases = (text,)
159	1	font_size = max_font_size // len(phrases)
160	1	for phrase in phrases:
161	1	font_size = min(_maximize_font_size(font, phrase, max_text_len),
162		font_size)
163
164		# Rebuild text with new lines
165	1	text = '\n'.join(phrases)
166
167	1	return font_size, text
168
169
170	1	def _draw_outlined_text(draw_image, text_position, text, font, font_size):
171		"""Draw white text with black outline on an image."""
172
173		# Draw black text outlines
174	1	outline_range = max(1, font_size // 25)
175	1	for x in range(-outline_range, outline_range + 1):
176	1	for y in range(-outline_range, outline_range + 1):
177	1	pos = (text_position[0] + x, text_position[1] + y)
178	1	draw_image.multiline_text(pos, text, (0, 0, 0),
179		font=font, align='center')
180
181		# Draw inner white text
182	1	draw_image.multiline_text(text_position, text, (255, 255, 255),
183		font=font, align='center')
184
185
186	1	def _add_blurred_background(foreground, background, width, height):
187		"""Add a blurred background to match the requested dimensions."""
188	1	base_width, base_height = foreground.size
189
190	1	border_width = min(width, base_width + 2)
191	1	border_height = min(height, base_height + 2)
192	1	border_dimensions = border_width, border_height
193	1	border = ImageFile.new('RGB', border_dimensions)
194	1	border.paste(foreground, ((border_width - base_width) // 2,
195		(border_height - base_height) // 2))
196
197	1	padded_dimensions = (width, height)
198	1	padded = background.resize(padded_dimensions, ImageFile.LANCZOS)
199
200	1	darkened = padded.point(lambda p: p * 0.4)
201
202	1	blurred = darkened.filter(ImageFilter.GaussianBlur(5))
203	1	blurred.format = 'PNG'
204
205	1	blurred_width, blurred_height = blurred.size
206	1	offset = ((blurred_width - border_width) // 2,
207		(blurred_height - border_height) // 2)
208	1	blurred.paste(border, offset)
209
210	1	return blurred
211
212
213	1	def _maximize_font_size(font, text, max_size):
214		"""Find the biggest font size that will fit."""
215	1	font_size = max_size
216
217	1	fontobj = ImageFont.truetype(font, font_size)
218	1	text_size = fontobj.getsize(text)
219	1	while text_size[0] > max_size and font_size > 1:
220	1	font_size = font_size - 1
221	1	fontobj = ImageFont.truetype(font, font_size)
222	1	text_size = fontobj.getsize(text)
223
224	1	return font_size
225
226
227	1	def _split(text):
228		"""Split a line of text into two similarly sized pieces.
229
230		>>> _split("Hello, world!")
231		('Hello,', 'world!')
232
233		>>> _split("This is a phrase that can be split.")
234		('This is a phrase', 'that can be split.')
235
236		>>> _split("This_is_a_phrase_that_can_not_be_split.")
237		('This_is_a_phrase_that_can_not_be_split.',)
238
239		"""
240	1	result = (text,)
241
242	1	if len(text) >= 3 and ' ' in text[1:-1]: # can split this string
243	1	space_indices = [i for i in range(len(text)) if text[i] == ' ']
244	1	space_proximities = [abs(i - len(text) // 2) for i in space_indices]
245	1	for i, j in zip(space_proximities, space_indices):
246	1	if i == min(space_proximities):
247	1	result = (text[:j], text[j + 1:])
248	1	break
249
250		return result
251

jacebrowning / memegen

Push — master ( 69cfd2...2dc0e9 )

Image.__init__() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

Image.init() A

2. Missing init.py files