jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/489590 ) Change subject: Revert "apy.py: check if QueryGenerator support namespaces" ...................................................................... Revert "apy.py: check if QueryGenerator support namespaces" All tests are failing. This reverts commit 16182e9b1406651a132801a0a3496b1ba37d5b3f. Change-Id: Icafb1c21c9563215bc51f8dbe010db205eaf4390 --- M pywikibot/data/api.py M pywikibot/pagegenerators.py M tests/api_tests.py M tests/utils.py 4 files changed, 13 insertions(+), 124 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/data/api.py b/pywikibot/data/api.py index 16ded04..1b86cf5 100644 --- a/pywikibot/data/api.py +++ b/pywikibot/data/api.py @@ -2811,21 +2811,6 @@ self.api_limit), _logger) - def support_namespace(self): - """Check if namespace is a supported parameter on this query. - - Note: this function will be removed when self.set_namespace() will - throw TypeError() instead of just giving a warning. - See T196619. - - @return: True if yes, False otherwise - @rtype: bool - """ - assert(self.limited_module) # some modules do not have a prefix - return bool( - self.site._paraminfo.parameter('query+' + self.limited_module, - 'namespace')) - def set_namespace(self, namespaces): """Set a namespace filter on this query. @@ -2835,12 +2820,9 @@ list of namespace identifiers. An empty iterator clears any namespace restriction. @raises KeyError: a namespace identifier was not resolved - - # TODO: T196619 - # @raises TypeError: module does not support a namespace parameter - # or a namespace identifier has an inappropriate - # type such as NoneType or bool, or more than one namespace - # if the API module does not support multiple namespaces + @raises TypeError: a namespace identifier has an inappropriate + type such as NoneType or bool, or more than one namespace + if the API module does not support multiple namespaces """ assert(self.limited_module) # some modules do not have a prefix param = self.site._paraminfo.parameter('query+' + self.limited_module, @@ -2848,16 +2830,7 @@ if not param: pywikibot.warning('{0} module does not support a namespace ' 'parameter'.format(self.limited_module)) - warn('set_namespace() will be modified to raise TypeError ' - 'when namespace parameter is not supported. ' - 'It will be a Breaking Change, please update your code ' - 'ASAP, due date July, 31st 2019.', FutureWarning, 2) - - # TODO: T196619 - # raise TypeError('{0} module does not support a namespace ' - # 'parameter'.format(self.limited_module)) - - return False + return if isinstance(namespaces, basestring): namespaces = namespaces.split('|') @@ -2879,8 +2852,6 @@ elif self.prefix + 'namespace' in self.request: del self.request[self.prefix + 'namespace'] - return None - def _query_continue(self): if all(key not in self.data[self.continue_name] for key in self.continuekey): diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index e24b626..9555c39 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -14,7 +14,7 @@ &params; """ # -# (C) Pywikibot team, 2008-2019 +# (C) Pywikibot team, 2008-2018 # # Distributed under the terms of the MIT license. # @@ -504,13 +504,8 @@ for i in range(len(self.gens)): if isinstance(self.gens[i], pywikibot.data.api.QueryGenerator): - if (self.namespaces - and self.gens[i].support_namespace()): - self.gens[i].set_namespace(self.namespaces) - # QueryGenerator does not support namespace param. - else: - self.gens[i] = NamespaceFilterPageGenerator( - self.gens[i], self.namespaces, self.site) + if self.namespaces: + self.gens[i].set_namespace(self.namespaces) if self.limit: self.gens[i].set_maximum_items(self.limit) else: @@ -1018,7 +1013,8 @@ def _handle_unconnectedpages(self, value): """Handle `-unconnectedpages` argument.""" - return self.site.unconnected_pages(total=_int_none(value)) + # T196619 don't use QueryGenerator due to namespace filtering + return (p for p in self.site.unconnected_pages(total=_int_none(value))) def _handle_imagesused(self, value): """Handle `-imagesused` argument.""" diff --git a/tests/api_tests.py b/tests/api_tests.py index e4d71c1..76d5fc3 100644 --- a/tests/api_tests.py +++ b/tests/api_tests.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """API test module.""" # -# (C) Pywikibot team, 2007-2019 +# (C) Pywikibot team, 2007-2018 # # Distributed under the terms of the MIT license. # @@ -852,84 +852,6 @@ self.assertEqual(len(links), count) -class TestDryQueryGeneratorNamespaceParam(TestCase): - - """Test setting of namespace param with ListGenerator. - - Generators with different characteristics are used. - site._paraminfo is not always faithful to API, but serves the purpose - here. - """ - - family = 'wikipedia' - code = 'en' - - dry = True - - def setUp(self): - """Set up test case.""" - super(TestDryQueryGeneratorNamespaceParam, self).setUp() - self.site = self.get_site() - self.site._paraminfo['query+querypage'] = { - 'prefix': 'qp', - 'limit': {'max': 10}, - } - self.site._paraminfo['query+allpages'] = { - 'prefix': 'ap', - 'limit': {'max': 10}, - 'namespace': {'multi': True} - } - self.site._paraminfo['query+alllinks'] = { - 'prefix': 'al', - 'limit': {'max': 10}, - 'namespace': {'default': 0} - } - self.site._paraminfo['query+links'] = { - 'prefix': 'pl', - } - self.site._paraminfo.query_modules_with_limits = {'querypage', - 'allpages', - 'alllinks'} - - def test_namespace_for_module_with_no_limit(self): - """Test PageGenerator set_namespace.""" - self.gen = api.PageGenerator(site=self.site, - generator='links', - parameters={'titles': 'test'}) - self.assertRaises(AssertionError, self.gen.set_namespace, 0) - self.assertRaises(AssertionError, self.gen.set_namespace, 1) - self.assertRaises(AssertionError, self.gen.set_namespace, None) - - def test_namespace_param_is_not_settable(self): - """Test ListGenerator support_namespace.""" - self.gen = api.ListGenerator(listaction='querypage', site=self.site) - self.assertFalse(self.gen.support_namespace()) - self.assertFalse(self.gen.set_namespace([0, 1])) - - def test_namespace_none(self): - """Test ListGenerator set_namespace with None.""" - self.gen = api.ListGenerator(listaction='alllinks', site=self.site) - self.assertRaises(TypeError, self.gen.set_namespace, None) - - def test_namespace_non_multi(self): - """Test ListGenerator set_namespace when non multi.""" - self.gen = api.ListGenerator(listaction='alllinks', site=self.site) - self.assertRaises(TypeError, self.gen.set_namespace, [0, 1]) - self.assertIsNone(self.gen.set_namespace(0)) - - def test_namespace_multi(self): - """Test ListGenerator set_namespace when multi.""" - self.gen = api.ListGenerator(listaction='allpages', site=self.site) - self.assertTrue(self.gen.support_namespace()) - self.assertIsNone(self.gen.set_namespace([0, 1])) - - def test_namespace_resolve_failed(self): - """Test ListGenerator set_namespace when resolve fails.""" - self.gen = api.ListGenerator(listaction='allpages', site=self.site) - self.assertTrue(self.gen.support_namespace()) - self.assertRaises(KeyError, self.gen.set_namespace, 10000) - - class TestDryListGenerator(TestCase): """Test ListGenerator.""" @@ -957,7 +879,7 @@ def test_namespace_zero(self): """Test ListGenerator set_namespace with 0.""" - self.assertIsNone(self.gen.set_namespace(0)) + self.gen.set_namespace(0) class TestCachedRequest(DefaultSiteTestCase): diff --git a/tests/utils.py b/tests/utils.py index 5819f8d..c0ce35b 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """Test utilities.""" # -# (C) Pywikibot team, 2013-2019 +# (C) Pywikibot team, 2013-2018 # # Distributed under the terms of the MIT license. # @@ -317,7 +317,7 @@ def parameter(self, module, param_name): """Load dry data.""" - return self[module].get(param_name) + return self[module][param_name] def __getitem__(self, name): """Return dry data or a dummy parameter block.""" -- To view, visit https://gerrit.wikimedia.org/r/489590 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: Icafb1c21c9563215bc51f8dbe010db205eaf4390 Gerrit-Change-Number: 489590 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Framawiki <framawiki(a)tools.wmflabs.org> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: Multichill <maarten(a)mdammers.nl> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: Zhuyifei1999 <zhuyifei1999(a)gmail.com> Gerrit-Reviewer: jenkins-bot (75)