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 . import curve as curve
34 from .util.itertools import reverse_enumerate
37 class NoteIndexList (list):
38 """A list that keeps track of a "current" item and additional notes.
40 :attr:`index` (i.e. "bookmark") is the index of the currently
41 current curve. Also keep a :class:`dict` of additional information
44 def __init__(self, name=None):
45 super(NoteIndexList, self).__init__()
49 self._set_ignored_attrs()
52 return str(self.__unicode__())
54 def __unicode__(self):
55 return u'<%s %s>' % (self.__class__.__name__, self.name)
60 def _set_ignored_attrs(self):
61 self._ignored_attrs = ['_ignored_attrs', '_default_attrs']
62 self._default_attrs = {
66 def __getstate__(self):
67 state = dict(self.__dict__)
68 for key in self._ignored_attrs:
71 for key,value in self._default_attrs.items():
72 if key in state and state[key] == value:
74 assert 'items' not in state
76 self._assert_clean_state(self, state)
77 for item in self: # save curves and their attributes
78 item_state = self._item_getstate(item)
79 self._assert_clean_state(item, item_state)
80 state['items'].append(item_state)
83 def __setstate__(self, state):
84 self._set_ignored_attrs()
85 for key,value in self._default_attrs.items():
86 setattr(self, key, value)
87 for key,value in state.items():
90 setattr(self, key, value)
91 for item_state in state['items']:
92 self.append(self._item_setstate(item_state))
94 def _item_getstate(self, item):
97 def _item_setstate(self, state):
100 def _assert_clean_state(self, owner, state):
101 for k,v in state.items():
102 if k == 'drivers': # HACK. Need better driver serialization.
105 yaml.safe_dump((k,v))
106 except RepresenterError, e:
107 raise NotImplementedError(
108 'cannot convert %s.%s = %s (%s) to safe YAML'
109 % (owner.__class__.__name__, k, v, type(v)))
111 def _setup_item(self, item):
112 """Perform any required initialization before returning an item.
116 def index(self, value=None, *args, **kwargs):
117 """Extend `list.index`, returning the current index if `value`
122 return super(NoteIndexList, self).index(value, *args, **kwargs)
127 item = self[self._index]
128 self._setup_item(item)
131 def jump(self, index):
135 self._index = index % len(self)
138 self.jump(self._index + 1)
141 self.jump(self._index - 1)
143 def items(self, reverse=False):
144 """Iterate through `self` calling `_setup_item` on each item
149 Updates :attr:`_index` during the iteration so
150 :func:`~hooke.plugin.curve.current_curve_callback` works as
151 expected in :class:`~hooke.command.Command`\s called from
152 :class:`~hooke.plugin.playlist.ApplyCommand`. After the
153 iteration completes, :attr:`_index` is restored to its
159 items = reverse_enumerate(self)
161 items = enumerate(self)
164 self._setup_item(item)
168 def filter(self, keeper_fn=lambda item:True, load_curves=True,
170 c = copy.deepcopy(self)
171 if load_curves == True:
172 items = c.items(reverse=True)
176 if keeper_fn(item, *args, **kwargs) != True:
178 try: # attempt to maintain the same current item
179 c._index = c.index(self.current())
185 class Playlist (NoteIndexList):
186 """A :class:`NoteIndexList` of :class:`hooke.curve.Curve`\s.
188 Keeps a list of :attr:`drivers` for loading curves.
190 def __init__(self, drivers, name=None):
191 super(Playlist, self).__init__(name=name)
192 self.drivers = drivers
193 self._max_loaded = 100 # curves to hold in memory simultaneously.
195 def _set_ignored_attrs(self):
196 super(Playlist, self)._set_ignored_attrs()
197 self._ignored_attrs.extend([
198 '_item_ignored_attrs', '_item_default_attrs',
200 self._item_ignored_attrs = []
201 self._item_default_attrs = {
208 self._loaded = [] # List of loaded curves, see :meth:`._setup_item`.
210 def _item_getstate(self, item):
211 assert isinstance(item, curve.Curve), type(item)
212 state = item.__getstate__()
213 for key in self._item_ignored_attrs:
216 for key,value in self._item_default_attrs.items():
217 if key in state and state[key] == value:
221 def _item_setstate(self, state):
222 for key,value in self._item_default_attrs.items():
225 item = curve.Curve(path=None)
226 item.__setstate__(state)
229 def append_curve_by_path(self, path, info=None, identify=True, hooke=None):
230 path = os.path.normpath(path)
231 c = curve.Curve(path, info=info)
234 c.identify(self.drivers)
238 def _setup_item(self, curve):
239 if curve != None and curve not in self._loaded:
240 if curve not in self:
242 if curve.driver == None:
243 c.identify(self.drivers)
244 if curve.data == None:
246 self._loaded.append(curve)
247 if len(self._loaded) > self._max_loaded:
248 oldest = self._loaded.pop(0)
252 class FilePlaylist (Playlist):
253 """A file-backed :class:`Playlist`.
257 def __init__(self, drivers, name=None, path=None):
258 super(FilePlaylist, self).__init__(drivers, name)
259 self.path = self._base_path = None
261 self._relative_curve_paths = True
263 def _set_ignored_attrs(self):
264 super(FilePlaylist, self)._set_ignored_attrs()
265 self._ignored_attrs.append('_digest')
268 def __getstate__(self):
269 state = super(FilePlaylist, self).__getstate__()
270 assert 'version' not in state, state
271 state['version'] = self.version
274 def __setstate__(self, state):
275 assert('version') in state, state
276 version = state.pop('version')
277 assert version == FilePlaylist.version, (
278 'invalid version %s (%s) != %s (%s)'
279 % (version, type(version),
280 FilePlaylist.version, type(FilePlaylist.version)))
281 super(FilePlaylist, self).__setstate__(state)
283 def _item_getstate(self, item):
284 state = super(FilePlaylist, self)._item_getstate(item)
285 if state.get('path', None) != None:
286 path = os.path.abspath(os.path.expanduser(state['path']))
287 if self._relative_curve_paths == True:
288 path = os.path.relpath(path, self._base_path)
292 def _item_setstate(self, state):
293 item = super(FilePlaylist, self)._item_setstate(state)
295 item.set_path(os.path.join(self._base_path, state['path']))
298 def set_path(self, path):
300 if self._base_path == None:
301 self._base_path = os.getcwd()
303 if not path.endswith('.hkp'):
306 self._base_path = os.path.dirname(os.path.abspath(
307 os.path.expanduser(self.path)))
308 if self.name == None:
309 self.name = os.path.basename(path)
311 def append_curve_by_path(self, path, *args, **kwargs):
312 if self._base_path != None:
313 path = os.path.join(self._base_path, path)
314 super(FilePlaylist, self).append_curve_by_path(path, *args, **kwargs)
317 return self.digest() == self._digest
320 r"""Compute the sha1 digest of the flattened playlist
326 >>> root_path = os.path.sep + 'path'
327 >>> p = FilePlaylist(drivers=[],
328 ... path=os.path.join(root_path, 'to','playlist'))
329 >>> p.info['note'] = 'An example playlist'
330 >>> c = curve.Curve(os.path.join(root_path, 'to', 'curve', 'one'))
331 >>> c.info['note'] = 'The first curve'
333 >>> c = curve.Curve(os.path.join(root_path, 'to', 'curve', 'two'))
334 >>> c.info['note'] = 'The second curve'
337 '\xa1\x1ax\xb1|\x84uA\xe4\x1d\xbf`\x004|\x82\xc2\xdd\xc1\x9e'
339 string = self.flatten()
340 return hashlib.sha1(string).digest()
343 """Create a string representation of the playlist.
345 A playlist is a YAML document with the following minimal syntax::
349 - path: picoforce.000
350 - path: picoforce.001
352 Relative paths are interpreted relative to the location of the
358 >>> from .engine import CommandMessage
360 >>> root_path = os.path.sep + 'path'
361 >>> p = FilePlaylist(drivers=[],
362 ... path=os.path.join(root_path, 'to','playlist'))
363 >>> p.info['note'] = 'An example playlist'
364 >>> c = curve.Curve(os.path.join(root_path, 'to', 'curve', 'one'))
365 >>> c.info['note'] = 'The first curve'
367 >>> c = curve.Curve(os.path.join(root_path, 'to', 'curve', 'two'))
368 >>> c.info['attr with spaces'] = 'The second curve\\nwith endlines'
369 >>> c.command_stack.extend([
370 ... CommandMessage('command A', {'arg 0':0, 'arg 1':'X'}),
371 ... CommandMessage('command B', {'arg 0':1, 'arg 1':'Y'}),
374 >>> print p.flatten() # doctest: +REPORT_UDIFF
375 # Hooke playlist version 0.2
379 _relative_curve_paths: true
381 info: {note: An example playlist}
383 - info: {note: The first curve}
387 - arguments: {arg 0: 0, arg 1: X}
389 - arguments: {arg 0: 1, arg 1: Y}
391 info: {attr with spaces: 'The second curve
397 path: /path/to/playlist.hkp
400 >>> p._relative_curve_paths = False
401 >>> print p.flatten() # doctest: +REPORT_UDIFF
402 # Hooke playlist version 0.2
406 _relative_curve_paths: false
408 info: {note: An example playlist}
410 - info: {note: The first curve}
412 path: /path/to/curve/one
414 - arguments: {arg 0: 0, arg 1: X}
416 - arguments: {arg 0: 1, arg 1: Y}
418 info: {attr with spaces: 'The second curve
422 path: /path/to/curve/two
424 path: /path/to/playlist.hkp
428 yaml_string = yaml.dump(self.__getstate__(), allow_unicode=True)
429 return ('# Hooke playlist version %s\n' % self.version) + yaml_string
431 def from_string(self, string):
432 u"""Load a playlist from a string.
439 >>> string = '''# Hooke playlist version 0.2
442 ... - path: picoforce.000
443 ... - path: picoforce.001
445 >>> p = FilePlaylist(drivers=[],
446 ... path=os.path.join('/path', 'to', 'my', 'playlist'))
447 >>> p.from_string(string)
450 /path/to/my/picoforce.000
451 /path/to/my/picoforce.001
453 More complicated example.
455 >>> string = '''# Hooke playlist version 0.2
456 ... _base_path: /path/to
460 ... _relative_curve_paths: true
461 ... info: {note: An example playlist}
463 ... - info: {note: The first curve}
466 ... - arguments: {arg 0: 0, arg 1: X}
467 ... command: command A
468 ... - arguments: {arg 0: 1, arg 1: Y}
469 ... command: command B
470 ... info: {attr with spaces: 'The second curve
475 ... name: playlist.hkp
476 ... path: /path/to/playlist.hkp
479 >>> p = FilePlaylist(drivers=[],
480 ... path=os.path.join('path', 'to', 'my', 'playlist'))
481 >>> p.from_string(string)
485 {'note': 'An example playlist'}
487 ... print curve.name, curve.path
488 one /path/to/curve/one
489 two /path/to/curve/two
490 >>> p[-1].info['attr with spaces']
491 'The second curve\\nwith endlines'
492 >>> type(p[-1].command_stack)
493 <class 'hooke.command_stack.CommandStack'>
494 >>> p[-1].command_stack # doctest: +NORMALIZE_WHITESPACE
495 [<CommandMessage command A {arg 0: 0, arg 1: X}>,
496 <CommandMessage command B {arg 0: 1, arg 1: Y}>]
498 state = yaml.load(string)
499 self.__setstate__(state)
501 def save(self, path=None, makedirs=True):
502 """Saves the playlist to a YAML file.
505 dirname = os.path.dirname(self.path) or '.'
506 if makedirs == True and not os.path.isdir(dirname):
508 with open(self.path, 'w') as f:
509 f.write(self.flatten())
510 self._digest = self.digest()
512 def load(self, path=None, identify=True, hooke=None):
513 """Load a playlist from a file.
516 with open(self.path, 'r') as f:
518 self.from_string(text)
519 self._digest = self.digest()
521 curve.set_hooke(hooke)
523 curve.identify(self.drivers)
526 class Playlists (NoteIndexList):
527 """A :class:`NoteIndexList` of :class:`FilePlaylist`\s.
529 def __init__(self, *arg, **kwargs):
530 super(Playlists, self).__init__(*arg, **kwargs)
532 def _item_getstate(self, item):
533 assert isinstance(item, FilePlaylist), type(item)
534 return item.__getstate__()
536 def _item_setstate(self, state):
537 item = FilePlaylist(drivers=[])
538 item.__setstate__(state)