Rename CapBase to Capability

This commit is contained in:
Florent 2014-09-23 10:20:09 +02:00
commit 44dffce7b2
31 changed files with 64 additions and 64 deletions

View file

@ -19,7 +19,7 @@ Select capabilities
******************* *******************
Each module implements one or many :doc:`capabilities </api/capabilities/index>` to tell what kind of features the Each module implements one or many :doc:`capabilities </api/capabilities/index>` to tell what kind of features the
website provides. A capability is a class derived from :class:`weboob.capabilities.base.CapBase` and with some abstract website provides. A capability is a class derived from :class:`weboob.capabilities.base.Capability` and with some abstract
methods (which raise ``NotImplementedError``). methods (which raise ``NotImplementedError``).
A capability needs to be as generic as possible to allow a maximum number of modules to implement it. A capability needs to be as generic as possible to allow a maximum number of modules to implement it.

View file

@ -1,5 +1,5 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
from .base import UserError, NotLoaded, NotAvailable, BaseObject, CapBase from .base import UserError, NotLoaded, NotAvailable, BaseObject, Capability
__all__ = ['UserError', 'NotLoaded', 'NotAvailable', 'BaseObject', 'CapBase'] __all__ = ['UserError', 'NotLoaded', 'NotAvailable', 'BaseObject', 'Capability']

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, StringField, Field, UserError from .base import Capability, BaseObject, StringField, Field, UserError
__all__ = ['AccountRegisterError', 'Account', 'StatusField', 'CapAccount'] __all__ = ['AccountRegisterError', 'Account', 'StatusField', 'CapAccount']
@ -56,7 +56,7 @@ class StatusField(object):
self.flags = flags self.flags = flags
class CapAccount(CapBase): class CapAccount(Capability):
""" """
Capability for websites when you can create and manage accounts. Capability for websites when you can create and manage accounts.

View file

@ -29,7 +29,7 @@ from weboob.tools.ordereddict import OrderedDict
__all__ = ['UserError', 'FieldNotFound', 'NotAvailable', __all__ = ['UserError', 'FieldNotFound', 'NotAvailable',
'NotLoaded', 'CapBase', 'Field', 'IntField', 'DecimalField', 'NotLoaded', 'Capability', 'Field', 'IntField', 'DecimalField',
'FloatField', 'StringField', 'BytesField', 'FloatField', 'StringField', 'BytesField',
'empty', 'BaseObject'] 'empty', 'BaseObject']
@ -152,7 +152,7 @@ class NotLoadedType(object):
NotLoaded = NotLoadedType() NotLoaded = NotLoadedType()
class CapBase(object): class Capability(object):
""" """
This is the base class for all capabilities. This is the base class for all capabilities.

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, Field, StringField,\ from .base import Capability, BaseObject, Field, StringField,\
IntField, UserError IntField, UserError
from .date import DateField, DeltaField from .date import DateField, DeltaField
@ -232,7 +232,7 @@ class Query(BaseObject):
BaseObject.__init__(self, '') BaseObject.__init__(self, '')
class CapBugTracker(CapBase): class CapBugTracker(Capability):
""" """
Bug trackers websites. Bug trackers websites.
""" """

View file

@ -20,7 +20,7 @@
import datetime import datetime
from .base import CapBase, BaseObject, StringField, UserError from .base import Capability, BaseObject, StringField, UserError
from .date import DateField from .date import DateField
@ -53,7 +53,7 @@ class ChatMessage(BaseObject):
self.date = datetime.datetime.utcnow() self.date = datetime.datetime.utcnow()
class CapChat(CapBase): class CapChat(Capability):
""" """
Websites with a chat system. Websites with a chat system.
""" """

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, StringField, IntField, Field from .base import Capability, BaseObject, StringField, IntField, Field
from .date import DateField from .date import DateField
@ -69,7 +69,7 @@ class Person(BaseObject):
self.name = name self.name = name
class CapCinema(CapBase): class CapCinema(Capability):
""" """
Cinema databases. Cinema databases.
""" """

View file

@ -19,7 +19,7 @@
from weboob.tools.ordereddict import OrderedDict from weboob.tools.ordereddict import OrderedDict
from .base import CapBase, BaseObject, UserError, StringField, Field from .base import Capability, BaseObject, UserError, StringField, Field
__all__ = ['CapCollection', 'BaseCollection', 'Collection', 'CollectionNotFound'] __all__ = ['CapCollection', 'BaseCollection', 'Collection', 'CollectionNotFound']
@ -95,7 +95,7 @@ class Collection(BaseCollection):
return u'Unknown collection' return u'Unknown collection'
class CapCollection(CapBase): class CapCollection(Capability):
def iter_resources_flat(self, objs, split_path, clean_only=False): def iter_resources_flat(self, objs, split_path, clean_only=False):
""" """
Call iter_resources() to fetch all resources in the tree. Call iter_resources() to fetch all resources in the tree.

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, Field, StringField, BytesField, IntField, \ from .base import Capability, BaseObject, Field, StringField, BytesField, IntField, \
UserError UserError
from weboob.tools.ordereddict import OrderedDict from weboob.tools.ordereddict import OrderedDict
@ -165,7 +165,7 @@ class Query(BaseObject):
self.message = message self.message = message
class CapContact(CapBase): class CapContact(Capability):
def iter_contacts(self, status=Contact.STATUS_ALL, ids=None): def iter_contacts(self, status=Contact.STATUS_ALL, ids=None):
""" """
Iter contacts Iter contacts

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, StringField, Field from .base import Capability, BaseObject, StringField, Field
from .date import DateField from .date import DateField
@ -45,7 +45,7 @@ class Revision(BaseObject):
minor = Field('Is this change minor?', bool) minor = Field('Is this change minor?', bool)
class CapContent(CapBase): class CapContent(Capability):
def get_content(self, id, revision=None): def get_content(self, id, revision=None):
""" """
Get a content from an ID. Get a content from an ID.

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, Field, StringField, UserError from .base import Capability, BaseObject, Field, StringField, UserError
from .date import DateField from .date import DateField
from .contact import Contact from .contact import Contact
@ -90,7 +90,7 @@ class Event(BaseObject):
message = StringField('Message of the event') message = StringField('Message of the event')
class CapDating(CapBase): class CapDating(Capability):
""" """
Capability for dating websites. Capability for dating websites.
""" """

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, NotAvailable, Field, StringField from .base import Capability, BaseObject, NotAvailable, Field, StringField
from .date import DateField from .date import DateField
@ -60,7 +60,7 @@ class BaseFile(BaseObject):
return self.id2url(self.id) return self.id2url(self.id)
class CapFile(CapBase): class CapFile(Capability):
""" """
Provide file download Provide file download
""" """

View file

@ -19,7 +19,7 @@
from weboob.tools.capabilities.thumbnail import Thumbnail from weboob.tools.capabilities.thumbnail import Thumbnail
from .base import CapBase, BaseObject, NotLoaded, Field, StringField, \ from .base import Capability, BaseObject, NotLoaded, Field, StringField, \
BytesField, IntField, FloatField BytesField, IntField, FloatField
from .date import DateField from .date import DateField
@ -104,7 +104,7 @@ class BaseImage(BaseObject):
return self.data is not NotLoaded return self.data is not NotLoaded
class CapGallery(CapBase): class CapGallery(Capability):
""" """
This capability represents the ability for a website backend to provide videos. This capability represents the ability for a website backend to provide videos.
""" """

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, StringField, FloatField, Field, UserError, empty from .base import Capability, BaseObject, StringField, FloatField, Field, UserError, empty
from .date import DateField from .date import DateField
__all__ = ['Gauge', 'GaugeSensor', 'GaugeMeasure', 'CapGauge', 'SensorNotFound'] __all__ = ['Gauge', 'GaugeSensor', 'GaugeMeasure', 'CapGauge', 'SensorNotFound']
@ -74,7 +74,7 @@ class GaugeSensor(BaseObject):
return "<GaugeSensor id=%s name=%s>" % (self.id, self.name) return "<GaugeSensor id=%s name=%s>" % (self.id, self.name)
class CapGauge(CapBase): class CapGauge(Capability):
def iter_gauges(self, pattern=None): def iter_gauges(self, pattern=None):
""" """
Iter gauges. Iter gauges.

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, StringField, FloatField from .base import Capability, BaseObject, StringField, FloatField
__all__ = ['IpLocation', 'CapGeolocIp'] __all__ = ['IpLocation', 'CapGeolocIp']
@ -42,7 +42,7 @@ class IpLocation(BaseObject):
BaseObject.__init__(self, ipaddr) BaseObject.__init__(self, ipaddr)
class CapGeolocIp(CapBase): class CapGeolocIp(Capability):
""" """
Access information about IP addresses database. Access information about IP addresses database.
""" """

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, Field, IntField, DecimalField, \ from .base import Capability, BaseObject, Field, IntField, DecimalField, \
StringField, BytesField StringField, BytesField
from .date import DateField from .date import DateField
@ -105,7 +105,7 @@ class City(BaseObject):
name = StringField('Name of city') name = StringField('Name of city')
class CapHousing(CapBase): class CapHousing(Capability):
""" """
Capability of websites to search housings. Capability of websites to search housings.
""" """

View file

@ -17,7 +17,7 @@
# You should have received a copy of the GNU Affero General Public License # You should have received a copy of the GNU Affero General Public License
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import BaseObject, CapBase, StringField from .base import BaseObject, Capability, StringField
from .date import DateField from .date import DateField
__all__ = ['BaseJobAdvert', 'CapJob'] __all__ = ['BaseJobAdvert', 'CapJob']
@ -68,7 +68,7 @@ class BaseJobAdvert(BaseObject):
return self.id2url(self.id) return self.id2url(self.id)
class CapJob(CapBase): class CapJob(Capability):
""" """
Capability of job annouce websites. Capability of job annouce websites.
""" """

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, StringField from .base import Capability, BaseObject, StringField
__all__ = ['SongLyrics', 'CapLyrics'] __all__ = ['SongLyrics', 'CapLyrics']
@ -37,7 +37,7 @@ class SongLyrics(BaseObject):
self.title = title self.title = title
class CapLyrics(CapBase): class CapLyrics(Capability):
""" """
Lyrics websites. Lyrics websites.
""" """

View file

@ -21,7 +21,7 @@
import datetime import datetime
import time import time
from .base import CapBase, BaseObject, NotLoaded, Field, StringField, \ from .base import Capability, BaseObject, NotLoaded, Field, StringField, \
IntField, UserError IntField, UserError
from .date import DateField from .date import DateField
@ -169,7 +169,7 @@ class Thread(_Thread):
yield m yield m
class CapMessages(CapBase): class CapMessages(Capability):
""" """
Capability to read messages. Capability to read messages.
""" """
@ -213,7 +213,7 @@ class CantSendMessage(UserError):
""" """
class CapMessagesPost(CapBase): class CapMessagesPost(Capability):
""" """
This capability allow user to send a message. This capability allow user to send a message.
""" """

View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>. # along with weboob. If not, see <http://www.gnu.org/licenses/>.
from .base import CapBase, BaseObject, Field, StringField, UserError from .base import Capability, BaseObject, Field, StringField, UserError
from .date import DateField from .date import DateField
@ -43,7 +43,7 @@ class Parcel(BaseObject):
history = Field('History', list) history = Field('History', list)
class CapParcel(CapBase): class CapParcel(Capability):
def get_parcel_tracking(self, id): def get_parcel_tracking(self, id):
""" """
Get information abouut a parcel. Get information abouut a parcel.

Some files were not shown because too many files have changed in this diff Show more