nojhan/weboob-devel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Rename BaseModule to Module and Module to LoadedModule

Browse source
This commit is contained in:
Florent 2014-09-23 10:16:35 +02:00
commit 5a1d83b567
166 changed files with 359 additions and 359 deletions
Download patch file Download diff file Expand all files Collapse all files

2
weboob/capabilities/base.py
View file

@ -127,7 +127,7 @@ class NotLoadedType(object):
"""
NotLoaded is a constant to use on not loaded fields.
When you use :func:`weboob.tools.backend.BaseModule.fillobj` on a object based on :class:`BaseObject`,
When you use :func:`weboob.tools.backend.Module.fillobj` on a object based on :class:`BaseObject`,
it will request all fields with this value.
"""

2
weboob/core/bcall.py
View file

@ -50,7 +50,7 @@ class BackendsCall(object):
def __init__(self, backends, function, *args, **kwargs):
"""
:param backends: List of backends to call
:type backends: list[:class:`BaseModule`]
:type backends: list[:class:`Module`]
:param function: backends' method name, or callable object.
:type function: :class:`str` or :class:`callable`
"""

12
weboob/core/modules.py
View file

@ -21,11 +21,11 @@ import os
import imp
import logging
from weboob.tools.backend import BaseModule
from weboob.tools.backend import Module
from weboob.tools.log import getLogger
__all__ = ['Module', 'ModulesLoader', 'RepositoryModulesLoader', 'ModuleLoadError']
__all__ = ['LoadedModule', 'ModulesLoader', 'RepositoryModulesLoader', 'ModuleLoadError']
class ModuleLoadError(Exception):
@ -34,17 +34,17 @@ class ModuleLoadError(Exception):
self.module = module_name
class Module(object):
class LoadedModule(object):
def __init__(self, package):
self.logger = getLogger('backend')
self.package = package
self.klass = None
for attrname in dir(self.package):
attr = getattr(self.package, attrname)
if isinstance(attr, type) and issubclass(attr, BaseModule) and attr != BaseModule:
if isinstance(attr, type) and issubclass(attr, Module) and attr != Module:
self.klass = attr
if not self.klass:
raise ImportError('%s is not a backend (no BaseModule class found)' % package)
raise ImportError('%s is not a backend (no Module class found)' % package)
@property
def name(self):
@ -143,7 +143,7 @@ class ModulesLoader(object):
try:
fp, pathname, description = imp.find_module(module_name, [path])
try:
module = Module(imp.load_module(module_name, fp, pathname, description))
module = LoadedModule(imp.load_module(module_name, fp, pathname, description))
finally:
if fp:
fp.close()

16
weboob/core/ouiboube.py
View file

@ -25,7 +25,7 @@ from weboob.core.modules import ModulesLoader, RepositoryModulesLoader, ModuleLo
from weboob.core.backendscfg import BackendsConfig
from weboob.core.repositories import Repositories, IProgress
from weboob.core.scheduler import Scheduler
from weboob.tools.backend import BaseModule
from weboob.tools.backend import Module
from weboob.tools.config.iconfig import ConfigError
from weboob.tools.log import getLogger
@ -97,7 +97,7 @@ class WebNip(object):
:type storage: :class:`weboob.tools.storage.IStorage`
:param name: name of backend
:type name: :class:`basestring`
:rtype: :class:`weboob.tools.backend.BaseModule`
:rtype: :class:`weboob.tools.backend.Module`
"""
module = self.modules_loader.get_or_load_module(module_name)
@ -127,7 +127,7 @@ class WebNip(object):
:type params: :class:`dict`
:param storage: storage to use
:type storage: :class:`weboob.tools.storage.IStorage`
:rtype: :class:`weboob.tools.backend.BaseModule`
:rtype: :class:`weboob.tools.backend.Module`
"""
if name is None:
name = module_name
@ -192,7 +192,7 @@ class WebNip(object):
:param caps: optional list of capabilities to select backends
:type caps: tuple[:class:`weboob.capabilities.base.CapBase`]
:rtype: iter[:class:`weboob.tools.backend.BaseModule`]
:rtype: iter[:class:`weboob.tools.backend.Module`]
"""
for _, backend in sorted(self.backend_instances.iteritems()):
if caps is None or backend.has_caps(caps):
@ -228,7 +228,7 @@ class WebNip(object):
backends = self.backend_instances.values()
_backends = kwargs.pop('backends', None)
if _backends is not None:
if isinstance(_backends, BaseModule):
if isinstance(_backends, Module):
backends = [_backends]
elif isinstance(_backends, basestring):
if len(_backends) > 0:
@ -376,7 +376,7 @@ class Weboob(WebNip):
:type storage: :class:`weboob.tools.storage.IStorage`
:param name: name of backend
:type name: :class:`basestring`
:rtype: :class:`weboob.tools.backend.BaseModule`
:rtype: :class:`weboob.tools.backend.Module`
"""
minfo = self.repositories.get_module_info(module_name)
if minfo is None:
@ -404,7 +404,7 @@ class Weboob(WebNip):
:param errors: if specified, store every errors in this list
:type errors: list[:class:`LoadError`]
:returns: loaded backends
:rtype: dict[:class:`str`, :class:`weboob.tools.backend.BaseModule`]
:rtype: dict[:class:`str`, :class:`weboob.tools.backend.Module`]
"""
loaded = {}
if storage is None:
@ -446,7 +446,7 @@ class Weboob(WebNip):
try:
backend_instance = module.create_instance(self, instance_name, params, storage)
except BaseModule.ConfigError as e:
except Module.ConfigError as e:
if errors is not None:
errors.append(self.LoadError(instance_name, e))
else:

4
weboob/core/repositories.py
View file

@ -32,7 +32,7 @@ from compileall import compile_dir
from io import BytesIO
from weboob.tools.exceptions import BrowserHTTPError, BrowserHTTPNotFound
from .modules import Module
from .modules import LoadedModule
from weboob.tools.log import getLogger
from weboob.tools.misc import to_unicode
try:
@ -281,7 +281,7 @@ class Repository(object):
try:
fp, pathname, description = imp.find_module(name, [path])
try:
module = Module(imp.load_module(name, fp, pathname, description))
module = LoadedModule(imp.load_module(name, fp, pathname, description))
finally:
if fp:
fp.close()

12
weboob/tools/backend.py
View file

@ -29,7 +29,7 @@ from weboob.tools.log import getLogger
from weboob.tools.value import ValuesDict
__all__ = ['BackendStorage', 'BackendConfig', 'BaseModule']
__all__ = ['BackendStorage', 'BackendConfig', 'Module']
class BackendStorage(object):
@ -37,8 +37,8 @@ class BackendStorage(object):
This is an abstract layer to store data in storages (:mod:`weboob.tools.storage`)
easily.
It is instancied automatically in constructor of :class:`BaseModule`, in the
:attr:`BaseModule.storage` attribute.
It is instancied automatically in constructor of :class:`Module`, in the
:attr:`Module.storage` attribute.
:param name: name of backend
:param storage: storage object
@ -156,7 +156,7 @@ class BackendConfig(ValuesDict):
if value is None:
if not nofail and field.required:
raise BaseModule.ConfigError('Backend(%s): Configuration error: Missing parameter "%s" (%s)'
raise Module.ConfigError('Backend(%s): Configuration error: Missing parameter "%s" (%s)'
% (cfg.instname, name, field.description))
value = field.default
@ -165,7 +165,7 @@ class BackendConfig(ValuesDict):
field.load(cfg.instname, value, cfg.weboob.callbacks)
except ValueError as v:
if not nofail:
raise BaseModule.ConfigError(
raise Module.ConfigError(
'Backend(%s): Configuration error for field "%s": %s' % (cfg.instname, name, v))
cfg[name] = field
@ -202,7 +202,7 @@ class BackendConfig(ValuesDict):
self.weboob.backends_config.add_backend(self.instname, self.modname, dump, edit)
class BaseModule(object):
class Module(object):
"""
Base class for backends.

4
weboob/tools/capabilities/gallery/genericcomicreader.py
View file

@ -22,7 +22,7 @@
import re
from weboob.capabilities.gallery import CapGallery, BaseGallery, BaseImage
from weboob.tools.backend import BaseModule
from weboob.tools.backend import Module
from weboob.tools.browser import BaseBrowser, BasePage
__all__ = ['GenericComicReaderModule']
@ -63,7 +63,7 @@ class GenericComicReaderBrowser(BaseBrowser):
image.data = self.readurl(image.url)
class GenericComicReaderModule(BaseModule, CapGallery):
class GenericComicReaderModule(Module, CapGallery):
NAME = 'genericcomicreader'
MAINTAINER = u'Noé Rubinstein'
EMAIL = 'noe.rubinstein@gmail.com'

4
weboob/tools/capabilities/messages/GenericModule.py
View file

@ -21,11 +21,11 @@
import time
from weboob.capabilities.messages import CapMessages, Message, Thread
from weboob.capabilities.base import find_object
from weboob.tools.backend import BaseModule
from weboob.tools.backend import Module
from weboob.tools.newsfeed import Newsfeed
class GenericNewspaperModule(BaseModule, CapMessages):
class GenericNewspaperModule(Module, CapMessages):
"""
GenericNewspaperModule class
"""