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
|
#------------------------------------------------------------------------------
# Copyright (c) 2005-2009, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
#------------------------------------------------------------------------------
""" The default resource manager.
A resource manager locates and loads application resources such as images and
sounds etc.
"""
# Standard library imports.
import collections, glob, inspect, os, sys, types
from os.path import join
from zipfile import is_zipfile, ZipFile
# Enthought library imports.
from traits.api import HasTraits, Instance, List
from traits.util.resource import get_path
# Local imports.
from pyface.resource.resource_factory import ResourceFactory
from pyface.resource.resource_reference import ImageReference
import six
class ResourceManager(HasTraits):
""" The default resource manager.
A resource manager locates and loads application resources such as images
and sounds etc.
"""
# Allowed extensions for image resources.
IMAGE_EXTENSIONS = ['.png', '.jpg', '.bmp', '.gif', '.ico']
# A list of additional search paths. These paths are fallbacks, and hence
# have lower priority than the paths provided by resource objects.
extra_paths = List
# The resource factory is responsible for actually creating resources.
# This is used so that (for example) different GUI toolkits can create
# a images in the format that they require.
resource_factory = Instance(ResourceFactory)
###########################################################################
# 'ResourceManager' interface.
###########################################################################
def locate_image(self, image_name, path, size=None):
""" Locates an image. """
if not isinstance(path, collections.Sequence):
path = [path]
resource_path = []
for item in list(path) + self.extra_paths:
if isinstance(item, six.string_types):
resource_path.append(item)
elif isinstance(item, types.ModuleType):
resource_path.append(item)
else:
resource_path.extend(self._get_resource_path(item))
return self._locate_image(image_name, resource_path, size)
def load_image(self, image_name, path, size=None):
""" Loads an image. """
reference = self.locate_image(image_name, path, size)
if reference is not None:
image = reference.load()
else:
image = None
return image
###########################################################################
# Private interface.
###########################################################################
def _locate_image(self, image_name, resource_path, size):
""" Attempts to locate an image resource.
If the image is found, an image resource reference is returned.
If the image is NOT found None is returned.
"""
# If the image name contains a file extension (eg. '.jpg') then we will
# only accept an an EXACT filename match.
basename, extension = os.path.splitext(image_name)
if len(extension) > 0:
extensions = [extension]
pattern = image_name
# Otherwise, we will search for common image suffixes.
else:
extensions = self.IMAGE_EXTENSIONS
pattern = image_name + '.*'
# Try the 'images' sub-directory first (since that is commonly
# where we put them!). If the image is not found there then look
# in the directory itself.
if size is None:
subdirs = ['images', '']
else:
subdirs = ['images/%dx%d' % (size[0], size[1]), 'images', '']
for dirname in resource_path:
# If we come across a reference to a module, use pkg_resources
# to try and find the image inside of an .egg, .zip, etc.
if isinstance(dirname, types.ModuleType):
from pkg_resources import resource_string
for path in subdirs:
for extension in extensions:
searchpath = '%s/%s%s' % (path, basename, extension)
try:
data = resource_string(dirname.__name__, searchpath)
return ImageReference(self.resource_factory,
data = data)
except IOError:
pass
else:
continue
# Is there anything resembling the image name in the directory?
for path in subdirs:
filenames = glob.glob(join(dirname, path, pattern))
for filename in filenames:
not_used, extension = os.path.splitext(filename)
if extension in extensions:
reference = ImageReference(
self.resource_factory, filename=filename
)
return reference
# Is there an 'images' zip file in the directory?
zip_filename = join(dirname, 'images.zip')
if os.path.isfile(zip_filename):
zip_file = ZipFile(zip_filename, 'r')
# Try the image name itself, and then the image name with
# common images suffixes.
for extension in extensions:
try:
image_data = zip_file.read(basename + extension)
reference = ImageReference(
self.resource_factory, data=image_data
)
return reference
except:
pass
# is this a path within a zip file?
# first, find the zip file in the path
filepath = dirname
zippath = ''
while not is_zipfile(filepath) and \
os.path.splitdrive(filepath)[1].startswith('\\') and \
os.path.splitdrive(filepath)[1].startswith('/'):
filepath, tail = os.path.split(filepath)
if zippath != '':
zippath = tail + '/' + zippath
else:
zippath = tail
# if we found a zipfile, then look inside it for the image!
if is_zipfile(filepath):
zip_file = ZipFile(filepath)
for subpath in ['images', '']:
for extension in extensions:
try:
# this is a little messy. since zip files don't
# recognize a leading slash, we have to be very
# particular about how we build this path when
# there are empty strings
if zippath != '':
path = zippath + '/'
else:
path = ''
if subpath != '':
path = path + subpath + '/'
path = path + basename + extension
# now that we have the path we can attempt to load
# the image
image_data = zip_file.read(path)
reference = ImageReference(
self.resource_factory, data=image_data
)
# if there was no exception then return the result
return reference
except:
pass
return None
def _get_resource_path(self, object):
""" Returns the resource path for an object. """
if hasattr(object, 'resource_path'):
resource_path = object.resource_path
else:
resource_path = self._get_default_resource_path(object)
return resource_path
def _get_default_resource_path(self, object):
""" Returns the default resource path for an object. """
resource_path = []
for klass in inspect.getmro(object.__class__):
try:
resource_path.append(get_path(klass))
# We get an attribute error when we get to a C extension type (in
# our case it will most likley be 'CHasTraits'. We simply ignore
# everything after this point!
except AttributeError:
break
return resource_path
#### EOF ######################################################################
|
