change vocabulary

s/module/backend
s/backend/configured_backend
s/frontend/application
This commit is contained in:
Christophe Benz 2010-07-12 03:07:10 +02:00
commit 5c2ab81e16
27 changed files with 347 additions and 347 deletions

View file

@ -26,45 +26,50 @@ import re
import stat
import weboob.backends
from weboob.core.backend import BaseBackend
from weboob.capabilities.cap import ICap
from weboob.tools.backend import BaseBackend
__all__ = ['Module']
__all__ = ['Backend', 'BackendsConfig', 'BackendsLoader']
class Module(object):
def __init__(self, name, module):
self.name = name
self.module = module
class Backend(object):
def __init__(self, package):
self.package = package
self.klass = None
for attrname in dir(self.module):
attr = getattr(self.module, attrname)
for attrname in dir(self.package):
attr = getattr(self.package, attrname)
if isinstance(attr, type) and issubclass(attr, BaseBackend) and attr != BaseBackend:
self.klass = attr
if not self.klass:
raise ImportError("This is not a backend module (no BaseBackend class found)")
raise ImportError('%s is not a backend (no BaseBackend class found)' % package)
def get_name(self):
@property
def name(self):
return self.klass.NAME
def get_maintainer(self):
@property
def maintainer(self):
return '%s <%s>' % (self.klass.MAINTAINER, self.klass.EMAIL)
def get_version(self):
@property
def version(self):
return self.klass.VERSION
def get_description(self):
@property
def description(self):
return self.klass.DESCRIPTION
def get_license(self):
@property
def license(self):
return self.klass.LICENSE
def get_config(self):
@property
def config(self):
return self.klass.CONFIG
def get_icon_path(self):
@property
def icon_path(self):
return self.klass.ICON
def iter_caps(self):
@ -78,9 +83,11 @@ class Module(object):
return True
return False
def create_backend(self, weboob, name, config, storage):
debug('Created backend "%s"' % name)
return self.klass(weboob, name, config, storage)
def create_instance(self, weboob, name, config, storage):
backend_instance = self.klass(weboob, name, config, storage)
debug('Created backend instance "%s"' % name)
return backend_instance
class BackendsConfig(object):
class WrongPermissions(Exception):
@ -128,7 +135,7 @@ class BackendsConfig(object):
config = SafeConfigParser()
config.read(self.confpath)
if not config.has_section(name):
raise KeyError(u'Backend "%s" not found' % name)
raise KeyError(u'Backend instance "%s" not found' % name)
items = dict(config.items(name, raw=True))
try:
@ -141,19 +148,20 @@ class BackendsConfig(object):
config = SafeConfigParser()
config.read(self.confpath)
config.remove_section(name)
with open(self.confpath, 'wb') as f:
with open(self.confpath, 'w') as f:
config.write(f)
class ModulesLoader(object):
class BackendsLoader(object):
def __init__(self):
self.modules = {}
self.loaded = {}
def get_or_load_module(self, name):
if name not in self.modules:
self.load_module('weboob.backends.%s' % name)
return self.modules[name]
def get_or_load_backend(self, name):
if name not in self.loaded:
self.load_backend(name)
return self.loaded[name]
def iter_existing_module_names(self):
def iter_existing_backend_names(self):
for path in weboob.backends.__path__:
regexp = re.compile('^%s/([\w\d_]+)$' % path)
for root, dirs, files in os.walk(path):
@ -161,23 +169,24 @@ class ModulesLoader(object):
if m and '__init__.py' in files:
yield m.group(1)
def load(self):
for existing_module_name in self.iter_existing_module_names():
self.load_module('weboob.backends.%s' % existing_module_name)
def load_all(self):
for existing_backend_name in self.iter_existing_backend_names():
self.load_backend(existing_backend_name)
def load_module(self, name):
def load_backend(self, name):
try:
module = Module(name, __import__(name, fromlist=[str(name)]))
package_name = 'weboob.backends.%s' % name
backend = Backend(__import__(package_name, fromlist=[str(package_name)]))
except ImportError, e:
msg = 'Unable to load module "%s": %s' % (name, e)
msg = u'Unable to load backend "%s": %s' % (name, e)
if logging.root.level == logging.DEBUG:
exception(msg)
return
else:
error(msg)
return
if module.get_name() in self.modules:
warning('Module "%s" is already loaded (%s)' % (self.modules[module.get_name()].module, name))
if backend.name in self.loaded:
debug('Backend "%s" is already loaded from %s' % (name, backend.package.__path__[0]))
return
self.modules[module.get_name()] = module
debug('Loaded module "%s" from %s' % (name, module.module.__path__))
self.loaded[backend.name] = backend
debug('Loaded backend "%s" from %s' % (name, backend.package.__path__[0]))

View file

@ -23,9 +23,9 @@ import os
import sys
from weboob.core.bcall import BackendsCall
from weboob.core.modules import ModulesLoader, BackendsConfig
from weboob.core.backend import BaseBackend
from weboob.core.backends import BackendsConfig, BackendsLoader
from weboob.core.scheduler import Scheduler
from weboob.tools.backend import BaseBackend
if sys.version_info[:2] <= (2, 5):
import weboob.tools.property
@ -40,7 +40,7 @@ class Weboob(object):
def __init__(self, workdir=WORKDIR, backends_filename=None, scheduler=None):
self.workdir = workdir
self.backends = {}
self.backend_instances = {}
# Scheduler
if scheduler is None:
@ -53,10 +53,10 @@ class Weboob(object):
elif not os.path.isdir(self.workdir):
warning('"%s" is not a directory' % self.workdir)
# Modules loader
self.modules_loader = ModulesLoader()
# Backends loader
self.backends_loader = BackendsLoader()
# Backends config
# Backend instances config
if not backends_filename:
backends_filename = os.path.join(self.workdir, self.BACKENDS_FILENAME)
elif not backends_filename.startswith('/'):
@ -64,41 +64,26 @@ class Weboob(object):
self.backends_config = BackendsConfig(backends_filename)
def load_backends(self, caps=None, names=None, storage=None):
loaded_backends = {}
for name, _type, params in self.backends_config.iter_backends():
try:
module = self.modules_loader.get_or_load_module(_type)
except KeyError:
warning(u'Unable to find module "%s" for backend "%s"' % (_type, name))
loaded = {}
self.backends_loader.load_all()
for backend_name, backend in self.backends_loader.loaded.iteritems():
if caps is not None and not backend.has_caps(caps) or \
names is not None and backend_name not in names:
continue
backend_instance = backend.create_instance(self, backend_name, {}, storage)
self.backend_instances[backend_name] = loaded[backend_name] = backend_instance
return loaded
# Check conditions
if caps is not None and not module.has_caps(caps) or \
names is not None and name not in names:
def load_configured_backends(self, caps=None, names=None, storage=None):
loaded = {}
for instance_name, backend_name, params in self.backends_config.iter_backends():
backend = self.backends_loader.get_or_load_backend(backend_name)
if caps is not None and not backend.has_caps(caps) or \
names is not None and instance_name not in names:
continue
try:
self.backends[name] = module.create_backend(self, name, params, storage)
loaded_backends[name] = self.backends[name]
except Exception, e:
warning(u'Unable to load "%s" backend: %s. filename=%s' % (name, e, self.backends_config.confpath))
return loaded_backends
def load_modules(self, caps=None, names=None, storage=None):
loaded_backends = {}
self.modules_loader.load()
for name, module in self.modules_loader.modules.iteritems():
if caps is not None and not module.has_caps(caps) or \
names is not None and name not in names:
continue
try:
name = module.get_name()
self.backends[name] = module.create_backend(self, name, {}, storage)
loaded_backends[name] = self.backends[name]
except Exception, e:
warning(u'Unable to load "%s" module as backend with no config: %s' % (name, e))
return loaded_backends
backend_instance = backend.create_instance(self, instance_name, params, storage)
self.backend_instances[instance_name] = loaded[instance_name] = backend_instance
return loaded
def iter_backends(self, caps=None):
"""
@ -109,7 +94,7 @@ class Weboob(object):
@param caps Optional list of capabilities to select backends
@return iterator on selected backends.
"""
for name, backend in sorted(self.backends.iteritems()):
for name, backend in sorted(self.backend_instances.iteritems()):
if caps is None or backend.has_caps(caps):
with backend:
yield backend
@ -134,7 +119,7 @@ class Weboob(object):
def do_caps(self, caps, function, *args, **kwargs):
"""
Do calls on loaded modules with the specified capabilities, in
Do calls on loaded backends with the specified capabilities, in
separated threads.
See also documentation of the 'do' method.
@ -156,14 +141,14 @@ class Weboob(object):
elif isinstance(backends, (list,tuple)):
old_backends = backends
backends = []
for b in old_backends:
if isinstance(b, (str,unicode)):
for backend in old_backends:
if isinstance(backend, (str,unicode)):
try:
backends.append(self.backends[self.backends.index(b)])
backends.append(self.backends[self.backends.index(backend)])
except ValueError:
pass
else:
backends.append(b)
backends.append(backend)
return BackendsCall(backends, function, *args, **kwargs)
def schedule(self, interval, function, *args):