/usr/share/pyshared/glue.py is in glue-sprite 0.2.5-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 | #!/usr/bin/env python
import re
import os
import sys
import copy
import time
import signal
import hashlib
import subprocess
import ConfigParser
from optparse import OptionParser, OptionGroup
from PIL import Image as PImage
__version__ = '0.2.5'
TRANSPARENT = (255, 255, 255, 0)
CAMELCASE_SEPARATOR = 'camelcase'
CONFIG_FILENAME = 'sprite.conf'
ORDERINGS = ['maxside', 'width', 'height', 'area']
VALID_IMAGE_EXTENSIONS = ['png', 'jpg', 'jpeg', 'gif']
PSEUDO_CLASSES = set(['link', 'visited', 'active', 'hover', 'focus',
'first-letter', 'first-line', 'first-child',
'before', 'after'])
DEFAULT_SETTINGS = {'padding': '0',
'margin': '0',
'algorithm': 'square',
'ordering': 'maxside',
'namespace': 'sprite',
'crop': False,
'url': '',
'less': False,
'optipng': False,
'html': False,
'ignore_filename_paddings': False,
'png8': False,
'separator': '-',
'global_template': ('%(all_classes)s{background-image:'
'url(%(sprite_url)s);'
'background-repeat:no-repeat}\n'),
'each_template': ('%(class_name)s{'
'background-position:%(x)s %(y)s;'
'width:%(width)s;height:%(height)s;}\n')}
TEST_HTML_TEMPLATE = """
<html><head><title>Glue Sprite Test Html</title>
<link rel="stylesheet" type="text/css" href="%(css_url)s"></head><body>
<style type="text/css">tr div:hover{ border:1px solid #ccc;}
tr div{ border:1px solid white;}</style><h1>CSS Classes</h1><table>
<tr><th>CSS Class</th><th>Result</th></tr>%(sprites)s</table>
<p><em>Generated using <a href="http://gluecss.com"/>Glue v%(version)s</a>
</em></p></body></html>
"""
TEST_HTML_SPRITE_TEMPLATE = """
<tr><td>.%(class_name)s </td><td><div class="%(class_name)s"></div></td></tr>
"""
class MultipleImagesWithSameNameError(Exception):
"""Raised if two images pretend to generate the same CSS class name."""
error_code = 2
class SourceImagesNotFoundError(Exception):
"""Raised if a folder doesn't contain any valid image."""
error_code = 3
class NoSpritesFoldersFoundError(Exception):
"""Raised if no sprites folders could be found."""
error_code = 4
class InvalidImageAlgorithmError(Exception):
"""Raised if the provided algorithm name is invalid."""
error_code = 5
class InvalidImageOrderingError(Exception):
"""Raised if the provided ordering is invalid."""
error_code = 6
class PILUnavailableError(Exception):
"""Raised if some PIL decoder isn't available."""
error_code = 7
class SquareAlgorithmNode(object):
def __init__(self, x=0, y=0, width=0, height=0, used=False,
down=None, right=None):
"""Node constructor.
:param x: X coordinate.
:param y: Y coordinate.
:param width: Image width.
:param height: Image height.
:param used: Flag to determine if the node is used.
:param down: Down :class:`~Node`.
:param right Right :class:`~Node`.
"""
self.x = x
self.y = y
self.width = width
self.height = height
self.used = used
self.right = right
self.down = down
def find(self, node, width, height):
"""Find a node to allocate this image size (width, height).
:param node: Node to search in.
:param width: Pixels to grow down (width).
:param height: Pixels to grow down (height).
"""
if node.used:
return self.find(node.right, width, height) or \
self.find(node.down, width, height)
elif node.width >= width and node.height >= height:
return node
return None
def grow(self, width, height):
""" Grow the canvas to the most appropriate direction.
:param width: Pixels to grow down (width).
:param height: Pixels to grow down (height).
"""
can_grow_d = width <= self.width
can_grow_r = height <= self.height
should_grow_r = can_grow_r and self.height >= (self.width + width)
should_grow_d = can_grow_d and self.width >= (self.height + height)
if should_grow_r:
return self.grow_right(width, height)
elif should_grow_d:
return self.grow_down(width, height)
elif can_grow_r:
return self.grow_right(width, height)
elif can_grow_d:
return self.grow_down(width, height)
return None
def grow_right(self, width, height):
"""Grow the canvas to the right.
:param width: Pixels to grow down (width).
:param height: Pixels to grow down (height).
"""
old_self = copy.copy(self)
self.used = True
self.x = self.y = 0
self.width += width
self.down = old_self
self.right = SquareAlgorithmNode(x=old_self.width,
y=0,
width=width,
height=self.height)
node = self.find(self, width, height)
if node:
return self.split(node, width, height)
return None
def grow_down(self, width, height):
"""Grow the canvas down.
:param width: Pixels to grow down (width).
:param height: Pixels to grow down (height).
"""
old_self = copy.copy(self)
self.used = True
self.x = self.y = 0
self.height += height
self.right = old_self
self.down = SquareAlgorithmNode(x=0,
y=old_self.height,
width=self.width,
height=height)
node = self.find(self, width, height)
if node:
return self.split(node, width, height)
return None
def split(self, node, width, height):
"""Split the node to allocate a new one of this size.
:param node: Node to be splitted.
:param width: New node width.
:param height: New node height.
"""
node.used = True
node.down = SquareAlgorithmNode(x=node.x,
y=node.y + height,
width=node.width,
height=node.height - height)
node.right = SquareAlgorithmNode(x=node.x + width,
y=node.y,
width=node.width - width,
height=height)
return node
class SquareAlgorithm(object):
def process(self, sprite):
root = SquareAlgorithmNode(width=sprite.images[0].absolute_width,
height=sprite.images[0].absolute_height)
# Loot all over the images creating a binary tree
for image in sprite.images:
node = root.find(root, image.absolute_width, image.absolute_height)
if node: # Use this node
node = root.split(node, image.absolute_width,
image.absolute_height)
else: # Grow the canvas
node = root.grow(image.absolute_width, image.absolute_height)
image.x = node.x
image.y = node.y
class VerticalAlgorithm(object):
def process(self, sprite):
y = 0
for image in sprite.images:
image.x = 0
image.y = y
y += image.absolute_height
class VerticalRightAlgorithm(object):
def process(self, sprite):
max_width = max([i.width for i in sprite.images])
y = 0
for image in sprite.images:
image.x = max_width - image.width
image.y = y
y += image.absolute_height
class HorizontalAlgorithm(object):
def process(self, sprite):
x = 0
for image in sprite.images:
image.y = 0
image.x = x
x += image.absolute_width
class HorizontalBottomAlgorithm(object):
def process(self, sprite):
max_height = max([i.height for i in sprite.images])
x = 0
for image in sprite.images:
image.y = max_height - image.height
image.x = x
x += image.absolute_width
class DiagonalAlgorithm(object):
def process(self, sprite):
x = y = 0
for image in sprite.images:
image.x = x
image.y = y
x += image.absolute_width
y += image.absolute_height
ALGORITHMS = {'square': SquareAlgorithm,
'vertical': VerticalAlgorithm,
'vertical-right': VerticalRightAlgorithm,
'horizontal': HorizontalAlgorithm,
'horizontal-bottom': HorizontalBottomAlgorithm,
'diagonal': DiagonalAlgorithm}
class Image(object):
def __init__(self, name, sprite):
"""Image constructor
:param name: Image name.
:param sprite: :class:`~Sprite` instance for this image."""
self.x = None
self.y = None
self.name = name
self.sprite = sprite
self.filename, self.format = name.rsplit('.', 1)
pseudo = set(self.filename.split('_')).intersection(PSEUDO_CLASSES)
self.pseudo = ':%s' % list(pseudo)[-1] if pseudo else ''
image_path = os.path.join(sprite.path, name)
image_file = open(image_path, "rb")
try:
source_image = PImage.open(image_file)
source_image.load()
self.image = PImage.new('RGBA', source_image.size, (0, 0, 0, 0))
if source_image.mode == 'L':
alpha = source_image.split()[0]
transparency = source_image.info.get('transparency')
mask = PImage.eval(alpha, lambda a: 0 if a == transparency else 255)
self.image.paste(source_image, (0, 0), mask=mask)
else:
self.image.paste(source_image, (0, 0))
except IOError, e:
raise PILUnavailableError(e.args[0].split()[1])
image_file.close()
if self.sprite.config.crop:
self._crop_image()
self.width, self.height = self.image.size
margin = int(self.sprite.config.margin)
self.absolute_width = self.width + self.padding[1] + self.padding[3] + (margin * 2)
self.absolute_height = self.height + self.padding[0] + self.padding[2] + (margin * 2)
def _crop_image(self):
"""Crop the image searching for the smallest possible bounding box
without losing any non-transparent pixel.
This crop is only used if the crop flag is set in the config.
"""
width, height = self.image.size
maxx = maxy = 0
minx = miny = sys.maxint
for x in xrange(width):
for y in xrange(height):
if y > miny and y < maxy and maxx == x:
continue
if self.image.getpixel((x, y)) != TRANSPARENT:
if x < minx:
minx = x
if x > maxx:
maxx = x
if y < miny:
miny = y
if y > maxy:
maxy = y
self.image = self.image.crop((minx, miny, maxx + 1, maxy + 1))
def _generate_padding(self, padding):
"""Return a 4-elements list with the desired padding.
:param padding: Padding as a list or a raw string representing
the padding for this image."""
if type(padding) == str:
padding = padding.replace('px', '').split()
if len(padding) == 4:
padding = padding
elif len(padding) == 3:
padding = padding + [padding[1]]
elif len(padding) == 2:
padding = padding * 2
elif len(padding) == 1:
padding = padding * 4
else:
padding = [DEFAULT_SETTINGS['padding']] * 4
return map(int, padding)
@property
def class_name(self):
"""Return the CSS class name for this file.
This CSS class name will have the following format:
``.[namespace]-[sprite_name]-[image_name]{ ... }``
The image_name will only contain alphanumeric characters,
``-`` and ``_``. The default namespace is ``sprite``, but it could
be overridden using the ``--namespace`` optional argument.
* ``animals/cat.png`` will be ``.sprite-animals-cat``
* ``animals/cow_20.png`` will be ``.sprite-animals-cow``
* ``animals/cat_hover.png`` will be ``.sprite-animals-cat:hover``
* ``animals/cow_20_hover.png`` will be ``.sprite-animals-cow:hover``
The separator used is also configurable using the ``--separator``
option. For a camelCase representation of the CSS class name use
``camelcase`` as separator.
"""
name = self.filename
# Remove padding information
if not self.sprite.manager.config.ignore_filename_paddings:
padding_info_name = '-'.join(self._padding_info)
if padding_info_name:
padding_info_name = '_%s' % padding_info_name
name = name.replace(padding_info_name, '')
# Remove pseudo-class information
if self.pseudo:
name = name.replace('_%s' % self.pseudo[1:], '')
# Clean filename
name = re.sub(r'[^\w\-_]', '', name)
# Customize the name if necessary
separator = self.sprite.manager.config.separator
if separator == CAMELCASE_SEPARATOR:
separator = ''
if self.sprite.namespace:
name = name[:1].capitalize() + name[1:]
# Add pseudo-class information
name = '%s%s' % (name, self.pseudo)
return separator.join([self.sprite.namespace, name])
@property
def _padding_info(self):
"""Return the padding information from the filename."""
for block in self.filename.split('_')[::-1]:
if re.match(r"^(\d+-?){,3}\d+$", block):
return block.split('-')
return []
@property
def padding(self):
"""Return the padding for this image based on the filename and
the sprite settings file.
* ``filename.png`` will have the default padding ``10px``.
* ``filename_20.png`` -> ``20px`` all around the image.
* ``filename_1-2-3.png`` -> ``1px 2px 3px 2px`` around the image.
* ``filename_1-2-3-4.png`` -> ``1px 2px 3px 4px`` around the image.
"""
padding = self._padding_info
if len(padding) == 0 or \
self.sprite.manager.config.ignore_filename_paddings:
padding = self.sprite.config.padding
return self._generate_padding(padding)
def __lt__(self, img):
"""Use maxside, width, height or area as ordering algorithm.
:param img: Another :class:`~Image`."""
ordering = self.sprite.config.ordering
ordering = ordering[1:] if ordering.startswith('-') else ordering
if ordering not in ORDERINGS:
raise InvalidImageOrderingError(ordering)
if ordering == 'width':
return self.absolute_width <= img.absolute_width
elif ordering == 'height':
return self.absolute_height <= img.absolute_height
elif ordering == 'area':
return self.absolute_width * self.absolute_height <= \
img.absolute_width * img.absolute_height
else:
return max(self.absolute_width, self.absolute_height) <= \
max(img.absolute_width, img.absolute_height)
class Sprite(object):
def __init__(self, name, path, manager):
"""Sprite constructor.
:param name: Sprite name.
:param path: Sprite path
:param manager: Sprite manager. :class:`~ProjectSpriteManager` or
:class:`SimpleSpriteManager`"""
self.name = name
self.manager = manager
self.images = []
self.path = path
self.cachebuster_hash = ''
self.config = manager.config.extend(get_file_config(self.path))
self.process()
def process(self):
"""Process a sprite path searching for all the images and then
allocate all of them in the most appropriate position.
"""
algorithm = ALGORITHMS.get(self.config.algorithm)
if not algorithm:
raise InvalidImageAlgorithmError(self.config.algorithm)
self.algorithm = algorithm()
self.images = self._locate_images()
self.algorithm.process(self)
def _locate_images(self):
"""Return all valid images within a folder.
All files with a extension not included i
(png, jpg, jpeg and gif) or beginning with '.' will be ignored.
If the folder doesn't contain any valid image it will raise
:class:`~MultipleImagesWithSameNameError`
The list of images will be ordered using the desired ordering
algorithm. The default is 'maxside'.
"""
extensions = '|'.join(VALID_IMAGE_EXTENSIONS)
extension_re = re.compile('.+\.(%s)$' % extensions, re.IGNORECASE)
files = sorted(os.listdir(self.path))
images = [Image(n, sprite=self) for n in files if \
not n.startswith('.') and \
extension_re.match(n)]
if not len(images):
raise SourceImagesNotFoundError()
# Check if there are duplicate class names
class_names = [i.class_name for i in images]
if len(set(class_names)) != len(images):
dup = [i for i in images if class_names.count(i.class_name) > 1]
raise MultipleImagesWithSameNameError(dup)
for image in images:
self.manager.log("\t %s => .%s" % (image.name, image.class_name))
return sorted(images, reverse=self.config.ordering[0] != '-')
def save_image(self):
"""Create the image file for this sprite."""
self.manager.log("Creating '%s' image file..." % self.name)
sprite_output_path = self.manager.output_path('img')
# Search for the max x and y (Necessary to generate the canvas).
width = height = 0
for image in self.images:
x = image.x + image.absolute_width
y = image.y + image.absolute_height
if width < x:
width = x
if height < y:
height = y
# Create the sprite canvas
canvas = PImage.new('RGBA', (width, height), (0, 0, 0, 0))
# Paste the images inside the canvas
margin = int(self.config.margin)
for image in self.images:
canvas.paste(image.image, (image.x + image.padding[3] + margin,
image.y + image.padding[0] + margin))
if self.config.cachebuster or self.config.cachebuster_filename:
self.cachebuster_hash = hashlib.sha1(canvas.tostring()
).hexdigest()[:6]
# Save png
sprite_filename = '%s.png' % self.filename
sprite_image_path = os.path.join(sprite_output_path, sprite_filename)
args, kwargs = [sprite_image_path], dict(optimize=True)
if self.config.png8:
# Get the alpha band
alpha = canvas.split()[-1]
canvas = canvas.convert('RGB'
).convert('P', palette=PImage.ADAPTIVE, colors=255)
# Set all pixel values below 128 to 255, and the rest to 0
mask = PImage.eval(alpha, lambda a: 255 if a <= 128 else 0)
# Paste the color of index 255 and use alpha as a mask
canvas.paste(255, mask)
kwargs.update({'transparency': 255})
save = lambda: canvas.save(*args, **kwargs)
save()
if self.config.optipng:
command = ["%s %s" % (self.config.optipngpath,
sprite_image_path)]
error = subprocess.call(command, shell=True, stdin=subprocess.PIPE,
stdout=subprocess.PIPE)
if error:
self.manager.log("Error: optipng has failed, reverting to "
"the original file.")
save()
def save_css(self):
"""Create the CSS or LESS file for this sprite."""
format = 'less' if self.config.less else 'css'
self.manager.log("Creating '%s' %s file..." % (self.name, format))
output_path = self.manager.output_path('css')
filename = '%s.%s' % (self.filename, format)
css_filename = os.path.join(output_path, filename)
# Fix css urls on Windows
css_filename = '/'.join(css_filename.split('\\'))
css_file = open(css_filename, 'w')
# get all the class names and join them
class_names = ',\n'.join(['.%s' % i.class_name for i in self.images \
if ':' not in i.class_name])
# add the global style for all the sprites for less bloat
template = self.config.global_template.decode('unicode-escape')
css_file.write(template % {'all_classes': class_names,
'sprite_url': self.image_url})
# compile one template for each file
margin = int(self.config.margin)
for image in self.images:
x = '%spx' % ((image.x * -1 if image.x else 0) - margin)
y = '%spx' % ((image.y * -1 if image.y else 0) - margin)
height = '%spx' % (image.absolute_height - (margin * 2))
width = '%spx' % (image.absolute_width - (margin * 2))
template = self.config.each_template.decode('unicode-escape')
css_file.write(template % {'class_name': '.%s' % image.class_name,
'sprite_url': self.image_url,
'height': height,
'width': width,
'y': y,
'x': x})
css_file.close()
def save_html(self):
self.manager.log("Creating '%s' html file..." % self.name)
output_path = self.manager.output_path('css')
filename = '%s.html' % self.filename
html_filename = os.path.join(output_path, filename)
# CSS output format
format = 'less' if self.config.less else 'css'
# Fix css urls on Windows
html_filename = '/'.join(html_filename.split('\\'))
html_file = open(html_filename, 'w')
# get all the class names and join them
class_names = [i.class_name for i in self.images \
if ':' not in i.class_name]
sprite_template = TEST_HTML_SPRITE_TEMPLATE.decode('unicode-escape')
sprites_html = [sprite_template % {'class_name':c} for c in class_names]
file_template = TEST_HTML_TEMPLATE.decode('unicode-escape')
html_file.write(file_template % {'sprites': ''.join(sprites_html),
'css_url': '%s.%s' % (self.filename, format),
'version': __version__})
html_file.close()
@property
def namespace(self):
"""Return the namespace for this sprite."""
namespace = [self.name]
separator = self.config.separator
if self.config.namespace:
namespace.insert(0, self.config.namespace)
if separator == CAMELCASE_SEPARATOR:
namespace = [n.lower().capitalize() if i > 0 else n.lower() \
for i, n in enumerate(namespace)]
separator = ''
return separator.join(namespace)
@property
def filename(self):
"""Return the desired filename for files generated by this sprite."""
if self.config.cachebuster_filename:
return '%s_%s' % (self.name, self.cachebuster_hash)
return self.name
@property
def image_path(self):
"""Return the output path for the image file."""
return os.path.join(self.manager.output_path('img'),
'%s.png' % self.filename)
@property
def image_url(self):
"""Return the sprite image url."""
url = os.path.relpath(self.image_path, self.manager.output_path('css'))
if self.config.url:
url = os.path.join(self.config.url, '%s.png' % self.filename)
if self.config.cachebuster:
url = "%s?%s" % (url, self.cachebuster_hash)
return url
class ConfigManager(object):
"""Manage all the available configuration.
If no config is available, return the default one."""
def __init__(self, *args, **kwargs):
"""ConfigManager constructor.
:param *args: List of config dictionaries. The order of this list is
important because as soon as a config property
is available it will be returned.
:param defaults: Dictionary with the default configuration.
:param priority: Dictionary with the command line configuration. This
configuration will override any other from any source.
"""
self.defaults = kwargs.get('defaults', {})
self.priority = kwargs.get('priority', {})
self.sources = list(args)
def extend(self, config):
"""Return a new :class:`~ConfigManager` instance with this new config
inside the sources list.
:param config: Dictionary with the new config.
"""
return self.__class__(config, priority=self.priority,
defaults=self.defaults, *self.sources)
def __getattr__(self, name):
"""Return the first available configuration value for this key. This
method always prioritizes the command line configuration. If this key
is not available within any configuration dictionary, it returns the
default value
:param name: Configuration property name.
"""
sources = [self.priority] + self.sources
for source in sources:
value = source.get(name)
if value is not None:
return value
return self.defaults.get(name)
class BaseManager(object):
def __init__(self, path, config, output=None):
"""BaseManager constructor.
:param path: Sprite path.
:param config: :class:`~ConfigManager` instance with all the
configuration for this sprite.
:param output: output dir.
"""
self.path = path
self.config = config
self.output = output
self.sprites = []
def process_sprite(self, path, name):
"""Create a new Sprite using this path and name and append it to the
sprites list.
:param path: Sprite path.
:param name: Sprite name.
"""
self.log("Processing '%s':" % name)
sprite = Sprite(name=name, path=path, manager=self)
self.sprites.append(sprite)
def save(self):
"""Save all the sprites inside this manager."""
for sprite in self.sprites:
sprite.save_image()
sprite.save_css()
if sprite.manager.config.html:
sprite.save_html()
def output_path(self, format):
"""Return the path where all the generated files will be saved.
:param format: File format.
"""
if format == 'css' and self.config.css_dir:
sprite_output_path = self.config.css_dir
elif format == 'img' and self.config.img_dir:
sprite_output_path = self.config.img_dir
else:
sprite_output_path = self.output
if not os.path.exists(sprite_output_path):
os.makedirs(sprite_output_path)
return sprite_output_path
def log(self, message):
"""Print the message if necessary."""
if not self.config.quiet:
print(message)
def process(self):
raise NotImplementedError()
class ProjectSpriteManager(BaseManager):
def process(self):
"""Process a path searching for folders that contain images.
Every folder will be a new sprite with all the images inside.
The filename of the image can also contain information about the
padding needed around the image.
* ``filename.png`` will have the default padding (10px).
* ``filename_20.png`` will have 20px all around the image.
* ``filename_1-2-3.png`` will have 1px 2px 3px 2px around the image.
* ``filename_1-2-3-4.png`` will have 1px 2px 3px 4px around the image.
The generated CSS file will have a CSS class for every image found
inside the sprites folder. These CSS class names will have the
following format:
``.[namespace]-[sprite_name]-[image_name]{ ... }``
The image_name will only contain alphanumeric characters,
``-`` and ``_``. The default namespace is ``sprite``, but it could be
overridden using the ``--namespace`` optional argument.
* ``animals/cat.png`` CSS class will be ``.sprite-animals-cat``
* ``animals/cow_20.png`` CSS class will be ``.sprite-animals-cow``
If two images have the same name,
:class:`~MultipleImagesWithSameNameError` will be raised.
This is not the default manager. It is only used if you use
the ``--project`` argument.
"""
for sprite_name in os.listdir(self.path):
# Only process folders
path = os.path.join(self.path, sprite_name)
if os.path.isdir(path) and not sprite_name.startswith('.'):
self.process_sprite(path=path, name=sprite_name)
if not len(self.sprites):
raise NoSpritesFoldersFoundError()
self.save()
class SimpleSpriteManager(BaseManager):
def process(self):
"""Process a single folder and create one sprite. It works the
same way as :class:`~ProjectSpriteManager`, but only for one folder.
This is the default manager.
"""
self.process_sprite(path=self.path, name=os.path.basename(self.path))
self.save()
class WatchManager(object):
def __init__(self, path, action):
self.action = action
self.path = path
self.last_hash = None
def run(self):
signal.signal(signal.SIGINT, self.signal_handler)
while True:
try:
current_hash = self.generate_hash()
if self.last_hash != current_hash:
self.action()
self.last_hash = current_hash
except Exception:
pass
finally:
time.sleep(0.2)
def signal_handler(self, signal, frame):
print 'You pressed Ctrl+C!'
sys.exit(0)
def generate_hash(self):
hash_list = []
for root, dirs, files in os.walk(self.path):
for f in sorted([f for f in files if not f.startswith('.')]):
hash_list.append(os.path.join(root, f))
hash_list.append(str(os.path.getmtime(os.path.join(root, f))))
hash_list = ''.join(hash_list)
return hashlib.sha1(hash_list).hexdigest()
def get_file_config(path, section='sprite'):
"""Return, as a dictionary, all the available configuration inside the
sprite configuration file on this path.
:param path: Path where the configuration file is.
:param section: The configuration file section that needs to be read.
"""
def clean(value):
return {'true': True, 'false': False}.get(value.lower(), value)
config = ConfigParser.RawConfigParser()
config.read(os.path.join(path, CONFIG_FILENAME))
try:
keys = config.options(section)
except ConfigParser.NoSectionError:
return {}
return dict([[k, clean(config.get(section, k))] for k in keys])
def command_exists(command):
"""Check if a command exists by running it.
:param command: command name.
"""
try:
subprocess.check_call([command], shell=True, stdin=subprocess.PIPE,
stderr=subprocess.PIPE, stdout=subprocess.PIPE)
except subprocess.CalledProcessError:
return False
return True
#########################################################################
# PIL currently doesn't support full alpha for PNG8 so it's necessary to
# monkey patch PIL to support them.
# http://mail.python.org/pipermail/image-sig/2010-October/006533.html
#########################################################################
from PIL import ImageFile, PngImagePlugin
def patched_chunk_tRNS(self, pos, len):
i16 = PngImagePlugin.i16
s = ImageFile._safe_read(self.fp, len)
if self.im_mode == "P":
self.im_info["transparency"] = map(ord, s)
elif self.im_mode == "L":
self.im_info["transparency"] = i16(s)
elif self.im_mode == "RGB":
self.im_info["transparency"] = i16(s), i16(s[2:]), i16(s[4:])
return s
PngImagePlugin.PngStream.chunk_tRNS = patched_chunk_tRNS
def patched_load(self):
if self.im and self.palette and self.palette.dirty:
apply(self.im.putpalette, self.palette.getdata())
self.palette.dirty = 0
self.palette.rawmode = None
try:
trans = self.info["transparency"]
except KeyError:
self.palette.mode = "RGB"
else:
try:
for i, a in enumerate(trans):
self.im.putpalettealpha(i, a)
except TypeError:
self.im.putpalettealpha(trans, 0)
self.palette.mode = "RGBA"
if self.im:
return self.im.pixel_access(self.readonly)
PImage.Image.load = patched_load
#########################################################################
def main():
parser = OptionParser(usage=("usage: %prog [options] source_dir [<output> "
"| --css=<dir> --img=<dir>]"))
parser.add_option("--project", action="store_true",
dest="project", help="generate sprites for multiple folders")
parser.add_option("-c", "--crop", dest="crop", action='store_true',
help="crop images removing unnecessary transparent margins")
parser.add_option("-l", "--less", dest="less", action='store_true',
help="generate output stylesheets as .less instead of .css")
parser.add_option("-u", "--url", dest="url", default=None,
help="prepend this url to the sprites filename")
parser.add_option("-q", "--quiet", dest="quiet", action='store_true',
help="suppress all normal output")
parser.add_option("-p", "--padding", dest="padding", default=None,
help="force this padding in all images")
parser.add_option("-w", "--watch", dest="watch", default=False,
action='store_true',
help=("Watch the source folder for changes and rebuild "
"when new files appear, disappear or change."))
parser.add_option("-v", "--version", action="store_true", dest="version",
help="show program's version number and exit")
group = OptionGroup(parser, "Output Options")
group.add_option("--css", dest="css_dir", default='',
help="output directory for css files", metavar='DIR')
group.add_option("--img", dest="img_dir", default='', metavar='DIR',
help="output directory for img files")
group.add_option("--html", dest="html", default=None, action="store_true",
help=("generate test html file using the sprite "
"image and CSS."))
parser.add_option_group(group)
group = OptionGroup(parser, "Advanced Options")
group.add_option("-a", "--algorithm", dest="algorithm", default=None,
help=("allocation algorithm: square, vertical, horizontal "
"(default: square)"), metavar='NAME')
group.add_option("--ordering", dest="ordering", default=None,
help=("ordering criteria: maxside, width, height or "
"area (default: maxside)"), metavar='NAME')
group.add_option("--margin", dest="margin", default=None,
help="force this margin in all images", type=int)
group.add_option("--namespace", dest="namespace", default=None,
help="namespace for all css classes (default: sprite)")
group.add_option("--png8", action="store_true", dest="png8",
help=("the output image format will be png8 "
"instead of png32"))
group.add_option("--ignore-filename-paddings",
dest="ignore_filename_paddings", action='store_true',
help="ignore filename paddings")
parser.add_option_group(group)
group = OptionGroup(parser, "Output CSS Template Options")
group.add_option("--separator", dest="separator",
help=("Customize the separator used to join CSS class "
"names. If you want to use camelCase use "
"'camelcase' as separator."),
metavar='SEPARATOR')
group.add_option("--global-template", dest="global_template",
help=("Customize the global section of the output CSS."
"This section will be added only once for each "
"sprite."),
metavar='TEMPLATE')
group.add_option("--each-template", dest="each_template",
help=("Customize each image output CSS."
"This section will be added once for each "
"image inside the sprite."),
metavar='TEMPLATE')
parser.add_option_group(group)
group = OptionGroup(parser, "Optipng Options",
"You need to install optipng before using these options")
group.add_option("--optipng", dest="optipng", action='store_true',
help="postprocess images using optipng")
group.add_option("--optipngpath", dest="optipngpath", default='optipng',
help="path to optipng (default: optipng)", metavar='PATH')
parser.add_option_group(group)
group = OptionGroup(parser, "Browser Cache Invalidation Options")
group.add_option("--cachebuster", dest="cachebuster",
action='store_true',
help=("use the sprite's sha1 first 6 characters as a "
"queryarg everytime that file is referred from "
"the css"))
group.add_option("--cachebuster-filename", dest="cachebuster_filename",
action='store_true',
help=("append the sprite's sha first 6 characters "
"to the otput filename"))
parser.add_option_group(group)
(options, args) = parser.parse_args()
if options.version:
sys.stdout.write("%s\n" % __version__)
sys.exit(0)
if options.cachebuster and options.cachebuster_filename:
parser.error("You can't use --cachebuster and "
"--cachebuster-filename at the same time.")
if not len(args):
parser.error("You must provide the folder containing the sprites.")
if len(args) == 1 and not (options.css_dir and options.img_dir):
parser.error(("You must choose the output folder using either the "
"output argument or both --img and --css."))
if len(args) == 2 and (options.css_dir or options.img_dir):
parser.error(("You must choose between using an unique output dir, or "
"using --css and --img."))
if options.optipng and not command_exists(options.optipngpath):
parser.error("'optipng' seems to be unavailable. You need to "
"install it before using --optipng, or "
"provide a path using --optipngpath.")
source = os.path.abspath(args[0])
output = os.path.abspath(args[1]) if len(args) == 2 else None
if not os.path.isdir(source):
parser.error("Directory not found: '%s'" % source)
if options.project:
manager_cls = ProjectSpriteManager
else:
manager_cls = SimpleSpriteManager
# Get configuration from file
config = get_file_config(source)
# Convert options to dict
options = options.__dict__
config = ConfigManager(config, priority=options, defaults=DEFAULT_SETTINGS)
manager = manager_cls(path=source, output=output, config=config)
if manager.config.watch:
WatchManager(path=source, action=manager.process).run()
sys.exit(0)
try:
manager.process()
except MultipleImagesWithSameNameError, e:
sys.stderr.write("Error: Some images will have the same class name:\n")
for image in e.args[0]:
sys.stderr.write('\t %s => .%s\n' % (image.name, image.class_name))
sys.exit(e.error_code)
except SourceImagesNotFoundError, e:
sys.stderr.write("Error: No images found.\n")
sys.exit(e.error_code)
except NoSpritesFoldersFoundError, e:
sys.stderr.write("Error: No sprites folders found.\n")
sys.exit(e.error_code)
except InvalidImageOrderingError, e:
sys.stderr.write("Error: Invalid image ordering %s.\n" % e.args[0])
sys.exit(e.error_code)
except InvalidImageAlgorithmError, e:
sys.stderr.write("Error: Invalid image algorithm %s.\n" % e.args[0])
sys.exit(e.error_code)
except PILUnavailableError, e:
sys.stderr.write(("Error: PIL %s decoder is unavailable"
"Please read the documentation and "
"install it before spriting this kind of "
"images.\n") % e.args[0])
sys.exit(e.error_code)
except Exception:
sys.stderr.write("Error: Unknown Error.\n")
sys.exit(1)
if __name__ == "__main__":
main()
|