Adds a revert window to lib.reverts.api and lib.reverts.database

Author: halfak

examples/lib.reverts.api.py

@@ -5,12 +5,11 @@
 from mw.api import Session
 from mw.lib import reverts
 
-
 session = Session("https://en.wikipedia.org/w/api.php")
 revisions = session.user_contribs.query(user={"PermaNoob"}, direction="newer")
 
 for rev in revisions:
-    revert = reverts.api.check_rev(session, rev)
+    revert = reverts.api.check_rev(session, rev, window=60*60*24*2)
     if revert is not None:
         print("{0} reverted {1} to {2}".format(
             revert.reverting['revid'],

mw/__init__.py

@@ -1,3 +1,3 @@
 from .types import Timestamp, Namespace
 
-__version__ = "0.4.13"
+__version__ = "0.4.14"

mw/lib/reverts/api.py

@@ -42,7 +42,7 @@ def check_rev(session, rev, **kwargs):
 
 
 def check(session, rev_id, page_id=None, radius=defaults.RADIUS,
-          before=None, properties=None):
+          before=None, window=None, properties=None):
     """
     Checks whether a revision was reverted (identity) and returns a named tuple
     of Revert(reverting, reverteds, reverted_to).
@@ -55,9 +55,14 @@ def check(session, rev_id, page_id=None, radius=defaults.RADIUS,
         page_id : int
             the ID of the page the revision occupies (slower if not provided)
         radius : int
-            a positive integer indicating the maximum number of revisions that can be reverted
+            a positive integer indicating the maximum number of revisions
+            that can be reverted
         before : :class:`mw.Timestamp`
-            if set, limits the search for *reverting* revisions to those which were saved before this timestamp
+            if set, limits the search for *reverting* revisions to those which
+            were saved before this timestamp
+        window : int
+            if set, limits the search for *reverting* revisions to those which
+            were saved within `window` seconds after the reverted edit
         properties : set( str )
             a set of properties to include in revisions (see :class:`mw.api.Revisions`)
     """
@@ -99,6 +104,9 @@ def check(session, rev_id, page_id=None, radius=defaults.RADIUS,
         # reverted.  Just return None.
         return None
 
+    if window is not None and before is None:
+        before = Timestamp(current_rev['timestamp']) + window
+
     # Load future revisions
     future_revs = session.revisions.query(
         pageids={page_id},

mw/lib/reverts/database.py

@@ -51,7 +51,8 @@ def check_row(db, rev_row, **kwargs):
     return check(db, rev_id, page_id=page_id, **kwargs)
 
 
-def check(db, rev_id, page_id=None, radius=defaults.RADIUS, check_archive=False, before=None):
+def check(db, rev_id, page_id=None, radius=defaults.RADIUS, check_archive=False,
+          before=None, window=None):
 
     """
     Checks whether a revision was reverted (identity) and returns a named tuple
@@ -70,6 +71,9 @@ def check(db, rev_id, page_id=None, radius=defaults.RADIUS, check_archive=False,
             should the archive table be checked for reverting revisions?
         before : `Timestamp`
             if set, limits the search for *reverting* revisions to those which were saved before this timestamp
+        window : int
+            if set, limits the search for *reverting* revisions to those which
+            were saved within `window` seconds after the reverted edit
     """
 
     if not hasattr(db, "revisions") and hasattr(db, "all_revisions"):
@@ -113,6 +117,9 @@ def check(db, rev_id, page_id=None, radius=defaults.RADIUS, check_archive=False,
         # reverted.  Just return None.
         return None
 
+    if window is not None and before is None:
+        before = Timestamp(current_rev['rev_timestamp']) + window
+
     # Load future revisions
     future_revs = dbrevs.query(
         page_id=page_id,

setup.py

@@ -2,11 +2,9 @@
 
 from setuptools import find_packages
 
-import mw
-
 setup(
     name='mediawiki-utilities',
-    version=mw.__version__,
+    version="0.4.14",
     author='Aaron Halfaker',
     author_email='aaron.halfaker@gmail.com',
     packages=find_packages(),