jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/843508 )
Change subject: [IMPR] Allow all Site.categorymembers() parameters for Category.members()
......................................................................
[IMPR] Allow all Site.categorymembers() parameters for Category.members()
- enable all parameters of Site.categorymembers() with
Category.members() method
- call Category.members() to implement Category.articles to prevent
code duplication
Change-Id: I85be8e7730430e7d8e20b230866858e03d347203
---
M pywikibot/page/_category.py
1 file changed, 48 insertions(+), 45 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/page/_category.py b/pywikibot/page/_category.py
index 69bdf0d..f94b8bd 100644
--- a/pywikibot/page/_category.py
+++ b/pywikibot/page/_category.py
@@ -121,7 +121,6 @@
def articles(self, *,
recurse: Union[int, bool] = False,
- total: Optional[int] = None,
**kwargs: Any) -> Iterable[Page]:
"""
Yield all articles in the current category.
@@ -142,29 +141,62 @@
3
4
- .. versionchanged:: 8.0.0
+ .. versionchanged:: 8.0
all parameters are keyword arguments only.
:param recurse: if not False or 0, also iterate articles in
subcategories. If an int, limit recursion to this number of
levels. (Example: ``recurse=1`` will iterate articles in
first-level subcats, but no deeper.)
+ :param kwargs: Additional parameters. Refer to
+ :meth:`APISite.categorymembers()
+ <pywikibot.site._generators.GeneratorsMixin.categorymembers>`
+ for complete list (*member_type* excluded).
+ """
+ if kwargs.pop('member_type', False):
+ raise TypeError(
+ "articles() got an unexpected keyword argument 'member_type'")
+
+ return self.members(
+ member_type=['page', 'file'], recurse=recurse, **kwargs)
+
+ def members(self, *,
+ recurse: bool = False,
+ total: Optional[int] = None,
+ **kwargs: Any) -> Iterable[Page]:
+ """Yield all category contents (subcats, pages, and files).
+
+ **Usage:**
+
+ >>> site = pywikibot.Site('wikipedia:test')
+ >>> cat = pywikibot.Category(site, 'Pywikibot')
+ >>> list(cat.members(member_type='subcat'))
+ [Category('Category:Subpage testing')]
+ >>> list(cat.members(member_type=['page', 'file']))
+ [Page('Pywikibot nobots test')]
+
+ Calling this method with ``member_type='subcat'`` is *almost*
+ equal to calling :meth:`subcategories`. Calling this method with
+ ``member_type=['page', 'file']`` is equal to calling
+ :meth:`articles`.
+
+ .. versionchanged:: 8.0
+ all parameters are keyword arguments only. Additional
+ parameters are supported.
+
+ :param recurse: if not False or 0, also iterate articles in
+ subcategories. If an int, limit recursion to this number of
+ levels. (Example: ``recurse=1`` will iterate articles in
+ first-level subcats, but no deeper.)
:param total: iterate no more than this number of pages in
total (at all levels)
:param kwargs: Additional parameters. Refer to
:meth:`APISite.categorymembers()
<pywikibot.site._generators.GeneratorsMixin.categorymembers>`
- for complete list (*member_type* excluded).
+ for complete list.
"""
- if kwargs.pop('member_type', False):
- raise TypeError(
- "articles() got an unexpected keyword argument 'member_type'")
-
seen = set()
- for member in self.site.categorymembers(self,
- total=total,
- member_type=['page', 'file'],
- **kwargs):
+ for member in self.site.categorymembers(self, total=total, **kwargs):
if recurse:
seen.add(hash(member))
yield member
@@ -176,45 +208,16 @@
if recurse:
if not isinstance(recurse, bool) and recurse:
recurse -= 1
+
for subcat in self.subcategories():
- for article in subcat.articles(recurse=recurse,
- total=total,
- **kwargs):
- hash_value = hash(article)
+ for member in subcat.members(
+ recurse=recurse, total=total, **kwargs):
+ hash_value = hash(member)
if hash_value in seen:
continue
seen.add(hash_value)
- yield article
- if total is None:
- continue
-
- total -= 1
- if total == 0:
- return
-
- def members(self, recurse: bool = False,
- namespaces=None,
- total: Optional[int] = None,
- content: bool = False):
- """Yield all category contents (subcats, pages, and files).
-
- :rtype: typing.Iterable[pywikibot.Page]
- """
- for member in self.site.categorymembers(
- self, namespaces=namespaces, total=total, content=content):
- yield member
- if total is not None:
- total -= 1
- if total == 0:
- return
- if recurse:
- if not isinstance(recurse, bool) and recurse:
- recurse -= 1
- for subcat in self.subcategories():
- for article in subcat.members(
- recurse, namespaces, total=total, content=content):
- yield article
+ yield member
if total is None:
continue
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/843508
To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I85be8e7730430e7d8e20b230866858e03d347203
Gerrit-Change-Number: 843508
Gerrit-PatchSet: 9
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged