Revision: 6470
Author: nicdumz
Date: 2009-03-03 05:38:35 +0000 (Tue, 03 Mar 2009)
Log Message:
-----------
Adding logentries : A set of skeleton classes to wrap data returned by the API on
logevents queries.
Wrappers still have to be implemented, with generic methods, and methods specific to each
log type, but the Factory has been implemented and tested.
Added Paths:
-----------
branches/rewrite/pywikibot/data/logentries.py
Added: branches/rewrite/pywikibot/data/logentries.py
===================================================================
--- branches/rewrite/pywikibot/data/logentries.py (rev 0)
+++ branches/rewrite/pywikibot/data/logentries.py 2009-03-03 05:38:35 UTC (rev 6470)
@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+"""
+Objects representing Mediawiki log entries
+"""
+#
+# (C) Pywikipedia bot team, 2007-08
+#
+# Distributed under the terms of the MIT license.
+#
+__version__ = '$Id: $'
+
+from api import APIError
+
+class LogEntry(object):
+ """Generic log entry"""
+ def __init__(self, apidata):
+ """Initialize object from a logevent dict returned by MW
API"""
+ raise NotImplementedError(self.__class__)
+
+class BlockEntry(LogEntry):
+ pass
+
+class ProtectEntry(LogEntry):
+ pass
+
+class RightsEntry(LogEntry):
+ pass
+
+class DeleteEntry(LogEntry):
+ pass
+
+class UploadEntry(LogEntry):
+ pass
+
+class MoveEntry(LogEntry):
+ pass
+
+class ImportEntry(LogEntry):
+ pass
+
+class PatrolEntry(LogEntry):
+ pass
+
+class NewUsersEntry(LogEntry):
+ pass
+
+#TODO entries for merge,suppress,makebot,gblblock,renameuser,globalauth,gblrights ?
+
+
+_logtypes = {
+ 'block':BlockEntry,
+ 'protect':ProtectEntry,
+ 'rights':RightsEntry,
+ 'delete':DeleteEntry,
+ 'upload':UploadEntry,
+ 'move':MoveEntry,
+ 'import':ImportEntry,
+ 'patrol':PatrolEntry,
+ 'newusers':NewUsersEntry
+}
+
+def _getEntryClass(logtype):
+ """
+ Returns the class corresponding to the @logtype string parameter.
+ Returns LogEntry if logtype is unknown or not supported
+ """
+ try:
+ return _logtypes[logtype]
+ except KeyError:
+ return LogEntry
+
+class LogEntryFactory(object):
+ """
+ LogEntry Factory
+
+ Only available method is create()
+ """
+ def __init__(self, logtype=None):
+ """
+ @param logtype: The log type of the log entries, if known in advance.
+ If None, the Factory will fetch the log entry from
+ the data to create each object.
+ @type logtype: (letype) str : move/block/patrol/etc...
+ """
+ if logtype is None:
+ self._creator = self._createFromData
+ else:
+ # Bind a Class object to self._creator:
+ # When called, it will initialize a new object of that class
+ self._creator = _getEntryClass(logtype)
+
+ def create(self, logdata):
+ """
+ Instantiates the LogEntry object representing logdata
+ @param logdata: <item> returned by the api
+ @type logdata: dict
+
+ @return LogEntry object representing logdata
+ """
+ return self._creator(logdata)
+
+ def _createFromData(self, logdata):
+ """
+ Checks for logtype from data, and creates the correct LogEntry
+ """
+ try:
+ logtype = logdata['type']
+ return _getEntryClass(logtype)(logdata)
+ except KeyError:
+ raise APIError("Log entry has no 'type' key")