Pywikibot-commits December 2024

pywikibot-commits@lists.wikimedia.org

1 participants
114 discussions

[Gerrit] ...core[master]: doc: adjust classproperty docstrings for Python 3.12 and below
by Xqt (Code Review) 02 Dec '24

02 Dec '24

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099734?usp=email ) Change subject: doc: adjust classproperty docstrings for Python 3.12 and below ...................................................................... doc: adjust classproperty docstrings for Python 3.12 and below Bug: T381279 Change-Id: I22706940b1fc4f8ab401313495ff923cc6e9a634 --- M pywikibot/tools/__init__.py 1 file changed, 11 insertions(+), 3 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 7375d0d..d36f52c 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -180,11 +180,19 @@ """Initializer: hold the class method and documentation.""" self.method = cls_method self.__annotations__ = self.method.__annotations__ - self.__doc__ = (':class:`classproperty<tools.classproperty>` ' - f'{self.method.__doc__}') + doc = self.method.__doc__ + self.__doc__ = f':class:`classproperty<tools.classproperty>` {doc}' + rtype = self.__annotations__.get('return') if rtype: - self.__doc__ += f'\n\n:rtype: {rtype}' + lines = doc.splitlines() + + if len(lines) > 2 and PYTHON_VERSION < (3, 13): + spaces = ' ' * re.search('[^ ]', lines[2]).start() + else: + spaces = '' + + self.__doc__ += f'\n{spaces}:rtype: {rtype}' def __get__(self, instance, owner): """Get the attribute of the owner class by its method.""" -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099734?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I22706940b1fc4f8ab401313495ff923cc6e9a634 Gerrit-Change-Number: 1099734 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: Add support for new wiki
by Meno25 (Code Review) 02 Dec '24

02 Dec '24

Meno25 has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099688?usp=email ) Change subject: Add support for new wiki ...................................................................... Add support for new wiki * idwikivoyage Bug: T381082 Change-Id: Ie097cf346093a7057776738cc002d477daa82102 --- M pywikibot/families/wikivoyage_family.py 1 file changed, 2 insertions(+), 2 deletions(-) Approvals: Meno25: Verified; Looks good to me, approved diff --git a/pywikibot/families/wikivoyage_family.py b/pywikibot/families/wikivoyage_family.py index bc541fc..9f0b942 100644 --- a/pywikibot/families/wikivoyage_family.py +++ b/pywikibot/families/wikivoyage_family.py @@ -18,8 +18,8 @@ codes = { 'bn', 'cs', 'de', 'el', 'en', 'eo', 'es', 'fa', 'fi', 'fr', 'he', 'hi', - 'it', 'ja', 'nl', 'pl', 'ps', 'pt', 'ro', 'ru', 'shn', 'sv', 'tr', - 'uk', 'vi', 'zh', + 'id', 'it', 'ja', 'nl', 'pl', 'ps', 'pt', 'ro', 'ru', 'shn', 'sv', + 'tr', 'uk', 'vi', 'zh', } category_redirect_templates = { -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099688?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Ie097cf346093a7057776738cc002d477daa82102 Gerrit-Change-Number: 1099688 Gerrit-PatchSet: 2 Gerrit-Owner: Meno25 <meno25mail(a)gmail.com> Gerrit-Reviewer: Meno25 <meno25mail(a)gmail.com> Gerrit-Reviewer: jenkins-bot Gerrit-CC: Xqt <info(a)gno.de>

1 0

[Gerrit] ...core[master]: doc: Remove duplicate family.Family entry
by Xqt (Code Review) 02 Dec '24

02 Dec '24

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099641?usp=email ) Change subject: doc: Remove duplicate family.Family entry ...................................................................... doc: Remove duplicate family.Family entry Change-Id: I355ee2ad8d5d3e91b406721e3efeae77c520495d --- M docs/api_ref/family.rst 1 file changed, 1 insertion(+), 0 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/docs/api_ref/family.rst b/docs/api_ref/family.rst index 9717a19..314d96a 100644 --- a/docs/api_ref/family.rst +++ b/docs/api_ref/family.rst @@ -4,6 +4,7 @@ .. automodule:: family :synopsis: Objects representing MediaWiki families + :exclude-members: Family .. autoclass:: Family -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099641?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I355ee2ad8d5d3e91b406721e3efeae77c520495d Gerrit-Change-Number: 1099641 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: doc: Enable docstring with classproperty methods
by Xqt (Code Review) 01 Dec '24

01 Dec '24

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099361?usp=email ) Change subject: doc: Enable docstring with classproperty methods ...................................................................... doc: Enable docstring with classproperty methods - modify docstring of classproperty methods to show a preleading classproperty and add rtype if present. - return the modified decorator class when Sphinx is running. Bug: T380628 Change-Id: Ie44c9f89d34e7cf4aec332daf8cbed9b30ac0dc8 --- M pywikibot/tools/__init__.py 1 file changed, 10 insertions(+), 2 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 298f095..7375d0d 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -177,12 +177,20 @@ """ def __init__(self, cls_method) -> None: - """Hold the class method.""" + """Initializer: hold the class method and documentation.""" self.method = cls_method - self.__doc__ = self.method.__doc__ + self.__annotations__ = self.method.__annotations__ + self.__doc__ = (':class:`classproperty<tools.classproperty>` ' + f'{self.method.__doc__}') + rtype = self.__annotations__.get('return') + if rtype: + self.__doc__ += f'\n\n:rtype: {rtype}' def __get__(self, instance, owner): """Get the attribute of the owner class by its method.""" + if SPHINX_RUNNING: + return self + return self.method(owner) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1099361?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Ie44c9f89d34e7cf4aec332daf8cbed9b30ac0dc8 Gerrit-Change-Number: 1099361 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits December 2024