Support Python 3 without the 2to3 tool

docs/conf.py

@@ -53,10 +53,10 @@
 try:
     release = pkg_resources.get_distribution('glue').version
 except pkg_resources.DistributionNotFound:
-    print 'To build the documentation, The distribution information of glue'
-    print 'Has to be available.  Either install the package into your'
-    print 'development environment or run "setup.py develop" to setup the'
-    print 'metadata.  A virtualenv is recommended!'
+    print('To build the documentation, The distribution information of glue')
+    print('Has to be available.  Either install the package into your')
+    print('development environment or run "setup.py develop" to setup the')
+    print('metadata.  A virtualenv is recommended!')
     sys.exit(1)
 del pkg_resources
 

glue/algorithms/__init__.py

@@ -1,9 +1,9 @@
-from diagonal import DiagonalAlgorithm
-from horizontal import HorizontalAlgorithm
-from horizontal_bottom import HorizontalBottomAlgorithm
-from square import SquareAlgorithm
-from vertical import VerticalAlgorithm
-from vertical_right import VerticalRightAlgorithm
+from .diagonal import DiagonalAlgorithm
+from .horizontal import HorizontalAlgorithm
+from .horizontal_bottom import HorizontalBottomAlgorithm
+from .square import SquareAlgorithm
+from .vertical import VerticalAlgorithm
+from .vertical_right import VerticalRightAlgorithm
 
 algorithms = {'diagonal': DiagonalAlgorithm,
               'horizontal': HorizontalAlgorithm,

glue/bin.py

@@ -5,6 +5,7 @@
 
 from PIL import Image as PImage
 
+from glue.compat import itervalues, iterkeys, text_type
 from glue.formats import formats
 from glue.helpers import redirect_stdout
 from glue import exceptions
@@ -20,13 +21,13 @@ def main(argv=None):
 
     parser.add_argument("--source", "-s",
                         dest="source",
-                        type=unicode,
+                        type=text_type,
                         default=os.environ.get('GLUE_SOURCE', None),
                         help="Source path")
 
     parser.add_argument("--output", "-o",
                         dest="output",
-                        type=unicode,
+                        type=text_type,
                         default=os.environ.get('GLUE_OUTPUT', None),
                         help="Output path")
 
@@ -80,7 +81,7 @@ def main(argv=None):
     group.add_argument("-a", "--algorithm",
                        dest="algorithm",
                        metavar='NAME',
-                       type=unicode,
+                       type=text_type,
                        default=os.environ.get('GLUE_ALGORITHM', 'square'),
                        choices=['square', 'vertical', 'horizontal',
                                 'vertical-right', 'horizontal-bottom',
@@ -92,15 +93,15 @@ def main(argv=None):
     group.add_argument("--ordering",
                        dest="algorithm_ordering",
                        metavar='NAME',
-                       type=unicode,
+                       type=text_type,
                        default=os.environ.get('GLUE_ORDERING', 'maxside'),
                        choices=['maxside', 'width', 'height', 'area', 'filename',
                                 '-maxside', '-width', '-height', '-area', '-filename'],
                        help=("Ordering criteria: maxside, width, height, area or "
                              "filename (default: maxside)"))
 
     # Populate the parser with options required by other formats
-    for format in formats.itervalues():
+    for format in itervalues(formats):
         format.populate_argument_parser(parser)
 
     #
@@ -146,7 +147,7 @@ def add_deprecated_argument(*args, **kwargs):
         options.enabled_formats.remove('img')
 
     # Fail if any of the deprecated arguments is used
-    for argument in deprecated_arguments.iterkeys():
+    for argument in iterkeys(deprecated_arguments):
         if getattr(options, argument, None):
             parser.error(("{0} argument is deprectated "
                           "since v0.3").format(deprecated_arguments[argument]))
@@ -233,16 +234,16 @@ def add_deprecated_argument(*args, **kwargs):
                 manager.process()
         else:
             manager.process()
-    except exceptions.ValidationError, e:
+    except exceptions.ValidationError as e:
         sys.stderr.write(e.args[0])
         return e.error_code
-    except exceptions.SourceImagesNotFoundError, e:
+    except exceptions.SourceImagesNotFoundError as e:
         sys.stderr.write("Error: No images found in %s.\n" % e.args[0])
         return e.error_code
-    except exceptions.NoSpritesFoldersFoundError, e:
+    except exceptions.NoSpritesFoldersFoundError as e:
         sys.stderr.write("Error: No sprites folders found in %s.\n" % e.args[0])
         return e.error_code
-    except exceptions.PILUnavailableError, e:
+    except exceptions.PILUnavailableError as e:
         sys.stderr.write(("Error: PIL {0} decoder is unavailable"
                           "Please read the documentation and "
                           "install it before spriting this kind of "

glue/compat.py

@@ -0,0 +1,29 @@
+import sys
+
+PY3 = sys.version_info[0] == 3
+
+if PY3:  # pragma: no cover
+    text_type = str
+    binary_type = bytes
+
+    def itervalues(d):
+        return d.values()
+
+    def iterkeys(d):
+        return d.keys()
+
+    def iteritems(d):
+        return d.items()
+
+else:  # pragma: no cover
+    text_type = unicode
+    binary_type = str
+
+    def itervalues(d):
+        return d.itervalues()
+
+    def iterkeys(d):
+        return d.iterkeys()
+
+    def iteritems(d):
+        return d.iteritems()

glue/core.py

@@ -3,12 +3,20 @@
 import sys
 import copy
 import hashlib
-import StringIO
-import ConfigParser
+try:
+    from StringIO import StringIO
+except ImportError:
+    from io import BytesIO as StringIO
+
+try:
+    from ConfigParser import RawConfigParser, NoSectionError
+except ImportError:
+    from configparser import RawConfigParser, NoSectionError
 
 from PIL import Image as PILImage
 
 from glue.algorithms import algorithms
+from glue.compat import iteritems
 from glue.helpers import cached_property, round_up
 from glue.formats import ImageFormat
 from glue.exceptions import SourceImagesNotFoundError, PILUnavailableError
@@ -23,11 +31,11 @@ def _get_config_from_file(self, filename, section):
         def clean(value):
             return {'true': True, 'false': False}.get(value.lower(), value)
 
-        config = ConfigParser.RawConfigParser()
+        config = RawConfigParser()
         config.read(os.path.join(self.config_path, filename))
         try:
             keys = config.options(section)
-        except ConfigParser.NoSectionError:
+        except NoSectionError:
             return {}
         return dict([[k, clean(config.get(section, k))] for k in keys])
 
@@ -48,16 +56,13 @@ def __init__(self, path, config):
         with open(self.path, "rb") as img:
             self._image_data = img.read()
 
-        print "\t{0} added to sprite".format(self.filename)
+        print("\t{0} added to sprite".format(self.filename))
 
     @cached_property
     def image(self):
         """Return a Pil representation of this image """
 
-        if sys.version < '3':
-            imageio = StringIO.StringIO(self._image_data)
-        else:
-            imageio = StringIO.BytesIO(self._image_data)
+        imageio = StringIO(self._image_data)
 
         try:
             source_image = PILImage.open(imageio)
@@ -70,7 +75,7 @@ def image(self):
                 img.paste(source_image, (0, 0), mask=mask)
             else:
                 img.paste(source_image, (0, 0))
-        except IOError, e:
+        except IOError as e:
             raise PILUnavailableError(e.args[0].split()[1])
         finally:
             imageio.close()
@@ -105,7 +110,6 @@ def margin(self):
         return self._generate_spacing_info(self.config['margin'])
 
     def _generate_spacing_info(self, data):
-
         data = data.split(',' if ',' in data else ' ')
 
         if len(data) == 4:
@@ -119,7 +123,7 @@ def _generate_spacing_info(self, data):
         else:
             data = [0] * 4
 
-        return map(int, data)
+        return list(map(int, data))
 
     @cached_property
     def horizontal_spacing(self):
@@ -196,7 +200,7 @@ def __init__(self, path, config, name=None):
             if ratio_output_key not in self.config:
                 self.config[ratio_output_key] = img_format.output_path(ratio)
 
-        print "Processing '{0}':".format(self.name)
+        print("Processing '{0}':".format(self.name))
 
         # Generate sprite map
         self.process()
@@ -220,7 +224,7 @@ def hash(self):
             hash_list.append(os.path.relpath(image.path))
             hash_list.append(image._image_data)
 
-        for key, value in self.config.iteritems():
+        for key, value in iteritems(self.config):
             hash_list.append(key)
             hash_list.append(value)
 

glue/formats/base.py

@@ -9,6 +9,7 @@
 
 from glue.helpers import round_up, nearest_fration
 from glue import __version__
+from glue.compat import iteritems
 
 
 class BaseFormat(object):
@@ -54,7 +55,7 @@ def validate(self):
     @property
     def format_label(self):
         from glue.formats import formats
-        return dict((v,k) for k, v in formats.iteritems())[self.__class__]
+        return dict((v, k) for k, v in iteritems(formats))[self.__class__]
 
     @classmethod
     def populate_argument_parser(cls, parser):

glue/formats/caat.py

@@ -1,6 +1,6 @@
 import os
 
-from base import BaseJSONFormat
+from .base import BaseJSONFormat
 
 
 class CAATFormat(BaseJSONFormat):

glue/formats/cocos2d.py

@@ -1,6 +1,6 @@
 import os
 
-from base import BasePlistFormat
+from .base import BasePlistFormat
 
 
 class Cocos2dFormat(BasePlistFormat):

glue/formats/css.py

@@ -3,7 +3,8 @@
 import codecs
 
 from glue import __version__
-from base import JinjaTextFormat
+from glue.compat import iteritems, text_type
+from .base import JinjaTextFormat
 
 from ..exceptions import ValidationError
 
@@ -54,20 +55,20 @@ def populate_argument_parser(cls, parser):
 
         group.add_argument("--namespace",
                            dest="css_namespace",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_CSS_NAMESPACE', 'sprite'),
                            help="Namespace for all css classes (default: sprite)")
 
         group.add_argument("--sprite-namespace",
                            dest="css_sprite_namespace",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_CSS_SPRITE_NAMESPACE',
                                                   '{sprite_name}'),
                            help="Namespace for all sprites (default: {sprite_name})")
 
         group.add_argument("-u", "--url",
                            dest="css_url",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_CSS_URL', ''),
                            help="Prepend this string to the sprites path")
 
@@ -94,7 +95,7 @@ def populate_argument_parser(cls, parser):
 
         group.add_argument("--separator",
                            dest="css_separator",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_CSS_SEPARATOR', '-'),
                            metavar='SEPARATOR',
                            help=("Customize the separator used to join CSS class "
@@ -103,7 +104,7 @@ def populate_argument_parser(cls, parser):
 
         group.add_argument("--pseudo-class-separator",
                            dest="css_pseudo_class_separator",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_CSS_PSEUDO_CLASS_SEPARATOR', '__'),
                            metavar='SEPARATOR',
                            help=("Customize the separator glue will use in order "
@@ -163,7 +164,7 @@ def get_context(self, *args, **kwargs):
         if self.sprite.config['css_url']:
             context['sprite_path'] = '{0}{1}'.format(self.sprite.config['css_url'], context['sprite_filename'])
 
-            for r, ratio in context['ratios'].iteritems():
+            for r, ratio in iteritems(context['ratios']):
                 ratio['sprite_path'] = '{0}{1}'.format(self.sprite.config['css_url'], ratio['sprite_filename'])
 
         # Add cachebuster if required
@@ -174,7 +175,7 @@ def apply_cachebuster(path):
 
             context['sprite_path'] = apply_cachebuster(context['sprite_path'])
 
-            for r, ratio in context['ratios'].iteritems():
+            for r, ratio in iteritems(context['ratios']):
                 ratio['sprite_path'] = apply_cachebuster(ratio['sprite_path'])
 
         return context

glue/formats/img.py

@@ -4,6 +4,7 @@
 from PIL import PngImagePlugin
 
 from glue import __version__
+from glue.compat import text_type
 from glue.helpers import round_up, cached_property
 from .base import BaseFormat
 
@@ -19,7 +20,7 @@ def populate_argument_parser(cls, parser):
 
         group.add_argument("--img",
                            dest="img_dir",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_IMG', True),
                            metavar='DIR',
                            help="Output directory for img files")
@@ -38,13 +39,13 @@ def populate_argument_parser(cls, parser):
 
         group.add_argument("-p", "--padding",
                            dest="padding",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_PADDING', '0'),
                            help="Force this padding in all images")
 
         group.add_argument("--margin",
                            dest="margin",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_MARGIN', '0'),
                            help="Force this margin in all images")
 
@@ -57,7 +58,7 @@ def populate_argument_parser(cls, parser):
 
         group.add_argument("--ratios",
                            dest="ratios",
-                           type=unicode,
+                           type=text_type,
                            default=os.environ.get('GLUE_RATIOS', '1'),
                            help="Create sprites based on these ratios")