1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
3 # This file is part of Hooke.
5 # Hooke is free software: you can redistribute it and/or modify it
6 # under the terms of the GNU Lesser General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
10 # Hooke is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
13 # Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with Hooke. If not, see
17 # <http://www.gnu.org/licenses/>.
19 """The `playlist` module provides a :class:`Playlist` and its subclass
20 :class:`FilePlaylist` for manipulating lists of
21 :class:`hooke.curve.Curve`\s.
31 from yaml.representer import RepresenterError
33 from .command_stack import CommandStack
34 from .curve import Curve
35 from .util.itertools import reverse_enumerate
38 class NoteIndexList (list):
39 """A list that keeps track of a "current" item and additional notes.
41 :attr:`index` (i.e. "bookmark") is the index of the currently
42 current curve. Also keep a :class:`dict` of additional information
45 def __init__(self, name=None):
46 super(NoteIndexList, self).__init__()
47 self._set_default_attrs()
48 self.__setstate__({'name': name})
51 return str(self.__unicode__())
53 def __unicode__(self):
54 return u'<%s %s>' % (self.__class__.__name__, self.name)
59 def _set_default_attrs(self):
60 self._default_attrs = {
66 def __getstate__(self):
67 return self.__dict__.copy()
69 def __setstate__(self, state):
70 self._set_default_attrs()
73 self.__dict__.update(self._default_attrs)
75 self.__dict__.update(state)
77 print state, type(state), e
78 if self.info in [None, {}]:
81 def _setup_item(self, item):
82 """Perform any required initialization before returning an item.
86 def index(self, value=None, *args, **kwargs):
87 """Extend `list.index`, returning the current index if `value`
92 return super(NoteIndexList, self).index(value, *args, **kwargs)
97 item = self[self._index]
98 self._setup_item(item)
101 def jump(self, index):
105 self._index = index % len(self)
108 self.jump(self._index + 1)
111 self.jump(self._index - 1)
113 def items(self, reverse=False):
114 """Iterate through `self` calling `_setup_item` on each item
119 Updates :attr:`_index` during the iteration so
120 :func:`~hooke.plugin.curve.current_curve_callback` works as
121 expected in :class:`~hooke.command.Command`\s called from
122 :class:`~hooke.plugin.playlist.ApplyCommand`. After the
123 iteration completes, :attr:`_index` is restored to its
129 items = reverse_enumerate(self)
131 items = enumerate(self)
134 self._setup_item(item)
138 def filter(self, keeper_fn=lambda item:True, load_curves=True,
140 c = copy.deepcopy(self)
141 if load_curves == True:
142 items = c.items(reverse=True)
146 if keeper_fn(item, *args, **kwargs) != True:
148 try: # attempt to maintain the same current item
149 c._index = c.index(self.current())
155 class Playlist (NoteIndexList):
156 """A :class:`NoteIndexList` of :class:`hooke.Curve`\s.
158 Keeps a list of :attr:`drivers` for loading curves.
160 def __init__(self, drivers, name=None):
161 super(Playlist, self).__init__(name=name)
162 self.drivers = drivers
163 self._max_loaded = 100 # curves to hold in memory simultaneously.
165 def _set_default_attrs(self):
166 super(Playlist, self)._set_default_attrs()
167 self._default_attrs['drivers'] = []
168 # List of loaded curves, see :meth:`._setup_item`.
169 self._default_attrs['_loaded'] = []
170 self._default_attrs['_max_loaded'] = 100
172 def __setstate__(self, state):
173 super(Playlist, self).__setstate__(state)
174 if self.drivers in [None, {}]:
176 if self._loaded in [None, {}]:
179 def append_curve(self, curve):
182 def append_curve_by_path(self, path, info=None, identify=True, hooke=None):
183 path = os.path.normpath(path)
184 c = Curve(path, info=info)
187 c.identify(self.drivers)
191 def _setup_item(self, curve):
192 if curve != None and curve not in self._loaded:
193 if curve not in self:
195 if curve.driver == None:
196 c.identify(self.drivers)
197 if curve.data == None:
199 self._loaded.append(curve)
200 if len(self._loaded) > self._max_loaded:
201 oldest = self._loaded.pop(0)
205 class FilePlaylist (Playlist):
206 """A file-backed :class:`Playlist`.
211 >>> p = FilePlaylist(drivers=['Driver A', 'Driver B'])
212 >>> p.append(Curve('dummy/path/A'))
213 >>> p.append(Curve('dummy/path/B'))
215 The data-type is pickleable, to ensure we can move it between
216 processes with :class:`multiprocessing.Queue`\s.
219 >>> s = pickle.dumps(p)
220 >>> z = pickle.loads(s)
226 ['Driver A', 'Driver B']
228 The data-type is also YAMLable (see :mod:`hooke.util.yaml`).
237 ['Driver A', 'Driver B']
241 def __init__(self, drivers, name=None, path=None):
242 super(FilePlaylist, self).__init__(drivers, name)
243 self.path = self._base_path = None
245 self.relative_curve_paths = True
246 self._relative_curve_paths = False
248 def _set_default_attrs(self):
249 super(FilePlaylist, self)._set_default_attrs()
250 self._default_attrs['relative_curve_paths'] = True
251 self._default_attrs['_relative_curve_paths'] = False
252 self._default_attrs['_digest'] = None
254 def __getstate__(self):
255 state = super(FilePlaylist, self).__getstate__()
256 assert 'version' not in state, state
257 state['version'] = self.version
260 def __setstate__(self, state):
261 if 'version' in state:
262 version = state.pop('version')
263 assert version == FilePlaylist.version, (
264 'invalid version %s (%s) != %s (%s)'
265 % (version, type(version),
266 FilePlaylist.version, type(FilePlaylist.version)))
267 super(FilePlaylist, self).__setstate__(state)
269 def set_path(self, path):
270 orig_base_path = getattr(self, '_base_path', None)
272 if self._base_path == None:
273 self._base_path = os.getcwd()
275 if not path.endswith('.hkp'):
278 self._base_path = os.path.dirname(os.path.abspath(
279 os.path.expanduser(self.path)))
280 if self.name == None:
281 self.name = os.path.basename(path)
282 if self._base_path != orig_base_path:
283 self.update_curve_paths()
285 def update_curve_paths(self):
287 curve.set_path(self._curve_path(curve.path))
289 def _curve_path(self, path):
290 if self._base_path == None:
291 self._base_path = os.getcwd()
292 path = os.path.join(self._base_path, path)
293 if self._relative_curve_paths == True:
294 path = os.path.relpath(path, self._base_path)
297 def append_curve(self, curve):
298 curve.set_path(self._curve_path(curve.path))
299 super(FilePlaylist, self).append_curve(curve)
301 def append_curve_by_path(self, path, *args, **kwargs):
302 path = self._curve_path(path)
303 super(FilePlaylist, self).append_curve_by_path(path, *args, **kwargs)
306 return self.digest() == self._digest
309 r"""Compute the sha1 digest of the flattened playlist
315 >>> root_path = os.path.sep + 'path'
316 >>> p = FilePlaylist(drivers=[],
317 ... path=os.path.join(root_path, 'to','playlist'))
318 >>> p.info['note'] = 'An example playlist'
319 >>> c = Curve(os.path.join(root_path, 'to', 'curve', 'one'))
320 >>> c.info['note'] = 'The first curve'
321 >>> p.append_curve(c)
322 >>> c = Curve(os.path.join(root_path, 'to', 'curve', 'two'))
323 >>> c.info['note'] = 'The second curve'
324 >>> p.append_curve(c)
326 'f\xe26i\xb98i\x1f\xb61J7:\xf2\x8e\x1d\xde\xc3}g'
328 string = self.flatten()
329 return hashlib.sha1(string).digest()
332 """Create a string representation of the playlist.
334 A playlist is a YAML document with the following minimal syntax::
336 !!python/object/new:hooke.playlist.FilePlaylist
340 - !!python/object:hooke.curve.Curve
341 path: /path/to/curve/one
342 - !!python/object:hooke.curve.Curve
343 path: /path/to/curve/two
345 Relative paths are interpreted relative to the location of the
351 >>> from .engine import CommandMessage
353 >>> root_path = os.path.sep + 'path'
354 >>> p = FilePlaylist(drivers=[],
355 ... path=os.path.join(root_path, 'to','playlist'))
356 >>> p.info['note'] = 'An example playlist'
357 >>> c = Curve(os.path.join(root_path, 'to', 'curve', 'one'))
358 >>> c.info['note'] = 'The first curve'
359 >>> p.append_curve(c)
360 >>> c = Curve(os.path.join(root_path, 'to', 'curve', 'two'))
361 >>> c.info['attr with spaces'] = 'The second curve\\nwith endlines'
362 >>> c.command_stack.extend([
363 ... CommandMessage('command A', {'arg 0':0, 'arg 1':'X'}),
364 ... CommandMessage('command B', {'arg 0':1, 'curve':c}),
366 >>> p.append_curve(c)
367 >>> print p.flatten() # doctest: +REPORT_UDIFF
368 # Hooke playlist version 0.2
369 !!python/object/new:hooke.playlist.FilePlaylist
371 - !!python/object:hooke.curve.Curve
372 info: {note: The first curve}
375 - &id001 !!python/object:hooke.curve.Curve
376 command_stack: !!python/object/new:hooke.command_stack.CommandStack
378 - !!python/object:hooke.engine.CommandMessage
379 arguments: {arg 0: 0, arg 1: X}
381 - !!python/object:hooke.engine.CommandMessage
386 info: {attr with spaces: 'The second curve
393 info: {note: An example playlist}
395 path: /path/to/playlist.hkp
398 >>> p.relative_curve_paths = False
399 >>> print p.flatten() # doctest: +REPORT_UDIFF
400 # Hooke playlist version 0.2
401 !!python/object/new:hooke.playlist.FilePlaylist
403 - !!python/object:hooke.curve.Curve
404 info: {note: The first curve}
406 path: /path/to/curve/one
407 - &id001 !!python/object:hooke.curve.Curve
408 command_stack: !!python/object/new:hooke.command_stack.CommandStack
410 - !!python/object:hooke.engine.CommandMessage
411 arguments: {arg 0: 0, arg 1: X}
413 - !!python/object:hooke.engine.CommandMessage
418 info: {attr with spaces: 'The second curve
422 path: /path/to/curve/two
425 info: {note: An example playlist}
427 path: /path/to/playlist.hkp
428 relative_curve_paths: false
432 rcp = self._relative_curve_paths
433 self._relative_curve_paths = self.relative_curve_paths
434 self.update_curve_paths()
435 self._relative_curve_paths = rcp
437 yaml_string = yaml.dump(self, allow_unicode=True)
438 self.update_curve_paths()
439 return ('# Hooke playlist version %s\n' % self.version) + yaml_string
441 def save(self, path=None, makedirs=True):
442 """Saves the playlist to a YAML file.
445 dirname = os.path.dirname(self.path) or '.'
446 if makedirs == True and not os.path.isdir(dirname):
448 with open(self.path, 'w') as f:
449 f.write(self.flatten())
450 self._digest = self.digest()
453 def from_string(string):
454 u"""Load a playlist from a string.
461 >>> string = '''# Hooke playlist version 0.2
462 ... !!python/object/new:hooke.playlist.FilePlaylist
466 ... - !!python/object:hooke.curve.Curve
468 ... - !!python/object:hooke.curve.Curve
471 >>> p = from_string(string)
472 >>> p.set_path('/path/to/playlist')
474 ... print curve.name, curve.path
475 one /path/to/curve/one
476 two /path/to/curve/two
478 More complicated example.
480 >>> string = '''# Hooke playlist version 0.2
481 ... !!python/object/new:hooke.playlist.FilePlaylist
483 ... - !!python/object:hooke.curve.Curve
484 ... info: {note: The first curve}
486 ... path: /path/to/curve/one
487 ... - &id001 !!python/object:hooke.curve.Curve
488 ... command_stack: !!python/object/new:hooke.command_stack.CommandStack
490 ... - !!python/object:hooke.engine.CommandMessage
491 ... arguments: {arg 0: 0, arg 1: X}
492 ... command: command A
493 ... - !!python/object:hooke.engine.CommandMessage
497 ... command: command B
498 ... info: {attr with spaces: 'The second curve
502 ... path: /path/to/curve/two
504 ... _base_path: /path/to
506 ... info: {note: An example playlist}
507 ... name: playlist.hkp
508 ... path: /path/to/playlist.hkp
511 >>> p = from_string(string)
512 >>> p.set_path('/path/to/playlist')
516 {'note': 'An example playlist'}
518 ... print curve.name, curve.path
519 one /path/to/curve/one
520 two /path/to/curve/two
521 >>> p[-1].info['attr with spaces']
522 'The second curve\\nwith endlines'
523 >>> type(p[-1].command_stack)
524 <class 'hooke.command_stack.CommandStack'>
525 >>> p[0].command_stack
527 >>> type(p[0].command_stack)
528 <class 'hooke.command_stack.CommandStack'>
529 >>> p[-1].command_stack # doctest: +NORMALIZE_WHITESPACE
530 [<CommandMessage command A {arg 0: 0, arg 1: X}>,
531 <CommandMessage command B {arg 0: 1, curve: <Curve two>}>]
532 >>> type(p[1].command_stack)
533 <class 'hooke.command_stack.CommandStack'>
535 >>> c2.command_stack[-1].arguments['curve'] == c2
538 return yaml.load(string)
540 def load(path=None, identify=True, hooke=None):
541 """Load a playlist from a file.
543 with open(self.path, 'r') as f:
545 playlist = from_string(text)
546 playlist._digest = playlist.digest()
547 for curve in playlist:
548 curve.set_hooke(hooke)
550 curve.identify(playlist.drivers)
554 class Playlists (NoteIndexList):
555 """A :class:`NoteIndexList` of :class:`FilePlaylist`\s.