jenkins-bot submitted this change.
[IMPR] Use UserDict for LogEntry
A UserDict holds its data in a data attribute which is a dict.
The dict can be accessed directly or via data attribute. This
enables to access all LogEntry entries directly with its key
even there is no corresponding method to retrieve the data.
The access via the data attribute still works.
- Remove the LogDict helper dict which is no longer used.
- Copy the one and only __missing__ method from LogDict
to LogEntry class which works like a dict now.
- Remove data._type attribute which was used by LogDict
- Shortcut each getting data; the data attribute is no
longer necessary.
- Remove __ne__ method which just returns the opposite
of __eq__; this is done by default.
- Remove logid, pageid, ns, type, action, user, comment
methods which just returns the corresponding data and
replace them by __getattr__.
- Some tests added to verify that LogEntry.data[item] is
equal to LogEntry[item] managed by UserDict.
Change-Id: Ic04f63150fd29123b2459dbf291d79e71fb95bf8
---
M pywikibot/logentries.py
M tests/logentries_tests.py
2 files changed, 71 insertions(+), 83 deletions(-)
diff --git a/pywikibot/logentries.py b/pywikibot/logentries.py
index 3daf72c..b4dd0e7 100644
--- a/pywikibot/logentries.py
+++ b/pywikibot/logentries.py
@@ -1,47 +1,30 @@
# -*- coding: utf-8 -*-
"""Objects representing Mediawiki log entries."""
#
-# (C) Pywikibot team, 2007-2019
+# (C) Pywikibot team, 2007-2020
#
# Distributed under the terms of the MIT license.
#
-from __future__ import absolute_import, division, unicode_literals
+from collections import UserDict
import pywikibot
from pywikibot.exceptions import Error, HiddenKeyError
-from pywikibot.tools import deprecated, classproperty, UnicodeType
+from pywikibot.tools import deprecated, classproperty
_logger = 'wiki'
-class LogDict(dict):
+class LogEntry(UserDict):
+ """Generic log entry.
+
+ LogEntry parameters may be retrieved by the corresponding method
+ or the LogEntry key. The following statements are equivalent:
+
+ action = logentry.action()
+ action = logentry['action']
+ action = logentry.data['action']
"""
- Simple custom dict that raises custom Errors when a key is missing.
-
- HiddenKeyError is raised when the user does not have permission.
- KeyError is raised otherwise.
-
- It also logs debugging information when a key is missing.
- """
-
- def __missing__(self, key):
- """Debug when the key is missing."""
- pywikibot.debug('API log entry received:\n' + repr(self),
- _logger)
- if ((key in ('ns', 'title', 'pageid', 'logpage', 'params', 'action')
- and 'actionhidden' in self)
- or (key == 'comment' and 'commenthidden' in self)
- or (key == 'user' and 'userhidden' in self)):
- raise HiddenKeyError(
- "Log entry ({0}) has a hidden '{1}' key and you don't have "
- 'permission to view it.'.format(self._type, key))
- raise KeyError("Log entry (%s) has no '%s' key" % (self._type, key))
-
-
-class LogEntry(object):
-
- """Generic log entry."""
# Log type expected. None for every type, or one of the (letype) str :
# block/patrol/etc...
@@ -50,13 +33,32 @@
def __init__(self, apidata, site):
"""Initialize object from a logevent dict returned by MW API."""
- self.data = LogDict(apidata)
+ super(LogEntry, self).__init__(apidata)
self.site = site
expected_type = self._expected_type
if expected_type is not None and expected_type != self.type():
raise Error('Wrong log type! Expecting %s, received %s instead.'
% (expected_type, self.type()))
- self.data._type = self.type()
+
+ def __missing__(self, key):
+ """Debug when the key is missing.
+
+ HiddenKeyError is raised when the user does not have permission.
+ KeyError is raised otherwise.
+
+ It also logs debugging information when a key is missing.
+ """
+ pywikibot.debug('API log entry received:\n' + repr(self),
+ _logger)
+ hidden = {'action', 'logpage', 'ns', 'pageid', 'params', 'title'}
+ if ((key in hidden and 'actionhidden' in self)
+ or (key == 'comment' and 'commenthidden' in self)
+ or (key == 'user' and 'userhidden' in self)):
+ raise HiddenKeyError(
+ "Log entry ({}) has a hidden '{}' key and you don't have "
+ 'permission to view it.'.format(self['type'], key))
+ raise KeyError("Log entry ({}) has no '{}' key"
+ .format(self['type'], key))
def __repr__(self):
"""Return a string representation of LogEntry object."""
@@ -76,9 +78,13 @@
return False
return self.logid() == other.logid() and self.site == other.site
- def __ne__(self, other):
- """Compare if self is not equal to other."""
- return not self == other
+ def __getattr__(self, item):
+ """Return several items from dict used as methods."""
+ if item in ('action', 'comment', 'logid', 'ns', 'pageid', 'type',
+ 'user'): # TODO use specific User class for 'user'?
+ return lambda: self[item]
+
+ return super(LogEntry, self).__getattribute__(item)
@property
def _params(self):
@@ -87,22 +93,10 @@
@rtype: dict or None
"""
- if 'params' in self.data:
- return self.data['params']
+ if 'params' in self:
+ return self['params']
else: # try old mw style preceding mw 1.19
- return self.data[self._expected_type]
-
- def logid(self):
- """Return the id of the log entry."""
- return self.data['logid']
-
- def pageid(self):
- """Return the log id of the page handled by this log entry."""
- return self.data['pageid']
-
- def ns(self):
- """Return the namespace id of the page handled by this log entry."""
- return self.data['ns']
+ return self[self._expected_type]
@deprecated('page()', since='20150617')
def title(self):
@@ -122,36 +116,16 @@
@rtype: pywikibot.Page
"""
if not hasattr(self, '_page'):
- self._page = pywikibot.Page(self.site, self.data['title'])
+ self._page = pywikibot.Page(self.site, self['title'])
return self._page
- def type(self):
- """The type of this logentry."""
- return self.data['type']
-
- def action(self):
- """The action of this log entry."""
- return self.data['action']
-
- def user(self):
- """Return the user name doing this action."""
- # TODO use specific User class ?
- return self.data['user']
-
def timestamp(self):
"""Timestamp object corresponding to event timestamp."""
if not hasattr(self, '_timestamp'):
self._timestamp = pywikibot.Timestamp.fromISOformat(
- self.data['timestamp'])
+ self['timestamp'])
return self._timestamp
- def comment(self):
- """Return the logentry's comment.
-
- @rtype: str
- """
- return self.data['comment']
-
class OtherLogEntry(LogEntry):
@@ -174,7 +148,7 @@
@rtype: pywikibot.User
"""
if not hasattr(self, '_page'):
- self._page = pywikibot.User(self.site, self.data['title'])
+ self._page = pywikibot.User(self.site, self['title'])
return self._page
@@ -194,10 +168,10 @@
super(BlockEntry, self).__init__(apidata, site)
# When an autoblock is removed, the "title" field is not a page title
# See bug T19781
- pos = self.data['title'].find('#')
+ pos = self['title'].find('#')
self.isAutoblockRemoval = pos > 0
if self.isAutoblockRemoval:
- self._blockid = int(self.data['title'][pos + 1:])
+ self._blockid = int(self['title'][pos + 1:])
def page(self):
"""
@@ -228,7 +202,7 @@
if not hasattr(self, '_flags'):
self._flags = self._params['flags']
# pre mw 1.19 returned a delimited string.
- if isinstance(self._flags, UnicodeType):
+ if isinstance(self._flags, str):
if self._flags:
self._flags = self._flags.split(',')
else:
@@ -300,7 +274,7 @@
@rtype: pywikibot.FilePage
"""
if not hasattr(self, '_page'):
- self._page = pywikibot.FilePage(self.site, self.data['title'])
+ self._page = pywikibot.FilePage(self.site, self['title'])
return self._page
diff --git a/tests/logentries_tests.py b/tests/logentries_tests.py
index 37a376a..6d8ce78 100644
--- a/tests/logentries_tests.py
+++ b/tests/logentries_tests.py
@@ -5,8 +5,6 @@
#
# Distributed under the terms of the MIT license.
#
-from __future__ import absolute_import, division, unicode_literals
-
import datetime
import pywikibot
@@ -20,7 +18,6 @@
from tests.aspects import (
unittest, MetaTestCaseClass, TestCase, DeprecationTestCase
)
-from tests.utils import add_metaclass
class TestLogentriesBase(TestCase):
@@ -67,13 +64,17 @@
logentry = self._get_logentry(logtype)
self.assertIn(logtype, logentry.__class__.__name__.lower())
self.assertEqual(logentry._expected_type, logtype)
+
if logtype not in LogEntryFactory._logtypes:
self.assertIsInstance(logentry, OtherLogEntry)
+
if self.site_key == 'old':
self.assertNotIn('params', logentry.data)
else:
self.assertNotIn(logentry.type(), logentry.data)
+
self.assertIsInstance(logentry.action(), UnicodeType)
+
try:
self.assertIsInstance(logentry.comment(), UnicodeType)
except HiddenKeyError as e:
@@ -83,11 +84,21 @@
r"don't have permission to view it\.")
except KeyError as e:
self.assertRegex(str(e), "Log entry ([^)]+) has no 'comment' key")
+ else:
+ self.assertEqual(logentry.comment(), logentry['comment'])
+
self.assertIsInstance(logentry.logid(), int)
self.assertIsInstance(logentry.timestamp(), pywikibot.Timestamp)
+
if 'title' in logentry.data: # title may be missing
self.assertIsInstance(logentry.ns(), int)
self.assertIsInstance(logentry.pageid(), int)
+
+ # test new UserDict style
+ self.assertEqual(logentry.data['title'], logentry['title'])
+ self.assertEqual(logentry.ns(), logentry['ns'])
+ self.assertEqual(logentry.pageid(), logentry['pageid'])
+
self.assertGreaterEqual(logentry.ns(), -2)
self.assertGreaterEqual(logentry.pageid(), 0)
if logtype == 'block' and logentry.isAutoblockRemoval:
@@ -100,10 +111,16 @@
self.assertIsInstance(logentry.page(), pywikibot.Page)
else:
self.assertRaises(KeyError, logentry.page)
+
self.assertEqual(logentry.type(), logtype)
self.assertIsInstance(logentry.user(), UnicodeType)
self.assertGreaterEqual(logentry.logid(), 0)
+ # test new UserDict style
+ self.assertEqual(logentry.type(), logentry['type'])
+ self.assertEqual(logentry.user(), logentry['user'])
+ self.assertEqual(logentry.logid(), logentry['logid'])
+
class TestLogentriesMeta(MetaTestCaseClass):
@@ -128,13 +145,10 @@
return super(TestLogentriesMeta, cls).__new__(cls, name, bases, dct)
-@add_metaclass
-class TestLogentries(TestLogentriesBase):
+class TestLogentries(TestLogentriesBase, metaclass=TestLogentriesMeta):
"""Test general LogEntry properties."""
- __metaclass__ = TestLogentriesMeta
-
class TestSimpleLogentries(TestLogentriesBase):
To view, visit change 576912. To unsubscribe, or for help writing mail filters, visit settings.