Pywikibot-commits

pywikibot-commits@lists.wikimedia.org

1 participants
13478 discussions

[Gerrit] ...core[master]: [doc] Update ROADMAP.rst
by jenkins-bot (Code Review) 25 May '24

25 May '24

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035856?usp=email ) Change subject: [doc] Update ROADMAP.rst ...................................................................... [doc] Update ROADMAP.rst Change-Id: I15e336058996b0aeca8e7b978416592920afc702 --- M ROADMAP.rst 1 file changed, 2 insertions(+), 1 deletion(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/ROADMAP.rst b/ROADMAP.rst index d1ef503..e42e037 100644 --- a/ROADMAP.rst +++ b/ROADMAP.rst @@ -1,13 +1,14 @@ Current release --------------- +* Use :class:`data.api.CachedRequest` for userinfo requests (:phab:`T348925`) * Raise :exc:`exceptions.SectionError` if a section does not exists on a page (:phab:`T107141`) * Retry api request on ServerError (:phab:`T364275`, :phab:`T364393`) Deprecations ------------ -* 9.2.0: *total* argument in ``-logevents`` pagegenrators option is deprecated; +* 9.2.0: *total* argument in ``-logevents`` pagegenerators option is deprecated; use ``-limit`` instead (:phab:`T128981`) * 9.0.0: The *content* parameter of :meth:`proofreadpage.IndexPage.page_gen` is deprecated and will be ignored (:phab:`T358635`) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035856?usp=email 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: I15e336058996b0aeca8e7b978416592920afc702 Gerrit-Change-Number: 1035856 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] use CachedRequest for userinfo requests
by jenkins-bot (Code Review) 25 May '24

25 May '24

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1034059?usp=email ) Change subject: [IMPR] use CachedRequest for userinfo requests ...................................................................... [IMPR] use CachedRequest for userinfo requests The expiry for userinfo is set to 1 day and can be changed within user-config.py file. The second call for the same userinfo is upto 50 times faster. Also create the site within its own worker thread. Now preload_sites.py is up to 90 times faster than before and only half as fast than pwb 8. Bug: T348925 Change-Id: I2bc6c375ee9b676e0a40a372362f37ee4a61ced8 --- M pywikibot/config.py M pywikibot/scripts/preload_sites.py M pywikibot/site/_apisite.py 3 files changed, 35 insertions(+), 12 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/config.py b/pywikibot/config.py index 7f12bcc..b2f20fb 100644 --- a/pywikibot/config.py +++ b/pywikibot/config.py @@ -175,6 +175,8 @@ site_interface = 'APISite' # number of days to cache namespaces, api configuration, etc. API_config_expiry = 30 +# userinfo expiry +API_uinfo_expiry = 1 # The maximum number of bytes which uses a GET request, if not positive # it'll always use POST requests diff --git a/pywikibot/scripts/preload_sites.py b/pywikibot/scripts/preload_sites.py index 8ff7d57..27a31f7 100755 --- a/pywikibot/scripts/preload_sites.py +++ b/pywikibot/scripts/preload_sites.py @@ -6,13 +6,18 @@ -worker:<num> The number of parallel tasks to be run. Default is the number of processors on the machine -Usage:: +**Usage:** python pwb.py preload_sites [{<family>}] [-worker:{<num>}] -To force preloading, change the global expiry value to 0:: +To force preloading, change the global expiry values to 0: - python pwb.py -API_config_expiry:0 preload_sites [{<family>}] + python pwb.py -API_config_expiry:0 -API_uinfo_expiry:0 \ + preload_sites [{<family>}] + +or run the :mod:`cache<scripts.maintenance.cache>` script previeously: + + python pwb.py cache -delete .. versionchanged:: 7.4 script was moved to the framework scripts folder. @@ -57,7 +62,17 @@ def preload_family(family: str, executor: ThreadPoolExecutor) -> None: - """Preload all sites of a single family file.""" + """Preload all sites of a single family file. + + .. versionchanged:: 9.2 + use a separate worker thread for each site. + """ + + def create_page(code, family): + """Preload siteinfo and userinfo.""" + site = pywikibot.Site(code, family) + pywikibot.Page(site, 'Main Page') + msg = 'Preloading sites of {} family{}' pywikibot.info(msg.format(family, '...')) @@ -65,14 +80,13 @@ for code in exceptions.get(family, []): if code in codes: codes.remove(code) + obsolete = Family.load(family).obsolete futures = set() for code in codes: if code not in obsolete: - site = pywikibot.Site(code, family) - # page title does not care - futures.add(executor.submit(pywikibot.Page, site, 'Main page')) + futures.add(executor.submit(create_page, code, family)) wait(futures) pywikibot.info(msg.format(family, ' completed.')) diff --git a/pywikibot/site/_apisite.py b/pywikibot/site/_apisite.py index 729a7ec..0fe76de 100644 --- a/pywikibot/site/_apisite.py +++ b/pywikibot/site/_apisite.py @@ -648,6 +648,10 @@ .. seealso:: :api:`Userinfo` .. versionchanged:: 8.0 Use API formatversion 2. + .. versionchanged:: 9.2 + API call is made through :class:`data.api.CachedRequest` with + expiry is set in ``API_uinfo_expiry`` within + :ref:`Account settings`. :return: A dict with the following keys and values: @@ -661,11 +665,14 @@ """ if not hasattr(self, '_userinfo'): - uirequest = self.simple_request( - action='query', - meta='userinfo', - uiprop='blockinfo|hasmsg|groups|rights|ratelimits', - formatversion=2, + uirequest = self._request( + expiry=pywikibot.config.API_uinfo_expiry, + parameters={ + 'action': 'query', + 'meta': 'userinfo', + 'uiprop': 'blockinfo|hasmsg|groups|rights|ratelimits', + 'formatversion': 2, + } ) uidata = uirequest.submit() assert 'query' in uidata, \ -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1034059?usp=email 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: I2bc6c375ee9b676e0a40a372362f37ee4a61ced8 Gerrit-Change-Number: 1034059 Gerrit-PatchSet: 4 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [cleanup] remove arguments cleanup introduced with pwb 6.0.0
by jenkins-bot (Code Review) 25 May '24

25 May '24

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1033678?usp=email ) Change subject: [cleanup] remove arguments cleanup introduced with pwb 6.0.0 ...................................................................... [cleanup] remove arguments cleanup introduced with pwb 6.0.0 Change-Id: I1ccc08b60e126397377707569cb31040bd9697cd --- M scripts/solve_disambiguation.py 1 file changed, 4 insertions(+), 74 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/solve_disambiguation.py b/scripts/solve_disambiguation.py index ac7f4ad..26c1dae 100755 --- a/scripts/solve_disambiguation.py +++ b/scripts/solve_disambiguation.py @@ -75,7 +75,7 @@ """ # -# (C) Pywikibot team, 2003-2023 +# (C) Pywikibot team, 2003-2024 # # Distributed under the terms of the MIT license. # @@ -107,7 +107,7 @@ NoPageError, PageSaveRelatedError, ) -from pywikibot.tools import first_lower, first_upper, issue_deprecation_warning +from pywikibot.tools import first_lower, first_upper from pywikibot.tools.formatter import SequenceOutputter @@ -610,7 +610,7 @@ } # refer -help message for complete options documentation - disambig_options = { + available_options = { 'always': None, # always perform the same action 'pos': [], # add possibilities as alternative disambig 'just': True, # just and only use the possibilities given with command @@ -621,83 +621,13 @@ 'min': 0, # minimum number of pages on a disambig } - # needed for argument cleanup - available_options = disambig_options - def __init__(self, *args, **kwargs) -> None: """Initializer.""" - self._clean_args(args, kwargs) - super().__init__(**kwargs) + super().__init__(*args, **kwargs) self.ignores = set() self.summary = None self.dn_template_str = i18n.translate(self.site, dn_template) - def _clean_args(self, args, kwargs) -> None: - """Cleanup positional and keyword arguments. - - Replace positional arguments with keyword arguments. - Replace old keywords with new keywords which are given by - argument handling. - - This also fixes arguments which aren't currently used by - BaseDisambigBot abstract class but was introduced for the old - DisambiguationRobot to prevent multiple deprecation warnings. - """ - # New keys of positional arguments - keys = ('always', 'pos', 'just', 'dnskip', 'generator', 'primary', - 'main', 'first', 'min') - - # Keys mapping from old argument name to new keywords. - # The ordering of dics is not safe for Python < 3.7. Therefore - # we need a dict in addition to key above. - keymap = { - 'alternatives': 'pos', - 'getAlternatives': 'just', - 'dnSkip': 'dnskip', - 'main_only': 'main', - 'first_only': 'first', - 'minimum': 'min', - } - - # Replace positional arguments with keyword arguments - for i, arg in enumerate(args): - key = keys[i] - issue_deprecation_warning( - f'Positional argument {i + 1} ({arg})', - f'keyword argument "{key}={arg}"', - since='6.0.0') - if key in kwargs: - pywikibot.warning('{!r} is given as keyword argument {!r} ' - 'already; ignoring {!r}' - .format(key, arg, kwargs[key])) - else: - kwargs[key] = arg - - # replace old keywords to new - for key in list(kwargs): - if key in keymap: - newkey = keymap[key] - issue_deprecation_warning( - f'{key!r} argument of {self.__class__.__name__}', - repr(newkey), since='6.0.0') - kwargs[newkey] = kwargs.pop(key) - - # Expand available_options - # Currently scripts may have its own options set - added_keys = [] - for key in keys: - if key != 'generator' and key not in self.available_options: - added_keys.append(key) - self.available_options[key] = self.disambig_options[key] - if added_keys: - pywikibot.warning("""\ -The following keys were added to available_options: -{options}. -Either add them to available_options setting of {classname} -bot class or use available_options.update() to use default settings from -DisambiguationRobot""".format(options=added_keys, - classname=self.__class__.__name__)) - def checkContents(self, text: str) -> str | None: # noqa: N802 """ Check if the text matches any of the ignore regexes. -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1033678?usp=email 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: I1ccc08b60e126397377707569cb31040bd9697cd Gerrit-Change-Number: 1033678 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: D3r1ck01 <dalangi-ctr(a)wikimedia.org> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [IMPR] Add a new decorator to deprecate positional arguments
by jenkins-bot (Code Review) 25 May '24

25 May '24

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1033627?usp=email ) Change subject: [IMPR] Add a new decorator to deprecate positional arguments ...................................................................... [IMPR] Add a new decorator to deprecate positional arguments The new deprecate_positionals decorator can be used to circumvent a TypeError when using positional arguments if a keyword-only argument is required but throws a FutureWarning. The advantage is to have a deprecation period when introducing keyword-only syntax for methods and functions. Change-Id: I549a2e951e5b0c1ed10f2a1d656b27b226d03c63 --- M pywikibot/tools/__init__.py M pywikibot/tools/_deprecate.py M tests/tools_deprecate_tests.py 3 files changed, 173 insertions(+), 1 deletion(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 586684e..32c0bf2 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -52,6 +52,7 @@ add_decorated_full_name, add_full_name, deprecate_arg, + deprecate_positionals, deprecated, deprecated_args, get_wrapper_depth, @@ -69,6 +70,7 @@ 'add_decorated_full_name', 'add_full_name', 'deprecate_arg', + 'deprecate_positionals', 'deprecated', 'deprecated_args', 'get_wrapper_depth', diff --git a/pywikibot/tools/_deprecate.py b/pywikibot/tools/_deprecate.py index 9bbc133..05d5bc3 100644 --- a/pywikibot/tools/_deprecate.py +++ b/pywikibot/tools/_deprecate.py @@ -19,7 +19,7 @@ deprecation decorators moved to _deprecate submodule """ # -# (C) Pywikibot team, 2008-2023 +# (C) Pywikibot team, 2008-2024 # # Distributed under the terms of the MIT license. # @@ -31,6 +31,7 @@ import sys import types from contextlib import suppress +from functools import wraps from importlib import import_module from inspect import getfullargspec from typing import Any @@ -431,6 +432,84 @@ return decorator +def deprecate_positionals(since: str = ''): + """Decorator for methods that issues warnings for positional arguments. + + This decorator allowes positional arguments after keyword-only + argument syntax (:pep:`3102`) but throws a FutureWarning. The + decorator makes the needed argument updates before passing them to + the called function or method. This decorator may be used for a + deprecation period when require keyword-only arguments. + + Example: + + .. code-block:: python + + @deprecate_positionals(since='9.2.0') + def f(posarg, *, kwarg): + ... + + f('foo', 'bar') + + This function call passes but throws a FutureWarning. Without + decorator a TypeError would be raised. + + .. caution:: The decorated function may not use ``*args`` or + ``**kwargs``. The sequence of keyword-only arguments must match + the sequence of the old positional arguments, otherwise the + assignment of the arguments to the keyworded arguments will fail. + .. versionadded:: 9.2 + + :param since: a version string when some positional arguments were + deprecated + """ + def decorator(func): + """Outer wrapper. Inspect the parameters of *func*. + + :param func: function or method beeing wrapped. + """ + + @wraps(func) + def wrapper(*args: Any, **kwargs: Any) -> Any: + """Throws the warning and makes the argument fixing. + + :param args: args passed to the decorated functoin or method + :param kwargs: kwargs passed to the decorated function or + method + :return: the value returned by the decorated function or + method + """ + if len(args) > positionals: + replace_args = list(zip(arg_keys[positionals:], + args[positionals:])) + pos_args = "', '".join(name for name, arg in replace_args) + keyw_args = ', '.join('{}={!r}'.format(name, arg) + for name, arg in replace_args) + issue_deprecation_warning( + f"Passing '{pos_args}' as positional " + f'argument(s) to {func.__qualname__}()', + f'keyword arguments like {keyw_args}', + since=since) + + args = args[:positionals] + kwargs.update(replace_args) + + return func(*args, **kwargs) + + sig = inspect.signature(func) + arg_keys = list(sig.parameters) + + # find the first KEYWORD_ONLY index + for positionals, key in enumerate(arg_keys): + if sig.parameters[key].kind in (inspect.Parameter.KEYWORD_ONLY, + inspect.Parameter.VAR_KEYWORD): + break + + return wrapper + + return decorator + + def remove_last_args(arg_names): """ Decorator to declare all args additionally provided deprecated. diff --git a/tests/tools_deprecate_tests.py b/tests/tools_deprecate_tests.py index fd5cc21..ebdd248 100755 --- a/tests/tools_deprecate_tests.py +++ b/tests/tools_deprecate_tests.py @@ -14,6 +14,7 @@ PYTHON_VERSION, add_full_name, deprecate_arg, + deprecate_positionals, deprecated, deprecated_args, remove_last_args, @@ -153,6 +154,13 @@ return foo +@deprecate_positionals() +def positionals_test_function(foo: str, *, + bar: int, baz: str = '') -> tuple[int, str]: + """Deprecating positional parameters.""" + return foo + baz, bar ** 2 + + class DeprecatedMethodClass: """Class with methods deprecated.""" @@ -232,6 +240,12 @@ """Deprecating last positional parameter.""" return foo + @deprecate_positionals() + def test_method(self, foo: str, *, + bar: int = 5, baz: str = '') -> tuple[int, str]: + """Deprecating positional parameters.""" + return foo + baz, bar ** 2 + @deprecated() class DeprecatedClassNoInit: @@ -606,6 +620,83 @@ "The value(s) provided for 'bar' have been dropped." .format(__name__)) + def test_deprecate_positionals(self): + """Test deprecation of positional parameters.""" + msg = ('Passing {param} as positional argument(s) to {func}() is ' + 'deprecated; use keyword arguments like {instead} instead.') + + f = DeprecatedMethodClass().test_method + func = 'DeprecatedMethodClass.test_method' + + 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'")) + + 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')) + + 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')) + + with self.subTest(test=4): + rv1, rv2 = f('Pywiki', bar=4) + self.assertEqual(rv1, 'Pywiki') + self.assertEqual(rv2, 16) + self.assertNoDeprecation() + + with self.subTest(test=5): + rv1, rv2 = f(foo='Pywiki') + self.assertEqual(rv1, 'Pywiki') + self.assertEqual(rv2, 25) + self.assertNoDeprecation() + + f = positionals_test_function + func = 'positionals_test_function' + + with self.subTest(test=6): + 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'")) + + 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')) + + 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')) + + with self.subTest(test=9): + rv1, rv2 = f('Pywiki', bar=9) + self.assertEqual(rv1, 'Pywiki') + self.assertEqual(rv2, 81) + self.assertNoDeprecation() + def test_remove_last_args_invalid(self): """Test invalid @remove_last_args on functions.""" with self.assertRaisesRegex( -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1033627?usp=email 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: I549a2e951e5b0c1ed10f2a1d656b27b226d03c63 Gerrit-Change-Number: 1033627 Gerrit-PatchSet: 6 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [tests] add TestScriptSimulate.test_commons_information to expected f...
by jenkins-bot (Code Review) 25 May '24

25 May '24

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035854?usp=email ) Change subject: [tests] add TestScriptSimulate.test_commons_information to expected failures ...................................................................... [tests] add TestScriptSimulate.test_commons_information to expected failures Change-Id: I607b5aae36d1523b0ca2ed1cf9e6fec1915f6a03 --- M tests/script_tests.py 1 file changed, 1 insertion(+), 0 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/tests/script_tests.py b/tests/script_tests.py index 7c11281..9f9df0a 100755 --- a/tests/script_tests.py +++ b/tests/script_tests.py @@ -364,6 +364,7 @@ _expected_failures = { 'catall', # stdout user interaction 'checkimages', + 'commons_information', # no empty out_result 'revertbot', 'transwikiimport', } -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035854?usp=email 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: I607b5aae36d1523b0ca2ed1cf9e6fec1915f6a03 Gerrit-Change-Number: 1035854 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [cleanup] drop bool values of deprecate_arg and deprecated_args
by jenkins-bot (Code Review) 24 May '24

24 May '24

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1033038?usp=email ) Change subject: [cleanup] drop bool values of deprecate_arg and deprecated_args ...................................................................... [cleanup] drop bool values of deprecate_arg and deprecated_args bool values and None values were implemented to throw a DeprecationWarning, PendingDeprecationWarning or FutureWarning but we only used the later since years and never used the PendingDeprecationWarning. Also update tests and backport types.NoneType. Change-Id: I10ca6346525e71998d839e696b5e088242c76600 --- M pywikibot/backports.py M pywikibot/tools/_deprecate.py M tests/tools_deprecate_tests.py 3 files changed, 44 insertions(+), 32 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/backports.py b/pywikibot/backports.py index 8b9d989..815f7d3 100644 --- a/pywikibot/backports.py +++ b/pywikibot/backports.py @@ -116,10 +116,12 @@ removesuffix = str.removesuffix # type: ignore[assignment] -# bpo-38200 if PYTHON_VERSION < (3, 10) or SPHINX_RUNNING: from itertools import tee + NoneType = type(None) + + # bpo-38200 def pairwise(iterable): """Return successive overlapping pairs taken from the input iterable. @@ -132,6 +134,7 @@ next(b, None) return zip(a, b) else: + from types import NoneType from itertools import pairwise # type: ignore[no-redef] diff --git a/pywikibot/tools/_deprecate.py b/pywikibot/tools/_deprecate.py index 9bbc133..571aad1 100644 --- a/pywikibot/tools/_deprecate.py +++ b/pywikibot/tools/_deprecate.py @@ -19,7 +19,7 @@ deprecation decorators moved to _deprecate submodule """ # -# (C) Pywikibot team, 2008-2023 +# (C) Pywikibot team, 2008-2024 # # Distributed under the terms of the MIT license. # @@ -36,6 +36,7 @@ from typing import Any from warnings import warn +from pywikibot.backports import NoneType from pywikibot.tools import SPHINX_RUNNING @@ -309,10 +310,12 @@ deprecated = add_full_name(deprecated) -def deprecate_arg(old_arg: str, new_arg: str | bool | None): +def deprecate_arg(old_arg: str, new_arg: str | None = None): """Decorator to declare old_arg deprecated and replace it with new_arg. - Usage: + **Usage:** + + .. code-block:: python @deprecate_arg('foo', 'bar') def my_function(bar='baz'): pass @@ -323,9 +326,12 @@ # ignores 'foo' keyword no longer used by my_function :func:`deprecated_args` decorator should be used in favour of this - ``deprecate_arg`` decorator but it is held to deprecate args which - become a reserved word in future Python releases and to prevent - syntax errors. + ``deprecate_arg`` decorator but it is held to deprecate args of + reserved words even for future Python releases and to prevent syntax + errors. + + .. versionchanged:: 9.2 + bool type of *new_arg* is no longer supported. :param old_arg: old keyword :param new_arg: new keyword @@ -333,21 +339,29 @@ return deprecated_args(**{old_arg: new_arg}) -def deprecated_args(**arg_pairs): +def deprecated_args(**arg_pairs: str | None): """Decorator to declare multiple args deprecated. - Usage: + **Usage:** + + .. code-block:: python @deprecated_args(foo='bar', baz=None) def my_function(bar='baz'): pass # replaces 'foo' keyword by 'bar' and ignores 'baz' keyword + .. versionchanged:: 3.0.20200703 + show a FutureWarning if the *arg_pairs* value is True; don't show + a warning if the value is an empty string. + .. versionchanged:: 6.4 + show a FutureWarning for renamed arguments + .. versionchanged:: 9.2 + bool type argument is no longer supported. + :param arg_pairs: Each entry points to the new argument name. If an - argument is to be removed, the value may be one of the following: - - None: shows a DeprecationWarning - - False: shows a PendingDeprecationWarning - - True: shows a FutureWarning (only once) - - empty string: no warning is printed + argument is to be removed, the value may be either an empty str + or ``None``; the later also shows a `FutureWarning` once. + :raises TypeError: *arg_pairs* value is neither str nor None or """ def decorator(obj): """Outer wrapper. @@ -376,15 +390,18 @@ if old_arg not in __kw: continue - if new_arg not in [True, False, None, '']: + if not isinstance(new_arg, (str, NoneType)): + raise TypeError( + f'deprecated_arg value for {old_arg} of {name} must ' + f'be either str or None, not {type(new_arg).__name__}') + + if new_arg: if new_arg in __kw: warn('{new_arg} argument of {name} ' 'replaces {old_arg}; cannot use both.' .format_map(output_args), RuntimeWarning, depth) else: - # If the value is positionally given this will - # cause a TypeError, which is intentional warn('{old_arg} argument of {name} ' 'is deprecated; use {new_arg} instead.' .format_map(output_args), @@ -393,15 +410,9 @@ elif new_arg == '': pass else: - if new_arg is False: - cls = PendingDeprecationWarning - elif new_arg is True: - cls = FutureWarning - else: # new_arg is None - cls = DeprecationWarning warn('{old_arg} argument of {name} is deprecated.' .format_map(output_args), - cls, depth) + FutureWarning, depth) del __kw[old_arg] return obj(*__args, **__kw) diff --git a/tests/tools_deprecate_tests.py b/tests/tools_deprecate_tests.py index fd5cc21..c4a6895 100755 --- a/tests/tools_deprecate_tests.py +++ b/tests/tools_deprecate_tests.py @@ -135,7 +135,7 @@ return foo -@deprecated_args(bah='foo', silent=False, loud=True, old=None) +@deprecated_args(bah='foo', silent=None, loud=None, old='') def deprecated_func_arg3(foo=None): """Test deprecated_args with three drops and one rename.""" return foo @@ -459,6 +459,7 @@ def test_deprecate_and_remove_function_args(self): """Test @deprecated and removed function argument.""" + deprecation_msg = f' argument of {__name__ }.deprecated_func_arg3' rv = deprecated_func_arg3() self.assertIsNone(rv) self.assertNoDeprecation() @@ -469,19 +470,16 @@ rv = deprecated_func_arg3(foo=1, silent=42) self.assertEqual(rv, 1) - self.assertDeprecationClass(PendingDeprecationWarning) - self.assertOneDeprecationParts( - 'silent argument of ' + __name__ + '.deprecated_func_arg3') + self.assertDeprecationClass(FutureWarning) + self.assertOneDeprecationParts('silent' + deprecation_msg) rv = deprecated_func_arg3(3, loud='3') self.assertEqual(rv, 3) - self.assertOneDeprecationParts( - 'loud argument of ' + __name__ + '.deprecated_func_arg3') + self.assertOneDeprecationParts('loud' + deprecation_msg) rv = deprecated_func_arg3(4, old='4') self.assertEqual(rv, 4) - self.assertOneDeprecationParts( - 'old argument of ' + __name__ + '.deprecated_func_arg3') + self.assertNoDeprecation() def test_function_remove_last_args(self): """Test @remove_last_args on functions.""" -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1033038?usp=email 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: I10ca6346525e71998d839e696b5e088242c76600 Gerrit-Change-Number: 1033038 Gerrit-PatchSet: 4 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [tests] test with Python 3.13.0a/b instead of 3.13-dev
by Xqt (Code Review) 24 May '24

24 May '24

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035783?usp=email ) Change subject: [tests] test with Python 3.13.0a/b instead of 3.13-dev ...................................................................... [tests] test with Python 3.13.0a/b instead of 3.13-dev Change-Id: I4ad5f6f3531aef3a842f182f8278154c7b4ef302 --- M .github/workflows/doctest.yml M .github/workflows/login_tests-ci.yml M .github/workflows/oauth_tests-ci.yml M .github/workflows/pywikibot-ci.yml 4 files changed, 4 insertions(+), 5 deletions(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/.github/workflows/doctest.yml b/.github/workflows/doctest.yml index b4032be..6ec8aa6 100644 --- a/.github/workflows/doctest.yml +++ b/.github/workflows/doctest.yml @@ -23,10 +23,9 @@ max-parallel: 14 matrix: - python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12" ] + python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13.0-alpha - 3.13.0" ] os: [ windows-latest, macOS-latest, ubuntu-latest ] include: - - python-version: "3.13-dev" - python-version: "3.14-dev" exclude: - os: macOS-latest diff --git a/.github/workflows/login_tests-ci.yml b/.github/workflows/login_tests-ci.yml index 7d18e02..bc718bc 100644 --- a/.github/workflows/login_tests-ci.yml +++ b/.github/workflows/login_tests-ci.yml @@ -23,7 +23,7 @@ max-parallel: 1 matrix: - python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev", "3.14-dev" ] + python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13.0-alpha - 3.13.0", "3.14-dev" ] site: [ "wikipedia:en", "wikisource:zh", "wikipedia:test" ] include: - python-version: "3.7" diff --git a/.github/workflows/oauth_tests-ci.yml b/.github/workflows/oauth_tests-ci.yml index 3140908..d26c368 100644 --- a/.github/workflows/oauth_tests-ci.yml +++ b/.github/workflows/oauth_tests-ci.yml @@ -23,7 +23,7 @@ fail-fast: false matrix: - python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev", "3.14-dev" ] + python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13.0-alpha - 3.13.0", "3.14-dev" ] family: [ wikipedia ] code: [ test ] domain: [ "test.wikipedia.org" ] diff --git a/.github/workflows/pywikibot-ci.yml b/.github/workflows/pywikibot-ci.yml index e7ff0a2..d45d1ef 100644 --- a/.github/workflows/pywikibot-ci.yml +++ b/.github/workflows/pywikibot-ci.yml @@ -26,7 +26,7 @@ max-parallel: 17 matrix: - python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev", "3.14-dev" ] + python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13.0-alpha - 3.13.0", "3.14-dev" ] site: [ "wikipedia:en", "wikisource:zh" ] test_prod_only: [ true ] include: -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035783?usp=email 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: I4ad5f6f3531aef3a842f182f8278154c7b4ef302 Gerrit-Change-Number: 1035783 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-CC: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...i18n[master]: Localisation updates from https://translatewiki.net.
by jenkins-bot (Code Review) 23 May '24

23 May '24

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/i18n/+/1035379?usp=email ) Change subject: Localisation updates from https://translatewiki.net. ...................................................................... Localisation updates from https://translatewiki.net. Change-Id: I3bbfef7e268fff1c643978bd019a6998e22bae15 --- M protect/diq.json 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: L10n-bot: Looks good to me, approved jenkins-bot: Verified diff --git a/protect/diq.json b/protect/diq.json index 565d342..f065fd4 100644 --- a/protect/diq.json +++ b/protect/diq.json @@ -8,6 +8,6 @@ "protect-category": "Bot: Pelanê kategoriya %(cat)s pêrıne bışevekne", "protect-images": "Bot: Resımanê ke pela %(page)s derê pêrıne bışevekne", "protect-links": "Bot: Pelanê ke %(page)s ra gıre biyê pêrıne bışevekne", - "protect-ref": "Bot: Pelanê ke %(page)s de çemê benê pêrıne bışevekne", + "protect-ref": "Bot: Pelanê ke %(page)s de çıme benê, pêrıne bışevekne", "protect-simple": "Bot: Yew lista dosyeyan bışevekne." } -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/i18n/+/1035379?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/i18n Gerrit-Branch: master Gerrit-Change-Id: I3bbfef7e268fff1c643978bd019a6998e22bae15 Gerrit-Change-Number: 1035379 Gerrit-PatchSet: 1 Gerrit-Owner: L10n-bot <l10n-bot(a)translatewiki.net> Gerrit-Reviewer: L10n-bot <l10n-bot(a)translatewiki.net> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: Revert "[tests] use Python 3.13 for tests"
by Xqt (Code Review) 23 May '24

23 May '24

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035156?usp=email ) Change subject: Revert "[tests] use Python 3.13 for tests" ...................................................................... Revert "[tests] use Python 3.13 for tests" This reverts commit f1690b14eb855ac6ef2e414d8dc104678c2d6622. Reason for revert: not found, beta needed Change-Id: I438d09d3b9580f79a9c601d8c11a08003fedb7cc --- M .github/workflows/oauth_tests-ci.yml 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/.github/workflows/oauth_tests-ci.yml b/.github/workflows/oauth_tests-ci.yml index b87da06..3140908 100644 --- a/.github/workflows/oauth_tests-ci.yml +++ b/.github/workflows/oauth_tests-ci.yml @@ -23,7 +23,7 @@ fail-fast: false matrix: - python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14-dev" ] + python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev", "3.14-dev" ] family: [ wikipedia ] code: [ test ] domain: [ "test.wikipedia.org" ] -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035156?usp=email 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: I438d09d3b9580f79a9c601d8c11a08003fedb7cc Gerrit-Change-Number: 1035156 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-CC: jenkins-bot Gerrit-MessageType: merged

1 0

[Gerrit] ...core[master]: [tests] use Python 3.13 for tests
by Xqt (Code Review) 23 May '24

23 May '24

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035154?usp=email ) Change subject: [tests] use Python 3.13 for tests ...................................................................... [tests] use Python 3.13 for tests Change-Id: Ib79bfb7817b6647e3910030a11e59a3f36258026 Signed-off-by: Xqt <info(a)gno.de> --- M .github/workflows/oauth_tests-ci.yml 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: Xqt: Verified; Looks good to me, approved diff --git a/.github/workflows/oauth_tests-ci.yml b/.github/workflows/oauth_tests-ci.yml index 3140908..b87da06 100644 --- a/.github/workflows/oauth_tests-ci.yml +++ b/.github/workflows/oauth_tests-ci.yml @@ -23,7 +23,7 @@ fail-fast: false matrix: - python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev", "3.14-dev" ] + python-version: [ "pypy3.7", "pypy3.10", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14-dev" ] family: [ wikipedia ] code: [ test ] domain: [ "test.wikipedia.org" ] -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1035154?usp=email 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: Ib79bfb7817b6647e3910030a11e59a3f36258026 Gerrit-Change-Number: 1035154 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-CC: jenkins-bot Gerrit-MessageType: merged

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits