view pyntnclick/resources.py @ 586:cf65e91b30b1 pyntnclick

Use load_image where possible
author Stefano Rivera <stefano@rivera.za.net>
date Sat, 11 Feb 2012 16:56:01 +0200
parents 96ff2d8a8a9a
children f20d211d2c91
line wrap: on
line source

# -*- 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.language = language
        self._image_cache = {}
        self._mutated_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:

         * <resource_module>/<lang>/
         * <resource_module>/
         * <default_resource_module>/<lang>/
         * <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):
        paths = []
        for module in [self.resource_module, self.DEFAULT_RESOURCE_MODULE]:
            if self.language:
                fn = os.path.join(self.language, resource_path)
                paths.append(resource_filename(module, fn))
            paths.append(resource_filename(module, resource_path))
        return paths

    def load_image(self, image_name_fragments, mutators=(), basedir='images'):
        if isinstance(image_name_fragments, basestring):
            image_name_fragments = [image_name_fragments]
        image_path = self.get_resource_path(basedir, *image_name_fragments)

        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]
        key = (image_path, mutators)

        if key not in self._mutated_image_cache:
            for mutator in mutators:
                image = mutator(image)
            self._mutated_image_cache[key] = image

        return self._mutated_image_cache[key]