diff pyntnclick/resources.py @ 852:f95830b58336

Merge pyntnclick
author Stefano Rivera <stefano@rivera.za.net>
date Sat, 21 Jun 2014 22:04:35 +0200
parents 032c8c5563b8
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/pyntnclick/resources.py	Sat Jun 21 22:04:35 2014 +0200
@@ -0,0 +1,117 @@
+# -*- test-case-name: pyntnclick.tests.test_resources -*-
+
+import os
+from pkg_resources import resource_filename
+
+import pygame
+
+
+class ResourceNotFound(Exception):
+    pass
+
+
+class Resources(object):
+    """Resource loader and manager.
+
+    The `CONVERT_ALPHA` flag allows alpha conversions to be disabled so that
+    images may be loaded without having a display initialised. This is useful
+    in unit tests, for example.
+    """
+
+    DEFAULT_RESOURCE_MODULE = "pyntnclick.data"
+    CONVERT_ALPHA = True
+
+    def __init__(self, resource_module, language=None):
+        self.resource_module = resource_module
+        self.lang_dialect = language
+        self.language = language
+        if language:
+            self.language = language.split('_', 1)[0]
+        self._image_cache = {}
+        self._font_cache = {}
+        self._transformed_image_cache = {}
+
+    def get_resource_path(self, *resource_path_fragments):
+        """Find the resource in one of a number of different places.
+
+        The following directories are searched, in order:
+
+         * /<lang>_<dialect>/<resource_module>/
+         * /<lang>/<resource_module>/
+         * <resource_module>/
+         * /<lang>_<dialect>/<default_resource_module>/
+         * /<lang>/<default_resource_module>/
+         * <default_resource_module>/
+
+        If the `language` attribute is `None`, the paths with <lang> in them
+        are skipped.
+        """
+        resource_name = '/'.join(resource_path_fragments)
+        resource_name = os.path.join(*resource_name.split('/'))
+        for path in self.get_paths(resource_name):
+            if os.path.exists(path):
+                return path
+        raise ResourceNotFound(resource_name)
+
+    def get_paths(self, resource_path):
+        """Get list of resource paths to search.
+        """
+        paths = []
+        for module in [self.resource_module, self.DEFAULT_RESOURCE_MODULE]:
+            if self.lang_dialect:
+                fn = os.path.join(self.lang_dialect, resource_path)
+                paths.append(resource_filename(module, fn))
+            if self.language != self.lang_dialect:
+                fn = os.path.join(self.language, resource_path)
+                paths.append(resource_filename(module, fn))
+            paths.append(resource_filename(module, resource_path))
+        return paths
+
+    def get_image(self, *image_name_fragments, **kw):
+        """Load an image and optionally apply mutators.
+
+        All positional params end up in `image_name_fragments` and are joined
+        with the path separator.
+
+        Two keyword parameters are also accepted:
+
+         * `transforms` may contain transforms, which modify an image in-place
+           to apply various effects.
+
+         * `basedir` defaults to 'images', but may be overridden to load images
+           from other places. ('icons', for example.)
+        """
+
+        transforms = kw.get('transforms', ())
+        basedir = kw.get('basedir', 'images')
+
+        image_path = self.get_resource_path(basedir, *image_name_fragments)
+
+        key = (image_path, transforms)
+        if key in self._transformed_image_cache:
+            # We already have this cached, so shortcut the whole process.
+            return self._transformed_image_cache[key]
+
+        if image_path not in self._image_cache:
+            image = pygame.image.load(image_path)
+            if self.CONVERT_ALPHA:
+                image = image.convert_alpha(pygame.display.get_surface())
+            self._image_cache[image_path] = image
+        image = self._image_cache[image_path]
+
+        # Apply any transforms we're given.
+        for transform in transforms:
+            image = transform(image)
+        self._transformed_image_cache[key] = image
+
+        return image
+
+    def get_font(self, file_name, font_size, basedir=None):
+        """Load a a font, cached if possible."""
+        if basedir is None:
+            basedir = 'fonts'
+        key = (basedir, file_name, font_size)
+        if key not in self._font_cache:
+            fontfn = self.get_resource_path(basedir, file_name)
+            self._font_cache[key] = pygame.font.Font(fontfn, font_size)
+        return self._font_cache[key]