jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/416342 )

Change subject: [IMPR] Rename limit parameter for search_entities to total ......................................................................

[IMPR] Rename limit parameter for search_entities to total

- "total" parameter is used by all other generators in site.py - change site_tests and pagegenerators accordingly

Change-Id: I1168136cf22a8c3b0530b2dbd75fcf6920a89745 --- M pywikibot/pagegenerators.py M pywikibot/site.py M tests/site_tests.py 3 files changed, 8 insertions(+), 7 deletions(-)

Approvals: Framawiki: Looks good to me, approved jenkins-bot: Verified

diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index 24333a2..55a5c1b 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -2884,7 +2884,7 @@ language = site.lang repo = site.data_repository()

- data = repo.search_entities(text, language, limit=total) + data = repo.search_entities(text, language, total=total) for item in data: yield pywikibot.ItemPage(repo, item['id'])

diff --git a/pywikibot/site.py b/pywikibot/site.py index 53e7a6b..0185915 100644 --- a/pywikibot/site.py +++ b/pywikibot/site.py @@ -8094,7 +8094,8 @@ result = self.editEntity({}, data, bot=bot, **kwargs) return pywikibot.ItemPage(self, result['entity']['id'])

- def search_entities(self, search, language, limit=None, **kwargs): + @deprecated_args(limit='total') + def search_entities(self, search, language, total=None, **kwargs): """ Search for pages or properties that contain the given text.

@@ -8102,7 +8103,7 @@ @type search: str @param language: Language to search in. @type language: str - @param limit: Maximum number of pages to retrieve in total, or None in + @param total: Maximum number of pages to retrieve in total, or None in case of no limit. @type limit: int or None @return: 'search' list from API output. @@ -8124,6 +8125,6 @@ parameters = dict(search=search, language=language, **kwargs) gen = api.APIGenerator('wbsearchentities', data_name='search', site=self, parameters=parameters) - if limit is not None: - gen.set_maximum_items(limit) + if total is not None: + gen.set_maximum_items(total) return gen diff --git a/tests/site_tests.py b/tests/site_tests.py index 81700ca..1c5353e 100644 --- a/tests/site_tests.py +++ b/tests/site_tests.py @@ -3069,11 +3069,11 @@ def test_general(self): """Test basic search_entities functionality.""" datasite = self.get_repo() - pages = datasite.search_entities('abc', 'en', limit=50) + pages = datasite.search_entities('abc', 'en', total=50) self.assertGreater(len(list(pages)), 0) self.assertLessEqual(len(list(pages)), 50) pages = datasite.search_entities('alphabet', 'en', type='property', - limit=50) + total=50) self.assertGreater(len(list(pages)), 0) self.assertLessEqual(len(list(pages)), 50)