jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/536620 )
Change subject: [IMPR] Add ListGenerator for filearchive to site.py
......................................................................
[IMPR] Add ListGenerator for filearchive to site.py
Bug: T230196
Change-Id: Ib704dbb9536c9af116a1e985de00d5ee3a47921b
---
M pywikibot/site.py
M tests/site_tests.py
2 files changed, 108 insertions(+), 0 deletions(-)
Approvals:
Mpaa: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/site.py b/pywikibot/site.py
index f63c034..48ccbb5 100644
--- a/pywikibot/site.py
+++ b/pywikibot/site.py
@@ -4470,6 +4470,38 @@
aigen.request['gaisha1base36'] = sha1base36
return aigen
+ @deprecated_args(limit='total') # ignore falimit setting
+ def filearchive(self, start=None, end=None, reverse=False, total=None,
+ **kwargs):
+ """Iterate archived files.
+
+ Yields dict of file archive informations.
+
+ @see: U{https://www.mediawiki.org/wiki/API:filearchive}
+
+ @param start: start at this title (name need not exist)
+ @param end: end at this title (name need not exist)
+ @param reverse: if True, iterate in reverse lexigraphic order
+ @param total: maximum number of pages to retrieve in total
+ @keyword prefix: only iterate titles starting with this substring
+ @keyword sha1: only iterate image with this sha1 hash
+ @keyword sha1base36: same as sha1 but in base 36
+ @keyword prop: Image information to get. Default is timestamp
+ """
+ if start and end:
+ self.assert_valid_iter_params(self, 'filearchive', start, end,
+ reverse)
+ fagen = self._generator(api.ListGenerator,
+ type_arg='filearchive',
+ fafrom=start,
+ fato=end,
+ total=total)
+ for k, v in kwargs.items():
+ fagen.request['fa' + k] = v
+ if reverse:
+ fagen.request['fadir'] = 'descending'
+ return fagen
+
@deprecated_args(step=None)
def blocks(self, starttime=None, endtime=None, reverse=False,
blockids=None, users=None, iprange=None, total=None):
diff --git a/tests/site_tests.py b/tests/site_tests.py
index 30e1887..73b2da3 100644
--- a/tests/site_tests.py
+++ b/tests/site_tests.py
@@ -2715,6 +2715,82 @@
self.assertEqual(ll.site.family.name, 'wikipedia')
+class TestFileArchive(DeprecationTestCase):
+
+ """Test filearchive on Commons."""
+
+ family = 'commons'
+ code = 'commons'
+
+ cached = True
+
+ def test_filearchive(self):
+ """Test filearchive method."""
+ gen = self.site.filearchive(total=10)
+ self.assertNotIn('fafrom', str(gen.request))
+ self.assertNotIn('fato', str(gen.request))
+ fa = list(gen)
+ self.assertLessEqual(len(fa), 10)
+ for item in fa:
+ self.assertIsInstance(item, dict)
+ self.assertIn('id', item)
+ self.assertIn('name', item)
+ self.assertIn('ns', item)
+ self.assertIn('title', item)
+ self.assertIn('timestamp', item)
+ self.assertEqual(item['ns'], 6)
+ self.assertEqual('File:' + item['name'].replace('_', ' '),
+ item['title'])
+
+ def test_filearchive_limit(self):
+ """Test deprecated limit parameter."""
+ fa = list(self.site.filearchive(limit=10))
+ self.assertOneDeprecation()
+ self.assertLessEqual(len(fa), 10)
+
+ def test_filearchive_prefix(self):
+ """Test prefix parameter."""
+ gen = self.site.filearchive(prefix='py')
+ self.assertIn('faprefix=py', str(gen.request))
+ for item in gen:
+ self.assertTrue(item['name'].startswith('Py'))
+
+ def test_filearchive_prop(self):
+ """Test properties."""
+ gen = self.site.filearchive(prop=['sha1', 'size', 'user'], total=1)
+ self.assertIn('faprop=sha1|size|user', str(gen.request))
+ item = next(iter(gen))
+ self.assertIn('sha1', item)
+ self.assertIn('size', item)
+ self.assertIn('user', item)
+
+ def test_filearchive_reverse(self):
+ """Test reverse parameter."""
+ gen1 = self.site.filearchive(total=1)
+ gen2 = self.site.filearchive(reverse=True, total=1)
+ self.assertNotIn('fadir=', str(gen1.request))
+ self.assertIn('fadir=descending', str(gen2.request))
+ fa1 = next(iter(gen1))
+ fa2 = next(iter(gen2))
+ self.assertLess(fa1['name'], fa2['name'])
+
+ def test_filearchive_start(self):
+ """Test start/end parameters."""
+ gen = self.site.filearchive(start='py', end='wiki', total=1)
+ self.assertIn('fafrom=py', str(gen.request))
+ self.assertIn('fato=wiki', str(gen.request))
+ item = next(iter(gen))
+ self.assertGreaterEqual(item['name'], 'Py')
+
+ def test_filearchive_sha1(self):
+ """Test sha1 parameter."""
+ sha1 = '0d5a00aa774100408e60da09f5fb21f253b366f1'
+ gen = self.site.filearchive(sha1=sha1, prop='sha1', total=1)
+ self.assertIn('fasha1=' + sha1, str(gen.request))
+ item = next(iter(gen))
+ self.assertEqual(item['sha1'], sha1)
+
+
class TestWiktionarySite(TestCase):
"""Test Site Object on English Wiktionary."""
--
To view, visit https://gerrit.wikimedia.org/r/536620
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: Ib704dbb9536c9af116a1e985de00d5ee3a47921b
Gerrit-Change-Number: 536620
Gerrit-PatchSet: 6
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Mpaa <[email protected]>
Gerrit-Reviewer: Multichill <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot (75)
Gerrit-CC: Lokal Profil <[email protected]>
_______________________________________________
Pywikibot-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/pywikibot-commits
