Pywikibot-commits October 2025

pywikibot-commits@lists.wikimedia.org

1 participants
77 discussions

[Gerrit] ...core[master]: [bugfix] remove U+9676 replacement
by jenkins-bot (Code Review) 09 Oct '25

09 Oct '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193418?usp=email ) Change subject: [bugfix] remove U+9676 replacement ...................................................................... [bugfix] remove U+9676 replacement The U+9676 replacement in transliteration._trans dict is the last one of a group of replacements made in compat release but isn't usefull for the same key. Finally there is a direct replacement made in transliterate method. Therefore remove it from dict and keep the later. Also - use umlauts for 'ö' and 'ü' like in 'ä' - remove replacement für 'C' (U+67) which is an ASCII char - split extended latin to IPA ans PUA - use positional-only argument for char - use keyword-only arguments for prev and succ parameters - some tests added Change-Id: I9448a2801d6110992d3f380f0ef6b9a501c3a515 --- M pywikibot/userinterfaces/transliteration.py M tests/ui_tests.py 2 files changed, 53 insertions(+), 19 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/userinterfaces/transliteration.py b/pywikibot/userinterfaces/transliteration.py index 7e297d2..94179b4 100644 --- a/pywikibot/userinterfaces/transliteration.py +++ b/pywikibot/userinterfaces/transliteration.py @@ -6,7 +6,11 @@ # from __future__ import annotations -from pywikibot.tools import ModuleDeprecationWrapper, deprecate_arg +from pywikibot.tools import ( + ModuleDeprecationWrapper, + deprecate_arg, + deprecated_signature, +) #: Non ascii digits used by the framework @@ -70,11 +74,11 @@ 'Ṉ': 'N', 'Ṋ': 'N', 'Ɲ': 'N', 'ɲ': 'n', 'Ƞ': 'N', 'ǹ': 'n', 'ń': 'n', 'ñ': 'n', 'ņ': 'n', 'ň': 'n', 'ṅ': 'n', 'ṇ': 'n', 'ṉ': 'n', 'ṋ': 'n', 'ƞ': 'n', 'Ò': 'O', 'Ó': 'O', 'Ô': 'O', 'Õ': 'O', 'Ṍ': 'O', 'Ṏ': 'O', - 'Ȭ': 'O', 'Ö': 'O', 'Ō': 'O', 'Ṑ': 'O', 'Ṓ': 'O', 'Ŏ': 'O', 'Ǒ': 'O', + 'Ȭ': 'O', 'Ö': 'Oe', 'Ō': 'O', 'Ṑ': 'O', 'Ṓ': 'O', 'Ŏ': 'O', 'Ǒ': 'O', 'Ȯ': 'O', 'Ȱ': 'O', 'Ọ': 'O', 'Ǫ': 'O', 'Ǭ': 'O', 'Ơ': 'O', 'Ờ': 'O', 'Ớ': 'O', 'Ỡ': 'O', 'Ợ': 'O', 'Ở': 'O', 'Ỏ': 'O', 'Ɵ': 'O', 'Ø': 'O', 'Ǿ': 'O', 'ò': 'o', 'ó': 'o', 'ô': 'o', 'õ': 'o', 'ṍ': 'o', 'ṏ': 'o', - 'ȭ': 'o', 'ö': 'o', 'ō': 'o', 'ṑ': 'o', 'ṓ': 'o', 'ŏ': 'o', 'ǒ': 'o', + 'ȭ': 'o', 'ö': 'oe', 'ō': 'o', 'ṑ': 'o', 'ṓ': 'o', 'ŏ': 'o', 'ǒ': 'o', 'ȯ': 'o', 'ȱ': 'o', 'ọ': 'o', 'ǫ': 'o', 'ǭ': 'o', 'ơ': 'o', 'ờ': 'o', 'ớ': 'o', 'ỡ': 'o', 'ợ': 'o', 'ở': 'o', 'ỏ': 'o', 'ɵ': 'o', 'ø': 'o', 'ǿ': 'o', 'Ȍ': 'Ö', 'Ő': 'Ö', 'Ȫ': 'Ö', 'ȍ': 'ö', 'ő': 'ö', 'ȫ': 'ö', @@ -90,10 +94,10 @@ 'Ṭ': 'T', 'Ṯ': 'T', 'Ṱ': 'T', 'Ŧ': 'T', 'Ƭ': 'T', 'Ʈ': 'T', 'ţ': 't', 'ț': 't', 'ť': 't', 'ṫ': 't', 'ṭ': 't', 'ṯ': 't', 'ṱ': 't', 'ŧ': 't', 'Ⱦ': 't', 'ƭ': 't', 'ʈ': 't', 'Ù': 'U', 'Ú': 'U', 'Ũ': 'U', 'Ṹ': 'U', - 'Ṵ': 'U', 'Ü': 'U', 'Ṳ': 'U', 'Ū': 'U', 'Ṻ': 'U', 'Ŭ': 'U', 'Ụ': 'U', + 'Ṵ': 'U', 'Ü': 'Ue', 'Ṳ': 'U', 'Ū': 'U', 'Ṻ': 'U', 'Ŭ': 'U', 'Ụ': 'U', 'Ů': 'U', 'Ų': 'U', 'Ǔ': 'U', 'Ṷ': 'U', 'Ủ': 'U', 'Ư': 'U', 'Ữ': 'U', 'Ự': 'U', 'Ử': 'U', 'ù': 'u', 'ú': 'u', 'ũ': 'u', 'ṹ': 'u', 'ṵ': 'u', - 'ü': 'u', 'ṳ': 'u', 'ū': 'u', 'ṻ': 'u', 'ŭ': 'u', 'ụ': 'u', 'ů': 'u', + 'ü': 'ue', 'ṳ': 'u', 'ū': 'u', 'ṻ': 'u', 'ŭ': 'u', 'ụ': 'u', 'ů': 'u', 'ų': 'u', 'ǔ': 'u', 'ṷ': 'u', 'ủ': 'u', 'ư': 'u', 'ữ': 'u', 'ự': 'u', 'ử': 'u', 'Ȕ': 'Ü', 'Ű': 'Ü', 'Ǜ': 'Ü', 'Ǘ': 'Ü', 'Ǖ': 'Ü', 'Ǚ': 'Ü', 'ȕ': 'ü', 'ű': 'ü', 'ǜ': 'ü', 'ǘ': 'ü', 'ǖ': 'ü', 'ǚ': 'ü', 'Û': 'Ux', @@ -113,12 +117,14 @@ 'Ƣ': 'G', 'ᵷ': 'g', 'ɣ': 'g', 'ƣ': 'g', 'ᵹ': 'g', 'Ƅ': 'H', 'ƅ': 'h', 'Ƕ': 'Wh', 'ƕ': 'wh', 'Ɩ': 'I', 'ɩ': 'i', 'Ŋ': 'Ng', 'ŋ': 'ng', 'Œ': 'OE', 'œ': 'oe', 'Ɔ': 'O', 'ɔ': 'o', 'Ȣ': 'Ou', 'ȣ': 'ou', 'Ƽ': 'Q', 'ĸ': 'q', - 'ƽ': 'q', 'ȹ': 'qp', '\uf20e': 'r', 'ſ': 's', 'ß': 'ss', 'Ʃ': 'Sh', - 'ʃ': 'sh', 'ᶋ': 'sh', 'Ʉ': 'U', 'ʉ': 'u', 'Ʌ': 'V', 'ʌ': 'v', 'Ɯ': 'W', - 'Ƿ': 'W', 'ɯ': 'w', 'ƿ': 'w', 'Ȝ': 'Y', 'ȝ': 'y', 'Ĳ': 'IJ', 'ĳ': 'ij', - 'Ƨ': 'Z', 'ʮ': 'z', 'ƨ': 'z', 'Ʒ': 'Zh', 'ʒ': 'zh', 'Ǯ': 'Dzh', 'ǯ': 'dzh', - 'Ƹ': "'", 'ƹ': "'", 'ʔ': "'", 'ˀ': "'", 'Ɂ': "'", 'ɂ': "'", 'Þ': 'Th', - 'þ': 'th', 'C': '!', 'ʗ': '!', 'ǃ': '!', + 'ƽ': 'q', 'ȹ': 'qp', 'ſ': 's', 'ß': 'ss', 'Ĳ': 'IJ', 'ĳ': 'ij', 'Ɯ': 'W', + 'Ƿ': 'W', 'ƿ': 'w', 'Ȝ': 'Y', 'ȝ': 'y', 'Ƨ': 'Z', 'ƨ': 'z', 'Ʒ': 'Zh', + 'ʒ': 'zh', 'Ǯ': 'Dzh', 'ǯ': 'dzh', 'Þ': 'Th', 'þ': 'th', + # International Phonetic Alphabet + 'ʃ': 'sh', 'ᶋ': 'sh', 'Ʉ': 'U', 'ʉ': 'u', 'Ʌ': 'V', 'ʌ': 'v', 'ʔ': "'", + 'ˀ': "'", 'Ɂ': "'", 'ɂ': "'", 'ʗ': '!', 'ǃ': '!', 'Ƹ': "'", 'ƹ': "'", + # Private Use Area + '': 'r', # Punctuation and typography '«': '"', '»': '"', '“': '"', '”': '"', '„': '"', '¨': '"', '‘': "'", '’': "'", '′': "'", '@': '(at)', '¤': '$', '¢': 'c', '€': 'E', '£': 'L', @@ -193,7 +199,6 @@ 'ى': 'á', 'ﻯ': 'á', 'ﻰ': 'á', 'ﯼ': 'y', 'ﯽ': 'y', 'ﯿ': 'y', 'ﯾ': 'y', 'ﻻ': 'la', 'ﻼ': 'la', 'ﷲ': 'llah', 'إ': "a'", 'أ': "a'", 'ؤ': "w'", 'ئ': "y'", - '◌': 'iy', # indicates absence of vowels # Perso-Arabic 'پ': 'p', 'ﭙ': 'p', 'چ': 'ch', 'ژ': 'zh', 'گ': 'g', 'ﮔ': 'g', 'ﮕ': 'g', 'ﮓ': 'g', @@ -1117,23 +1122,29 @@ continue while (value.encode(encoding, 'replace').decode(encoding) == '?' and value in trans): - value = trans[value] + value = trans[value] # pragma: no cover trans[char] = value self.trans = trans @deprecate_arg('next', 'succ') # since 9.0 - def transliterate(self, char: str, default: str = '?', + @deprecated_signature(since='10.6.0') + def transliterate(self, char: str, /, default: str = '?', *, prev: str = '-', succ: str = '-') -> str: """Transliterate the character. .. versionchanged:: 9.0 *next* parameter was renamed to *succ*. + .. versionchanged:: 10.6 + *char* argument is positional only; *prev* and *succ* + arguments are keyword only. :param char: The character to transliterate. - :param default: The character used when there is no transliteration. + :param default: The character used when there is no + transliteration. :param prev: The previous character :param succ: The succeeding character - :return: The transliterated character which may be an empty string + :return: The transliterated character which may be an empty + string """ result = default if char in self.trans: diff --git a/tests/ui_tests.py b/tests/ui_tests.py index 74da260..fabe471 100755 --- a/tests/ui_tests.py +++ b/tests/ui_tests.py @@ -13,7 +13,9 @@ import platform import unittest from contextlib import nullcontext, redirect_stdout, suppress +from functools import partial from typing import NoReturn +from unicodedata import normalize from unittest.mock import patch import pywikibot @@ -33,7 +35,11 @@ terminal_interface_unix, terminal_interface_win32, ) -from pywikibot.userinterfaces.transliteration import NON_ASCII_DIGITS, _trans +from pywikibot.userinterfaces.transliteration import ( + NON_ASCII_DIGITS, + Transliterator, + _trans, +) from tests.aspects import TestCase, TestCaseBase @@ -366,21 +372,28 @@ '\x1b[93mu\x1b[0m\x1b[93me\x1b[0m\x1b[93mo\x1b[0m\n') -class TestTransliterationTable(TestCase): +class TestTransliteration(TestCase): """Test transliteration table.""" net = False + @classmethod + def setUpClass(cls) -> None: + """Set up Transliterator function.""" + trans = Transliterator('ascii') + cls.t = staticmethod(partial(trans.transliterate, prev='P')) + def test_ascii_digits(self) -> None: """Test that non ascii digits are in transliteration table.""" for lang, digits in NON_ASCII_DIGITS.items(): with self.subTest(lang=lang): - for char in digits: + for i, char in enumerate(digits): self.assertTrue(char.isdigit()) self.assertFalse(char.isascii()) self.assertIn(char, _trans, f'{char!r} not in transliteration table') + self.assertEqual(self.t(char), str(i)) def test_transliteration_table(self) -> None: """Test transliteration table consistency.""" @@ -388,6 +401,16 @@ with self.subTest(): self.assertNotEqual(k, v) + def test_transliterator(self) -> None: + """Test Transliterator.""" + for char in 'äöü': + self.assertEqual(self.t(char), normalize('NFD', char)[0] + 'e') + self.assertEqual(self.t('1'), '?') + self.assertEqual(self.t('◌'), 'P') + self.assertEqual(self.t('ッ'), '?') + self.assertEqual(self.t('仝'), 'P') + self.assertEqual(self.t('ຫ'), 'h') + # TODO: add tests for background colors. class FakeUITest(TestCase): -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193418?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: I9448a2801d6110992d3f380f0ef6b9a501c3a515 Gerrit-Change-Number: 1193418 Gerrit-PatchSet: 7 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: IMPR: Show user-agent with version script
by jenkins-bot (Code Review) 09 Oct '25

09 Oct '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1194032?usp=email ) Change subject: IMPR: Show user-agent with version script ...................................................................... IMPR: Show user-agent with version script Bug: T406458 Change-Id: If1ed512803e4609d67e36977ba61a7a524e90844 --- M pywikibot/scripts/version.py 1 file changed, 19 insertions(+), 2 deletions(-) Approvals: D3r1ck01: Looks good to me, but someone else must approve jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/scripts/version.py b/pywikibot/scripts/version.py index 454f7f0..661432b 100755 --- a/pywikibot/scripts/version.py +++ b/pywikibot/scripts/version.py @@ -7,9 +7,24 @@ registered family .. versionchanged:: 7.0 - version script was moved to the framework scripts folder + version script was moved to the framework scripts folder. .. versionadded:: 9.1.2 - the *-nouser* option. + the *-nouser* option was added. +.. versionchanged:: 10.6 + The User-Agent string is now printed for the default site. To print + it for another site, call the ``pwb`` wrapper with the global option, + e.g.: + + pwb -site:wikipedia:test version + + .. note:: + The shown UA reflects the default config settings. It might differ + if a user-agent is passed via the *headers* parameter to + :func:`comms.http.request`, :func:`comms.http.fetch` or to + :class:`comms.eventstreams.EventStreams`. It can also differ if + :func:`comms.http.fetch` is used with *use_fake_user_agent* set to + ``True`` or to a custom UA string, or if + *fake_user_agent_exceptions* is defined in the :mod:`config` file. """ # # (C) Pywikibot team, 2007-2025 @@ -23,6 +38,7 @@ from pathlib import Path import pywikibot +from pywikibot.comms.http import user_agent from pywikibot.version import getversion @@ -93,6 +109,7 @@ pywikibot.info(' Please reinstall requests!') pywikibot.info('Python: ' + sys.version) + pywikibot.info('User-Agent: ' + user_agent(pywikibot.Site())) # check environment settings settings = {key for key in os.environ if key.startswith('PYWIKIBOT')} -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1194032?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: If1ed512803e4609d67e36977ba61a7a524e90844 Gerrit-Change-Number: 1194032 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <dalangi-ctr(a)wikimedia.org> Gerrit-Reviewer: Jon Harald Søby <jhsoby(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: Tests: Remove unused return statements in tools_deprecate_tests
by jenkins-bot (Code Review) 05 Oct '25

05 Oct '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193572?usp=email ) Change subject: Tests: Remove unused return statements in tools_deprecate_tests ...................................................................... Tests: Remove unused return statements in tools_deprecate_tests Change-Id: I73f749403f7828368a4f0fcbc7770e209ed2d576 --- M tests/tools_deprecate_tests.py 1 file changed, 0 insertions(+), 4 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/tests/tools_deprecate_tests.py b/tests/tools_deprecate_tests.py index 5657ea3..776a51d 100755 --- a/tests/tools_deprecate_tests.py +++ b/tests/tools_deprecate_tests.py @@ -76,7 +76,6 @@ @deprecated() def deprecated_func_docstring(foo=None): """DEPRECATED. Deprecated function.""" - return foo @deprecated @@ -88,7 +87,6 @@ @deprecated def deprecated_func2_docstring(foo=None): """DEPRECATED, don't use this. Deprecated function.""" - return foo @deprecated(instead='baz') @@ -118,7 +116,6 @@ @deprecated def deprecated_func_docstring_arg(foo=None): """:param foo: Foo. DEPRECATED.""" - return foo @deprecated @@ -127,7 +124,6 @@ :param foo: Foo. DEPRECATED. """ - return foo @deprecated_args(bah='foo') -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193572?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: I73f749403f7828368a4f0fcbc7770e209ed2d576 Gerrit-Change-Number: 1193572 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]: [cleanup] remove Python 2 code in aspects.py
by jenkins-bot (Code Review) 05 Oct '25

05 Oct '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193570?usp=email ) Change subject: [cleanup] remove Python 2 code in aspects.py ...................................................................... [cleanup] remove Python 2 code in aspects.py Change-Id: I788c55b803c1868041d1b3756ce102af652670a3 --- M tests/aspects.py 1 file changed, 1 insertion(+), 4 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/tests/aspects.py b/tests/aspects.py index e980ea9..4ddcc35 100644 --- a/tests/aspects.py +++ b/tests/aspects.py @@ -1542,6 +1542,7 @@ r'(; use .* instead)?\.') source_adjustment_skips = [ + unittest.case._AssertRaisesBaseContext, unittest.case._AssertRaisesContext, TestCase.assertRaises, TestCase.assertRaisesRegex, @@ -1552,10 +1553,6 @@ # Require an instead string INSTEAD = object() - # Python 3 component in the call stack of _AssertRaisesContext - if hasattr(unittest.case, '_AssertRaisesBaseContext'): - source_adjustment_skips.append(unittest.case._AssertRaisesBaseContext) - def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193570?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: I788c55b803c1868041d1b3756ce102af652670a3 Gerrit-Change-Number: 1193570 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]: [IMPR] Add return after super(UI).encounter_color() call
by jenkins-bot (Code Review) 05 Oct '25

05 Oct '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193560?usp=email ) Change subject: [IMPR] Add return after super(UI).encounter_color() call ...................................................................... [IMPR] Add return after super(UI).encounter_color() call If none of stdin, stdout, or stderr is used, Win32UI.encounter_color() calls the base class implementation. This is not critical because the base class only raises NotImplementedError. However, returning after this call is safer, since the base implementation might change in the future and 'addr' would not be defined in such a case, leading to a NameError. Change-Id: I06007e07acfe2a64c564eaa553e4e897cbcf770d --- M pywikibot/userinterfaces/terminal_interface_win32.py 1 file changed, 2 insertions(+), 1 deletion(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/userinterfaces/terminal_interface_win32.py b/pywikibot/userinterfaces/terminal_interface_win32.py index 604fb6b..1001eda 100644 --- a/pywikibot/userinterfaces/terminal_interface_win32.py +++ b/pywikibot/userinterfaces/terminal_interface_win32.py @@ -1,6 +1,6 @@ """User interface for Win32 terminals.""" # -# (C) Pywikibot team, 2003-2024 +# (C) Pywikibot team, 2003-2025 # # Distributed under the terms of the MIT license. # @@ -57,6 +57,7 @@ addr = -12 else: super().encounter_color(color, target_stream) + return from ctypes.wintypes import DWORD, HANDLE get_handle = ctypes.WINFUNCTYPE(HANDLE, DWORD)( -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193560?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: I06007e07acfe2a64c564eaa553e4e897cbcf770d Gerrit-Change-Number: 1193560 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: IMPR: rename deprecate_positional to deprecated_signature
by jenkins-bot (Code Review) 05 Oct '25

05 Oct '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193468?usp=email ) Change subject: IMPR: rename deprecate_positional to deprecated_signature ...................................................................... IMPR: rename deprecate_positional to deprecated_signature Also - deprecate keyword arguments used for positional only parameters (PEP 570) - added some tests Change-Id: I3d54e0e26d17aea0ff8c973869cf9fc57f63b2c2 --- M pywikibot/_wbtypes.py M pywikibot/daemonize.py M pywikibot/page/_basepage.py M pywikibot/site/_apisite.py M pywikibot/site/_generators.py M pywikibot/throttle.py M pywikibot/tools/__init__.py M pywikibot/tools/_deprecate.py M tests/tools_deprecate_tests.py 9 files changed, 174 insertions(+), 83 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/_wbtypes.py b/pywikibot/_wbtypes.py index 3713931..89dea48 100644 --- a/pywikibot/_wbtypes.py +++ b/pywikibot/_wbtypes.py @@ -21,7 +21,7 @@ from pywikibot.backports import Iterator from pywikibot.time import Timestamp from pywikibot.tools import ( - deprecate_positionals, + deprecated_signature, issue_deprecation_warning, remove_last_args, ) @@ -113,7 +113,7 @@ _items = ('lat', 'lon', 'entity') - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def __init__( self, lat: float, @@ -326,7 +326,7 @@ ) return self._dim - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def get_globe_item(self, repo: DataSite | None = None, *, lazy_load: bool = False) -> pywikibot.ItemPage: """Return the ItemPage corresponding to the globe. @@ -436,7 +436,7 @@ _timestr_re = re.compile( r'([-+]?\d{1,16})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z') - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def __init__( self, year: int, @@ -651,7 +651,7 @@ return self._getSecondsAdjusted() == other._getSecondsAdjusted() @classmethod - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def fromTimestr( cls, datetimestr: str, @@ -703,7 +703,7 @@ timezone=timezone, calendarmodel=calendarmodel, site=site) @classmethod - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def fromTimestamp( cls, timestamp: Timestamp, diff --git a/pywikibot/daemonize.py b/pywikibot/daemonize.py index 9bdc9e5..a00c131 100644 --- a/pywikibot/daemonize.py +++ b/pywikibot/daemonize.py @@ -64,7 +64,7 @@ from enum import IntEnum from pathlib import Path -from pywikibot.tools import deprecate_positionals +from pywikibot.tools import deprecated_signature class StandardFD(IntEnum): @@ -79,7 +79,7 @@ is_daemon = False -@deprecate_positionals(since='10.6.0') +@deprecated_signature(since='10.6.0') def daemonize(*, close_fd: bool = True, chdir: bool = True, diff --git a/pywikibot/page/_basepage.py b/pywikibot/page/_basepage.py index f10c1d1..93af7cf 100644 --- a/pywikibot/page/_basepage.py +++ b/pywikibot/page/_basepage.py @@ -38,9 +38,9 @@ from pywikibot.tools import ( ComparableMixin, cached, - deprecate_positionals, deprecated, deprecated_args, + deprecated_signature, first_upper, ) @@ -1457,7 +1457,7 @@ force=force, asynchronous=asynchronous, callback=callback, **kwargs) - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def watch( self, *, unwatch: bool = False, @@ -1660,7 +1660,7 @@ """Convenience function to get the Wikibase item of a page.""" return pywikibot.ItemPage.fromPage(self) - @deprecate_positionals(since='9.2') + @deprecated_signature(since='9.2') def templates(self, *, content: bool = False, @@ -1705,7 +1705,7 @@ return list(self._templates) - @deprecate_positionals(since='9.2') + @deprecated_signature(since='9.2') def itertemplates( self, total: int | None = None, diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index ec61c45..a796814 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -73,8 +73,8 @@ MediaWikiVersion, cached, deprecate_arg, - deprecate_positionals, deprecated, + deprecated_signature, issue_deprecation_warning, merge_unique_dicts, normalize_username, @@ -2995,7 +2995,7 @@ return req.submit() @need_right('editmywatchlist') - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def watch( self, pages: BasePage | str | list[BasePage | str], diff --git a/pywikibot/site/_generators.py b/pywikibot/site/_generators.py index 9901495..8bdc721 100644 --- a/pywikibot/site/_generators.py +++ b/pywikibot/site/_generators.py @@ -26,7 +26,7 @@ ) from pywikibot.site._decorators import need_right from pywikibot.site._namespace import NamespaceArgType -from pywikibot.tools import deprecate_arg, deprecate_positionals, is_ip_address +from pywikibot.tools import deprecate_arg, deprecated_signature, is_ip_address from pywikibot.tools.itertools import filter_unique @@ -925,7 +925,7 @@ for linkdata in pageitem['extlinks']: yield linkdata['*'] - @deprecate_positionals(since='10.4.0') + @deprecated_signature(since='10.4.0') def allpages( self, start: str = '!', *, diff --git a/pywikibot/throttle.py b/pywikibot/throttle.py index 9d8c7da..eb270fb 100644 --- a/pywikibot/throttle.py +++ b/pywikibot/throttle.py @@ -27,7 +27,7 @@ import pywikibot from pywikibot import config from pywikibot.backports import Counter as CounterType -from pywikibot.tools import deprecate_positionals, deprecated, deprecated_args +from pywikibot.tools import deprecated, deprecated_args, deprecated_signature FORMAT_LINE = '{module_id} {pid} {time} {site}\n' @@ -343,7 +343,7 @@ time.sleep(seconds) @deprecated_args(requestsize=None) # since: 10.3.0 - @deprecate_positionals(since='10.3.0') + @deprecated_signature(since='10.3.0') def __call__(self, *, requestsize: int = 1, write: bool = False) -> None: """Apply throttling based on delay rules and request type. diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index a39cb51..bfc8da1 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -29,9 +29,9 @@ add_decorated_full_name, add_full_name, deprecate_arg, - deprecate_positionals, deprecated, deprecated_args, + deprecated_signature, get_wrapper_depth, issue_deprecation_warning, manage_wrapping, @@ -55,9 +55,9 @@ 'add_decorated_full_name', 'add_full_name', 'deprecate_arg', - 'deprecate_positionals', 'deprecated', 'deprecated_args', + 'deprecated_signature', 'get_wrapper_depth', 'issue_deprecation_warning', 'manage_wrapping', diff --git a/pywikibot/tools/_deprecate.py b/pywikibot/tools/_deprecate.py index 4f6ffe9..e72f514 100644 --- a/pywikibot/tools/_deprecate.py +++ b/pywikibot/tools/_deprecate.py @@ -443,28 +443,35 @@ return decorator -def deprecate_positionals(since: str = ''): - """Decorator for methods that issues warnings for positional arguments. +def deprecated_signature(since: str = ''): + """Decorator handling deprecated changes in function or method signatures. - This decorator allows positional arguments after keyword-only - argument syntax (:pep:`3102`) but throws a ``FutureWarning``. It - automatically maps the provided positional arguments to their - corresponding keyword-only parameters before invoking the decorated - method. + This decorator supports: - The intended use is during a deprecation period in which certain - parameters should be passed as keyword-only, allowing legacy calls - to continue working with a warning rather than immediately raising a - ``TypeError``. + - Deprecation of positional arguments that have been converted to + keyword-only parameters. + - Detection of invalid keyword usage for positional-only parameters. - .. important:: This decorator is only supported for instance or - class methods. It does not work for standalone functions. + Positional-only parameters (introduced in :pep:`570`) must be passed + positionally. If such parameters are passed as keyword arguments, + this decorator will emit a ``FutureWarning`` and automatically remap + them to positional arguments for backward compatibility. + + It allows positional arguments after keyword-only syntax (:pep:`3102`) + but emits a ``FutureWarning``. Positional arguments that are now + keyword-only are automatically mapped to their corresponding + keyword parameters before the decorated function or method is + invoked. + + The intended use is during a deprecation period, allowing legacy + calls to continue working with a warning instead of raising a + ``TypeError`` immediately. Example: .. code-block:: python - @deprecate_positionals(since='9.2.0') + @deprecated_signature(since='10.6.0') def f(posarg, *, kwarg): ... @@ -473,18 +480,27 @@ This function call passes but throws a ``FutureWarning``. Without the decorator, a ``TypeError`` would be raised. - .. caution:: The decorated function must not accept ``*args``. The - sequence of keyword-only arguments must match the sequence of the - old positional parameters, otherwise argument assignment will - fail. + .. note:: + If the parameter name was changed, use :func:`deprecated_args` + first. + + .. caution:: + The decorated function must not accept ``*args``. The order of + keyword-only arguments must match the order of the old positional + parameters; otherwise, argument assignment may fail. .. versionadded:: 9.2 .. versionchanged:: 10.4 Raises ``ValueError`` if method has a ``*args`` parameter. + .. versionchanged:: 10.6 + Renamed from ``deprecate_positionals``. Adds handling of + positional-only parameters and emits warnings if they are passed + as keyword arguments. - :param since: Mandatory version string indicating when certain - positional parameters were deprecated - :raises ValueError: If the method has an *args parameter. + :param since: Mandatory version string indicating when signature + changed. + :raises TypeError: If required positional arguments are missing. + :raises ValueError: If the method has an ``*args`` parameter. """ def decorator(func): """Outer wrapper. Inspect the parameters of *func*. @@ -502,10 +518,64 @@ :return: the value returned by the decorated function or method """ + # 1. fix deprecated positional-only usage + pos_only_in_kwargs = { + name: kwargs[name] + for name, p in params.items() + if p.kind == const.POSITIONAL_ONLY and name in kwargs + } + + if pos_only_in_kwargs: + new_args: list[Any] = [] + args_repr = [] # build representation for deprecation warning + idx = 0 # index for args + + for name in arg_keys: + param = params[name] + + if param.kind != const.POSITIONAL_ONLY: + # append remaining POSITIONAL_OR_KEYWORD arguments + new_args.extend(args[idx:]) + break + + if name in pos_only_in_kwargs: + # Value was passed as keyword → use it + value = kwargs.pop(name) + args_repr.append(repr(value)) + elif idx < len(args): + # Value from original args + value = args[idx] + idx += 1 + # Add ellipsis once for original args + if name not in ('cls', 'self') and ( + not args_repr or args_repr[-1] != '...'): + args_repr.append('...') + elif param.default is not param.empty: + # Value from default → show actual value + value = param.default + args_repr.append(repr(value)) + else: + raise TypeError( + f'Missing required positional argument: {name}' + ) + + new_args.append(value) + + args = tuple(new_args) + + args_str = ', '.join(args_repr) + issue_deprecation_warning( + f'Passing positional-only arguments as keywords to ' + f"{func.__qualname__}(): {', '.join(pos_only_in_kwargs)}", + f'positional arguments like {func.__name__}({args_str})', + since=since + ) + + # 2. warn for deprecated keyword-only usage as positional if len(args) > positionals: replace_args = list(zip(arg_keys[positionals:], args[positionals:])) - pos_args = "', '".join(name for name, arg in replace_args) + pos_args = "', '".join(name for name, _ in replace_args) keyw_args = ', '.join(f'{name}={arg!r}' for name, arg in replace_args) issue_deprecation_warning( @@ -520,17 +590,25 @@ return func(*args, **kwargs) sig = inspect.signature(func) + params = sig.parameters arg_keys = list(sig.parameters) + const = inspect.Parameter # find the first KEYWORD_ONLY index + positionals = 0 for positionals, key in enumerate(arg_keys): - if sig.parameters[key].kind == inspect.Parameter.VAR_POSITIONAL: + kind = params[key].kind + + # disallow *args entirely + if kind == const.VAR_POSITIONAL: raise ValueError( f'{func.__qualname__} must not have *{key} parameter') - if sig.parameters[key].kind in (inspect.Parameter.KEYWORD_ONLY, - inspect.Parameter.VAR_KEYWORD): + # stop counting when we reach keyword-only or **kwargs + if kind in (const.KEYWORD_ONLY, const.VAR_KEYWORD): break + else: + positionals += 1 # all were positional, no keyword found return wrapper diff --git a/tests/tools_deprecate_tests.py b/tests/tools_deprecate_tests.py index 728bb6f..5657ea3 100755 --- a/tests/tools_deprecate_tests.py +++ b/tests/tools_deprecate_tests.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 """Tests for deprecation tools.""" # -# (C) Pywikibot team, 2014-2024 +# (C) Pywikibot team, 2014-2025 # # Distributed under the terms of the MIT license. # @@ -15,9 +15,9 @@ PYTHON_VERSION, add_full_name, deprecate_arg, - deprecate_positionals, deprecated, deprecated_args, + deprecated_signature, remove_last_args, ) from tests.aspects import DeprecationTestCase @@ -154,9 +154,9 @@ return foo -@deprecate_positionals() -def positionals_test_function(foo: str, *, - bar: int, baz: str = '') -> tuple[int, str]: +@deprecated_signature() +def positionals_test_function(foo: str, /, *, + bar: int, baz: str = '') -> tuple[str, int]: """Deprecating positional parameters.""" return foo + baz, bar ** 2 @@ -240,9 +240,9 @@ """Deprecating last positional parameter.""" return foo - @deprecate_positionals() - def test_method(self, foo: str, *, - bar: int = 5, baz: str = '') -> tuple[int, str]: + @deprecated_signature() + def test_method(self, foo: str, /, *, + bar: int = 5, baz: str = '') -> tuple[str, int]: """Deprecating positional parameters.""" return foo + baz, bar ** 2 @@ -613,81 +613,94 @@ " The value(s) provided for 'bar' have been dropped." ) - def test_deprecate_positionals(self) -> None: - """Test deprecation of positional parameters.""" - msg = ('Passing {param} as positional argument(s) to {func}() is ' - 'deprecated; use keyword arguments like {instead} instead.') + def test_deprecated_signature(self) -> None: + """Test deprecation of parameters signature.""" + msg1 = ('Passing {param} as positional argument(s) to {func}() is ' + 'deprecated; use keyword arguments like {instead} instead.') + msg2 = ( + 'Passing positional-only arguments as keywords to {qual}(): ' + 'foo is deprecated; ' + "use positional arguments like {func}('Pywiki') instead." + ) f = DeprecatedMethodClass().test_method - func = 'DeprecatedMethodClass.test_method' + qual = f.__qualname__ + func = f.__name__ with self.subTest(test=1): rv1, rv2 = f('Pywiki', 1, 'bot') self.assertEqual(rv1, 'Pywikibot') self.assertEqual(rv2, 1) - self.assertOneDeprecation(msg.format(param="'bar', 'baz'", - func=func, - instead="bar=1, baz='bot'")) + self.assertOneDeprecation(msg1.format(param="'bar', 'baz'", + func=qual, + instead="bar=1, baz='bot'")) with self.subTest(test=2): rv1, rv2 = f('Pywiki', 2) self.assertEqual(rv1, 'Pywiki') self.assertEqual(rv2, 4) - self.assertOneDeprecation(msg.format(param="'bar'", - func=func, - instead='bar=2')) + self.assertOneDeprecation(msg1.format(param="'bar'", + func=qual, + instead='bar=2')) with self.subTest(test=3): rv1, rv2 = f('Pywiki', 3, baz='bot') self.assertEqual(rv1, 'Pywikibot') self.assertEqual(rv2, 9) - self.assertOneDeprecation(msg.format(param="'bar'", - func=func, - instead='bar=3')) + self.assertOneDeprecation(msg1.format(param="'bar'", + func=qual, + instead='bar=3')) with self.subTest(test=4): - rv1, rv2 = f('Pywiki', bar=4) + rv1, rv2 = f(foo='Pywiki') self.assertEqual(rv1, 'Pywiki') - self.assertEqual(rv2, 16) - self.assertNoDeprecation() + self.assertEqual(rv2, 25) + self.assertOneDeprecation(msg2.format(qual=qual, func=func)) with self.subTest(test=5): - rv1, rv2 = f(foo='Pywiki') + rv1, rv2 = f('Pywiki', bar=5) self.assertEqual(rv1, 'Pywiki') self.assertEqual(rv2, 25) self.assertNoDeprecation() f = positionals_test_function - func = 'positionals_test_function' + func = f.__name__ + qual = f.__qualname__ - with self.subTest(test=6): + with self.subTest(test=1): rv1, rv2 = f('Pywiki', 6, 'bot') self.assertEqual(rv1, 'Pywikibot') self.assertEqual(rv2, 36) - self.assertOneDeprecation(msg.format(param="'bar', 'baz'", - func=func, - instead="bar=6, baz='bot'")) + self.assertOneDeprecation(msg1.format(param="'bar', 'baz'", + func=qual, + instead="bar=6, baz='bot'")) with self.subTest(test=7): rv1, rv2 = f('Pywiki', 7) self.assertEqual(rv1, 'Pywiki') self.assertEqual(rv2, 49) - self.assertOneDeprecation(msg.format(param="'bar'", - func=func, - instead='bar=7')) + self.assertOneDeprecation(msg1.format(param="'bar'", + func=qual, + instead='bar=7')) with self.subTest(test=8): rv1, rv2 = f('Pywiki', 8, baz='bot') self.assertEqual(rv1, 'Pywikibot') self.assertEqual(rv2, 64) - self.assertOneDeprecation(msg.format(param="'bar'", - func=func, - instead='bar=8')) + self.assertOneDeprecation(msg1.format(param="'bar'", + func=qual, + instead='bar=8')) with self.subTest(test=9): - rv1, rv2 = f('Pywiki', bar=9) + rv1, rv2 = f(foo='Pywiki', bar=9) self.assertEqual(rv1, 'Pywiki') self.assertEqual(rv2, 81) + self.assertOneDeprecation(msg2.format(qual=qual, func=func)) + + with self.subTest(test=10): + rv1, rv2 = f('Pywiki', bar=10) + self.assertEqual(rv1, 'Pywiki') + self.assertEqual(rv2, 100) self.assertNoDeprecation() def test_remove_last_args_invalid(self) -> None: -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193468?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: I3d54e0e26d17aea0ff8c973869cf9fc57f63b2c2 Gerrit-Change-Number: 1193468 Gerrit-PatchSet: 9 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: [bugfix] finally reset messages in DeprecationTestCase.assertOneDepre...
by jenkins-bot (Code Review) 05 Oct '25

05 Oct '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193568?usp=email ) Change subject: [bugfix] finally reset messages in DeprecationTestCase.assertOneDeprecation ...................................................................... [bugfix] finally reset messages in DeprecationTestCase.assertOneDeprecation Bug: T406428 Change-Id: I03cbae772e30c89460e4e546a8aaf6522e1292bb --- M tests/aspects.py 1 file changed, 9 insertions(+), 7 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/tests/aspects.py b/tests/aspects.py index b691abc..e980ea9 100644 --- a/tests/aspects.py +++ b/tests/aspects.py @@ -1666,13 +1666,15 @@ def assertOneDeprecation(self, msg=None, count=1) -> None: """Assert that exactly one deprecation message happened and reset.""" - self.assertDeprecation(msg) - # This is doing such a weird structure, so that it shows any other - # deprecation message from the set. - self.assertCountEqual(set(self.deprecation_messages), - [self.deprecation_messages[0]]) - self.assertLength(self.deprecation_messages, count) - self._reset_messages() + try: + self.assertDeprecation(msg) + # This is doing such a weird structure, so that it shows any other + # deprecation message from the set. + self.assertCountEqual(set(self.deprecation_messages), + [self.deprecation_messages[0]]) + self.assertLength(self.deprecation_messages, count) + finally: + self._reset_messages() def assertNoDeprecation(self, msg=None) -> None: """Assert that no deprecation warning happened.""" -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1193568?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: I03cbae772e30c89460e4e546a8aaf6522e1292bb Gerrit-Change-Number: 1193568 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits October 2025