From 5547e14e113ae33f01f7fbe23662eb67ba072374 Mon Sep 17 00:00:00 2001 From: Christophe Benz Date: Sun, 11 Jul 2010 22:00:18 +0200 Subject: [PATCH] enhance formatters --- weboob/applications/videoob/videoob.py | 2 +- weboob/applications/weboobcfg/weboobcfg.py | 69 +++++----- .../applications/weboorrents/weboorrents.py | 2 +- weboob/tools/application/console.py | 17 ++- .../application/formatters/iformatter.py | 3 +- .../formatters/{instances.py => load.py} | 44 +++---- weboob/tools/application/formatters/table.py | 2 +- weboob/tools/ordereddict.py | 124 ++++++++++++++++++ 8 files changed, 197 insertions(+), 66 deletions(-) rename weboob/tools/application/formatters/{instances.py => load.py} (50%) create mode 100644 weboob/tools/ordereddict.py diff --git a/weboob/applications/videoob/videoob.py b/weboob/applications/videoob/videoob.py index 5592067f..20cd1c3d 100644 --- a/weboob/applications/videoob/videoob.py +++ b/weboob/applications/videoob/videoob.py @@ -50,6 +50,6 @@ class Videoob(ConsoleApplication): @ConsoleApplication.command('Search for videos') def command_search(self, pattern=None): self.load_modules(ICapVideo) - self.set_header(u'Search pattern: %s' % pattern if pattern else u'Last videos') + self.set_formatter_header(u'Search pattern: %s' % pattern if pattern else u'Last videos') for backend, video in self.do('iter_search_results', pattern=pattern, nsfw=self.options.nsfw): self.format(video, backend.name) diff --git a/weboob/applications/weboobcfg/weboobcfg.py b/weboob/applications/weboobcfg/weboobcfg.py index becd2c1d..f49cef1a 100644 --- a/weboob/applications/weboobcfg/weboobcfg.py +++ b/weboob/applications/weboobcfg/weboobcfg.py @@ -15,6 +15,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + import ConfigParser import logging import os @@ -22,6 +23,7 @@ import subprocess import re from weboob.tools.application.console import ConsoleApplication +from weboob.tools.ordereddict import OrderedDict __all__ = ['WeboobCfg'] @@ -30,7 +32,7 @@ __all__ = ['WeboobCfg'] class WeboobCfg(ConsoleApplication): APPNAME = 'weboobcfg' VERSION = '0.1' - COPYRIGHT = 'Copyright(C) 2010 Romain Bignon' + COPYRIGHT = 'Copyright(C) 2010 Christophe Benz, Romain Bignon' def main(self, argv): return self.process_command(*argv[1:]) @@ -42,22 +44,18 @@ class WeboobCfg(ConsoleApplication): return False return True - @ConsoleApplication.command('List modules') - def command_modules(self, *caps): - print ' Name Capabilities Description ' - print '+--------------+----------------------+----------------------------------------+' + @ConsoleApplication.command('List backends') + def command_backends(self, *caps): + self.set_default_formatter('table') self.weboob.modules_loader.load() - for name, module in self.weboob.modules_loader.modules.iteritems(): - if caps and not self.caps_included(module.iter_caps(), caps): + for name, backend in self.weboob.modules_loader.modules.iteritems(): + if caps and not self.caps_included(backend.iter_caps(), caps): continue - - first_line = True - for cap in module.iter_caps(): - if first_line: - print ' %-14s %-21s %s' % (name, cap.__name__, module.get_description()) - first_line = False - else: - print ' %s' % cap.__name__ + row = OrderedDict([('Name', name), + ('Capabilities', ', '.join(cap.__name__ for cap in backend.iter_caps())), + ('Description', backend.get_description()), + ]) + self.format(row) @ConsoleApplication.command('List applications') def command_applications(self, *caps): @@ -71,24 +69,24 @@ class WeboobCfg(ConsoleApplication): applications.add(m.group(1)) print ' '.join(sorted(applications)).encode('utf-8') - @ConsoleApplication.command('Display a module') - def command_modinfo(self, name): + @ConsoleApplication.command('Display information about a backend') + def command_info(self, name): try: - module = self.weboob.modules_loader.get_or_load_module(name) + backend = self.weboob.modules_loader.get_or_load_module(name) except KeyError: - logging.error('No such module: %s' % name) + logging.error('No such backend: "%s"' % name) return 1 print '.------------------------------------------------------------------------------.' - print '| Module %-69s |' % module.get_name() + print '| Backend %-68s |' % backend.get_name() print "+-----------------.------------------------------------------------------------'" - print '| Version | %s' % module.get_version() - print '| Maintainer | %s' % module.get_maintainer() - print '| License | %s' % module.get_license() - print '| Description | %s' % module.get_description() - print '| Capabilities | %s' % ', '.join([cap.__name__ for cap in module.iter_caps()]) + print '| Version | %s' % backend.get_version() + print '| Maintainer | %s' % backend.get_maintainer() + print '| License | %s' % backend.get_license() + print '| Description | %s' % backend.get_description() + print '| Capabilities | %s' % ', '.join([cap.__name__ for cap in backend.iter_caps()]) first = True - for key, field in module.get_config().iteritems(): + for key, field in backend.get_config().iteritems(): value = field.description if not field.default is None: value += ' (default: %s)' % field.default @@ -98,7 +96,7 @@ class WeboobCfg(ConsoleApplication): first = False else: print '| | %s: %s' % (key, value) - print "'-----------------' " + print "'-----------------'" @ConsoleApplication.command('Add a configured backend') @@ -157,19 +155,22 @@ class WeboobCfg(ConsoleApplication): except ConfigParser.DuplicateSectionError: print u'Instance "%s" already exists for backend "%s".' % (new_name, name) - @ConsoleApplication.command('List backends') - def command_list(self): - print ' Instance Name Name Params ' - print '+---------------+--------------+------------------------------------------------+' + @ConsoleApplication.command('List configured backends') + def command_configured(self): + self.set_default_formatter('table') for instance_name, name, params in self.weboob.backends_config.iter_backends(): - print ' %-15s %-14s %-47s' % (instance_name, name, ', '.join('%s=%s' % (key, value) for key, value in params.iteritems())) + row = OrderedDict([('Instance name', instance_name), + ('Backend name', name), + ('Configuration', ', '.join('%s=%s' % (key, value) for key, value in params.iteritems())), + ]) + self.format(row) - @ConsoleApplication.command('Remove a backend') + @ConsoleApplication.command('Remove a configured backend') def command_remove(self, instance_name): try: self.weboob.backends_config.remove_backend(instance_name) except ConfigParser.NoSectionError: - logging.error("Backend '%s' does not exist" % instance_name) + logging.error('Backend instance "%s" does not exist' % instance_name) return 1 @ConsoleApplication.command('Edit configuration file') diff --git a/weboob/applications/weboorrents/weboorrents.py b/weboob/applications/weboorrents/weboorrents.py index 71e2f42e..25f719c2 100644 --- a/weboob/applications/weboorrents/weboorrents.py +++ b/weboob/applications/weboorrents/weboorrents.py @@ -66,6 +66,6 @@ class Weboorrents(ConsoleApplication): @ConsoleApplication.command('Search torrents') def command_search(self, pattern=None): - self.set_header(u'Search pattern: %s' % pattern if pattern else u'Last torrents') + self.set_formatter_header(u'Search pattern: %s' % pattern if pattern else u'Last torrents') for backend, torrent in self.weboob.do('iter_torrents', pattern=pattern): self.format(torrent, backend.name) diff --git a/weboob/tools/application/console.py b/weboob/tools/application/console.py index 89d0f5d0..962acce2 100644 --- a/weboob/tools/application/console.py +++ b/weboob/tools/application/console.py @@ -27,7 +27,7 @@ from weboob.core import CallErrors from weboob.core.modules import BackendsConfig from .base import BackendNotFound, BaseApplication -from .formatters.instances import formatters +from .formatters.load import formatters, load_formatter from .results import ResultsCondition, ResultsConditionException @@ -60,8 +60,7 @@ class ConsoleApplication(BaseApplication): results_options = OptionGroup(self._parser, 'Results Options') results_options.add_option('-c', '--condition', help='filter result items to display given a boolean condition') - results_options.add_option('-f', '--formatter', default='multiline', choices=formatters.keys(), - help='select output formatter (%s)' % u','.join(formatters.keys())) + results_options.add_option('-f', '--formatter', choices=formatters, help='select output formatter (%s)' % u','.join(formatters)) results_options.add_option('-s', '--select', help='select result item key(s) to display (comma-separated)') self._parser.add_option_group(results_options) @@ -73,7 +72,11 @@ class ConsoleApplication(BaseApplication): pass def _handle_app_options(self): - self.formatter = formatters[self.options.formatter] + if self.options.formatter: + formatter_name = self.options.formatter + else: + formatter_name = 'multiline' + self.formatter = load_formatter(formatter_name) if self.options.no_header: self.formatter.display_header = False @@ -205,7 +208,11 @@ class ConsoleApplication(BaseApplication): def command(doc_string, f=register_command): return partial(f, doc_string=doc_string) - def set_header(self, string): + def set_default_formatter(self, name): + if not self.options.formatter: + self.formatter = load_formatter(name) + + def set_formatter_header(self, string): self.formatter.set_header(string) def format(self, result, backend_name=None): diff --git a/weboob/tools/application/formatters/iformatter.py b/weboob/tools/application/formatters/iformatter.py index 2b4d75e1..f6d20761 100644 --- a/weboob/tools/application/formatters/iformatter.py +++ b/weboob/tools/application/formatters/iformatter.py @@ -43,7 +43,8 @@ class IFormatter(object): call it. It can be used to specify the fields order. @param obj [object] object to format - @param selected_fields [list] fields to display. If None, all fields are selected. + @param backend_name [str] name of backend, used to create object ID + @param selected_fields [tuple] fields to display. If None, all fields are selected @param condition [Condition] condition to objects to display @return a string of the formatted object """ diff --git a/weboob/tools/application/formatters/instances.py b/weboob/tools/application/formatters/load.py similarity index 50% rename from weboob/tools/application/formatters/instances.py rename to weboob/tools/application/formatters/load.py index 3090b153..4a8297cc 100644 --- a/weboob/tools/application/formatters/instances.py +++ b/weboob/tools/application/formatters/load.py @@ -15,30 +15,28 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -from .multiline import MultilineFormatter -from .simple import SimpleFormatter + +__all__ = ['load_formatter'] -__all__ = ['formatters'] +formatters = ('htmltable', 'multiline', 'simple', 'table', 'webkit') + - -formatters = dict( - multiline=MultilineFormatter(), - simple=SimpleFormatter(), - ) - -try: - from .table import TableFormatter - formatters.update(dict( - table=TableFormatter(), - htmltable=TableFormatter(result_funcname='get_html_string'), - )) - try: +def load_formatter(name): + if name not in formatters: + raise Exception(u'Formatter "%s" not found' % name) + if name in ('htmltable', 'table'): + from .table import TableFormatter + if name == 'htmltable': + return TableFormatter(result_funcname='get_html_string') + elif name == 'table': + return TableFormatter() + elif name == 'simple': + from .simple import SimpleFormatter + return SimpleFormatter() + elif name == 'multiline': + from .multiline import MultilineFormatter + return MultilineFormatter() + elif name == 'webkit': from .webkit import WebkitGtkFormatter - formatters.update(dict( - webkit=WebkitGtkFormatter(), - )) - except ImportError: - pass -except ImportError: - pass + return WebkitGtkFormatter() diff --git a/weboob/tools/application/formatters/table.py b/weboob/tools/application/formatters/table.py index f02af62d..21267f52 100644 --- a/weboob/tools/application/formatters/table.py +++ b/weboob/tools/application/formatters/table.py @@ -48,7 +48,7 @@ class TableFormatter(IFormatter): elif self.result_funcname == 'get_html_string': s+= '

%s

' % self.header s += "\n" - table = PrettyTable(self.column_headers) + table = PrettyTable(list(self.column_headers)) for column_header in self.column_headers: table.set_field_align(column_header, 'l') for line in self.queue: diff --git a/weboob/tools/ordereddict.py b/weboob/tools/ordereddict.py new file mode 100644 index 00000000..6d8bd91e --- /dev/null +++ b/weboob/tools/ordereddict.py @@ -0,0 +1,124 @@ +# -*- coding: utf-8 -*- + +# Copyright(C) 2010 Christophe Benz +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, version 3 of the License. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + +try: + from ordereddict import OrderedDict +except: +## {{{ http://code.activestate.com/recipes/576693/ (r6) + from UserDict import DictMixin + + + class OrderedDict(dict, DictMixin): + + def __init__(self, *args, **kwds): + if len(args) > 1: + raise TypeError('expected at most 1 arguments, got %d' % len(args)) + try: + self.__end + except AttributeError: + self.clear() + self.update(*args, **kwds) + + def clear(self): + self.__end = end = [] + end += [None, end, end] # sentinel node for doubly linked list + self.__map = {} # key --> [key, prev, next] + dict.clear(self) + + def __setitem__(self, key, value): + if key not in self: + end = self.__end + curr = end[1] + curr[2] = end[1] = self.__map[key] = [key, curr, end] + dict.__setitem__(self, key, value) + + def __delitem__(self, key): + dict.__delitem__(self, key) + key, prev, next = self.__map.pop(key) + prev[2] = next + next[1] = prev + + def __iter__(self): + end = self.__end + curr = end[2] + while curr is not end: + yield curr[0] + curr = curr[2] + + def __reversed__(self): + end = self.__end + curr = end[1] + while curr is not end: + yield curr[0] + curr = curr[1] + + def popitem(self, last=True): + if not self: + raise KeyError('dictionary is empty') + if last: + key = reversed(self).next() + else: + key = iter(self).next() + value = self.pop(key) + return key, value + + def __reduce__(self): + items = [[k, self[k]] for k in self] + tmp = self.__map, self.__end + del self.__map, self.__end + inst_dict = vars(self).copy() + self.__map, self.__end = tmp + if inst_dict: + return (self.__class__, (items,), inst_dict) + return self.__class__, (items,) + + def keys(self): + return list(self) + + setdefault = DictMixin.setdefault + update = DictMixin.update + pop = DictMixin.pop + values = DictMixin.values + items = DictMixin.items + iterkeys = DictMixin.iterkeys + itervalues = DictMixin.itervalues + iteritems = DictMixin.iteritems + + def __repr__(self): + if not self: + return '%s()' % (self.__class__.__name__,) + return '%s(%r)' % (self.__class__.__name__, self.items()) + + def copy(self): + return self.__class__(self) + + @classmethod + def fromkeys(cls, iterable, value=None): + d = cls() + for key in iterable: + d[key] = value + return d + + def __eq__(self, other): + if isinstance(other, OrderedDict): + return len(self)==len(other) and self.items() == other.items() + return dict.__eq__(self, other) + + def __ne__(self, other): + return not self == other +## end of http://code.activestate.com/recipes/576693/ }}}