Mercurial > boomslang

annotate pyntnclick/resources.py @ 593:1eb1537173ef pyntnclick

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some image transforms.
author Jeremy Thurgood <firxen@gmail.com>
date Sat, 11 Feb 2012 17:41:35 +0200
parents 4117d7b201a4
children 38f75cef86d0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
561
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
1 # -*- test-case-name: pyntnclick.tests.test_resources -*-
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
2
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
3 import os
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
4 from pkg_resources import resource_filename
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
5
571
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
6 import pygame
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
7
561
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
8
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
9 class ResourceNotFound(Exception):
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
10 pass
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
11
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
12
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
13 class Resources(object):
584
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
14 """Resource loader and manager.
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
15
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
16 The `CONVERT_ALPHA` flag allows alpha conversions to be disabled so that
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
17 images may be loaded without having a display initialised. This is useful
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
18 in unit tests, for example.
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
19 """
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
20
561
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
21 DEFAULT_RESOURCE_MODULE = "pyntnclick.data"
571
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
22 CONVERT_ALPHA = True
561
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
23
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
24 def __init__(self, resource_module, language=None):
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
25 self.resource_module = resource_module
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
26 self.language = language
571
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
27 self._image_cache = {}
591
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
28 self._transformed_image_cache = {}
561
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
29
571
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
30 def get_resource_path(self, *resource_path_fragments):
584
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
31 """Find the resource in one of a number of different places.
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
32
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
33 The following directories are searched, in order:
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
34
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
35 * <resource_module>/<lang>/
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
36 * <resource_module>/
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
37 * <default_resource_module>/<lang>/
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
38 * <default_resource_module>/
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
39
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
40 If the `language` attribute is `None`, the paths with <lang> in them
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
41 are skipped.
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
42 """
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
43 resource_name = '/'.join(resource_path_fragments)
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
44 resource_name = os.path.join(*resource_name.split('/'))
561
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
45 for path in self.get_paths(resource_name):
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
46 if os.path.exists(path):
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
47 return path
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
48 raise ResourceNotFound(resource_name)
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
49
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
50 def get_paths(self, resource_path):
587
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
51 """Get list of resource paths to search.
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
52 """
561
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
53 paths = []
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
54 for module in [self.resource_module, self.DEFAULT_RESOURCE_MODULE]:
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
55 if self.language:
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
56 fn = os.path.join(self.language, resource_path)
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
57 paths.append(resource_filename(module, fn))
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
58 paths.append(resource_filename(module, resource_path))
e207dfad0d9e Start of resource manager.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
59 return paths
571
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
60
591
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
61 def get_image(self, image_name_fragments, transforms=(), basedir='images'):
587
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
62 """Load an image and optionally apply mutators.
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
63
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
64 The `image_name_fragments` parameter may be either a string or a list
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
65 of strings. The latter is a convenience for things that compose an
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
66 image name out of several fragments.
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
67
591
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
68 The `transforms` param may contain transforms, which modify an image
593
1eb1537173ef Add some image transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 591
diff changeset
69 in-place to apply various effects.
587
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
70
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
71 The `basedir` param defaults to 'images', but may be overriden to load
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
72 images from other places. ('icons', for example.)
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
73 """
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
74
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
75 # Juggle our various params and find an appropriate image path.
584
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
76 if isinstance(image_name_fragments, basestring):
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
77 image_name_fragments = [image_name_fragments]
96ff2d8a8a9a Allow list of image name fragments in load_image. Also, some docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 580
diff changeset
78 image_path = self.get_resource_path(basedir, *image_name_fragments)
575
970cdc219e15 Add image mutation to resource loader.
Jeremy Thurgood <firxen@gmail.com>
parents: 571
diff changeset
79
591
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
80 key = (image_path, transforms)
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
81 if key in self._transformed_image_cache:
587
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
82 # We already have this cached, so shortcut the whole process.
591
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
83 return self._transformed_image_cache[key]
587
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
84
571
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
85 if image_path not in self._image_cache:
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
86 image = pygame.image.load(image_path)
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
87 if self.CONVERT_ALPHA:
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
88 image = image.convert_alpha(pygame.display.get_surface())
20e296d4a3a5 Add load_image to Resources.
Jeremy Thurgood <firxen@gmail.com>
parents: 561
diff changeset
89 self._image_cache[image_path] = image
575
970cdc219e15 Add image mutation to resource loader.
Jeremy Thurgood <firxen@gmail.com>
parents: 571
diff changeset
90 image = self._image_cache[image_path]
970cdc219e15 Add image mutation to resource loader.
Jeremy Thurgood <firxen@gmail.com>
parents: 571
diff changeset
91
593
1eb1537173ef Add some image transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 591
diff changeset
92 # Apply any transforms we're given.
591
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
93 for transform in transforms:
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
94 image = transform(image)
4117d7b201a4 mutators -> transforms.
Jeremy Thurgood <firxen@gmail.com>
parents: 587
diff changeset
95 self._transformed_image_cache[key] = image
575
970cdc219e15 Add image mutation to resource loader.
Jeremy Thurgood <firxen@gmail.com>
parents: 571
diff changeset
96
587
f20d211d2c91 load_image() -> get_image() and more docs.
Jeremy Thurgood <firxen@gmail.com>
parents: 584
diff changeset
97 return image