/usr/share/pyshared/pymt/loader.py is in python-pymt 0.5.1-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 | '''
Loader: asynchronous loader, easily extensible.
This is the Asynchronous Loader. You can use it to load an image
and use it, even if data are not yet available. You must specify a default
loading image for using a such loader ::
from pymt import *
image = Loader.image('mysprite.png')
You can also load image from url ::
image = Loader.image('http://mysite.com/test.png')
If you want to change the default loading image, you can do ::
Loader.loading_image = Image('another_loading.png')
'''
__all__ = ('Loader', 'LoaderBase', 'ProxyImage')
from pymt import pymt_data_dir
from pymt.logger import pymt_logger
from pymt.clock import getClock
from pymt.cache import Cache
from pymt.utils import SafeList
from pymt.core.image import ImageLoader, Image
from pymt.event import EventDispatcher
from abc import ABCMeta, abstractmethod
import time
import collections
import os
# Register a cache for loader
Cache.register('pymt.loader', limit=500, timeout=60)
class ProxyImage(Image, EventDispatcher):
'''Image returned by the Loader.image() function.
:Properties:
`loaded`: bool, default to False
It can be True if the image is already cached
:Events:
`on_load`
Fired when the image is loaded and changed
'''
def __init__(self, arg, **kwargs):
kwargs.setdefault('loaded', False)
super(ProxyImage, self).__init__(arg, **kwargs)
self.loaded = kwargs.get('loaded')
self.register_event_type('on_load')
def on_load(self):
pass
class LoaderBase(object):
'''Common base for Loader and specific implementation.
By default, Loader will be the best available loader implementation.
The _update() function is called every 1 / 25.s or each frame if we have
less than 25 FPS.
'''
__metaclass__ = ABCMeta
def __init__(self):
self._loading_image = None
self._error_image = None
self._q_load = collections.deque()
self._q_done = collections.deque()
self._client = SafeList()
self._running = False
self._start_wanted = False
getClock().schedule_interval(self._update, 1 / 25.)
def __del__(self):
try:
getClock().unschedule(self._update)
except Exception:
pass
@property
def loading_image(self):
'''Image used for loading (readonly)'''
if not self._loading_image:
loading_png_fn = os.path.join(pymt_data_dir, 'loader.png')
self._loading_image = ImageLoader.load(filename=loading_png_fn)
return self._loading_image
@property
def error_image(self):
'''Image used for error (readonly)'''
if not self._error_image:
error_png_fn = os.path.join(pymt_data_dir, 'error.png')
self._error_image = ImageLoader.load(filename=error_png_fn)
return self._error_image
@abstractmethod
def start(self):
'''Start the loader thread/process'''
self._running = True
@abstractmethod
def run(self, *largs):
'''Main loop for the loader.'''
pass
@abstractmethod
def stop(self):
'''Stop the loader thread/process'''
self._running = False
def _load(self, parameters):
'''(internal) Loading function, called by the thread.
Will call _load_local() if the file is local,
or _load_urllib() if the file is on Internet'''
filename, load_callback, post_callback = parameters
proto = filename.split(':', 1)[0]
if load_callback is not None:
data = load_callback(filename)
elif proto in ('http', 'https', 'ftp'):
data = self._load_urllib(filename)
else:
data = self._load_local(filename)
if post_callback:
data = post_callback(data)
self._q_done.append((filename, data))
def _load_local(self, filename):
'''(internal) Loading a local file'''
return ImageLoader.load(filename)
def _load_urllib(self, filename):
'''(internal) Loading a network file. First download it, save it to a
temporary file, and pass it to _load_local()'''
import urllib2, tempfile
data = None
try:
suffix = '.%s' % (filename.split('.')[-1])
_out_osfd, _out_filename = tempfile.mkstemp(
prefix='pymtloader', suffix=suffix)
# read from internet
fd = urllib2.urlopen(filename)
idata = fd.read()
fd.close()
# write to local filename
os.write(_out_osfd, idata)
os.close(_out_osfd)
# load data
data = self._load_local(_out_filename)
except Exception:
pymt_logger.exception('Failed to load image <%s>' % filename)
return self.error_image
finally:
os.unlink(_out_filename)
return data
def _update(self, *largs):
'''(internal) Check if a data is loaded, and pass to the client'''
# want to start it ?
if self._start_wanted:
if not self._running:
self.start()
self._start_wanted = False
while True:
try:
filename, data = self._q_done.pop()
except IndexError:
return
# create the image
image = data#ProxyImage(data)
Cache.append('pymt.loader', filename, image)
# update client
for c_filename, client in self._client[:]:
if filename != c_filename:
continue
# got one client to update
client.image = image
client.loaded = True
client.dispatch_event('on_load')
self._client.remove((c_filename, client))
def image(self, filename, load_callback=None, post_callback=None):
'''Load a image using loader. A Proxy image is returned
with a loading image ::
img = Loader.image(filename)
# img will be a ProxyImage.
# You'll use it the same as an Image class.
# Later, when the image is really loaded,
# the loader will change the img.image property
# to the new loaded image
'''
data = Cache.get('pymt.loader', filename)
if data not in (None, False):
# found image
return ProxyImage(data,
loading_image=self.loading_image,
loaded=True)
client = ProxyImage(self.loading_image,
loading_image=self.loading_image)
self._client.append((filename, client))
if data is None:
# if data is None, this is really the first time
self._q_load.append((filename, load_callback, post_callback))
Cache.append('pymt.loader', filename, False)
self._start_wanted = True
else:
# already queued for loading
pass
return client
#
# Loader implementation
#
if 'PYMT_DOC' in os.environ:
Loader = None
else:
#
# Try to use pygame as our first choice for loader
#
try:
import pygame
class LoaderPygame(LoaderBase):
def __init__(self):
super(LoaderPygame, self).__init__()
self.worker = None
def start(self):
super(LoaderPygame, self).start()
self.worker = pygame.threads.WorkerQueue()
self.worker.do(self.run)
def stop(self):
super(LoaderPygame, self).stop()
self.worker.stop()
def run(self, *largs):
while self._running:
try:
parameters = self._q_load.pop()
except:
time.sleep(0.1)
continue
self.worker.do(self._load, parameters)
Loader = LoaderPygame()
pymt_logger.info('Loader: using <pygame> as thread loader')
except:
#
# Default to the clock loader
#
class LoaderClock(LoaderBase):
'''Loader implementation using a simple Clock()'''
def start(self):
super(LoaderClock, self).start()
getClock().schedule_interval(self.run, 0.0001)
def stop(self):
super(LoaderClock, self).stop()
getClock().unschedule(self.run)
def run(self, *largs):
try:
parameters = self._q_load.pop()
except IndexError:
return
self._load(parameters)
Loader = LoaderClock()
pymt_logger.info('Loader: using <clock> as thread loader')
|