Pywikibot-commits June 2025

pywikibot-commits@lists.wikimedia.org

1 participants
97 discussions

[Gerrit] ...core[master]: IMPR: use keyword only args in some private methods
by jenkins-bot (Code Review) 11 Jun '25

11 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155605?usp=email ) Change subject: IMPR: use keyword only args in some private methods ...................................................................... IMPR: use keyword only args in some private methods Change-Id: I3566ae31b9dedb184122d605c53ec4bfd68d4d00 --- M pywikibot/cosmetic_changes.py M pywikibot/data/api/_optionset.py M tests/api_tests.py 3 files changed, 6 insertions(+), 5 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/cosmetic_changes.py b/pywikibot/cosmetic_changes.py index 9244283..57b39ad 100644 --- a/pywikibot/cosmetic_changes.py +++ b/pywikibot/cosmetic_changes.py @@ -203,7 +203,7 @@ MATCH = 3 -def _format_isbn_match(match: Match[str], strict: bool = True) -> str: +def _format_isbn_match(match: Match[str], *, strict: bool = True) -> str: """Helper function to validate and format a single matched ISBN.""" if not stdnum_isbn: raise NotImplementedError( @@ -221,7 +221,7 @@ return stdnum_isbn.format(isbn) -def _reformat_ISBNs(text: str, strict: bool = True) -> str: +def _reformat_ISBNs(text: str, *, strict: bool = True) -> str: """Helper function to normalise ISBNs in text. :raises Exception: Invalid ISBN encountered when strict enabled diff --git a/pywikibot/data/api/_optionset.py b/pywikibot/data/api/_optionset.py index aeabc0c..1c88117 100644 --- a/pywikibot/data/api/_optionset.py +++ b/pywikibot/data/api/_optionset.py @@ -1,6 +1,6 @@ """Object representing boolean API option.""" # -# (C) Pywikibot team, 2015-2024 +# (C) Pywikibot team, 2015-2025 # # Distributed under the terms of the MIT license. # @@ -54,7 +54,7 @@ if data: self.from_dict(data) - def _set_site(self, site, module: str, param: str, + def _set_site(self, site, module: str, param: str, *, clear_invalid: bool = False) -> None: """Set the site and valid names. diff --git a/tests/api_tests.py b/tests/api_tests.py index d2944cb..f0e3ca1 100755 --- a/tests/api_tests.py +++ b/tests/api_tests.py @@ -327,7 +327,8 @@ with self.assertRaises(KeyError): options._set_site(self.get_site(), 'recentchanges', 'show') self.assertLength(options, 2) - options._set_site(self.get_site(), 'recentchanges', 'show', True) + options._set_site(self.get_site(), 'recentchanges', 'show', + clear_invalid=True) self.assertLength(options, 1) with self.assertRaises(TypeError): options._set_site(self.get_site(), 'recentchanges', 'show') -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155605?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: I3566ae31b9dedb184122d605c53ec4bfd68d4d00 Gerrit-Change-Number: 1155605 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: Update type annotations
by jenkins-bot (Code Review) 11 Jun '25

11 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155541?usp=email ) Change subject: IMPR: Update type annotations ...................................................................... IMPR: Update type annotations Change-Id: I3269bae8698edcd77b123bcf9fc1815e9f29fdb7 --- M docs/conf.py M pwb.py M pywikibot/comms/http.py M pywikibot/data/api/_generators.py M pywikibot/data/api/_optionset.py M pywikibot/data/api/_paraminfo.py M pywikibot/data/api/_requests.py M pywikibot/data/memento.py M pywikibot/editor.py M pywikibot/families/wikipedia_family.py M pywikibot/families/wiktionary_family.py M pywikibot/family.py M pywikibot/login.py M pywikibot/page/_basepage.py M pywikibot/page/_collections.py M pywikibot/page/_decorators.py M pywikibot/page/_filepage.py M pywikibot/page/_links.py M pywikibot/page/_page.py M pywikibot/page/_toolforge.py M pywikibot/page/_user.py M pywikibot/page/_wikibase.py M pywikibot/pagegenerators/_generators.py M pywikibot/proofreadpage.py M pywikibot/scripts/generate_user_files.py M pywikibot/scripts/login.py M pywikibot/scripts/wrapper.py M pywikibot/site/_basesite.py M pywikibot/site/_tokenwallet.py M pywikibot/site_detect.py M pywikibot/specialbots/_upload.py M pywikibot/textlib.py M pywikibot/tools/__init__.py M pywikibot/tools/_deprecate.py M pywikibot/tools/threading.py M pywikibot/userinterfaces/gui.py M pywikibot/userinterfaces/terminal_interface_base.py M scripts/archivebot.py M scripts/blockpageschecker.py M scripts/category_graph.py M scripts/category_redirect.py M scripts/clean_sandbox.py M scripts/create_isbn_edition.py M scripts/delinker.py M scripts/harvest_template.py M scripts/interwiki.py M scripts/maintenance/addwikis.py M scripts/maintenance/cache.py M scripts/maintenance/colors.py M scripts/maintenance/make_i18n_dict.py M scripts/maintenance/unidata.py M scripts/movepages.py M scripts/noreferences.py M scripts/nowcommons.py M scripts/patrol.py M scripts/reflinks.py M scripts/replace.py M scripts/touch.py M scripts/unlink.py M scripts/unusedfiles.py M scripts/weblinkchecker.py M tests/__init__.py M tests/add_text_tests.py M tests/api_tests.py M tests/archivebot_tests.py M tests/aspects.py M tests/basepage.py M tests/basesite_tests.py M tests/bot_tests.py M tests/cache_tests.py M tests/category_bot_tests.py M tests/collections_tests.py M tests/cosmetic_changes_tests.py M tests/data_ingestion_tests.py M tests/deletionbot_tests.py M tests/diff_tests.py M tests/djvu_tests.py M tests/dry_api_tests.py M tests/edit_failure_tests.py M tests/edit_tests.py M tests/eventstreams_tests.py M tests/family_tests.py M tests/file_tests.py M tests/fixes_tests.py M tests/generate_family_file_tests.py M tests/gui_tests.py M tests/http_tests.py M tests/i18n_tests.py M tests/interwiki_graph_tests.py M tests/interwikidata_tests.py M tests/interwikimap_tests.py M tests/l10n_tests.py M tests/link_tests.py M tests/linter_tests.py M tests/logentries_tests.py M tests/login_tests.py M tests/mediawikiversion_tests.py M tests/namespace_tests.py M tests/oauth_tests.py M tests/page_tests.py M tests/pagegenerators_tests.py M tests/paraminfo_tests.py M tests/patrolbot_tests.py M tests/proofreadpage_tests.py M tests/reflinks_tests.py M tests/replacebot_tests.py M tests/script_tests.py M tests/site_decorators_tests.py M tests/site_detect_tests.py M tests/site_generators_tests.py M tests/site_login_logout_tests.py M tests/site_tests.py M tests/siteinfo_tests.py M tests/sparql_tests.py M tests/tests_tests.py M tests/textlib_tests.py M tests/time_tests.py M tests/timestripper_tests.py M tests/titletranslate_tests.py M tests/token_tests.py M tests/tools_deprecate_tests.py M tests/tools_tests.py M tests/ui_tests.py M tests/upload_tests.py M tests/user_tests.py M tests/utils.py M tests/wbtypes_tests.py M tests/wikibase_edit_tests.py M tests/wikibase_tests.py M tests/xmlreader_tests.py 130 files changed, 570 insertions(+), 557 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/docs/conf.py b/docs/conf.py index e0e68e1..1da84b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ """Configuration file for Sphinx.""" # -# (C) Pywikibot team, 2014-2024 +# (C) Pywikibot team, 2014-2025 # # Distributed under the terms of the MIT license. # @@ -514,7 +514,7 @@ } -def pywikibot_docstring_fixups(app, what, name, obj, options, lines): +def pywikibot_docstring_fixups(app, what, name, obj, options, lines) -> None: """Remove plain 'Initializer.' or 'Allocator.' docstring. .. versionchanged:: 8.2 @@ -527,7 +527,8 @@ lines[:] = lines[2:] -def pywikibot_script_docstring_fixups(app, what, name, obj, options, lines): +def pywikibot_script_docstring_fixups(app, what, name, obj, options, + lines) -> None: """Pywikibot specific conversions.""" from scripts.cosmetic_changes import warning @@ -579,7 +580,7 @@ length = 0 -def setup(app): +def setup(app) -> None: """Implicit Sphinx extension hook.""" app.connect('autodoc-process-docstring', pywikibot_docstring_fixups) app.connect('autodoc-process-docstring', pywikibot_script_docstring_fixups) diff --git a/pwb.py b/pwb.py index 077d9a3..0691ea3 100755 --- a/pwb.py +++ b/pwb.py @@ -29,7 +29,7 @@ sys.exit(VERSIONS_REQUIRED_MESSAGE.format(version=sys.version)) -def main(): +def main() -> None: """Entry point for :func:`tests.utils.execute_pwb`.""" from pathlib import Path path = Path(__file__).parent / 'pywikibot' / 'scripts' / 'wrapper.py' diff --git a/pywikibot/comms/http.py b/pywikibot/comms/http.py index 50dd2eb..e5d9b37 100644 --- a/pywikibot/comms/http.py +++ b/pywikibot/comms/http.py @@ -305,7 +305,7 @@ return None -def error_handling_callback(response): +def error_handling_callback(response) -> None: """Raise exceptions and log alerts. :param response: Response returned by Session.request(). diff --git a/pywikibot/data/api/_generators.py b/pywikibot/data/api/_generators.py index 2e89f36..ebdd536 100644 --- a/pywikibot/data/api/_generators.py +++ b/pywikibot/data/api/_generators.py @@ -434,7 +434,7 @@ self.site._paraminfo.parameter('query+' + self.limited_module, 'namespace')) - def set_namespace(self, namespaces): + def set_namespace(self, namespaces) -> bool | None: """Set a namespace filter on this query. :param namespaces: namespace identifiers to limit query results @@ -883,7 +883,7 @@ return result.ns() in self._namespaces -def _update_pageid(page, pagedict: dict): +def _update_pageid(page, pagedict: dict) -> None: """Update pageid.""" if 'pageid' in pagedict: page._pageid = int(pagedict['pageid']) @@ -942,7 +942,7 @@ page._templates = templ_pages -def _update_categories(page, categories): +def _update_categories(page, categories) -> None: """Update page categories.""" cat_pages = {pywikibot.Page(page.site, ct['title']) for ct in categories} if hasattr(page, '_categories'): diff --git a/pywikibot/data/api/_optionset.py b/pywikibot/data/api/_optionset.py index 75019c7..aeabc0c 100644 --- a/pywikibot/data/api/_optionset.py +++ b/pywikibot/data/api/_optionset.py @@ -55,7 +55,7 @@ self.from_dict(data) def _set_site(self, site, module: str, param: str, - clear_invalid: bool = False): + clear_invalid: bool = False) -> None: """Set the site and valid names. As soon as the site has been not None, any subsequent calls will fail, @@ -93,7 +93,7 @@ '"{}"'.format('", "'.join(invalid_names))) self._site_set = True - def from_dict(self, dictionary): + def from_dict(self, dictionary) -> None: """Load options from the dict. The options are not cleared before. If changes have been made @@ -129,7 +129,7 @@ self._enabled = enabled | (self._enabled - disabled - removed) self._disabled = disabled | (self._disabled - enabled - removed) - def __setitem__(self, name, value): + def __setitem__(self, name, value) -> None: """Set option to enabled, disabled or neither.""" if value is True: if self._site_set and name not in self._valid_enable: diff --git a/pywikibot/data/api/_paraminfo.py b/pywikibot/data/api/_paraminfo.py index d15f41c..2464394 100644 --- a/pywikibot/data/api/_paraminfo.py +++ b/pywikibot/data/api/_paraminfo.py @@ -76,7 +76,7 @@ else: self._modules[name] = modules - def _init(self): + def _init(self) -> None: assert ('query' in self._modules) is ('main' in self._paraminfo) # Skip if ParamInfo is already initialized diff --git a/pywikibot/data/api/_requests.py b/pywikibot/data/api/_requests.py index b1d5737..33f9fd5 100644 --- a/pywikibot/data/api/_requests.py +++ b/pywikibot/data/api/_requests.py @@ -19,7 +19,7 @@ from contextlib import suppress from email.mime.nonmultipart import MIMENonMultipart from pathlib import Path -from typing import Any +from typing import Any, NoReturn from urllib.parse import unquote, urlencode, urlparse from warnings import warn @@ -401,7 +401,7 @@ """ return iter(self.items()) - def _add_defaults(self): + def _add_defaults(self) -> None: """Add default parameters to the API request. This method will only add them once. @@ -1178,7 +1178,7 @@ self._cachetime = None @classmethod - def create_simple(cls, req_site, **kwargs): + def create_simple(cls, req_site, **kwargs) -> NoReturn: """Unsupported as it requires at least two parameters.""" raise NotImplementedError('CachedRequest cannot be created simply.') diff --git a/pywikibot/data/memento.py b/pywikibot/data/memento.py index 337f36c..7c572bf 100644 --- a/pywikibot/data/memento.py +++ b/pywikibot/data/memento.py @@ -89,7 +89,7 @@ :return: A :class:`MementoClient` obj. """ # noqa: E501, W505 - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" # To prevent documentation inclusion from inherited class # because it is malformed. diff --git a/pywikibot/editor.py b/pywikibot/editor.py index d965b4d..d5c6d71 100644 --- a/pywikibot/editor.py +++ b/pywikibot/editor.py @@ -43,7 +43,7 @@ Editor detection functions were moved from :mod:`config`. """ - def __init__(self): + def __init__(self) -> None: """Setup external Editor.""" self.editor: str if config.editor is True: diff --git a/pywikibot/families/wikipedia_family.py b/pywikibot/families/wikipedia_family.py index ac6e522..a546d23 100644 --- a/pywikibot/families/wikipedia_family.py +++ b/pywikibot/families/wikipedia_family.py @@ -222,7 +222,7 @@ } @classmethod - def __post_init__(cls): + def __post_init__(cls) -> None: """Add 'yue' code alias due to :phab:`T341960`. .. versionadded:: 8.3 diff --git a/pywikibot/families/wiktionary_family.py b/pywikibot/families/wiktionary_family.py index 5e4ae08..b9647c0 100644 --- a/pywikibot/families/wiktionary_family.py +++ b/pywikibot/families/wiktionary_family.py @@ -93,7 +93,7 @@ } @classmethod - def __post_init__(cls): + def __post_init__(cls) -> None: """Add 'zh-yue' code alias due to :phab:`T341960`. .. versionadded:: 8.3 diff --git a/pywikibot/family.py b/pywikibot/family.py index e04b48a..9e9e251 100644 --- a/pywikibot/family.py +++ b/pywikibot/family.py @@ -18,7 +18,7 @@ from itertools import chain from os.path import basename, dirname, splitext from textwrap import fill -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, NoReturn import pywikibot from pywikibot import config @@ -545,14 +545,14 @@ """Return path to api.php.""" return f'{self.scriptpath(code)}/api.php' - def eventstreams_host(self, code): + def eventstreams_host(self, code) -> NoReturn: """Hostname for EventStreams. .. versionadded:: 3.0 """ raise NotImplementedError('This family does not support EventStreams') - def eventstreams_path(self, code): + def eventstreams_path(self, code) -> NoReturn: """Return path for EventStreams. .. versionadded:: 3.0 diff --git a/pywikibot/login.py b/pywikibot/login.py index 0622488..a3679c7 100644 --- a/pywikibot/login.py +++ b/pywikibot/login.py @@ -118,7 +118,7 @@ if getattr(config, 'password_file', ''): self.readPassword() - def __repr__(self): + def __repr__(self) -> str: """Return representation string for LoginManager. ..versionadded:: 10.0 diff --git a/pywikibot/page/_basepage.py b/pywikibot/page/_basepage.py index 58ede58..20301e3 100644 --- a/pywikibot/page/_basepage.py +++ b/pywikibot/page/_basepage.py @@ -413,7 +413,7 @@ return self._revisions[self._revid] return None - def _getInternals(self): + def _getInternals(self) -> None: """Helper function for get(). Stores latest revision in self if it doesn't contain it, doesn't think. @@ -1282,7 +1282,7 @@ callback=None, apply_cosmetic_changes: bool | None = None, quiet: bool = False, - **kwargs): + **kwargs) -> None: """Save the current contents of page's text to the wiki. .. versionchanged:: 7.0 @@ -1356,7 +1356,11 @@ cc=apply_cosmetic_changes, quiet=quiet, **kwargs) @allow_asynchronous - def _save(self, summary=None, cc=None, quiet: bool = False, **kwargs): + def _save(self, + summary=None, + cc=None, + quiet: bool = False, + **kwargs) -> None: """Helper function for save().""" link = self.title(as_link=True) if cc or (cc is None and config.cosmetic_changes): @@ -1485,7 +1489,7 @@ return self.site.purgepages([self], **kwargs) @deprecated_args(botflag='bot') # since 9.3.0 - def touch(self, callback=None, bot: bool = False, **kwargs): + def touch(self, callback=None, bot: bool = False, **kwargs) -> None: """Make a touch edit for this page. See Meth:`save` method docs for all parameters. The following @@ -2128,7 +2132,7 @@ return item['revisions'][0] return [] - def markDeletedRevision(self, timestamp, undelete: bool = True): + def markDeletedRevision(self, timestamp, undelete: bool = True) -> None: """Mark the revision identified by timestamp for undeletion. .. seealso:: diff --git a/pywikibot/page/_collections.py b/pywikibot/page/_collections.py index 5f6822f..adcaa86 100644 --- a/pywikibot/page/_collections.py +++ b/pywikibot/page/_collections.py @@ -493,7 +493,7 @@ """Ordered collection of sub-entities indexed by their ids.""" - def __init__(self, repo, data=None): + def __init__(self, repo, data=None) -> None: """Initializer. :param repo: Wikibase site @@ -508,7 +508,7 @@ if data: self.extend(data) - def _validate_isinstance(self, obj): + def _validate_isinstance(self, obj) -> None: if not isinstance(obj, self.type_class): raise TypeError( f'{type(self).__name__} should only hold instances of ' @@ -524,10 +524,10 @@ raise ValueError(f'No entity with id {index} was found') from e return self._data[index] - def __setitem__(self, index, value): + def __setitem__(self, index, value) -> None: raise NotImplementedError - def __delitem__(self, index): + def __delitem__(self, index) -> None: if isinstance(index, str): try: index = self._by_key[index] @@ -537,10 +537,10 @@ del self._data[index] del self._by_key[obj.id] - def __len__(self): + def __len__(self) -> int: return len(self._data) - def insert(self, index, obj): + def insert(self, index, obj) -> None: """Insert a sub-entity to the collection.""" self._validate_isinstance(obj) self._data.insert(index, obj) diff --git a/pywikibot/page/_decorators.py b/pywikibot/page/_decorators.py index 38c2d1f..6997d52 100644 --- a/pywikibot/page/_decorators.py +++ b/pywikibot/page/_decorators.py @@ -24,7 +24,7 @@ the first and a possible exception that occurred during saving in the second thread or None as the second argument. """ - def handle(func, self, *args, **kwargs): + def handle(func, self, *args, **kwargs) -> None: do_async = kwargs.pop('asynchronous', False) callback = kwargs.pop('callback', None) err = None diff --git a/pywikibot/page/_filepage.py b/pywikibot/page/_filepage.py index 6de3ecd..5512908 100644 --- a/pywikibot/page/_filepage.py +++ b/pywikibot/page/_filepage.py @@ -480,7 +480,7 @@ self._metadata = None self.update(file_revision) - def update(self, file_revision): + def update(self, file_revision) -> None: """Update FileInfo with new values. .. versionadded:: 8.6 @@ -517,7 +517,7 @@ return self._metadata @metadata.setter - def metadata(self, value): + def metadata(self, value) -> None: """Set metadata. .. versionadded:: 8.6 diff --git a/pywikibot/page/_links.py b/pywikibot/page/_links.py index bf5e323..5886be4 100644 --- a/pywikibot/page/_links.py +++ b/pywikibot/page/_links.py @@ -361,7 +361,7 @@ return (newsite.family.name, newsite.code) return (fam.name, code) # text before : doesn't match any known prefix - def parse(self): + def parse(self) -> None: """Parse wikitext of the link. Called internally when accessing attributes. diff --git a/pywikibot/page/_page.py b/pywikibot/page/_page.py index 6e5f277..1b30fba 100644 --- a/pywikibot/page/_page.py +++ b/pywikibot/page/_page.py @@ -130,7 +130,7 @@ keep_section: bool = False, save: bool = True, **kwargs - ): + ) -> None: """Change the page's text to point to the redirect page. .. versionchanged:: 9.3 diff --git a/pywikibot/page/_toolforge.py b/pywikibot/page/_toolforge.py index 973cd72..a5d6d54 100644 --- a/pywikibot/page/_toolforge.py +++ b/pywikibot/page/_toolforge.py @@ -28,7 +28,7 @@ #: Supported wikipedia site codes WIKIBLAME_CODES = 'als', 'bar', 'de', 'en', 'it', 'nds', 'sco' - def _check_wh_supported(self): + def _check_wh_supported(self) -> None: """Check if WikiHistory is supported.""" if self.site.family.name != 'wikipedia': raise NotImplementedError( diff --git a/pywikibot/page/_user.py b/pywikibot/page/_user.py index 1a4ba58..80a6de1 100644 --- a/pywikibot/page/_user.py +++ b/pywikibot/page/_user.py @@ -261,7 +261,7 @@ return ('emailuser' in maildata and maildata['emailuser']['result'] == 'Success') - def block(self, *args, **kwargs): + def block(self, *args, **kwargs) -> None: """Block user. Refer :py:obj:`APISite.blockuser` method for parameters. diff --git a/pywikibot/page/_wikibase.py b/pywikibot/page/_wikibase.py index 4860083..1d36615 100644 --- a/pywikibot/page/_wikibase.py +++ b/pywikibot/page/_wikibase.py @@ -19,7 +19,7 @@ from collections import OrderedDict, defaultdict from contextlib import suppress from itertools import chain -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, NoReturn import pywikibot from pywikibot.exceptions import ( @@ -139,7 +139,7 @@ f"'{type(self).__name__}' object has no attribute '{name}'" ) - def _initialize_empty(self): + def _initialize_empty(self) -> None: for key, cls in self.DATA_ATTRIBUTES.items(): setattr(self, key, cls.new_empty(self.repo)) @@ -391,7 +391,7 @@ return super().__getattr__(name) - def _assert_has_id(self): + def _assert_has_id(self) -> None: if self.id != '-1': return @@ -546,7 +546,7 @@ data = {'labels': labels} self.editEntity(data, **kwargs) - def addClaim(self, claim, bot: bool = True, **kwargs): + def addClaim(self, claim, bot: bool = True, **kwargs) -> None: """Add a claim to the MediaInfo. .. versionadded:: 8.5 @@ -873,7 +873,7 @@ keep_section: bool = False, save: bool = True, **kwargs - ): + ) -> NoReturn: """Set target of a redirect for a Wikibase page. Has not been implemented in the Wikibase API yet, except for ItemPage. @@ -881,7 +881,7 @@ raise NotImplementedError @allow_asynchronous - def addClaim(self, claim, bot: bool = True, **kwargs): + def addClaim(self, claim, bot: bool = True, **kwargs) -> None: """Add a claim to the entity. :param claim: The claim to add @@ -1404,7 +1404,7 @@ if datatype: self._type = datatype - def exists(self): + def exists(self) -> bool: """Determine if the property exists in the data repository. .. versionadded:: 9.4 @@ -1852,7 +1852,7 @@ data['references'].append(reference) return data - def setTarget(self, value): + def setTarget(self, value) -> None: """Set the target value in the local object. :param value: The new target value. @@ -1905,7 +1905,7 @@ """ return self.snaktype - def setSnakType(self, value): + def setSnakType(self, value) -> None: """Set the type of snak. :param value: Type of snak @@ -1954,7 +1954,7 @@ """ self.addSources([claim], **kwargs) - def addSources(self, claims, **kwargs): + def addSources(self, claims, **kwargs) -> None: """Add the claims as one source. :param claims: the claims to add @@ -2001,7 +2001,7 @@ source_dict[source.getID()].append(source) self.sources.remove(source_dict) - def addQualifier(self, qualifier, **kwargs): + def addQualifier(self, qualifier, **kwargs) -> None: """Add the given qualifier. :param qualifier: the qualifier to add @@ -2191,7 +2191,7 @@ super().__init__(site, title, entity_type='lexeme') assert self.id == self._link.title - def get_data_for_new_entity(self): + def get_data_for_new_entity(self) -> NoReturn: """Return data required for creation of a new lexeme.""" raise NotImplementedError # TODO @@ -2267,7 +2267,7 @@ return new_data @allow_asynchronous - def add_form(self, form, **kwargs): + def add_form(self, form, **kwargs) -> None: """Add a form to the lexeme. :param form: The form to add @@ -2310,7 +2310,7 @@ # TODO: senses - def mergeInto(self, lexeme, **kwargs): + def mergeInto(self, lexeme, **kwargs) -> None: """Merge the lexeme into another lexeme. :param lexeme: The lexeme to merge into @@ -2367,15 +2367,15 @@ return self._on_lexeme @on_lexeme.setter - def on_lexeme(self, lexeme): + def on_lexeme(self, lexeme) -> None: self._on_lexeme = lexeme @on_lexeme.deleter - def on_lexeme(self): + def on_lexeme(self) -> None: self._on_lexeme = None @allow_asynchronous - def addClaim(self, claim, **kwargs): + def addClaim(self, claim, **kwargs) -> None: """Add a claim to the form. :param claim: The claim to add diff --git a/pywikibot/pagegenerators/_generators.py b/pywikibot/pagegenerators/_generators.py index 2958652..7308caa 100644 --- a/pywikibot/pagegenerators/_generators.py +++ b/pywikibot/pagegenerators/_generators.py @@ -985,7 +985,7 @@ if page.site == site: yield page - def set_maximum_items(self, value: int, /): + def set_maximum_items(self, value: int, /) -> None: """Set the maximum number of items to be retrieved from google. This method is added to be used by the @@ -1462,7 +1462,7 @@ .. versionadded:: 9.0 """ - def __init__(self, id: int): + def __init__(self, id: int) -> None: """Initializer. :param id: The PagePile id to query diff --git a/pywikibot/proofreadpage.py b/pywikibot/proofreadpage.py index 502d9e4..bfb8300 100644 --- a/pywikibot/proofreadpage.py +++ b/pywikibot/proofreadpage.py @@ -125,7 +125,7 @@ .. versionadded:: 8.0 """ - def __init__(self, attr, value): + def __init__(self, attr, value) -> None: """Initializer.""" self.attr = attr self._value = self._convert(value) @@ -152,14 +152,14 @@ return self._value @value.setter - def value(self, value): + def value(self, value) -> None: self._value = self._convert(value) - def __str__(self): + def __str__(self) -> str: attr = 'from' if self.attr == 'ffrom' else self.attr return f'{attr}={self._orig_value}' - def __repr__(self): + def __repr__(self) -> str: attr = 'from' if self.attr == 'ffrom' else self.attr return f"{type(self).__name__}('{attr}', {self._orig_value!r})" @@ -171,7 +171,7 @@ .. versionadded:: 8.0 """ - def __init__(self): + def __init__(self) -> None: """Initializer.""" self.attrs = WeakKeyDictionary() @@ -182,7 +182,7 @@ attr = self.attrs.get(obj) return attr.value if attr is not None else None - def __set__(self, obj, value): + def __set__(self, obj, value) -> None: attr = self.attrs.get(obj) if attr is not None: attr.value = value @@ -284,7 +284,7 @@ tosection = TagAttrDesc() onlysection = TagAttrDesc() - def __init__(self, text='<pages />'): + def __init__(self, text='<pages />') -> None: """Initializer.""" m = self.pat_tag.search(text) if m is None: @@ -308,17 +308,17 @@ if isinstance(v, TagAttrDesc)} return res - def __contains__(self, attr): + def __contains__(self, attr) -> bool: return getattr(self, attr) is not None - def __str__(self): + def __str__(self) -> str: descriptors = self.get_descriptors().items() attrs = [v.attrs.get(self) for k, v in descriptors if v.attrs.get(self) is not None] attrs = ' '.join(str(attr) for attr in attrs) return f'<pages {attrs} />' if attrs else '<pages />' - def __repr__(self): + def __repr__(self) -> str: return f"{self.__class__.__name__}('{self}')" diff --git a/pywikibot/scripts/generate_user_files.py b/pywikibot/scripts/generate_user_files.py index bd4d6fb..c5a5950 100755 --- a/pywikibot/scripts/generate_user_files.py +++ b/pywikibot/scripts/generate_user_files.py @@ -349,7 +349,7 @@ main_code: str, main_username: str, force: bool = False -): +) -> None: """Create a user-config.py in base_dir. Create a user-password.py if necessary. @@ -438,7 +438,7 @@ save_botpasswords(botpasswords, f_pass) -def save_botpasswords(botpasswords: str, path: Path): +def save_botpasswords(botpasswords: str, path: Path) -> None: """Write botpasswords to file. :param botpasswords: botpasswords for password file diff --git a/pywikibot/scripts/login.py b/pywikibot/scripts/login.py index eacc7f9..a940fca 100755 --- a/pywikibot/scripts/login.py +++ b/pywikibot/scripts/login.py @@ -95,7 +95,7 @@ ) -def login_one_site(code, family, oauth, logout, autocreate): +def login_one_site(code, family, oauth, logout, autocreate) -> None: """Login on one site.""" try: site = pywikibot.Site(code, family) diff --git a/pywikibot/scripts/wrapper.py b/pywikibot/scripts/wrapper.py index 1096e09..9396ad2 100755 --- a/pywikibot/scripts/wrapper.py +++ b/pywikibot/scripts/wrapper.py @@ -43,7 +43,7 @@ enable external scripts via entry points. """ # -# (C) Pywikibot team, 2012-2024 +# (C) Pywikibot team, 2012-2025 # # Distributed under the terms of the MIT license. # @@ -64,7 +64,7 @@ site_package = False -def check_pwb_versions(package: str): +def check_pwb_versions(package: str) -> None: """Validate package version and scripts version. Rules: @@ -113,7 +113,7 @@ # https://bitbucket.org/ned/coveragepy/src/2c5fb3a8b81c/setup.py?at=default#c… -def run_python_file(filename: str, args: list[str], package=None): +def run_python_file(filename: str, args: list[str], package=None) -> None: """Run a python file as if it were the main program on the command line. .. versionchanged:: 7.7 @@ -208,7 +208,9 @@ return fname, list(args[index:]), local, env -def _print_requirements(requirements, script, variant): # pragma: no cover +def _print_requirements(requirements, + script, + variant) -> None: # pragma: no cover """Print pip command to install requirements.""" if not requirements: return @@ -459,7 +461,7 @@ return find_alternates(filename, path_list) -def execute(): +def execute() -> bool: """Parse arguments, extract filename and run the script. .. versionadded:: 7.0 @@ -526,7 +528,7 @@ return True -def main(): +def main() -> None: """Script entry point. Print doc if necessary. .. versionchanged:: 7.0 @@ -539,7 +541,7 @@ print(__doc__) -def run(): # pragma: no cover +def run() -> None: # pragma: no cover """Site package entry point. Print doc if necessary. .. versionadded:: 7.0 diff --git a/pywikibot/site/_basesite.py b/pywikibot/site/_basesite.py index 4122284..28a33a4 100644 --- a/pywikibot/site/_basesite.py +++ b/pywikibot/site/_basesite.py @@ -97,7 +97,7 @@ @property @deprecated(since='8.5.0') - def use_hard_category_redirects(self): + def use_hard_category_redirects(self) -> bool: """Hard redirects are used for this site. Originally create as property for future use for a proposal to @@ -306,7 +306,7 @@ """Return list of localized PAGENAMEE tags for the site.""" return ['PAGENAMEE'] - def lock_page(self, page, block: bool = True): + def lock_page(self, page, block: bool = True) -> None: """Lock page for writing. Must be called before writing any page. We don't want different threads trying to write to the same page diff --git a/pywikibot/site/_tokenwallet.py b/pywikibot/site/_tokenwallet.py index 8237ad7..0baabde 100644 --- a/pywikibot/site/_tokenwallet.py +++ b/pywikibot/site/_tokenwallet.py @@ -91,7 +91,7 @@ return (f'{type(self).__name__}' f'(pywikibot.Site({self.site.sitename!r}{user}))') - def clear(self): + def clear(self) -> None: """Clear the self._tokens cache. Tokens are reloaded when needed. .. versionadded:: 8.0 diff --git a/pywikibot/site_detect.py b/pywikibot/site_detect.py index 1c58945..95b6ddb 100644 --- a/pywikibot/site_detect.py +++ b/pywikibot/site_detect.py @@ -273,7 +273,7 @@ self.set_api_url(attrs['src']) -def check_response(response): +def check_response(response) -> None: """Raise ClientError or ServerError depending on http status. .. versionadded:: 3.0 diff --git a/pywikibot/specialbots/_upload.py b/pywikibot/specialbots/_upload.py index acbf01c..bbe2e6a 100644 --- a/pywikibot/specialbots/_upload.py +++ b/pywikibot/specialbots/_upload.py @@ -469,7 +469,7 @@ return False - def run(self): + def run(self) -> None: """Run bot. .. versionchanged:: 9.1 diff --git a/pywikibot/textlib.py b/pywikibot/textlib.py index dbbae33..6d9faba 100644 --- a/pywikibot/textlib.py +++ b/pywikibot/textlib.py @@ -728,7 +728,7 @@ return replace_list[1] return None - def check_classes(replacement): + def check_classes(replacement) -> None: """Normalize the replacement into a list.""" if not isinstance(replacement, (pywikibot.Page, pywikibot.Link)): raise ValueError('The replacement must be None, False, a' diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py index 6e9bc35..8fcae2d 100644 --- a/pywikibot/tools/__init__.py +++ b/pywikibot/tools/__init__.py @@ -663,7 +663,7 @@ mode: int = 0o600, quiet: bool = False, create: bool = False -): +) -> None: """Check file mode and update it, if needed. .. versionadded:: 3.0 diff --git a/pywikibot/tools/_deprecate.py b/pywikibot/tools/_deprecate.py index 8a05ae5..fbeb9b7 100644 --- a/pywikibot/tools/_deprecate.py +++ b/pywikibot/tools/_deprecate.py @@ -191,7 +191,7 @@ instead: str | None = None, depth: int = 2, *, warning_class: type | None = None, - since: str | None = None): + since: str | None = None) -> None: """Issue a deprecation warning. .. versionchanged:: 7.0 @@ -671,7 +671,7 @@ replacement_name: str | None = None, warning_message: str | None = None, since: str = '', - future_warning: bool = True): + future_warning: bool = True) -> None: """Add the name to the local deprecated names dict. .. versionchanged:: 7.0 diff --git a/pywikibot/tools/threading.py b/pywikibot/tools/threading.py index 0692c05..35d2bdf 100644 --- a/pywikibot/tools/threading.py +++ b/pywikibot/tools/threading.py @@ -275,14 +275,14 @@ bound = self._bound_semaphore._initial_value return '' if bound == self._max_workers else f'{sep}{bound}' - def __str__(self): + def __str__(self) -> str: """String of current BoundedPoolExecutor type. Includes *max_bound* if necessary. """ return f'{type(self).__name__}({self._bound()})' - def __repr__(self): + def __repr__(self) -> str: """Representation string of BoundedPoolExecutor. Includes the *executor* and *max_bound* if necessary. diff --git a/pywikibot/userinterfaces/gui.py b/pywikibot/userinterfaces/gui.py index acee922..6c9d180 100644 --- a/pywikibot/userinterfaces/gui.py +++ b/pywikibot/userinterfaces/gui.py @@ -259,7 +259,7 @@ self.tag_add(tkinter.SEL, start, end) self.focus_set() - def goto_line_event(self, event): + def goto_line_event(self, event) -> str | None: """Perform goto line operation.""" lineno = simpledialog.askinteger('Goto', 'Go to line number:', parent=self) diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py index 6b2994c..094b1af 100644 --- a/pywikibot/userinterfaces/terminal_interface_base.py +++ b/pywikibot/userinterfaces/terminal_interface_base.py @@ -11,7 +11,7 @@ import re import sys import threading -from typing import Any +from typing import Any, NoReturn import pywikibot from pywikibot import config @@ -140,7 +140,7 @@ warnings_logger = logging.getLogger('py.warnings') warnings_logger.addHandler(warning_handler) - def encounter_color(self, color, target_stream): + def encounter_color(self, color, target_stream) -> NoReturn: """Abstract method to handle the next color encountered.""" raise NotImplementedError(f'The {type(self).__name__} class does not' ' support colors.') diff --git a/scripts/archivebot.py b/scripts/archivebot.py index 9231ed1..33f4fe9 100755 --- a/scripts/archivebot.py +++ b/scripts/archivebot.py @@ -954,7 +954,7 @@ :param args: command line arguments """ - def signal_handler(signum, frame): + def signal_handler(signum, frame) -> None: pywikibot.info('\n<<lightyellow>>User quit bot run...') exiting.set() diff --git a/scripts/blockpageschecker.py b/scripts/blockpageschecker.py index 68d0f36..b575eb1 100755 --- a/scripts/blockpageschecker.py +++ b/scripts/blockpageschecker.py @@ -236,7 +236,7 @@ summary = i18n.twtranslate(self.site, 'blockpageschecker-' + key) self.userPut(page, page.text, newtext, summary=summary) - def skip_page(self, page): + def skip_page(self, page) -> bool: """Skip if the user has not permission to edit.""" # FIXME: This check does not work : # PreloadingGenerator cannot set correctly page.edit_restrictioniction diff --git a/scripts/category_graph.py b/scripts/category_graph.py index b30655b..65c6206 100755 --- a/scripts/category_graph.py +++ b/scripts/category_graph.py @@ -71,7 +71,7 @@ """Bot to create graph of the category structure.""" @staticmethod - def setup_args(ap): + def setup_args(ap) -> None: """Declares arguments.""" ap.add_argument('-from', nargs='?', default=argparse.SUPPRESS) ap.add_argument('-to', nargs='?', default='') diff --git a/scripts/category_redirect.py b/scripts/category_redirect.py index 99bae63..fc4e0cc 100755 --- a/scripts/category_redirect.py +++ b/scripts/category_redirect.py @@ -231,7 +231,7 @@ log_text += ('\n\n' + message) return log_text - def setup_hard_redirect(self): + def setup_hard_redirect(self) -> None: """Setup hard redirect task.""" pywikibot.info('Checking hard-redirect category pages.') self.summary_key = REDIR_COMMENT @@ -317,7 +317,7 @@ else: self.counter['touch'] += 1 - def setup_soft_redirect(self): + def setup_soft_redirect(self) -> None: """Setup soft redirect task.""" pywikibot.info(f'\nChecking {self.cat.categoryinfo["subcats"]}' ' category redirect pages') diff --git a/scripts/clean_sandbox.py b/scripts/clean_sandbox.py index d40245c..57e06e3 100755 --- a/scripts/clean_sandbox.py +++ b/scripts/clean_sandbox.py @@ -229,7 +229,7 @@ self.generator = pages - def treat(self, page): + def treat(self, page) -> None: """Treat a single page.""" if not page.exists(): pywikibot.info('*** The sandbox is not existent, skipping.') diff --git a/scripts/create_isbn_edition.py b/scripts/create_isbn_edition.py index 77249ec..2f06ce6 100755 --- a/scripts/create_isbn_edition.py +++ b/scripts/create_isbn_edition.py @@ -589,7 +589,7 @@ transcmt = '#pwb Create ISBN edition' -def fatal_error(errcode, errtext): +def fatal_error(errcode, errtext) -> None: """A fatal error has occurred. Print the error message, and exit with an error code. diff --git a/scripts/delinker.py b/scripts/delinker.py index 939602c..73ae0f3 100755 --- a/scripts/delinker.py +++ b/scripts/delinker.py @@ -71,7 +71,7 @@ return True return super().skip_page(page) - def treat(self, file_page): + def treat(self, file_page) -> None: """Set page to current page and delink that page.""" # use image_regex from image.py namespace = file_page.site.namespaces[6] @@ -92,7 +92,7 @@ shown = True super().treat(page) - def treat_page(self): + def treat_page(self) -> None: """Delink a single page.""" new = re.sub(self.image_regex, '', self.current_page.text) self.put_current(new) @@ -205,7 +205,7 @@ self.summary_parameters = dict(item) return pywikibot.FilePage(item.page(), ignore_extension=True) - def teardown(self): + def teardown(self) -> None: """Save the last used logevent timestamp.""" if not hasattr(self, 'last_ts'): return diff --git a/scripts/harvest_template.py b/scripts/harvest_template.py index 91d2248..4c34843 100755 --- a/scripts/harvest_template.py +++ b/scripts/harvest_template.py @@ -213,7 +213,7 @@ self.linkR = textlib.compileLinkR() self.create_missing_item = self.opt.create - def setup(self): + def setup(self) -> None: """Cache some static data from wikis.""" self.cacheSources() self.templateTitles = self.getTemplateSynonyms(self.template_title) diff --git a/scripts/interwiki.py b/scripts/interwiki.py index 61bebbf..5a059d7 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -1055,7 +1055,7 @@ if self.conf.hintsareright: self.hintedsites.add(page.site) - def redir_checked(self, page, counter): + def redir_checked(self, page, counter) -> bool: """Check and handle redirect. Return True if check is done.""" if page.isRedirectPage(): redirect_target = page.getRedirectTarget() @@ -1282,7 +1282,7 @@ self.reportInterwikilessPage(page) self.askForHints(counter) - def isDone(self): + def isDone(self) -> bool: """Return True if all the work for this subject has completed.""" return not self.todo @@ -1404,7 +1404,7 @@ return result - def finish(self): + def finish(self) -> None: """Round up the subject, making any necessary changes. This should be called exactly once after the todo collection has @@ -1428,7 +1428,7 @@ self.post_processing() - def post_processing(self): + def post_processing(self) -> None: """Some finishing processes to be done.""" pywikibot.info(f'======Post-processing {self.origin}======') # Assemble list of accepted interwiki links @@ -1458,7 +1458,7 @@ if config.interwiki_backlink: self.reportBacklinks(new, updatedSites) - def process_limit_two(self, new, updated): + def process_limit_two(self, new, updated) -> None: """Post process limittwo.""" lclSite = self.origin.site lclSiteDone = False @@ -1508,7 +1508,7 @@ except GiveUpOnPage: break - def process_unlimited(self, new, updated): + def process_unlimited(self, new, updated) -> None: """Post process unlimited.""" for (site, page) in new.items(): # if we have an account for this site diff --git a/scripts/maintenance/addwikis.py b/scripts/maintenance/addwikis.py index 2c6eb67..b7cfaf3 100755 --- a/scripts/maintenance/addwikis.py +++ b/scripts/maintenance/addwikis.py @@ -36,7 +36,7 @@ ] -def update_family(family, wikis): +def update_family(family, wikis) -> None: """Update codes set in family file.""" joined_wikis = "', '".join(wikis) pywikibot.info(f"Adding '{joined_wikis}' to {family} family...\n") diff --git a/scripts/maintenance/cache.py b/scripts/maintenance/cache.py index 45674ff..9cc42af 100755 --- a/scripts/maintenance/cache.py +++ b/scripts/maintenance/cache.py @@ -96,16 +96,16 @@ """A Request cache entry.""" - def __init__(self, directory: str, filename: str): + def __init__(self, directory: str, filename: str) -> None: """Initializer.""" self.directory = directory self.filename = filename - def __str__(self): + def __str__(self) -> str: """Return string equivalent of object.""" return self.filename - def __repr__(self): + def __repr__(self) -> str: """Representation of object.""" return str(self._cachefile_path()) @@ -129,7 +129,7 @@ """ return self._get_cache_dir() / self._create_file_name() - def _load_cache(self): + def _load_cache(self) -> bool: """Load the cache entry.""" with self._cachefile_path().open('rb') as f: self.key, self._data, self._cachetime = pickle.load(f) @@ -192,7 +192,7 @@ self._parsed_key = (site, username, login_status, params) return self._parsed_key - def _rebuild(self): + def _rebuild(self) -> None: """Reconstruct the original Request from the key.""" if hasattr(self, '_parsed_key'): (site, username, login_status, params) = self._parsed_key @@ -213,14 +213,14 @@ value = value.decode(self.site.encoding()) self._params[key] = value.split('|') - def _delete(self): + def _delete(self) -> None: """Delete the cache entry.""" self._cachefile_path().unlink() def process_entries(cache_path, func, use_accesstime: bool | None = None, output_func=None, action_func=None, *, - tests: int | None = None): + tests: int | None = None) -> None: """Check the contents of the cache. This program tries to use file access times to determine whether @@ -419,7 +419,7 @@ return lines -def main(): +def main() -> None: """Process command line arguments and invoke bot.""" local_args = pywikibot.handle_args() cache_paths = None diff --git a/scripts/maintenance/colors.py b/scripts/maintenance/colors.py index 63c46a5..f2d0c86 100755 --- a/scripts/maintenance/colors.py +++ b/scripts/maintenance/colors.py @@ -12,7 +12,7 @@ from pywikibot.userinterfaces.terminal_interface_base import colors -def main(): +def main() -> None: """Main function.""" fg_colors = [col for col in colors if col != 'default'] bg_colors = fg_colors[:] diff --git a/scripts/maintenance/make_i18n_dict.py b/scripts/maintenance/make_i18n_dict.py index 8cc41ad..1a1ae26 100755 --- a/scripts/maintenance/make_i18n_dict.py +++ b/scripts/maintenance/make_i18n_dict.py @@ -47,7 +47,7 @@ """I18n bot.""" - def __init__(self, script, *args, **kwargs): + def __init__(self, script, *args, **kwargs) -> None: """Initializer.""" modules = script.split('.') self.scriptname = modules[0] @@ -65,7 +65,7 @@ self.messages[old] = new.replace('_', '-') self.dict = {} - def print_all(self): + def print_all(self) -> None: """Pretty print the dict as a file content to screen.""" if not self.dict: print('No messages found, read them first.\n' @@ -89,7 +89,7 @@ print(' },') print('};') - def read(self, oldmsg, newmsg=None): + def read(self, oldmsg, newmsg=None) -> None: """Read a single message from source script.""" msg = getattr(self.script, oldmsg) keys = list(msg.keys()) @@ -110,7 +110,7 @@ if 'en' not in keys: print('WARNING: "en" key missing for message ' + newmsg) - def run(self, quiet=False): + def run(self, quiet=False) -> None: """Run the bot, read the messages from source and print the dict. :param quiet: print the result if False @@ -121,7 +121,7 @@ if not quiet: self.print_all() - def to_json(self, quiet=True): + def to_json(self, quiet=True) -> None: """Run the bot and create json files. :param quiet: Print the result if False diff --git a/scripts/maintenance/unidata.py b/scripts/maintenance/unidata.py index f7b5b92..096a600 100755 --- a/scripts/maintenance/unidata.py +++ b/scripts/maintenance/unidata.py @@ -80,7 +80,7 @@ return site_excepts -def threads_target(q): +def threads_target(q) -> None: """Thread processing a single site.""" global families_excepts while True: @@ -104,7 +104,7 @@ return threads -def stop_threads(q, threads): +def stop_threads(q, threads) -> None: """Stop threads.""" for _ in range(NUMBER_OF_THREADS): q.put(None) @@ -112,7 +112,7 @@ t.join() -def main(): +def main() -> None: """Main loop processing sites.""" global families_excepts q = Queue() @@ -137,7 +137,7 @@ stop_threads(q, threads) -def save_json(obj, path): +def save_json(obj, path) -> None: """Save data to file.""" with open(path, 'w', encoding='utf8') as f: dump(obj, f) diff --git a/scripts/movepages.py b/scripts/movepages.py index 8086cd9..0850b4f 100755 --- a/scripts/movepages.py +++ b/scripts/movepages.py @@ -171,7 +171,7 @@ def _title_creator(self, page, prefix): """Create function to generate new title.""" - def create_new_title_prefix(prefix, page): + def create_new_title_prefix(prefix, page) -> str: """Replace prefix helper function.""" page_title = page.title(with_ns=False) return f'{prefix}{page_title}' diff --git a/scripts/noreferences.py b/scripts/noreferences.py index 79ca562..2f8a53e 100755 --- a/scripts/noreferences.py +++ b/scripts/noreferences.py @@ -768,7 +768,7 @@ f'localized for {self.site}') return oldText[:index].rstrip() + ref_section + oldText[index:] - def skip_page(self, page): + def skip_page(self, page) -> bool: """Check whether the page could be processed.""" if super().skip_page(page): return True diff --git a/scripts/nowcommons.py b/scripts/nowcommons.py index 02f60d7..6abfbeb 100755 --- a/scripts/nowcommons.py +++ b/scripts/nowcommons.py @@ -377,7 +377,7 @@ pywikibot.info( 'The file is not identical to the one on Commons.') - def teardown(self): + def teardown(self) -> None: """Show a message if no files were found.""" if self.generator_completed and not self.counter['read']: pywikibot.info('No transcluded files found for ' diff --git a/scripts/patrol.py b/scripts/patrol.py index 410c1ea..b571bff 100755 --- a/scripts/patrol.py +++ b/scripts/patrol.py @@ -111,7 +111,7 @@ self._load_prefix_index_aliases() - def _load_prefix_index_aliases(self): + def _load_prefix_index_aliases(self) -> None: """Load _prefixindex_aliases.""" for entry in self.site.siteinfo['specialpagealiases']: if entry['realname'] == 'Prefixindex': @@ -121,7 +121,7 @@ else: raise RuntimeError('No alias for "prefixindex"') - def setup(self): + def setup(self) -> None: """Load most recent watchlist_page for further processing.""" # Check for a more recent version after versionchecktime in sec. if (self.whitelist_load_ts and (time.time() - self.whitelist_load_ts @@ -275,7 +275,7 @@ return True return False - def treat(self, page): + def treat(self, page) -> None: """It loads the given page, does some changes, and saves it.""" choice = False diff --git a/scripts/reflinks.py b/scripts/reflinks.py index 5d14b93..795a9cc 100755 --- a/scripts/reflinks.py +++ b/scripts/reflinks.py @@ -530,7 +530,7 @@ urlobj.close() os.unlink(infile) - def setup(self): + def setup(self) -> None: """Read dead links from file.""" try: path = Path(listof404pages) @@ -542,7 +542,7 @@ 'http://www.twoevils.org/files/wikipedia/404-links.txt.gz\n' 'and to unzip it in the same directory') - def skip_page(self, page): + def skip_page(self, page) -> bool: """Skip unwanted pages.""" if super().skip_page(page): return True diff --git a/scripts/replace.py b/scripts/replace.py index 9ca9904..325d99e 100755 --- a/scripts/replace.py +++ b/scripts/replace.py @@ -246,7 +246,7 @@ return f'-{self.old} +{self.new}' @property - def container(self): + def container(self) -> None: """Container object which contains this replacement. A container object is an object that groups one or more replacements @@ -672,7 +672,7 @@ semicolon = self.site.mediawiki_message('semicolon-separator') return semicolon.join(summary_messages) - def skip_page(self, page): + def skip_page(self, page) -> bool: """Check whether treat should be skipped for the page.""" if super().skip_page(page): return True diff --git a/scripts/touch.py b/scripts/touch.py index a38d210..b751a6d 100755 --- a/scripts/touch.py +++ b/scripts/touch.py @@ -79,7 +79,7 @@ 'redirects': None } - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) self.pages = defaultdict(list) @@ -97,7 +97,7 @@ self.limit.setdefault(page.site, page.site.ratelimit('purge')) self.purgepages() - def teardown(self): + def teardown(self) -> None: """Purge remaining pages if no KeyboardInterrupt was made. .. versionadded:: 8.0 @@ -109,7 +109,7 @@ # show the counter even no purges were made self.counter['purge'] += 0 - def purgepages(self, flush=False): + def purgepages(self, flush=False) -> None: """Purge a bulk of page if rate limit exceeded. .. versionadded:: 8.0 diff --git a/scripts/unlink.py b/scripts/unlink.py index ea8ed3f..47d0a88 100755 --- a/scripts/unlink.py +++ b/scripts/unlink.py @@ -45,7 +45,7 @@ summary_key = 'unlink-unlinking' - def __init__(self, page_title: str, **kwargs): + def __init__(self, page_title: str, **kwargs) -> None: """Initialize a UnlinkBot instance with the given page to unlink.""" super().__init__(**kwargs) self.pageToUnlink = pywikibot.Page(self.site, page_title) # noqa: N803 @@ -57,7 +57,7 @@ """Return the title parameter.""" return {'title': self.pageToUnlink.title()} - def treat_page(self): + def treat_page(self) -> None: """Remove links pointing to the configured page from the given page.""" self.unlink(self.pageToUnlink) diff --git a/scripts/unusedfiles.py b/scripts/unusedfiles.py index 0618b51..d9309c0 100755 --- a/scripts/unusedfiles.py +++ b/scripts/unusedfiles.py @@ -145,7 +145,7 @@ else: self.append_text(usertalkpage, '\n\n' + msg2uploader + ' ~~~~') - def append_text(self, page, apptext): + def append_text(self, page, apptext) -> None: """Append apptext to the page.""" if page.isRedirectPage(): page = page.getRedirectTarget() diff --git a/scripts/weblinkchecker.py b/scripts/weblinkchecker.py index 05c061f..078aded 100755 --- a/scripts/weblinkchecker.py +++ b/scripts/weblinkchecker.py @@ -289,7 +289,7 @@ cls.hosts[name] = max(now, timestamp) + 6 return max(0, timestamp - now) - def run(self): + def run(self) -> None: """Run the bot.""" time.sleep(self.get_delay(self.name)) try: diff --git a/tests/__init__.py b/tests/__init__.py index 2ce9f52..530c2ea 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -199,7 +199,7 @@ script_test_modules) -def unittest_print(*args, **kwargs): +def unittest_print(*args, **kwargs) -> None: """Print information in test log.""" print(*args, **kwargs) # noqa: T201 @@ -286,7 +286,7 @@ """Add caching to every Request except logins.""" - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(0, *args, **kwargs) @@ -295,7 +295,7 @@ """Circumvent CachedRequest implementation.""" return cls(site=req_site, parameters=kwargs) - def _expired(self, dt): + def _expired(self, dt) -> bool: """Never invalidate cached data.""" return False @@ -319,7 +319,7 @@ original_expired = None -def patch_request(): +def patch_request() -> None: """Patch Request classes with TestRequest.""" global original_expired pywikibot.data.api.Request = TestRequest @@ -327,7 +327,7 @@ pywikibot.data.api.CachedRequest._expired = lambda *args, **kwargs: False -def unpatch_request(): +def unpatch_request() -> None: """Un-patch Request classes with TestRequest.""" pywikibot.data.api.Request = _original_Request pywikibot.data.api.CachedRequest._expired = original_expired diff --git a/tests/add_text_tests.py b/tests/add_text_tests.py index 30a7d7c..e032cb1 100755 --- a/tests/add_text_tests.py +++ b/tests/add_text_tests.py @@ -45,7 +45,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Setup test.""" super().setUp() pywikibot.bot.ui.clear() @@ -93,7 +93,7 @@ @patch('pywikibot.input') @patch('pywikibot.handle_args', Mock(side_effect=lambda args: args)) - def test_argument_prompt(self, input_mock): + def test_argument_prompt(self, input_mock) -> None: """Request an argument that requires a prompt.""" input_mock.return_value = 'hello world' @@ -141,7 +141,7 @@ bot.setup() self.assertEqual('hello\nworld', bot.opt.text) - def common_setup_test_with_textfile(self, mock_file): + def common_setup_test_with_textfile(self, mock_file) -> None: """Exercise both with a -textfile argument.""" bot = AddTextBot(textfile='/path/to/my/file.txt') # setup reads the file content @@ -156,13 +156,13 @@ f'Test for Python 3.10 but {PYTHON_VERSION} given') @patch('pathlib.Path._accessor.open', new_callable=mock_open, read_data='file data') - def test_textfile_py10(self, mock_file): + def test_textfile_py10(self, mock_file) -> None: """Test with a -textfile argument for Python 3.10.""" self.common_setup_test_with_textfile(mock_file) @unittest.skipIf(PYTHON_310, 'Test except for Python 3.10') @patch('io.open', new_callable=mock_open, read_data='file data') - def test_textfile_other(self, mock_file): + def test_textfile_other(self, mock_file) -> None: """Test with a -textfile argument for Python != 3.10.""" self.common_setup_test_with_textfile(mock_file) diff --git a/tests/api_tests.py b/tests/api_tests.py index fc9e001..d2944cb 100755 --- a/tests/api_tests.py +++ b/tests/api_tests.py @@ -12,6 +12,7 @@ import unittest from collections import defaultdict from contextlib import suppress +from typing import NoReturn from unittest.mock import patch import pywikibot.family @@ -363,7 +364,7 @@ titles = ('Broadcaster (definition)', 'Wiktionary', 'Broadcaster.com', 'Wikipedia:Disambiguation') - def setUp(self): + def setUp(self) -> None: """Set up test case.""" super().setUp() mysite = self.get_site() @@ -584,7 +585,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Set up test case.""" super().setUp() self.site = self.get_site() @@ -661,7 +662,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Set up test case.""" super().setUp() mysite = self.get_site() @@ -766,7 +767,7 @@ hostname = 'steward.wikimedia.org' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up steward Family.""" super().setUpClass() fam = pywikibot.family.AutoFamily( @@ -782,20 +783,20 @@ # for a password even if the username does not exist, and even if # pywikibot is not connected to a tty. T100964 - def setUp(self): + def setUp(self) -> None: """Patch the LoginManager to avoid UI interaction.""" super().setUp() self.orig_login_manager = pywikibot.login.ClientLoginManager pywikibot.login.ClientLoginManager = FakeLoginManager - def tearDown(self): + def tearDown(self) -> None: """Restore the original LoginManager.""" pywikibot.login.ClientLoginManager = self.orig_login_manager super().tearDown() @patch.object(pywikibot, 'info') @patch.object(pywikibot, 'warning') - def test_access_denied_notexist_username(self, warning, info): + def test_access_denied_notexist_username(self, warning, info) -> None: """Test the query with a username which does not exist.""" self.site._username = 'Not registered username' req = api.Request(site=self.site, parameters={'action': 'query'}) @@ -817,7 +818,7 @@ @patch.object(pywikibot, 'warning') @patch.object(pywikibot.config, 'usernames', defaultdict(dict)) - def test_access_denied_no_username(self, warning): + def test_access_denied_no_username(self, warning) -> None: """Test the query without a username.""" self.site._username = None req = api.Request(site=self.site, parameters={'action': 'query'}) @@ -884,7 +885,7 @@ """Dummy Throttle class.""" - def lag(self, lag): + def lag(self, lag) -> NoReturn: """Override lag method, save the lag value and exit the api loop.""" self._lagvalue = lag # save the lag value raise SystemExit # exit the api loop diff --git a/tests/archivebot_tests.py b/tests/archivebot_tests.py index 2c81554..d580b62 100755 --- a/tests/archivebot_tests.py +++ b/tests/archivebot_tests.py @@ -116,7 +116,7 @@ cached = True expected_failures = ['ar', 'scn', 'th'] - def test_archivebot(self, code=None): + def test_archivebot(self, code=None) -> None: """Test archivebot for one site.""" site = self.get_site(code) page = pywikibot.Page(site, 'user talk:xqt') @@ -175,7 +175,7 @@ cached = True - def test_archivebot(self, code=None): + def test_archivebot(self, code=None) -> None: """Test archivebot for one site.""" site = self.get_site(code) page = pywikibot.Page(site, 'user talk:mpaa') @@ -214,7 +214,7 @@ family = 'wikipedia' code = 'test' - def load_page(self, title: str): + def load_page(self, title: str) -> None: """Load the given page.""" page = pywikibot.Page(self.site, title) tmpl = pywikibot.Page(self.site, 'User:MiszaBot/config') diff --git a/tests/aspects.py b/tests/aspects.py index fe0f2df..39f0634 100644 --- a/tests/aspects.py +++ b/tests/aspects.py @@ -71,12 +71,12 @@ # before a note is added after the test. test_duration_warning_interval = 10 - def setUp(self): + def setUp(self) -> None: """Set up test.""" self.test_start = time.time() super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Tear down test.""" super().tearDown() self.test_completed = time.time() @@ -90,7 +90,7 @@ """Base class for all tests.""" - def assertIsEmpty(self, seq, msg=None): + def assertIsEmpty(self, seq, msg=None) -> None: """Check that the sequence is empty.""" self.assertIsInstance( seq, Sized, SIZED_ERROR) @@ -98,7 +98,7 @@ msg = self._formatMessage(msg, f'{safe_repr(seq)} is not empty') self.fail(msg) - def assertIsNotEmpty(self, seq, msg=None): + def assertIsNotEmpty(self, seq, msg=None) -> None: """Check that the sequence is not empty.""" self.assertIsInstance( seq, Sized, SIZED_ERROR) @@ -106,7 +106,7 @@ msg = self._formatMessage(msg, f'{safe_repr(seq)} is empty') self.fail(msg) - def assertLength(self, seq, other, msg=None): + def assertLength(self, seq, other, msg=None) -> None: """Verify that a sequence seq has the length of other.""" # the other parameter may be given as a sequence too self.assertIsInstance( @@ -370,7 +370,7 @@ $ pytest -a 'not site' """ - def setUp(self): + def setUp(self) -> None: """Set up test.""" self.old_Site_lookup_method = pywikibot.Site pywikibot.Site = lambda *args: self.fail( @@ -378,7 +378,7 @@ super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Tear down test.""" super().tearDown() @@ -393,12 +393,12 @@ API responses. """ - def setUp(self): + def setUp(self) -> None: """Set up test.""" patch_request() super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Tear down test.""" super().tearDown() unpatch_request() @@ -408,7 +408,7 @@ """Site interface to prevent sites being loaded.""" - def __init__(self, code, fam=None, user=None): + def __init__(self, code, fam=None, user=None) -> None: """Initializer.""" raise SiteDefinitionError( # pragma: no cover f'Loading site {fam}:{code} during dry test not permitted') @@ -425,7 +425,7 @@ $ pytest -a 'not site' """ - def setUp(self): + def setUp(self) -> None: """Set up test.""" self.old_config_interface = config.site_interface # TODO: put a dummy subclass into config.site_interface @@ -441,7 +441,7 @@ super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Tear down test.""" super().tearDown() @@ -457,7 +457,7 @@ _checked_hostnames = {} @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Prevent tests running if the host is down. @@ -560,14 +560,14 @@ """Run tests against a specific site, with a login.""" @classmethod - def require_site_user(cls, family, code): + def require_site_user(cls, family, code) -> None: """Check the user config has a valid login to the site.""" if not cls.has_site_user(family, code): raise unittest.SkipTest( f'{cls.__name__}: No username for {family}:{code}') @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Skip the test class if the user config does not have @@ -595,7 +595,7 @@ raise unittest.SkipTest( f'{cls.__name__}: Not able to login to {site}') - def setUp(self): + def setUp(self) -> None: """Set up the test case. Login to the site if it is not logged in. @@ -603,12 +603,12 @@ super().setUp() self._reset_login(True) - def tearDown(self): + def tearDown(self) -> None: """Log back into the site.""" super().tearDown() self._reset_login() - def _reset_login(self, skip_if_login_fails: bool = False): + def _reset_login(self, skip_if_login_fails: bool = False) -> None: """Login to all sites. There may be many sites, and setUp doesn't know which site is to @@ -653,7 +653,7 @@ """Require specific rights.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Skip the test class if the user does not have required rights. @@ -696,7 +696,7 @@ """ def wrap_method(key, sitedata, func): - def wrapped_method(self): + def wrapped_method(self) -> None: sitedata = self.sites[key] self.site_key = key self.family = sitedata['family'] @@ -880,7 +880,7 @@ return bases @staticmethod - def add_method(dct, test_name, method, doc=None, doc_suffix=None): + def add_method(dct, test_name, method, doc=None, doc_suffix=None) -> None: """Set method's __name__ and __doc__ and add it to dct. .. versionchanged:: 9.3 @@ -907,7 +907,7 @@ """Run tests on pre-defined sites.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Prefetch the Site object for each of the sites the test @@ -1004,7 +1004,7 @@ return (code in usernames[family] or '*' in usernames[family] or code in usernames['*'] or '*' in usernames['*']) - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) @@ -1072,7 +1072,7 @@ return decorated return add_patch - def patch(self, obj, attr_name, replacement): + def patch(self, obj, attr_name, replacement) -> None: """Patch the obj's attribute with the replacement. It will be reset after each ``tearDown``. @@ -1080,7 +1080,7 @@ self._patched_instances += [(obj, attr_name, getattr(obj, attr_name))] setattr(obj, attr_name, replacement) - def setUp(self): + def setUp(self) -> None: """Set up the test by initializing the patched list.""" super().setUp() self._patched_instances = [] @@ -1090,7 +1090,7 @@ self.patch(attribute._patching[0], attribute._patching[1], attribute) - def tearDown(self): + def tearDown(self) -> None: """Tear down the test by unpatching the patched.""" for patched in self._patched_instances: setattr(*patched) @@ -1102,7 +1102,7 @@ """Add the sites as attributes to the instances.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Add each initialized site as an attribute to cls.""" super().setUpClass() for site in cls.sites: @@ -1118,7 +1118,7 @@ code = config.mylang @classmethod - def override_default_site(cls, site): + def override_default_site(cls, site) -> None: """Override the default site. :param site: site tests should use @@ -1144,13 +1144,13 @@ """Save and restore the config.mylang and config.family.""" - def setUp(self): + def setUp(self) -> None: """Prepare the environment for running main() in a script.""" self.original_family = pywikibot.config.family self.original_code = pywikibot.config.mylang super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Restore the environment.""" pywikibot.config.family = self.original_family pywikibot.config.mylang = self.original_code @@ -1161,7 +1161,7 @@ """Tests that depend on the default site being set to the test site.""" - def setUp(self): + def setUp(self) -> None: """Prepare the environment for running main() in a script.""" super().setUp() site = self.get_site() @@ -1181,7 +1181,7 @@ """Test class to run against a WMF site, preferring the default site.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Check that the default site is a Wikimedia site. @@ -1212,7 +1212,7 @@ wikibase = True @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Checks that all sites are configured with a Wikibase repository, @@ -1244,7 +1244,7 @@ """Return the prefetched DataSite object.""" return cls.repo - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) @@ -1260,7 +1260,7 @@ """Run tests against a specific site connected to a wikibase.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Checks that all sites are configured as a Wikibase client, @@ -1295,7 +1295,7 @@ """Run tests against any site connected to Wikidata.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up the test class. Require the data repository is wikidata.org. @@ -1328,7 +1328,7 @@ pwb = True - def setUp(self): + def setUp(self) -> None: """Prepare the environment for running the pwb.py script.""" super().setUp() self.orig_pywikibot_dir = None @@ -1337,7 +1337,7 @@ base_dir = pywikibot.config.base_dir os.environ['PYWIKIBOT_DIR'] = base_dir - def tearDown(self): + def tearDown(self) -> None: """Restore the environment after running the pwb.py script.""" super().tearDown() del os.environ['PYWIKIBOT_DIR'] @@ -1369,7 +1369,7 @@ length = 3 @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up test class.""" if os.environ.get('PYWIKIBOT_TEST_NO_RC', '0') == '1': raise unittest.SkipTest( @@ -1404,7 +1404,7 @@ if hasattr(unittest.case, '_AssertRaisesBaseContext'): source_adjustment_skips.append(unittest.case._AssertRaisesBaseContext) - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) self.warning_log = [] @@ -1419,7 +1419,7 @@ self.context_manager = WarningSourceSkipContextManager( self.source_adjustment_skips) - def _reset_messages(self): + def _reset_messages(self) -> None: """Reset captured deprecation warnings.""" self._do_test_warning_filename = True del self.warning_log[:] @@ -1455,7 +1455,7 @@ f'instead argument must not be a {type(instead).__name__!r}') return msg - def assertDeprecationParts(self, deprecated=None, instead=None): + def assertDeprecationParts(self, deprecated=None, instead=None) -> None: """Assert that a deprecation warning happened. To simplify deprecation tests it just requires the to separated parts @@ -1473,7 +1473,7 @@ """ self.assertDeprecation(self._build_message(deprecated, instead)) - def assertDeprecation(self, msg=None): + def assertDeprecation(self, msg=None) -> None: """Assert that a deprecation warning happened. :param msg: Either the specific message or None to allow any generic @@ -1504,7 +1504,7 @@ self.assertDeprecationFile(self.expect_warning_filename) def assertOneDeprecationParts(self, deprecated=None, instead=None, - count=1): + count=1) -> None: """Assert that exactly one deprecation message happened and reset. It uses the same arguments as :py:obj:`assertDeprecationParts`. @@ -1512,7 +1512,7 @@ self.assertOneDeprecation(self._build_message(deprecated, instead), count) - def assertOneDeprecation(self, msg=None, count=1): + 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 @@ -1522,19 +1522,19 @@ self.assertLength(self.deprecation_messages, count) self._reset_messages() - def assertNoDeprecation(self, msg=None): + def assertNoDeprecation(self, msg=None) -> None: """Assert that no deprecation warning happened.""" if msg: # pragma: no cover self.assertNotIn(msg, self.deprecation_messages) else: self.assertIsEmpty(self.deprecation_messages) - def assertDeprecationClass(self, cls): + def assertDeprecationClass(self, cls) -> None: """Assert that all deprecation warning are of one class.""" for item in self.warning_log: self.assertIsInstance(item.message, cls) - def assertDeprecationFile(self, filename): + def assertDeprecationFile(self, filename) -> None: """Assert that all deprecation warning are of one filename.""" for item in self.warning_log: if (self._ignore_unknown_warning_packages @@ -1546,14 +1546,14 @@ f'item: {item}') @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Only operate in debug mode.""" if not __debug__: raise unittest.SkipTest( f'{cls.__name__} is disabled when __debug__ is disabled.') super().setUpClass() - def setUp(self): + def setUp(self) -> None: """Set up unit test.""" super().setUp() @@ -1562,7 +1562,7 @@ self._reset_messages() - def tearDown(self): + def tearDown(self) -> None: """Tear down unit test.""" self.context_manager.__exit__() @@ -1586,7 +1586,7 @@ """Return url of httpbin.""" return 'http://httpbin.org' + path - def get_httpbin_hostname(self): + def get_httpbin_hostname(self) -> str: """Return httpbin hostname.""" return 'httpbin.org' diff --git a/tests/basepage.py b/tests/basepage.py index 21ced30..5526ffe 100644 --- a/tests/basepage.py +++ b/tests/basepage.py @@ -16,7 +16,7 @@ _page = None - def setUp(self): + def setUp(self) -> None: """Set up test.""" super().setUp() assert self._page, 'setUp() must create an empty BasePage in _page' @@ -35,12 +35,12 @@ cached = False custom_text = 'foobar' - def setUp(self): + def setUp(self) -> None: """Set up test.""" super().setUp() assert self.cached is False, 'Tests do not support caching' - def _test_page_text(self, get_text=True): + def _test_page_text(self, get_text=True) -> None: """Test site.loadrevisions() with .text.""" page = self._page @@ -109,7 +109,7 @@ """Test base methods.""" - def _test_invoke(self): + def _test_invoke(self) -> None: """Basic invocation of some base methods and properties.""" self.assertTrue(self._page.exists()) self.assertIsNotNone(self._page.latest_revision) @@ -122,13 +122,13 @@ self._page.botMayEdit() - def _test_return_datatypes(self): + def _test_return_datatypes(self) -> None: """Test the base methods have correct datatypes only.""" self.assertIsInstance(self._page.langlinks(), list) self.assertIsInstance(self._page.templates(), list) self.assertIsInstance(self._page.isCategoryRedirect(), int) - def _test_no_wikitext(self): + def _test_no_wikitext(self) -> None: """Test the base methods responses simulate no wikitext.""" self._test_return_datatypes() self.assertEqual(self._page.langlinks(), []) diff --git a/tests/basesite_tests.py b/tests/basesite_tests.py index 9615f44..3a90a2f 100755 --- a/tests/basesite_tests.py +++ b/tests/basesite_tests.py @@ -68,7 +68,7 @@ dry = True - def test_properties(self, key): + def test_properties(self, key) -> None: """Test cases for BaseSite properties.""" mysite = self.get_site(key) self.assertEqual(mysite.doc_subpage, self.sites[key]['result']) diff --git a/tests/bot_tests.py b/tests/bot_tests.py index 17186c6..0687682 100755 --- a/tests/bot_tests.py +++ b/tests/bot_tests.py @@ -26,7 +26,7 @@ """Verify that i18n is available.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Verify that the translations are available.""" if not i18n.messages_available(): raise unittest.SkipTest( @@ -53,7 +53,7 @@ Site attributes are only present on Bot and SingleSitesBot, not MultipleSitesBot. """ - def treat(page): + def treat(page) -> None: self.assertEqual(page, next(self._page_iter)) if self._treat_site is None: self.assertFalse(hasattr(self.bot, 'site')) @@ -78,7 +78,7 @@ The pages may be set to True which sill use _treat_generator as the source for the pages. """ - def treat_page(): + def treat_page() -> None: treat(self.bot.current_page) if pages is True: @@ -88,7 +88,7 @@ def _exit(self, treated, written=0, exception=None): """Get tests which are executed on exit.""" - def exit(): + def exit() -> None: exc = sys.exc_info()[0] if exc is AssertionError: # When an AssertionError happened we shouldn't do these @@ -175,7 +175,7 @@ def test_CurrentPageBot(self) -> None: """Test normal Bot class.""" - def post_treat(page): + def post_treat(page) -> None: self.assertIs(self.bot.current_page, page) # Assert no specific site self._treat_site = None @@ -186,7 +186,7 @@ def test_Bot_ValueError(self) -> None: """Test normal Bot class with a ValueError in treat.""" - def post_treat(page): + def post_treat(page) -> None: if page.title() == 'Page 3': raise ValueError('Whatever') @@ -202,7 +202,7 @@ def test_Bot_KeyboardInterrupt(self) -> None: """Test normal Bot class with a KeyboardInterrupt in treat.""" - def post_treat(page): + def post_treat(page) -> None: if page.title() == 'Page 3': raise KeyboardInterrupt('Whatever') @@ -242,7 +242,7 @@ def _exit(self, treated=None, written=0, exception=None): """Set the number of treated pages to _count.""" - def exit(): + def exit() -> None: t = self._count if treated is None else treated # Due to PEP 3135 super()._exit(...)() would raise # RuntimeError: super(): no arguments @@ -251,7 +251,7 @@ def test_ExistingPageBot(self) -> None: """Test ExistingPageBot class.""" - def post_treat(page): + def post_treat(page) -> None: """Verify the page exists.""" self.assertTrue(page.exists()) @@ -271,7 +271,7 @@ """Yield just one current page (the last one).""" yield self._current_page - def post_treat(page): + def post_treat(page) -> None: """Verify the page is missing.""" self.assertFalse(page.exists()) @@ -300,7 +300,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self.option_handler = Options(baz=True) super().setUp() diff --git a/tests/cache_tests.py b/tests/cache_tests.py index 8509e43..1c1cc7b 100755 --- a/tests/cache_tests.py +++ b/tests/cache_tests.py @@ -22,7 +22,7 @@ net = False - def _check_cache_entry(self, entry): + def _check_cache_entry(self, entry) -> None: """Assert validity of the cache entry.""" self.assertIsInstance(entry.site, BaseSite) self.assertIsInstance(entry.site._loginstatus, int) diff --git a/tests/category_bot_tests.py b/tests/category_bot_tests.py index 82a1a7a..79cc1d0 100755 --- a/tests/category_bot_tests.py +++ b/tests/category_bot_tests.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 """Tests for the category bot script.""" # -# (C) Pywikibot team, 2015-2024 +# (C) Pywikibot team, 2015-2025 # # Distributed under the terms of the MIT license. # @@ -44,7 +44,9 @@ self._runtest_strip_cfd_templates('', '') - def _runtest_strip_cfd_templates(self, template_start, template_end): + def _runtest_strip_cfd_templates(self, + template_start, + template_end) -> None: """Run a CFD template stripping test, given CFD start/end templates.""" bot = CategoryMoveRobot(oldcat='Old', newcat='New') bot.newcat.text = ( diff --git a/tests/collections_tests.py b/tests/collections_tests.py index 74286a5..db9bbc8 100755 --- a/tests/collections_tests.py +++ b/tests/collections_tests.py @@ -25,7 +25,7 @@ collection_class = None - def _test_new_empty(self): + def _test_new_empty(self) -> None: """Test that new_empty method returns empty collection.""" cls = self.collection_class result = cls.new_empty(self.get_repo()) @@ -43,7 +43,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.site = self.get_site() @@ -131,7 +131,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.site = self.get_site() diff --git a/tests/cosmetic_changes_tests.py b/tests/cosmetic_changes_tests.py index 1203761..f616540 100755 --- a/tests/cosmetic_changes_tests.py +++ b/tests/cosmetic_changes_tests.py @@ -24,7 +24,7 @@ code = 'de' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Setup class for all tests.""" super().setUpClass() cls.cct = CosmeticChangesToolkit(Page(cls.site, 'Test')) @@ -190,7 +190,7 @@ dry = True @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Setup class for all tests.""" super().setUpClass() cls.cct.site._siteinfo._cache['general'] = ( diff --git a/tests/data_ingestion_tests.py b/tests/data_ingestion_tests.py index 9948335..82385af 100755 --- a/tests/data_ingestion_tests.py +++ b/tests/data_ingestion_tests.py @@ -29,7 +29,7 @@ }, } - def setUp(self): + def setUp(self) -> None: """Set up unit test.""" super().setUp() url = ('http://upload.wikimedia.org/wikipedia/commons/f/' @@ -82,7 +82,7 @@ family = 'commons' code = 'commons' - def setUp(self): + def setUp(self) -> None: """Set up unit test.""" super().setUp() with open(join_data_path('csv_ingestion.csv')) as fileobj: diff --git a/tests/deletionbot_tests.py b/tests/deletionbot_tests.py index 325d02a..22a521a 100755 --- a/tests/deletionbot_tests.py +++ b/tests/deletionbot_tests.py @@ -60,7 +60,7 @@ write = True @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up test class.""" super().setUpClass() cls.page = pywikibot.Page(cls.site, 'User:Unicodesnowman/DeleteMark') @@ -68,13 +68,13 @@ cls.save_page() # pragma: no cover @classmethod - def tearDownClass(cls): + def tearDownClass(cls) -> None: """Tear down test class.""" cls.save_page() super().tearDownClass() @classmethod - def save_page(cls): + def save_page(cls) -> None: """Reset the test page content.""" cls.page.text = 'Pywikibot deletion test.' cls.page.save('Pywikibot unit test') @@ -100,14 +100,14 @@ undelete_args = [] @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Patch APISite.login.""" patcher = patch.object(pywikibot.site.APISite, 'login') cls.addClassCleanup(patcher.stop) patcher.start() super().setUpClass() - def setUp(self): + def setUp(self) -> None: """Set up unit test.""" self._original_delete = pywikibot.Page.delete self._original_undelete = pywikibot.Page.undelete @@ -115,7 +115,7 @@ pywikibot.Page.undelete = undelete_dummy super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Tear down unit test.""" pywikibot.Page.delete = self._original_delete pywikibot.Page.undelete = self._original_undelete @@ -133,14 +133,14 @@ self.assertEqual(self.undelete_args, ['[[FoooOoOooO]]', 'foo']) -def delete_dummy(self, reason, prompt, mark, automatic_quit): +def delete_dummy(self, reason, prompt, mark, automatic_quit) -> int: """Dummy delete method.""" TestDeletionBot.delete_args = [self.title(as_link=True), reason, prompt, mark, automatic_quit] return 0 -def undelete_dummy(self, reason): +def undelete_dummy(self, reason) -> None: """Dummy undelete method.""" TestDeletionBot.undelete_args = [self.title(as_link=True), reason] diff --git a/tests/diff_tests.py b/tests/diff_tests.py index 6739df8..3a96629 100755 --- a/tests/diff_tests.py +++ b/tests/diff_tests.py @@ -91,7 +91,7 @@ net = False - def test_html_comparator(self, mocked_import): + def test_html_comparator(self, mocked_import) -> None: """Test html_comparator when bs4 not installed.""" with self.assertRaises(ImportError): html_comparator('') @@ -215,7 +215,7 @@ '<<lightgreen>>+ e\n<<default>>' '<<lightgreen>>+ w\n<<default>>') - def check_headers(self, mock): + def check_headers(self, mock) -> None: """Check if all headers were added to output.""" for header in self.headers: mock.assert_any_call(self.header_base.format(header)) @@ -223,7 +223,7 @@ @patch('pywikibot.info') @patch('pywikibot.userinterfaces.buffer_interface.UI.input', return_value='y') - def test_accept(self, input, mock): + def test_accept(self, input, mock) -> None: """Check output of cherry_pick if changes accepted.""" self.assertEqual(cherry_pick(self.oldtext, self.newtext), self.newtext) self.check_headers(mock) @@ -232,7 +232,7 @@ @patch('pywikibot.info') @patch('pywikibot.userinterfaces.buffer_interface.UI.input', return_value='n') - def test_reject(self, input, mock): + def test_reject(self, input, mock) -> None: """Check output of cherry_pick if changes rejected.""" self.assertEqual(cherry_pick(self.oldtext, self.newtext), self.oldtext) self.check_headers(mock) @@ -242,7 +242,7 @@ @patch('pywikibot.info') @patch('pywikibot.userinterfaces.buffer_interface.UI.input', return_value='q') - def test_quit(self, input, mock): + def test_quit(self, input, mock) -> None: """Check output of cherry_pick if quit.""" self.assertEqual(cherry_pick(self.oldtext, self.newtext), self.oldtext) self.check_headers(mock) @@ -252,7 +252,7 @@ @patch('pywikibot.info') @patch('pywikibot.userinterfaces.buffer_interface.UI.input', return_value='y') - def test_by_letter_accept(self, input, mock): + def test_by_letter_accept(self, input, mock) -> None: """Check cherry_pick output. If by_letter diff is enabled and changes accepted. @@ -265,7 +265,7 @@ @patch('pywikibot.info') @patch('pywikibot.userinterfaces.buffer_interface.UI.input', return_value='q') - def test_by_letter_quit(self, input, mock): + def test_by_letter_quit(self, input, mock) -> None: """Check cherry_pick output. If by_letter diff is enabled and quit during review. diff --git a/tests/djvu_tests.py b/tests/djvu_tests.py index 99ee710..f534d0b 100755 --- a/tests/djvu_tests.py +++ b/tests/djvu_tests.py @@ -33,7 +33,7 @@ test_txt = 'A file with non-ASCII characters, \nlike é or ç' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Skip if djvulibre library not installed.""" super().setUpClass() with skipping(OSError, msg='djvulibre library not installed.'): @@ -42,7 +42,7 @@ stderr=subprocess.PIPE) dp.communicate() - def setUp(self): # pragma: no cover + def setUp(self) -> None: # pragma: no cover """Set up test.""" super().setUp() self.djvu = DjVuFile(file_djvu) @@ -110,7 +110,7 @@ file_djvu_not_existing = join_djvu_data_path('not_existing.djvu') - def setUp(self): + def setUp(self) -> None: """Set up test.""" super().setUp() self.djvu = DjVuFile(file_djvu) diff --git a/tests/dry_api_tests.py b/tests/dry_api_tests.py index 9f10c9c..9423cd3 100755 --- a/tests/dry_api_tests.py +++ b/tests/dry_api_tests.py @@ -49,7 +49,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Initialize the fake requests.""" super().setUp() self.params = {'action': 'query', @@ -144,12 +144,12 @@ net = False - def setUp(self): + def setUp(self) -> None: """Create a mock family and site.""" class MockFamily(Family): @property - def name(self): + def name(self) -> str: return 'mock' class MockSite(pywikibot.site.APISite): @@ -158,15 +158,15 @@ _namespaces = {2: ['User']} - def __init__(self): + def __init__(self) -> None: self._user = 'anon' pywikibot.site.BaseSite.__init__(self, 'mock', MockFamily()) self._siteinfo = DummySiteinfo({'case': 'first-letter'}) - def version(self): + def version(self) -> str: return '1.31' # lowest supported release - def protocol(self): + def protocol(self) -> str: return 'http' @property @@ -176,7 +176,7 @@ def user(self): return self._user - def encoding(self): + def encoding(self) -> str: return 'utf-8' def encodings(self): @@ -186,7 +186,7 @@ def siteinfo(self): return self._siteinfo - def __repr__(self): + def __repr__(self) -> str: return 'MockSite()' def __getattr__(self, attr): @@ -384,7 +384,7 @@ } } - def setUp(self): + def setUp(self) -> None: """Add a real ParamInfo to the DrySite.""" super().setUp() site = self.get_site() diff --git a/tests/edit_failure_tests.py b/tests/edit_failure_tests.py index 840bef8..d78c6f2 100755 --- a/tests/edit_failure_tests.py +++ b/tests/edit_failure_tests.py @@ -86,7 +86,7 @@ code = 'test' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Skip tests for sysop accounts.""" super().setUpClass() if cls.site.has_group('sysop'): diff --git a/tests/edit_tests.py b/tests/edit_tests.py index 2e74c1d..852fd71 100755 --- a/tests/edit_tests.py +++ b/tests/edit_tests.py @@ -40,7 +40,7 @@ """Test writing to a page.""" global called_back - def callback(page, err): + def callback(page, err) -> None: global called_back self.assertEqual(page, p) self.assertIsNone(err) diff --git a/tests/eventstreams_tests.py b/tests/eventstreams_tests.py index 2f59b85..81c1ab2 100755 --- a/tests/eventstreams_tests.py +++ b/tests/eventstreams_tests.py @@ -37,7 +37,7 @@ }, } - def test_url_parameter(self, key): + def test_url_parameter(self, key) -> None: """Test EventStreams with given url.""" e = EventStreams(url=self.sites[key]['hostname']) self.assertEqual(e._url, self.sites[key]['hostname']) @@ -48,7 +48,7 @@ self.assertEqual(repr(e), f"EventStreams(url='{self.sites[key]['hostname']}')") - def test_url_from_site(self, key): + def test_url_from_site(self, key) -> None: """Test EventStreams with url from site.""" site = self.get_site(key) streams = 'recentchange' @@ -69,7 +69,7 @@ """Stream tests for eventstreams module.""" - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() site = self.get_site() @@ -113,7 +113,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Set up unit test.""" super().setUp() with mock.patch('pywikibot.comms.eventstreams.EventSource'): @@ -132,7 +132,7 @@ def test_filter_function_settings(self) -> None: """Test EventStreams filter function settings.""" - def foo(): + def foo() -> bool: """Dummy function.""" return True @@ -172,7 +172,7 @@ data = {'foo': True, 'bar': 'baz'} - def setUp(self): + def setUp(self) -> None: """Set up unit test.""" super().setUp() with mock.patch('pywikibot.comms.eventstreams.EventSource'): @@ -238,7 +238,7 @@ c = {'bar': 'baz'} self.assertNotEqual(f(c), g(c)) - def _test_filter(self, none_type, all_type, any_type, result): + def _test_filter(self, none_type, all_type, any_type, result) -> None: """Test a single fixed filter.""" self.es.filter = {'all': [], 'any': [], 'none': []} self.es.register_filter(lambda x: none_type, ftype='none') diff --git a/tests/family_tests.py b/tests/family_tests.py index 9567092..ca8d349 100755 --- a/tests/family_tests.py +++ b/tests/family_tests.py @@ -163,7 +163,7 @@ True) return site - def setUp(self): + def setUp(self) -> None: """Setup default article path.""" super().setUp() self.articlepath = '/wiki/$1' diff --git a/tests/file_tests.py b/tests/file_tests.py index bab02d2..27acf1f 100755 --- a/tests/file_tests.py +++ b/tests/file_tests.py @@ -197,7 +197,7 @@ code = 'commons' cached = True - def test_globalusage(self, key): + def test_globalusage(self, key) -> None: """Test globalusage generator.""" page = pywikibot.FilePage(self.site, 'File:Example.jpg') gen = page.globalusage(total=3) @@ -224,7 +224,7 @@ cached = True - def setUp(self): + def setUp(self) -> None: """Create File page.""" super().setUp() self.image = pywikibot.FilePage(self.site, self.file_name) diff --git a/tests/fixes_tests.py b/tests/fixes_tests.py index 4ba9558..1729da7 100755 --- a/tests/fixes_tests.py +++ b/tests/fixes_tests.py @@ -21,12 +21,12 @@ net = False - def setUp(self): + def setUp(self) -> None: """Backup the current fixes.""" super().setUp() self._old_fixes = fixes.fixes - def tearDown(self): + def tearDown(self) -> None: """Recover the current fixes.""" fixes.fixes = self._old_fixes super().tearDown() diff --git a/tests/generate_family_file_tests.py b/tests/generate_family_file_tests.py index b3f8e01..91b86fc 100755 --- a/tests/generate_family_file_tests.py +++ b/tests/generate_family_file_tests.py @@ -23,7 +23,7 @@ """Family file test creator.""" - def getapis(self): + def getapis(self) -> None: """Only load up to additional ten different wikis randomly.""" save = self.langs @@ -48,7 +48,7 @@ self.prefixes = [item['prefix'] for item in self.langs] self.langs = save - def writefile(self, verify): + def writefile(self, verify) -> None: """Pass writing.""" @@ -59,14 +59,14 @@ familyname = 'testgff' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up tests class.""" super().setUpClass() # test fails on wowwiki (T297042) if cls.site.family.name == 'wowwiki': raise unittest.SkipTest(f'skipping {cls.site} due to T297042') - def setUp(self): + def setUp(self) -> None: """Set up tests.""" super().setUp() answer = 's' if isinstance(self.site.family, WikimediaFamily) else 'y' diff --git a/tests/gui_tests.py b/tests/gui_tests.py index 2413c80..daad444 100755 --- a/tests/gui_tests.py +++ b/tests/gui_tests.py @@ -58,7 +58,7 @@ @require_modules('PIL') -def setUpModule(): +def setUpModule() -> None: """Skip tests if tkinter or PIL is not installed. .. versionchanged:: 7.7 diff --git a/tests/http_tests.py b/tests/http_tests.py index 7a86a10..37b3ea0 100755 --- a/tests/http_tests.py +++ b/tests/http_tests.py @@ -50,7 +50,7 @@ net = False - def setUp(self): + def setUp(self) -> None: """Set up test by configuring config.authenticate.""" super().setUp() self._authenticate = config.authenticate @@ -61,7 +61,7 @@ '*.wmflabs.org': ('7', '8', '8'), } - def tearDown(self): + def tearDown(self) -> None: """Tear down test by resetting config.authenticate.""" super().tearDown() config.authenticate = self._authenticate @@ -215,7 +215,7 @@ net = False - def setUp(self): + def setUp(self) -> None: """Set up unit test.""" super().setUp() self.orig_format = config.user_agent_format @@ -223,7 +223,7 @@ '{pwb} ({revision}) {http_backend} ' '{python}') - def tearDown(self): + def tearDown(self) -> None: """Tear down unit test.""" super().tearDown() config.user_agent_format = self.orig_format @@ -246,13 +246,13 @@ """Test the usage of fake user agent.""" - def setUp(self): + def setUp(self) -> None: """Set up the unit test.""" self.orig_fake_user_agent_exceptions = ( config.fake_user_agent_exceptions) super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Tear down unit test.""" config.fake_user_agent_exceptions = ( self.orig_fake_user_agent_exceptions) @@ -471,7 +471,7 @@ url = 'https://upload.wikimedia.org/wikipedia/commons/f/fc/MP_sounds.png' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Set up test class.""" super().setUpClass() @@ -502,7 +502,7 @@ 'args' key with urldecoded query string parameters. """ - def setUp(self): + def setUp(self) -> None: """Set up tests.""" super().setUp() self.url = self.get_httpbin_url('/get') diff --git a/tests/i18n_tests.py b/tests/i18n_tests.py index 2f647a3..80d6164 100755 --- a/tests/i18n_tests.py +++ b/tests/i18n_tests.py @@ -23,7 +23,7 @@ """Nested class to hold the family name attribute.""" - def __init__(self, code, family='wikipedia'): + def __init__(self, code, family='wikipedia') -> None: """Initializer.""" self.code = code self.family = self.Family() @@ -198,13 +198,13 @@ """Base class for tests using config.userinterface_lang.""" - def setUp(self): + def setUp(self) -> None: """Change the userinterface language to the site's code.""" super().setUp() self.orig_userinterface_lang = pywikibot.config.userinterface_lang pywikibot.config.userinterface_lang = self.get_site().code - def tearDown(self): + def tearDown(self) -> None: """Reset the userinterface language.""" pywikibot.config.userinterface_lang = self.orig_userinterface_lang super().tearDown() @@ -216,13 +216,13 @@ message_package = None - def setUp(self): + def setUp(self) -> None: """Load the test translations.""" self.orig_messages_package_name = i18n._messages_package_name i18n.set_messages_package(self.message_package) super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Load the original translations back.""" super().tearDown() i18n.set_messages_package(self.orig_messages_package_name) @@ -233,7 +233,7 @@ """Base class for TranslateWiki tests.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Verify that the test translations are not empty.""" if not isinstance(cls.message_package, str): raise TypeError( # pragma: no cover @@ -301,7 +301,7 @@ message = 'pywikibot-enter-category-name' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Verify that a translation does not yet exist.""" super().setUpClass() @@ -325,10 +325,10 @@ message_package = 'scripts.foobar.i18n' - def _capture_output(self, text, *args, **kwargs): + def _capture_output(self, text, *args, **kwargs) -> None: self.output_text = text - def setUp(self): + def setUp(self) -> None: """Patch the output and input methods.""" super().setUp() bot.set_interface('terminal') @@ -339,7 +339,7 @@ bot.ui.stream_output = self._capture_output self.old_cc_setting = config.cosmetic_changes_mylang_only - def tearDown(self): + def tearDown(self) -> None: """Restore the output and input methods.""" config.cosmetic_changes_mylang_only = self.old_cc_setting bot.ui._raw_input = self.orig_raw_input diff --git a/tests/interwiki_graph_tests.py b/tests/interwiki_graph_tests.py index f4e9b55..91fedc7 100755 --- a/tests/interwiki_graph_tests.py +++ b/tests/interwiki_graph_tests.py @@ -37,7 +37,7 @@ dry = True @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Setup test class.""" super().setUpClass() @@ -48,7 +48,7 @@ 'pl': DryPage(cls.plwikt, 'origin'), } - def setUp(self): + def setUp(self) -> None: """Setup interwiki_graph data.""" super().setUp() data = interwiki_graph.Subject(self.pages['en']) diff --git a/tests/interwikidata_tests.py b/tests/interwikidata_tests.py index 3c5af51..7a77ef3 100755 --- a/tests/interwikidata_tests.py +++ b/tests/interwikidata_tests.py @@ -21,15 +21,15 @@ """A dummy bot to prevent editing in production wikis.""" - def put_current(self): + def put_current(self) -> bool: """Prevent editing.""" return False - def create_item(self): + def create_item(self) -> bool: """Prevent creating items.""" return False - def try_to_add(self): + def try_to_add(self) -> None: """Prevent adding sitelinks to items.""" return @@ -53,7 +53,7 @@ }, } - def test_main(self, key): + def test_main(self, key) -> None: """Test main function interwikidata.py.""" site = self.get_site(key) pywikibot.config.family = site.family diff --git a/tests/interwikimap_tests.py b/tests/interwikimap_tests.py index ad36821..ae3aa65 100755 --- a/tests/interwikimap_tests.py +++ b/tests/interwikimap_tests.py @@ -63,7 +63,7 @@ }, } - def test_interwikimap(self, key): + def test_interwikimap(self, key) -> None: """Test interwiki map.""" site = self.get_site(key) iw_map = site._interwikimap @@ -92,7 +92,7 @@ entry.url.startswith(('http', 'irc://')), entry.url + ' does not start with "http" or "irc://') - def test_interwiki(self, key): + def test_interwiki(self, key) -> None: """Test site.interwiki method.""" site = self.get_site(key) prefix = self.sites[key]['family'] @@ -111,7 +111,7 @@ family = 'wikipedia' code = 'en' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.iw_map = self.site._interwikimap diff --git a/tests/l10n_tests.py b/tests/l10n_tests.py index 2930e9b..b16d40a 100755 --- a/tests/l10n_tests.py +++ b/tests/l10n_tests.py @@ -92,7 +92,7 @@ code = 'en' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Skip test gracefully if i18n package is missing.""" super().setUpClass() if not i18n.messages_available(): diff --git a/tests/link_tests.py b/tests/link_tests.py index 599b8f5..efd52b2 100755 --- a/tests/link_tests.py +++ b/tests/link_tests.py @@ -28,7 +28,7 @@ """Test ``Link.create_separated``.""" - def _test_link(self, link, page, section, label): + def _test_link(self, link, page, section, label) -> None: """Test the separate contents of the link.""" self.assertIs(link.site, self.site) self.assertEqual(link.title, page) @@ -243,7 +243,7 @@ family = 'wikipedia' code = 'en' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -315,7 +315,7 @@ family = 'wikipedia' code = 'en' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -391,7 +391,7 @@ PATTERN = '{colon}{first}:{second}:{title}' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -441,7 +441,7 @@ family = 'wikipedia' code = 'en' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'wikidata' @@ -495,7 +495,7 @@ }, } - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -529,7 +529,7 @@ family = 'species' code = 'species' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -620,7 +620,7 @@ family = 'wikipedia' code = 'en' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -671,7 +671,7 @@ family = 'wikipedia' code = 'en' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'wikidata' @@ -717,7 +717,7 @@ family = 'wikidata' code = 'test' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -755,7 +755,7 @@ family = 'species' code = 'species' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() config.mylang = 'en' @@ -895,7 +895,7 @@ """Test parsing namespaces when creating SiteLinks.""" - def _test_link(self, link, title, namespace, site_code, site_fam): + def _test_link(self, link, title, namespace, site_code, site_fam) -> None: """Test the separate contents of the link.""" self.assertEqual(link.title, title) self.assertEqual(link.namespace, namespace) diff --git a/tests/linter_tests.py b/tests/linter_tests.py index d46b388..b5aa651 100755 --- a/tests/linter_tests.py +++ b/tests/linter_tests.py @@ -18,7 +18,7 @@ """Test linter_pages methods.""" - def setUp(self): + def setUp(self) -> None: """Skip tests if Linter extension is missing.""" super().setUp() if not self.site.has_extension('Linter'): diff --git a/tests/logentries_tests.py b/tests/logentries_tests.py index 191b8f6..3fafb13 100755 --- a/tests/logentries_tests.py +++ b/tests/logentries_tests.py @@ -71,7 +71,7 @@ le = next(self.site.logevents(logtype=logtype, total=1)) return le - def _test_logevent(self, logtype): + def _test_logevent(self, logtype) -> None: """Test a single logtype entry.""" logentry = self._get_logentry(logtype) self.assertIn(logtype, logentry.__class__.__name__.lower()) @@ -139,7 +139,7 @@ def __new__(cls, name, bases, dct): """Create the new class.""" def test_method(logtype): - def test_logevent(self, key): + def test_logevent(self, key) -> None: """Test a single logtype entry.""" site = self.sites[key]['site'] if logtype not in site.logtypes: @@ -170,7 +170,7 @@ """Test logentry classes without special classes.""" - def test_simple_entries(self, key): + def test_simple_entries(self, key) -> None: """Test those entries which don't have an extra LogEntry subclass.""" # Unfortunately it's not possible to use the metaclass to create a # bunch of test methods for this too as the site instances haven't @@ -192,7 +192,7 @@ """Test LogEntry properties specific to their action.""" - def test_block_entry(self, key): + def test_block_entry(self, key) -> None: """Test BlockEntry methods.""" # only 'block' entries can be tested for logentry in self.site.logevents(logtype='block', total=5): @@ -214,13 +214,13 @@ self.assertIsNone(logentry.duration()) break - def test_rights_entry(self, key): + def test_rights_entry(self, key) -> None: """Test RightsEntry methods.""" logentry = self._get_logentry('rights') self.assertIsInstance(logentry.oldgroups, list) self.assertIsInstance(logentry.newgroups, list) - def test_move_entry(self, key): + def test_move_entry(self, key) -> None: """Test MoveEntry methods.""" logentry = self._get_logentry('move') if 'actionhidden' in logentry: @@ -233,14 +233,14 @@ self.assertIsInstance(logentry.target_page, pywikibot.Page) self.assertIsInstance(logentry.suppressedredirect(), bool) - def test_patrol_entry(self, key): + def test_patrol_entry(self, key) -> None: """Test PatrolEntry methods.""" logentry = self._get_logentry('patrol') self.assertIsInstance(logentry.current_id, int) self.assertIsInstance(logentry.previous_id, int) self.assertIsInstance(logentry.auto, bool) - def test_moved_target(self, key): + def test_moved_target(self, key) -> None: """Test moved_target method.""" # main page was moved around mainpage = self.get_mainpage(self.site) @@ -265,7 +265,7 @@ with self.assertRaises(NoMoveTargetError): page.moved_target() - def test_thanks_page(self, key): + def test_thanks_page(self, key) -> None: """Test Thanks page method return type.""" if not self.site.has_extension('Thanks'): self.skipTest('Thanks extension not available.') diff --git a/tests/login_tests.py b/tests/login_tests.py index 6f31cb3..a7a37ee 100755 --- a/tests/login_tests.py +++ b/tests/login_tests.py @@ -96,7 +96,7 @@ self.addCleanup(patcher.stop) return patcher.start() - def setUp(self): + def setUp(self) -> None: """Patch a variety of dependencies.""" super().setUp() self.config = self.patch('pywikibot.login.config') diff --git a/tests/mediawikiversion_tests.py b/tests/mediawikiversion_tests.py index c28eba5..deca280 100755 --- a/tests/mediawikiversion_tests.py +++ b/tests/mediawikiversion_tests.py @@ -54,7 +54,7 @@ self.assertGreater(self._make('1.33'), self._make('1.33-rc.2')) self.assertEqual(self._make('1.33rc1'), self._make('1.33-rc.1')) - def _version_check(self, version, digits, dev_version, suffix): + def _version_check(self, version, digits, dev_version, suffix) -> None: v = self._make(version) self.assertEqual(v.version, digits) self.assertEqual(v._dev_version, dev_version) diff --git a/tests/namespace_tests.py b/tests/namespace_tests.py index e56375b..34fd6ad 100755 --- a/tests/namespace_tests.py +++ b/tests/namespace_tests.py @@ -268,7 +268,7 @@ 'project_talk', 'PROJECT_TALK', 'Project_talk', 'Project_Talk:'], } - def setUp(self): + def setUp(self) -> None: """Setup namespaces dict.""" super().setUp() self.namespaces = builtin_NamespacesDict() diff --git a/tests/oauth_tests.py b/tests/oauth_tests.py index ddc2576..cecf17f 100755 --- a/tests/oauth_tests.py +++ b/tests/oauth_tests.py @@ -36,7 +36,7 @@ tokens = os.environ.get('PYWIKIBOT_TEST_OAUTH') return tuple(tokens.split(':')) if tokens is not None else None - def setUp(self): + def setUp(self) -> None: """Check if OAuth extension is installed and OAuth tokens are set.""" super().setUp() self.site = self.get_site() @@ -59,14 +59,14 @@ write = True - def setUp(self): + def setUp(self) -> None: """Set up test by checking site and initialization.""" super().setUp() self._authenticate = config.authenticate oauth_tokens = self.consumer_token + self.access_token config.authenticate[self.site.hostname()] = oauth_tokens - def tearDown(self): + def tearDown(self) -> None: """Tear down test by resetting config.authenticate.""" super().tearDown() config.authenticate = self._authenticate diff --git a/tests/page_tests.py b/tests/page_tests.py index 5a5c061..0b7fec2 100755 --- a/tests/page_tests.py +++ b/tests/page_tests.py @@ -136,7 +136,7 @@ l2 = pywikibot.page.Link('en:Test', source=self.frwiki) l3 = pywikibot.page.Link('wikipedia:en:Test', source=self.itwikt) - def assertHashCmp(link1, link2): + def assertHashCmp(link1, link2) -> None: self.assertEqual(link1, link2) self.assertEqual(hash(link1), hash(link2)) @@ -691,7 +691,7 @@ """Test for Page's repr implementation.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Initialize page instance.""" super().setUpClass() cls._old_encoding = config.console_encoding @@ -699,7 +699,7 @@ cls.page = pywikibot.Page(cls.site, 'Ō') @classmethod - def tearDownClass(cls): + def tearDownClass(cls) -> None: """Restore the original console encoding.""" config.console_encoding = cls._old_encoding super().tearDownClass() @@ -725,7 +725,7 @@ cached = True login = True - def setUp(self): + def setUp(self) -> None: """Setup test.""" super().setUp() self.page = pywikibot.Page(self.site, @@ -734,13 +734,13 @@ self.skipTest(f'Page {self.page.title()} exists! Change page name' ' in tests/page_tests.py') - def tearDown(self): + def tearDown(self) -> None: """Cleanup cache.""" if hasattr(self.page, '_bot_may_edit'): del self.page._bot_may_edit super().tearDown() - def _run_test(self, template, user, expected_result): + def _run_test(self, template, user, expected_result) -> None: """Run a single template test.""" del self.page.text self.page._text = template % {'user': user} diff --git a/tests/pagegenerators_tests.py b/tests/pagegenerators_tests.py index 19b365d..29aee4e 100755 --- a/tests/pagegenerators_tests.py +++ b/tests/pagegenerators_tests.py @@ -72,12 +72,12 @@ titles = en_wp_page_titles + en_wp_nopage_titles - def setUp(self): + def setUp(self) -> None: """Setup test.""" super().setUp() self.site = self.get_site() - def assertFunction(self, obj): + def assertFunction(self, obj) -> None: """Assert function test.""" self.assertTrue(hasattr(pagegenerators, obj)) self.assertTrue(callable(getattr(pagegenerators, obj))) @@ -201,7 +201,7 @@ base_title = ('Page:06-24-1920 -The Story of the Jones County ' 'Calf Case.pdf/{}') - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.site = self.get_site() @@ -227,7 +227,7 @@ category_list = ['Category:Validated'] - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.catfilter_list = [pywikibot.Category(self.site, cat) @@ -482,7 +482,7 @@ self.assertPageTitlesEqual(titles, expected_titles) @unittest.mock.patch('pywikibot.comms.http.fetch', autospec=True) - def test_url(self, mock_fetch): + def test_url(self, mock_fetch) -> None: """Test TextIOPageGenerator with URL.""" # Mock return value of fetch() fetch_return = unittest.mock.Mock() @@ -525,7 +525,7 @@ """Test the day page generator.""" - def _run_test(self, start_month=1, end_month=12, year=2000): + def _run_test(self, start_month=1, end_month=12, year=2000) -> None: """Test method for DayPageGenerator.""" params = { 'start_month': start_month, @@ -816,7 +816,8 @@ """Test item claim filter page generator generator.""" - def _simple_claim_test(self, prop, claim, qualifiers, valid, negate=False): + def _simple_claim_test(self, prop, claim, qualifiers, valid, + negate: bool = False) -> None: """Test given claim on sample (India) page. :param prop: the property to check @@ -1382,7 +1383,7 @@ }, } - def test_newpages_default(self, key): + def test_newpages_default(self, key) -> None: """Test newpages generator.""" site = self.get_site(key) gf = pagegenerators.GeneratorFactory(site=site) @@ -1401,7 +1402,7 @@ self.assertIsNotEmpty(pages, msg=failure_message) - def test_newpages_ns_default(self, key): + def test_newpages_ns_default(self, key) -> None: """Test newpages generator with limit argument.""" site = self.get_site(key) gf = pagegenerators.GeneratorFactory(site=site) @@ -1410,7 +1411,7 @@ self.assertIsNotNone(gen) self.assertPagesInNamespaces(gen, 0) - def test_newpages_ns(self, key): + def test_newpages_ns(self, key) -> None: """Test newpages generator with limit argument and namespace filter.""" site = self.get_site(key) gf = pagegenerators.GeneratorFactory(site=site) @@ -1425,7 +1426,7 @@ """Test pagegenerators.GeneratorFactory for wanted pages.""" - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.gf = pagegenerators.GeneratorFactory(site=self.site) @@ -1545,7 +1546,7 @@ """Test GeneratorFactory with pagegenerators.LogeventsPageGenerator.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Setup test class.""" super().setUpClass() site = pywikibot.Site() diff --git a/tests/paraminfo_tests.py b/tests/paraminfo_tests.py index 1add7bc..a89bdcd 100755 --- a/tests/paraminfo_tests.py +++ b/tests/paraminfo_tests.py @@ -37,17 +37,17 @@ f'No defined values for {module}.{parameter}') return param['type'] - def _check_param_values(self, site, module, parameter, expected): + def _check_param_values(self, site, module, parameter, expected) -> None: """Check that a parameter matches the expected list exactly.""" values = self._get_param_values(site, module, parameter) self.assertCountEqual(expected, values) - def _check_param_subset(self, site, module, parameter, expected): + def _check_param_subset(self, site, module, parameter, expected) -> None: """Check that a parameter contains all entries in expected list.""" values = self._get_param_values(site, module, parameter) self.assertLessEqual(set(expected), set(values)) - def _check_param_superset(self, site, module, parameter, expected): + def _check_param_superset(self, site, module, parameter, expected) -> None: """Check that a parameter only contains entries in expected list.""" values = self._get_param_values(site, module, parameter) exp = set(expected) diff --git a/tests/patrolbot_tests.py b/tests/patrolbot_tests.py index 8076df1..236f50d 100755 --- a/tests/patrolbot_tests.py +++ b/tests/patrolbot_tests.py @@ -33,7 +33,7 @@ """Test the PatrolBot class.""" - def setUp(self): + def setUp(self) -> None: """Create a bot dummy instance.""" super().setUp() self.bot = PatrolBot(self.site) diff --git a/tests/proofreadpage_tests.py b/tests/proofreadpage_tests.py index dfcc2ef..2d50c95 100755 --- a/tests/proofreadpage_tests.py +++ b/tests/proofreadpage_tests.py @@ -142,7 +142,7 @@ family = 'wikisource' code = 'en' - def setUp(self): + def setUp(self) -> None: """Set up test case.""" self._page = ProofreadPage( self.site, 'Page:Popular Science Monthly Volume 1.djvu/12') @@ -162,7 +162,7 @@ family = 'wikisource' code = 'en' - def setUp(self): + def setUp(self) -> None: """Set up test case.""" self._page = ProofreadPage( self.site, 'Page:Popular Science Monthly Volume 1.djvu/12') @@ -221,7 +221,7 @@ }, } - def test_parse_title(self, key): + def test_parse_title(self, key) -> None: """Test ProofreadPage_parse_title() function.""" data = self.sites[key] title = data['title'] @@ -439,7 +439,7 @@ @classmethod @require_modules('bs4') - def setUpClass(cls): + def setUpClass(cls) -> None: """Check whether bs4 module is installed already.""" super().setUpClass() @@ -466,7 +466,7 @@ '4 334\n', } - def setUp(self): + def setUp(self) -> None: """Test setUp.""" site = self.get_site() title = self.data['title'] @@ -637,7 +637,7 @@ family = 'wikisource' code = 'en' - def setUp(self): + def setUp(self) -> None: """Set up test case.""" self._page = IndexPage( self.site, 'Index:Popular Science Monthly Volume 1.djvu') @@ -657,7 +657,7 @@ family = 'wikisource' code = 'en' - def setUp(self): + def setUp(self) -> None: """Set up test case.""" self._page = IndexPage( self.site, 'Index:Popular Science Monthly Volume 1.djvu') @@ -721,7 +721,7 @@ cached = True @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Prepare get_page dataset for tests.""" super().setUpClass() for key, site_def in cls.sites.items(): @@ -735,7 +735,7 @@ for i in page_numbers} site_def['get_page'].append([label, page_set]) - def test_check_if_cached(self, key): + def test_check_if_cached(self, key) -> None: """Test if cache is checked and loaded properly.""" data = self.sites[key] index_page = IndexPage(self.site, self.sites[key]['index']) @@ -754,12 +754,12 @@ index_page._cached = False self.assertEqual(index_page.get_label_from_page_number(num), label) - def test_num_pages(self, key): + def test_num_pages(self, key) -> None: """Test num_pages property.""" index_page = IndexPage(self.site, self.sites[key]['index']) self.assertEqual(index_page.num_pages, self.sites[key]['num_pages']) - def test_get_labels(self, key): + def test_get_labels(self, key) -> None: """Test IndexPage page get_label_from_* functions.""" data = self.sites[key] num, title_num, label = data['get_label'] @@ -780,7 +780,7 @@ with self.assertRaises(KeyError): index_page.get_label_from_page(None) - def test_get_page_and_number(self, key): + def test_get_page_and_number(self, key) -> None: """Test IndexPage page get_page_number functions.""" data = self.sites[key] index_page = IndexPage(self.site, self.sites[key]['index']) @@ -820,7 +820,7 @@ n = index_page.get_number(p) self.assertEqual(index_page.get_page(n), p) - def test_page_gen(self, key): + def test_page_gen(self, key) -> None: """Test Index page generator.""" data = self.sites[key] num, title_num, _label = data['get_label'] @@ -861,7 +861,7 @@ missing_name = 'Page:Pywikibot test page.djvu/2' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Prepare tests by creating page instances.""" super().setUpClass() cls.index = IndexPage(cls.site, cls.index_name) @@ -904,7 +904,7 @@ other_template = '{{PoTM|bar=foobar}}' @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Prepare tests by creating an IndexPage instance.""" super().setUpClass() cls.index = IndexPage(cls.site, cls.index_name) diff --git a/tests/reflinks_tests.py b/tests/reflinks_tests.py index a44c97f..704415b 100755 --- a/tests/reflinks_tests.py +++ b/tests/reflinks_tests.py @@ -93,7 +93,7 @@ family = 'wikipedia' code = 'en' - def setUp(self): + def setUp(self) -> None: """Set up the script by patching the bot class.""" super().setUp() self._original_constructor = ReferencesRobot.__init__ @@ -101,7 +101,7 @@ ReferencesRobot.__init__ = dummy_constructor ReferencesRobot.run = lambda self: None - def tearDown(self): + def tearDown(self) -> None: """Tear down the test by undoing the bot class patch.""" ReferencesRobot.__init__ = self._original_constructor ReferencesRobot.run = self._original_run @@ -167,7 +167,7 @@ site=self.get_site()) -def dummy_constructor(self, *args, **kwargs): +def dummy_constructor(self, *args, **kwargs) -> None: """A constructor faking the actual constructor.""" TestReferencesBotConstructor.constructor_args = args TestReferencesBotConstructor.constructor_kwargs = kwargs diff --git a/tests/replacebot_tests.py b/tests/replacebot_tests.py index 2510e3d..069f32c 100755 --- a/tests/replacebot_tests.py +++ b/tests/replacebot_tests.py @@ -35,7 +35,7 @@ code = 'test' cached = False - def setUp(self): + def setUp(self) -> None: """Replace the original bot class with a fake one.""" class FakeReplaceBot(replace.ReplaceRobot): @@ -43,18 +43,18 @@ changed_pages = -42 # show that weird number to show this was used - def __init__(inner_self, *args, **kwargs): # noqa: N805 + def __init__(inner_self, *args, **kwargs) -> None: # noqa: N805 # Unpatch already here, as otherwise super calls will use # this class' super which is the class itself replace.ReplaceRobot = self._original_bot super().__init__(*args, **kwargs) self.bots.append(inner_self) - def run(inner_self): # noqa: N805 + def run(inner_self) -> None: # noqa: N805 """Nothing to do here.""" inner_self.changed_pages = -47 # show that run was called - def patched_login(): + def patched_login() -> None: """Do nothing.""" def patched_site(*args, **kwargs): @@ -75,7 +75,7 @@ pywikibot.bot.ui.clear() - def tearDown(self): + def tearDown(self) -> None: """Bring back the old bot class.""" replace.ReplaceRobot = self._original_bot replace.pywikibot.input = self._original_input @@ -83,7 +83,7 @@ with empty_sites(): super().tearDown() - def _fake_input(self, message): + def _fake_input(self, message) -> str: """Cache the message and return static text "TESTRUN".""" self.inputs.append(message) return 'TESTRUN' @@ -116,7 +116,7 @@ self.assertFalse(self.bots) def _test_replacement(self, replacement, clazz=replace.Replacement, - offset=0): + offset=0) -> None: """Test a replacement from the command line.""" self.assertIsInstance(replacement, clazz) self.assertEqual(replacement.old, str(offset * 2 + 1)) @@ -124,7 +124,7 @@ self.assertEqual(replacement.new, str(offset * 2 + 2)) def _test_fix_replacement(self, replacement, - length=1, offset=0, msg=False): + length=1, offset=0, msg=False) -> None: """Test a replacement from a fix.""" assert length > offset self._test_replacement(replacement, replace.ReplacementListEntry, @@ -157,7 +157,7 @@ self.assertEqual(bot.changed_pages, -47) return bot - def _apply(self, bot, expected, missing=None, title='Test page'): + def _apply(self, bot, expected, missing=None, title='Test page') -> None: """Test applying a test change.""" applied = set() if missing is True: diff --git a/tests/script_tests.py b/tests/script_tests.py index f5d6ae5..47a75f3 100755 --- a/tests/script_tests.py +++ b/tests/script_tests.py @@ -33,7 +33,7 @@ } -def check_script_deps(script_name): +def check_script_deps(script_name) -> bool: """Detect whether all dependencies are installed.""" if script_name in script_deps: for package_name in script_deps[script_name]: @@ -173,7 +173,7 @@ return collector(loader) -def import_script(script_name: str): +def import_script(script_name: str) -> None: """Import script for coverage only (T305795).""" if not ci_test_run: return # pragma: no cover diff --git a/tests/site_decorators_tests.py b/tests/site_decorators_tests.py index da72ac8..2bb893e 100755 --- a/tests/site_decorators_tests.py +++ b/tests/site_decorators_tests.py @@ -23,7 +23,7 @@ # Implemented without setUpClass(cls) and global variables as objects # were not completely disposed and recreated but retained 'memory' - def setUp(self): + def setUp(self) -> None: """Creating fake variables to appear as a site.""" self.code = 'test' self.family = lambda: None @@ -43,12 +43,12 @@ """Test cases for the must_be decorator.""" - def setUp(self): + def setUp(self) -> None: """Creating fake variables to appear as a site.""" self._userinfo = [] super().setUp() - def login(self, group): + def login(self, group) -> None: """Fake the log in as required user group.""" self._logged_in_as = group self._userinfo = [group] @@ -142,12 +142,12 @@ # Implemented without setUpClass(cls) and global variables as objects # were not completely disposed and recreated but retained 'memory' - def setUp(self): + def setUp(self) -> None: """Creating fake variables to appear as a site.""" self.userinfo = {'rights': []} super().setUp() - def login(self, group, right): + def login(self, group, right) -> None: """Fake the log in as required user group.""" self._logged_in_as = group self.userinfo['rights'] = [right] @@ -195,47 +195,47 @@ # Implemented without setUpClass(cls) and global variables as objects # were not completely disposed and recreated but retained 'memory' - def setUp(self): + def setUp(self) -> None: """Set up test method.""" super().setUp() self.version = lambda: '1.23' @need_version('1.24') - def too_new(self): + def too_new(self) -> bool: """Method which is to new.""" return True @need_version('1.23') - def old_enough(self): + def old_enough(self) -> bool: """Method which is as new as the server.""" return True @need_version('1.22') - def older(self): + def older(self) -> bool: """Method which is old enough.""" return True @need_version('1.24') @deprecated - def deprecated_unavailable_method(self): + def deprecated_unavailable_method(self) -> bool: """Method which is to new and then deprecated.""" return True @deprecated @need_version('1.24') - def deprecated_unavailable_method2(self): + def deprecated_unavailable_method2(self) -> bool: """Method which is deprecated first and then to new.""" return True @need_version('1.22') @deprecated - def deprecated_available_method(self): + def deprecated_available_method(self) -> bool: """Method which is old enough and then deprecated.""" return True @deprecated @need_version('1.22') - def deprecated_available_method2(self): + def deprecated_available_method2(self) -> bool: """Method which is deprecated first and then old enough.""" return True diff --git a/tests/site_detect_tests.py b/tests/site_detect_tests.py index 0033b84..670364c 100755 --- a/tests/site_detect_tests.py +++ b/tests/site_detect_tests.py @@ -28,7 +28,7 @@ net = True - def assertSite(self, url: str): + def assertSite(self, url: str) -> None: """Assert a MediaWiki site can be loaded from the url. :param url: Url of tested site @@ -37,7 +37,7 @@ with skipping(ServerError, requests_exceptions.Timeout): self.assertIsInstance(MWSite(url), MWSite) - def assertNoSite(self, url: str): + def assertNoSite(self, url: str) -> None: """Assert a url is not a MediaWiki site. :param url: Url of tested site diff --git a/tests/site_generators_tests.py b/tests/site_generators_tests.py index 8ee081f..30e551b 100755 --- a/tests/site_generators_tests.py +++ b/tests/site_generators_tests.py @@ -43,7 +43,7 @@ cached = True - def setUp(self): + def setUp(self) -> None: """Initialize self.site and self.mainpage.""" super().setUp() self.site = self.get_site() @@ -721,7 +721,7 @@ cached = True - def setUp(self): + def setUp(self) -> None: """Initialize self.site and self.mainpage.""" super().setUp() self.site = self.get_site() @@ -1585,7 +1585,7 @@ """Test random methods of a site.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Skip test on beta due to T282602.""" super().setUpClass() site = cls.get_site() @@ -1690,7 +1690,7 @@ # Implemented without setUpClass(cls) and global variables as objects # were not completely disposed and recreated but retained 'memory' - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.mysite = self.get_site() @@ -1823,7 +1823,7 @@ cached = True - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.page = pywikibot.Page(self.site, 'File:BoA – Woman.png') @@ -1938,7 +1938,7 @@ cached = True - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.site = self.get_site() @@ -2246,7 +2246,7 @@ break @patch.object(pywikibot, 'info') - def test_preload_langlinks_count(self, output_mock): + def test_preload_langlinks_count(self, output_mock) -> None: """Test preloading continuation works.""" mysite = self.get_site() mainpage = self.get_mainpage() diff --git a/tests/site_login_logout_tests.py b/tests/site_login_logout_tests.py index 11639e4..a5b41e6 100755 --- a/tests/site_login_logout_tests.py +++ b/tests/site_login_logout_tests.py @@ -82,7 +82,7 @@ self.assertFalse(raised) -def setUpModule(): +def setUpModule() -> None: """Skip tests if PYWIKIBOT_TEST_LOGOUT variable is not set.""" if os.environ.get('PYWIKIBOT_TEST_LOGOUT', '0') != '1': raise unittest.SkipTest('login/logout tests are disabled') diff --git a/tests/site_tests.py b/tests/site_tests.py index f885ee6..8b66149 100755 --- a/tests/site_tests.py +++ b/tests/site_tests.py @@ -279,7 +279,7 @@ cached = True - def worker(self): + def worker(self) -> None: """Lock a page, wait few seconds and unlock the page.""" page = pywikibot.Page(self.site, 'Foo') page.site.lock_page(page=page, block=True) @@ -824,7 +824,7 @@ """Test site.loadrevisions() caching.""" - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self._page = self.get_mainpage(force=True) super().setUp() @@ -921,7 +921,7 @@ login = True - def test_is_uploaddisabled(self, key): + def test_is_uploaddisabled(self, key) -> None: """Test is_uploaddisabled().""" site = self.get_site(key) self.assertEqual(site.is_uploaddisabled(), self.sites[key]['disabled']) @@ -964,7 +964,7 @@ """Test sametitle for enwt.""" self.assertFalse(self.get_site('enwt').sametitle('Foo', 'foo')) - def test_general(self, code): + def test_general(self, code) -> None: """Test sametitle.""" site = self.get_site(code) self.assertTrue(site.sametitle('File:Foo', 'Image:Foo')) @@ -1222,7 +1222,7 @@ cached = True - def test_get_property_names(self, key): + def test_get_property_names(self, key) -> None: """Test get_property_names method.""" mysite = self.get_site(key) pnames = mysite.get_property_names() @@ -1283,7 +1283,7 @@ ITEM = 'Q131303' - def test_page_from_repository(self, key): + def test_page_from_repository(self, key) -> None: """Validate page_from_repository.""" site = self.get_site(key) page = site.page_from_repository(self.ITEM) @@ -1321,7 +1321,7 @@ ITEM = 'Q6939656' - def test_page_from_repository(self, key): + def test_page_from_repository(self, key) -> None: """Validate page_from_repository.""" site = self.get_site(key) page = site.page_from_repository(self.ITEM) diff --git a/tests/siteinfo_tests.py b/tests/siteinfo_tests.py index 85aa5e3..577b5a6 100755 --- a/tests/siteinfo_tests.py +++ b/tests/siteinfo_tests.py @@ -25,7 +25,7 @@ cached = True - def setUp(self): + def setUp(self) -> None: """Clear siteinfo cache.""" super().setUp() self.site.siteinfo.clear() diff --git a/tests/sparql_tests.py b/tests/sparql_tests.py index cf38139..ead31de 100755 --- a/tests/sparql_tests.py +++ b/tests/sparql_tests.py @@ -91,7 +91,7 @@ """Simple test container for return values.""" - def __init__(self, value): + def __init__(self, value) -> None: """Create container.""" self.text = value @@ -105,7 +105,7 @@ """Test SPARQL queries.""" @patch.object(sparql.http, 'fetch') - def testQuerySelect(self, mock_method): + def testQuerySelect(self, mock_method) -> None: """Test SELECT query.""" mock_method.return_value = Container( SQL_RESPONSE_CONTAINER % f'{ITEM_Q498787}, {ITEM_Q677525}') @@ -127,7 +127,7 @@ 'Bad result') @patch.object(sparql.http, 'fetch') - def testQuerySelectFull(self, mock_method): + def testQuerySelectFull(self, mock_method) -> None: """Test SELECT query with full data.""" mock_method.return_value = Container( SQL_RESPONSE_CONTAINER % f'{ITEM_Q498787}, {ITEM_Q677525}') @@ -156,7 +156,7 @@ 'Wrong URI representation') @patch.object(sparql.http, 'fetch') - def testGetItems(self, mock_method): + def testGetItems(self, mock_method) -> None: """Test item list retrieval via SPARQL.""" mock_method.return_value = Container( SQL_RESPONSE_CONTAINER % (f'{ITEM_Q498787}, {ITEM_Q677525}, ' @@ -171,7 +171,7 @@ self.assertEqual(res, ['Q498787', 'Q677525', 'Q677525']) @patch.object(sparql.http, 'fetch') - def testQueryAsk(self, mock_method): + def testQueryAsk(self, mock_method) -> None: """Test ASK query.""" mock_method.return_value = Container(RESPONSE_TRUE) with skipping(pywikibot.exceptions.TimeoutError): diff --git a/tests/tests_tests.py b/tests/tests_tests.py index 4584bf3..08739ee 100755 --- a/tests/tests_tests.py +++ b/tests/tests_tests.py @@ -85,7 +85,7 @@ dry = True @require_version('') - def method(self): + def method(self) -> None: """Test method for decorator.""" def test_require_version(self) -> None: @@ -101,20 +101,20 @@ """Test require_version decorator.""" @require_version('') - def method_with_params(self, key): + def method_with_params(self, key) -> None: """Test method for decorated methods with unsupported arguments.""" - def method_failing(self): + def method_failing(self) -> None: """Test method for decorator with invalid parameter.""" self.assertTrue(False, 'should never happen') @require_version('>=1.31') - def method_succeed(self): + def method_succeed(self) -> None: """Test that decorator passes.""" self.assertTrue(False, 'intentional fail for method_succeed test') @require_version('<1.31') - def method_fail(self): + def method_fail(self) -> None: """Test that decorator skips.""" self.assertTrue(False, 'intentional fail for test') diff --git a/tests/textlib_tests.py b/tests/textlib_tests.py index b918223..18324ca 100755 --- a/tests/textlib_tests.py +++ b/tests/textlib_tests.py @@ -36,23 +36,23 @@ net = False @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Read test content.""" dirname = Path(__file__).parent / 'pages' file = dirname / 'enwiki_help_editing.page' cls.content = file.read_text(encoding='utf-8') - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self.catresult1 = '[[Category:Cat1]]\n[[Category:Cat2]]\n' super().setUp() - def assertContains(self, sn, msg=None): + def assertContains(self, sn, msg=None) -> None: """Test that file content contains sn.""" self.assertTrue(textlib.does_text_contain_section(self.content, sn), msg) - def assertNotContains(self, sn, msg=None): + def assertNotContains(self, sn, msg=None) -> None: """Test that file content does not contain sn.""" self.assertFalse(textlib.does_text_contain_section(self.content, sn), msg) @@ -311,7 +311,7 @@ net = False - def _common_results(self, func): + def _common_results(self, func) -> None: """Common cases.""" self.assertEqual(func('{{a}}'), [('a', OrderedDict())]) self.assertEqual(func('{{ a}}'), [('a', OrderedDict())]) @@ -366,7 +366,7 @@ self.assertEqual(func('{{a'), []) self.assertEqual(func('{{a}}{{foo|'), [('a', OrderedDict())]) - def _unstripped(self, func): + def _unstripped(self, func) -> None: """Common cases of unstripped results.""" self.assertEqual(func('{{a|b=}}'), [('a', OrderedDict((('b', ''), )))]) @@ -400,7 +400,7 @@ [('a', OrderedDict((('1', ' foo '), (' 2 ', ' bar '), ('2', ' baz '))))]) - def _stripped(self, func): + def _stripped(self, func) -> None: """Common cases of stripped results.""" self.assertEqual(func('{{a| }}'), [('a', OrderedDict((('1', ' '), )))]) @@ -429,13 +429,13 @@ [('a', OrderedDict((('1', ' foo '), ('2', ' baz '))))]) - def _etp_regex_differs(self, func): + def _etp_regex_differs(self, func) -> None: """Common cases not handled the same by ETP_REGEX.""" # inner {} should be treated as part of the value self.assertEqual(func('{{a|b={} }}'), [('a', OrderedDict((('b', '{} '), )))]) - def _order_differs(self, func): + def _order_differs(self, func) -> None: """Common cases where the order of templates differs.""" self.assertCountEqual(func('{{a|b={{c}}}}'), [('a', OrderedDict((('b', '{{c}}'), ))), @@ -451,7 +451,7 @@ ('2', 'd')])), ('b', OrderedDict([('1', 'c')]))]) - def _mwpfh_passes(self, func): + def _mwpfh_passes(self, func) -> None: """Common cases failing with wikitextparser but passes with mwpfh. Probably the behaviour of regex or mwpfh is wrong. @@ -682,7 +682,7 @@ '[[bug:1337]]?') @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Create a fake interwiki cache.""" super().setUpClass() # make APISite.interwiki work and prevent it from doing requests @@ -735,7 +735,7 @@ def test_unlink_all(self) -> None: """Test unlinking.""" - def callback(link, text, groups, rng): + def callback(link, text, groups, rng) -> bool: self.assertEqual(link.site, self.wp_site) return False self.assertEqual( @@ -909,7 +909,7 @@ def test_unicode_callback(self) -> None: """Test returning unicode in the callback.""" - def callback(link, text, groups, rng): + def callback(link, text, groups, rng) -> str | None: self.assertEqual(link.site, self.wp_site) if link.title == 'World': # This must be a unicode instance not bytes @@ -923,7 +923,7 @@ def test_bytes_callback(self) -> None: """Test returning bytes in the callback.""" - def callback(link, text, groups, rng): + def callback(link, text, groups, rng) -> bytes | None: self.assertEqual(link.site, self.wp_site) if link.title == 'World': # This must be a bytes instance not unicode @@ -1440,7 +1440,7 @@ """Test MultiTemplateMatchBuilder.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Cache namespace 10 (Template) case sensitivity.""" super().setUpClass() cls._template_not_case_sensitive = ( @@ -1510,12 +1510,12 @@ '[[baden:Site]] [[fr:{{PAGENAME}}]]') @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Define set of valid targets for the example text.""" super().setUpClass() cls.sites_set = {cls.enwp, cls.dewp} - def test_getLanguageLinks(self, key): + def test_getLanguageLinks(self, key) -> None: """Test if the function returns the correct titles and sites.""" with mock.patch('pywikibot.info') as m: lang_links = textlib.getLanguageLinks(self.example_text, @@ -1533,7 +1533,7 @@ """Test the extract_sections function.""" def _extract_sections_tests(self, result, header, sections, footer='', - title=''): + title='') -> None: """Test extract_sections function.""" self.assertIsInstance(result, tuple) self.assertIsInstance(result.sections, list) diff --git a/tests/time_tests.py b/tests/time_tests.py index ab3a40c..b3ec13a 100755 --- a/tests/time_tests.py +++ b/tests/time_tests.py @@ -102,7 +102,7 @@ return datetime(1970, 1, 1) + timedelta(seconds=sec, microseconds=usec) - def _test_set_from_string_fmt(self, fmt): + def _test_set_from_string_fmt(self, fmt) -> None: """Test creating instance from <FMT> string.""" for timestr, posix in self.test_results[fmt]: with self.subTest(timestr): diff --git a/tests/timestripper_tests.py b/tests/timestripper_tests.py index 5601cb7..fd49676 100755 --- a/tests/timestripper_tests.py +++ b/tests/timestripper_tests.py @@ -25,7 +25,7 @@ cached = True - def setUp(self): + def setUp(self) -> None: """Set up test cases.""" super().setUp() self.ts = TimeStripper(self.get_site()) @@ -223,7 +223,7 @@ cached = True - def test_timestripper_match(self, key): + def test_timestripper_match(self, key) -> None: """Test that correct date is matched.""" self.ts = TimeStripper(self.get_site(key)) @@ -254,7 +254,7 @@ self.assertEqual(self.ts.timestripper(txt_match), res) - def test_timestripper_nomatch(self, key): + def test_timestripper_nomatch(self, key) -> None: """Test that correct date is not matched.""" self.ts = TimeStripper(self.get_site(key)) txt_no_match = self.sites[key].get( diff --git a/tests/titletranslate_tests.py b/tests/titletranslate_tests.py index c595769..1eb8be5 100755 --- a/tests/titletranslate_tests.py +++ b/tests/titletranslate_tests.py @@ -32,7 +32,7 @@ }, } - def test_translate(self, key): + def test_translate(self, key) -> None: """Test translate method.""" site = self.get_site(key) result = translate(page=self.get_mainpage(site), auto=False, diff --git a/tests/token_tests.py b/tests/token_tests.py index 0f02611..d82b39c 100755 --- a/tests/token_tests.py +++ b/tests/token_tests.py @@ -54,7 +54,7 @@ """Verify token exists before running tests.""" - def setUp(self): + def setUp(self) -> None: """Skip test if user does not have token and clear site wallet.""" super().setUp() mysite = self.get_site() @@ -72,7 +72,7 @@ self._orig_wallet = self.site.tokens self.site.tokens.clear() - def tearDown(self): + def tearDown(self) -> None: """Restore site tokens.""" self.site._tokens = self._orig_wallet super().tearDown() diff --git a/tests/tools_deprecate_tests.py b/tests/tools_deprecate_tests.py index 6f34da1..728bb6f 100755 --- a/tests/tools_deprecate_tests.py +++ b/tests/tools_deprecate_tests.py @@ -9,6 +9,7 @@ import unittest from contextlib import suppress +from typing import NoReturn from pywikibot.tools import ( PYTHON_VERSION, @@ -26,24 +27,24 @@ def noop(foo=None): """Dummy decorator.""" def decorator(obj): - def wrapper(*args, **kwargs): + def wrapper(*args, **kwargs) -> NoReturn: raise Exception(obj.__full_name__) return wrapper return decorator @noop() -def decorated_func(): +def decorated_func() -> None: """Test dummy decorator.""" @noop(foo='bar') -def decorated_func2(): +def decorated_func2() -> None: """Test dummy decorator.""" @noop('baz') -def decorated_func3(): +def decorated_func3() -> None: """Test dummy decorator.""" @@ -142,7 +143,7 @@ @remove_last_args(['foo', 'bar']) -def deprecated_all(): +def deprecated_all() -> None: """Test remove_last_args with all args removed.""" return @@ -230,7 +231,7 @@ return foo @remove_last_args(['foo', 'bar']) - def deprecated_all(self): + def deprecated_all(self) -> None: """Deprecating positional parameters.""" return @@ -257,7 +258,7 @@ """Deprecated class.""" - def __init__(self, foo=None): + def __init__(self, foo=None) -> None: """Initializer.""" self.foo = foo @@ -438,7 +439,7 @@ def test_deprecate_function_arg(self) -> None: """Test @deprecated function argument.""" - def tests(func): + def tests(func) -> None: """Test function.""" rv = func() self.assertIsNone(rv) diff --git a/tests/tools_tests.py b/tests/tools_tests.py index 2b368aa..b3f578a 100755 --- a/tests/tools_tests.py +++ b/tests/tools_tests.py @@ -51,7 +51,7 @@ net = False @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Define base_file and original_content.""" super().setUpClass() cls.base_file = join_xml_data_path('article-pyrus.xml') @@ -115,7 +115,7 @@ net = False @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Define base_file and original_content.""" super().setUpClass() cls.base_file = join_xml_data_path('article-pyrus.xml') @@ -314,7 +314,7 @@ skip_list = [1, 3] - def __contains__(self, item): + def __contains__(self, item) -> bool: """Override to not process some items.""" if item in self.skip_list: return True @@ -328,7 +328,7 @@ process_again_list = [1, 3] - def add(self, item): + def add(self, item) -> None: """Override to not add some items.""" if item in self.process_again_list: return @@ -342,7 +342,7 @@ stop_list = [] - def __contains__(self, item): + def __contains__(self, item) -> bool: """Override to stop on encountering items.""" if item in self.stop_list: raise StopIteration @@ -356,7 +356,7 @@ stop_list = [] - def add(self, item): + def add(self, item) -> None: """Override to not continue on encountering items.""" if item in self.stop_list: raise StopIteration @@ -374,7 +374,7 @@ strs = [str(i) for i in ints] decs = [decimal.Decimal(i) for i in ints] - def _test_dedup_int(self, deduped, deduper, key=None): + def _test_dedup_int(self, deduped, deduper, key=None) -> None: """Test filter_unique results for int.""" if not key: key = passthrough @@ -406,7 +406,7 @@ with self.assertRaises(StopIteration): next(deduper) - def _test_dedup_str(self, deduped, deduper, key=None): + def _test_dedup_str(self, deduped, deduper, key=None) -> None: """Test filter_unique results for str.""" if not key: key = passthrough @@ -571,7 +571,7 @@ self.addCleanup(patcher.stop) return patcher.start() - def setUp(self): + def setUp(self) -> None: """Patch a variety of dependencies.""" super().setUp() self.stat = self.patch('os.stat') @@ -710,7 +710,7 @@ """Base class for intersect_generators test cases.""" - def assertEqualItertools(self, gens): + def assertEqualItertools(self, gens) -> None: """Assert intersect_generators result is same as set intersection.""" # If they are a generator, we need to convert to a list # first otherwise the generator is empty the second time. @@ -721,7 +721,7 @@ self.assertCountEqual(set(result), result) self.assertCountEqual(result, set_result) - def assertEqualItertoolsWithDuplicates(self, gens): + def assertEqualItertoolsWithDuplicates(self, gens) -> None: """Assert intersect_generators result equals Counter intersection.""" # If they are a generator, we need to convert to a list # first otherwise the generator is empty the second time. @@ -974,36 +974,36 @@ """Test class to verify cached decorator.""" - def __init__(self): + def __init__(self) -> None: """Initializer, reset read counter.""" self.read = 0 @cached - def foo(self): + def foo(self) -> str: """A method.""" self.read += 1 return 'foo' @property @cached - def bar(self): + def bar(self) -> str: """A property.""" self.read += 1 return 'bar' - def baz(self): + def baz(self) -> str: """An undecorated method.""" self.read += 1 return 'baz' @cached - def quux(self, force=False): + def quux(self, force=False) -> str: """Method with force.""" self.read += 1 return 'quux' @cached - def method_with_args(self, *args, **kwargs): + def method_with_args(self, *args, **kwargs) -> str: """Method with force.""" self.read += 1 return 'method_with_args' @@ -1015,7 +1015,7 @@ net = False - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self.foo = DecoratedMethods() super().setUp() diff --git a/tests/ui_tests.py b/tests/ui_tests.py index 5ad7129..a7c1b4e 100755 --- a/tests/ui_tests.py +++ b/tests/ui_tests.py @@ -12,6 +12,7 @@ import os import unittest from contextlib import redirect_stdout, suppress +from typing import NoReturn from unittest.mock import patch import pywikibot @@ -47,7 +48,7 @@ net = False - def setUp(self): + def setUp(self) -> None: """Setup test. Here we patch standard input, output, and errors, essentially @@ -71,7 +72,7 @@ pywikibot.ui.transliteration_target = None pywikibot.ui.encoding = 'utf-8' - def tearDown(self): + def tearDown(self) -> None: """Cleanup test.""" super().tearDown() @@ -384,7 +385,7 @@ expect_color = False ui_class = terminal_interface_base.UI - def setUp(self): + def setUp(self) -> None: """Create dummy instances for the test and patch encounter_color.""" super().setUp() self.ui_obj = self.ui_class() @@ -394,14 +395,14 @@ self.ui_obj.encounter_color = self._encounter_color self._index = 0 - def tearDown(self): + def tearDown(self) -> None: """Unpatch the encounter_color method.""" self.ui_obj.encounter_color = self._orig_encounter_color super().tearDown() self.assertEqual(self._index, len(self._colors) if self.expect_color else 0) - def _encounter_color(self, color, target_stream): + def _encounter_color(self, color, target_stream) -> NoReturn: """Patched encounter_color method.""" raise AssertionError( 'This method should not be invoked') # pragma: no cover @@ -465,18 +466,18 @@ expect_color = True expected = 'Hello world you!' - def setUp(self): + def setUp(self) -> None: """Force colorized_output to True.""" super().setUp() self._old_config = pywikibot.config.colorized_output pywikibot.config.colorized_output = True - def tearDown(self): + def tearDown(self) -> None: """Undo colorized_output configuration.""" pywikibot.config.colorized_output = self._old_config super().tearDown() - def _encounter_color(self, color, target_stream): + def _encounter_color(self, color, target_stream) -> None: """Verify that the written data, color and stream are correct.""" self.assertIs(target_stream, self.ui_obj.stdout) expected_color = self._colors[self._index][0] @@ -504,7 +505,7 @@ ui_class = terminal_interface_win32.Win32UI - def setUp(self): + def setUp(self) -> None: """Patch the ctypes import and initialize a stream and UI instance.""" super().setUp() self.ui_obj.stdout.isatty = lambda: self.expect_color diff --git a/tests/upload_tests.py b/tests/upload_tests.py index 7b43087..03c85a4 100755 --- a/tests/upload_tests.py +++ b/tests/upload_tests.py @@ -46,9 +46,9 @@ comment='pywikibot test', ignore_warnings=True, chunk_size=1024) - def _init_upload(self, chunk_size): + def _init_upload(self, chunk_size) -> None: """Do an initial upload causing an abort because of warnings.""" - def warn_callback(warnings): + def warn_callback(warnings) -> None: """A simple callback not automatically finishing the upload.""" self.assertCountEqual([w.code for w in warnings], expected_warns) # by now we know there are only two but just make sure @@ -75,7 +75,7 @@ self.assertRegex(self._file_key, r'[0-9a-z]+.[0-9a-z]+.\d+.png') self._verify_stash() - def _verify_stash(self): + def _verify_stash(self) -> None: info = self.site.stash_info(self._file_key, ['size', 'sha1']) if info['size'] == 1024: self.assertEqual('3503db342c8dfb0a38db0682b7370ddd271fa163', @@ -84,7 +84,7 @@ self.assertEqual('0408a0f6a5e057e701f3aed96b0d1fb913c3d9d0', info['sha1']) - def _finish_upload(self, chunk_size, file_name): + def _finish_upload(self, chunk_size, file_name) -> None: """Finish the upload.""" # Finish/continue upload with the given file key page = pywikibot.FilePage(self.site, 'MP_sounds-pwb.png') @@ -92,7 +92,7 @@ comment='pywikibot test', chunk_size=chunk_size, ignore_warnings=True, report_success=False) - def _test_continue_filekey(self, chunk_size): + def _test_continue_filekey(self, chunk_size) -> None: """Test uploading a chunk first and finish in a separate upload.""" self._init_upload(chunk_size) self._finish_upload(chunk_size, self.sounds_png) diff --git a/tests/user_tests.py b/tests/user_tests.py index 7439ba4..be5dbeb 100755 --- a/tests/user_tests.py +++ b/tests/user_tests.py @@ -23,7 +23,7 @@ family = 'wikipedia' code = 'de' - def _tests_unregistered_user(self, user, prop='invalid'): + def _tests_unregistered_user(self, user, prop='invalid') -> None: """Proceed user tests.""" self.assertEqual(user.title(with_ns=False), user.username) self.assertFalse(user.isRegistered()) diff --git a/tests/utils.py b/tests/utils.py index c80e331..95341b8 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -13,7 +13,7 @@ import warnings from contextlib import contextmanager, suppress from subprocess import PIPE, Popen, TimeoutExpired -from typing import Any +from typing import Any, NoReturn import pywikibot from pywikibot import config @@ -65,7 +65,7 @@ return gen -def entered_loop(iterable): +def entered_loop(iterable) -> bool: """Return True if iterable contains items.""" for _ in iterable: return True @@ -81,7 +81,7 @@ patched into the call stack. """ - def __init__(self, skip_list): + def __init__(self, skip_list) -> None: """Initializer. :param skip_list: List of objects to be skipped. The source of any @@ -100,7 +100,7 @@ return self._skip_list @skip_list.setter - def skip_list(self, value): + def skip_list(self, value) -> None: """Set list of objects to be skipped. :param value: List of objects to be skipped @@ -119,7 +119,7 @@ def __enter__(self): """Enter the context manager.""" - def detailed_show_warning(*args, **kwargs): + def detailed_show_warning(*args, **kwargs) -> None: """Replacement handler for warnings.showwarning.""" warn_msg = warnings.WarningMessage(*args, **kwargs) @@ -176,7 +176,7 @@ object given or calls the callable object. """ - def __init__(self, code, info, msg, test_case, regex=None): + def __init__(self, code, info, msg, test_case, regex=None) -> None: """Create instance expecting the code and info.""" self.code = code self.info = info @@ -217,7 +217,7 @@ """Dummy class to use instead of :py:obj:`data.api.ParamInfo`.""" - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" super().__init__(*args, **kwargs) self.action_modules = set() @@ -252,7 +252,7 @@ <pywikibot.site._siteinfo.Siteinfo>`. """ - def __init__(self, cache): + def __init__(self, cache) -> None: """Initializer.""" self._cache = {key: (item, False) for key, item in cache.items()} @@ -260,7 +260,7 @@ """Get item.""" return self.get(key, False) - def __setitem__(self, key, value): + def __setitem__(self, key, value) -> None: """Set item.""" self._cache[key] = (value, False) @@ -284,7 +284,7 @@ raise KeyError(key) - def __contains__(self, key): + def __contains__(self, key) -> bool: """Return False.""" return False @@ -295,11 +295,11 @@ """ return key in self._cache - def is_recognised(self, key): + def is_recognised(self, key) -> None: """Return None.""" return - def get_requested_time(self, key): + def get_requested_time(self, key) -> bool: """Return False.""" return False @@ -308,7 +308,7 @@ """Dummy class to use instead of :py:obj:`data.api.Request`.""" - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: """Initializer.""" _original_Request.__init__(self, *args, **kwargs) @@ -317,14 +317,14 @@ """Skip CachedRequest implementation.""" return _original_Request.create_simple(req_site, **kwargs) - def _expired(self, dt): + def _expired(self, dt) -> bool: """Never invalidate cached data.""" return False def _write_cache(self, data) -> None: """Never write data but just do nothing.""" - def submit(self): + def submit(self) -> NoReturn: """Prevented method.""" raise Exception(f'DryRequest rejecting request: {self._params!r}') @@ -335,7 +335,7 @@ _loginstatus = LoginStatus.NOT_ATTEMPTED - def __init__(self, code, fam, user): + def __init__(self, code, fam, user) -> None: """Initializer.""" super().__init__(code, fam, user) self._userinfo = pywikibot.tools.collections.EMPTY_DEFAULT @@ -370,7 +370,7 @@ author_ns, 'Author', case=self.siteinfo['case']) return ns_dict - def linktrail(self): + def linktrail(self) -> str: """Return default linkrail.""" return '[a-z]*' @@ -379,7 +379,7 @@ """Return dry data.""" return self._userinfo - def version(self): + def version(self) -> str: """Return a big dummy version string.""" return '999.999' @@ -412,7 +412,7 @@ interface=DryDataSite) return None - def login(self, *args, cookie_only=False, **kwargs): + def login(self, *args, cookie_only=False, **kwargs) -> None: """Overwrite login which is called when a site is initialized. .. versionadded:: 8.0.4 @@ -454,12 +454,12 @@ """Loads a fake password.""" @property - def password(self): + def password(self) -> str: """Get the fake password.""" return 'foo' @password.setter - def password(self, value): + def password(self, value) -> None: """Ignore password changes.""" diff --git a/tests/wbtypes_tests.py b/tests/wbtypes_tests.py index 64aab15..3ca00cf 100755 --- a/tests/wbtypes_tests.py +++ b/tests/wbtypes_tests.py @@ -22,7 +22,7 @@ """Test methods inherited or extended from _WbRepresentation.""" - def _test_hashable(self, representation): + def _test_hashable(self, representation) -> None: """Test that the representation is hashable.""" list_of_dupes = [representation, representation] self.assertLength(set(list_of_dupes), 1) @@ -690,7 +690,7 @@ the appropriate version. """ - def setUp(self): + def setUp(self) -> None: """Override setup to store repo and it's version.""" super().setUp() self.repo = self.get_repo() @@ -836,7 +836,7 @@ These require non dry tests due to the page.exists() call. """ - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self.commons = pywikibot.Site('commons') self.page = Page(self.commons, 'Data:Lyngby Hovedgade.map') @@ -911,7 +911,7 @@ These require non dry tests due to the page.exists() call. """ - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self.commons = pywikibot.Site('commons') self.page = Page(self.commons, 'Data:Bea.gov/GDP by state.tab') diff --git a/tests/wikibase_edit_tests.py b/tests/wikibase_edit_tests.py index eadbd32..89a98fc 100755 --- a/tests/wikibase_edit_tests.py +++ b/tests/wikibase_edit_tests.py @@ -462,7 +462,7 @@ login = True write = True - def setUp(self): + def setUp(self) -> None: """Add a claim with two qualifiers.""" super().setUp() testsite = self.get_repo() @@ -539,7 +539,7 @@ login = True write = True - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self.testsite = self.get_repo() self.item = pywikibot.ItemPage(self.testsite, 'Q68') @@ -549,7 +549,7 @@ badges=[badge]) super().setUp() - def tearDown(self): + def tearDown(self) -> None: """Tear down tests.""" self.item = None self.sitelink = None diff --git a/tests/wikibase_tests.py b/tests/wikibase_tests.py index aaaa244..cf0c0bb 100755 --- a/tests/wikibase_tests.py +++ b/tests/wikibase_tests.py @@ -50,7 +50,7 @@ """Test site.loadrevisions() caching.""" - def setUp(self): + def setUp(self) -> None: """Setup test.""" self._page = ItemPage(self.get_repo(), 'Q15169668') super().setUp() @@ -66,7 +66,7 @@ """General Wikibase tests.""" @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Setup test class.""" super().setUpClass() enwiki = pywikibot.Site('en', 'wikipedia') @@ -163,7 +163,7 @@ dry = True - def setUp(self): + def setUp(self) -> None: """Setup test.""" super().setUp() wikidata = self.get_repo() @@ -230,12 +230,12 @@ } @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Setup test class.""" super().setUpClass() cls.site = cls.get_site('enwiki') - def setUp(self): + def setUp(self) -> None: """Setup test.""" super().setUp() self.nyc = pywikibot.Page(pywikibot.page.Link('New York City', @@ -464,7 +464,7 @@ item.get() self.assertTrue(item.exists()) - def _test_fromPage_noitem(self, link): + def _test_fromPage_noitem(self, link) -> None: """Helper function to test a page without an associated item. It tests two of the ways to fetch an item: @@ -1012,7 +1012,7 @@ """Test behavior of ItemPage methods inherited from BasePage.""" - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self._page = ItemPage(self.get_repo(), 'Q60') super().setUp() @@ -1032,7 +1032,7 @@ """Test behavior of Page methods for wikibase item.""" - def setUp(self): + def setUp(self) -> None: """Setup tests.""" self._page = pywikibot.Page(self.site, 'Q60') super().setUp() @@ -1063,7 +1063,7 @@ } } - def setUp(self): + def setUp(self) -> None: """Setup Tests.""" super().setUp() self.wdp = ItemPage(self.get_repo(), 'Q60') @@ -1097,7 +1097,7 @@ net = False - def setUp(self): + def setUp(self) -> None: """Setup tests.""" super().setUp() self.data_out = { @@ -1288,7 +1288,7 @@ dry = True @classmethod - def setUpClass(cls): + def setUpClass(cls) -> None: """Setup test class.""" super().setUpClass() @@ -1351,7 +1351,7 @@ }, } - def test_own_client(self, key): + def test_own_client(self, key) -> None: """Test that a data repository family can be its own client.""" site = self.get_site(key) page = self.get_mainpage(site) @@ -1359,13 +1359,13 @@ self.assertEqual(page.site, site) self.assertEqual(item.site, site) - def test_page_from_repository(self, key): + def test_page_from_repository(self, key) -> None: """Test that page_from_repository method works for wikibase too.""" site = self.get_site(key) page = site.page_from_repository('Q5296') self.assertEqual(page, self.get_mainpage(site)) - def test_redirect_from_repository(self, key): + def test_redirect_from_repository(self, key) -> None: """Test page_from_repository method with redirects.""" site = self.get_site(key) item = self.sites[key]['item'] @@ -1396,7 +1396,7 @@ dry = True - def test_not_supported_family(self, key): + def test_not_supported_family(self, key) -> None: """Test that family without a data repository causes error.""" site = self.get_site(key) @@ -1407,12 +1407,12 @@ with self.assertRaisesRegex(WikiBaseError, regex): self.wdp.data_item() - def test_has_data_repository(self, key): + def test_has_data_repository(self, key) -> None: """Test that site has no data repository.""" site = self.get_site(key) self.assertFalse(site.has_data_repository) - def test_page_from_repository_fails(self, key): + def test_page_from_repository_fails(self, key) -> None: """Test that page_from_repository method fails.""" site = self.get_site(key) dummy_item = 'Q1' @@ -1425,7 +1425,7 @@ """Test cases to test toJSON() functions.""" - def setUp(self): + def setUp(self) -> None: """Setup test.""" super().setUp() wikidata = self.get_repo() diff --git a/tests/xmlreader_tests.py b/tests/xmlreader_tests.py index d615875..e9fa319 100755 --- a/tests/xmlreader_tests.py +++ b/tests/xmlreader_tests.py @@ -78,7 +78,7 @@ self.assertEqual(previous, result) return result - def _compare_variants(self, revisions): + def _compare_variants(self, revisions) -> None: """Compare the different XML file variants.""" previous = None previous = self._compare(previous, '.xml', revisions) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155541?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: I3269bae8698edcd77b123bcf9fc1815e9f29fdb7 Gerrit-Change-Number: 1155541 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: Don't appending to dictionary immediately following its definition
by jenkins-bot (Code Review) 10 Jun '25

10 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155379?usp=email ) Change subject: IMPR: Don't appending to dictionary immediately following its definition ...................................................................... IMPR: Don't appending to dictionary immediately following its definition Change-Id: I754e1185382a75fcff0608fe4ed0419efa081837 --- M pywikibot/userinterfaces/gui.py 1 file changed, 10 insertions(+), 14 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/userinterfaces/gui.py b/pywikibot/userinterfaces/gui.py index e560c72..acee922 100644 --- a/pywikibot/userinterfaces/gui.py +++ b/pywikibot/userinterfaces/gui.py @@ -13,7 +13,7 @@ .. seealso:: :mod:`editor` """ # -# (C) Pywikibot team, 2003-2024 +# (C) Pywikibot team, 2003-2025 # # Distributed under the terms of the MIT license. # @@ -84,26 +84,22 @@ @staticmethod def _initialize_config(theme): """Fix idleConf.GetHighlight method for different Python releases.""" - config = { + return { 'padx': 5, 'wrap': 'word', 'undo': 'True', 'width': idleConf.GetOption('main', 'EditorWindow', 'width'), 'height': idleConf.GetOption('main', 'EditorWindow', 'height'), + 'foreground': idleConf.GetHighlight(theme, 'normal')['foreground'], + 'background': idleConf.GetHighlight(theme, 'normal')['background'], + 'highlightcolor': idleConf.GetHighlight( + theme, 'hilite')['foreground'], + 'highlightbackground': idleConf.GetHighlight( + theme, 'hilite')['background'], + 'insertbackground': idleConf.GetHighlight( + theme, 'cursor')['foreground'], } - config['foreground'] = idleConf.GetHighlight( - theme, 'normal')['foreground'] - config['background'] = idleConf.GetHighlight( - theme, 'normal')['background'] - config['highlightcolor'] = idleConf.GetHighlight( - theme, 'hilite')['foreground'] - config['highlightbackground'] = idleConf.GetHighlight( - theme, 'hilite')['background'] - config['insertbackground'] = idleConf.GetHighlight( - theme, 'cursor')['foreground'] - return config - def add_bindings(self) -> None: """Assign key and events bindings to methods.""" # due to IDLE dependencies, this can't be called from __init__ -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155379?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: I754e1185382a75fcff0608fe4ed0419efa081837 Gerrit-Change-Number: 1155379 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: remove del statements from local scope
by jenkins-bot (Code Review) 10 Jun '25

10 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155376?usp=email ) Change subject: IMPR: remove del statements from local scope ...................................................................... IMPR: remove del statements from local scope Change-Id: I9f07af1b30222a160578c9ced018b50448791a9b --- M scripts/category.py M scripts/interwiki.py M scripts/welcome.py M tests/page_tests.py 4 files changed, 1 insertion(+), 8 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/scripts/category.py b/scripts/category.py index 8098501..3004af4 100755 --- a/scripts/category.py +++ b/scripts/category.py @@ -368,7 +368,6 @@ self.cat_content_db = databases['cat_content_db'] # like the above, but for supercategories self.superclass_db = databases['superclass_db'] - del databases except Exception: # If something goes wrong, just rebuild the database self.rebuild() @@ -1389,7 +1388,6 @@ result += ' ' + i18n.twtranslate(self.site, 'category-also-in', {'alsocat': comma.join( supercat_names)}) - del supercat_names result += '\n' if current_depth < self.max_depth: for subcat in self.cat_db.get_subcats(cat): diff --git a/scripts/interwiki.py b/scripts/interwiki.py index 4eb6108..61bebbf 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -531,7 +531,6 @@ elif arg == 'skipfile': skip_page_gen = pagegenerators.TextIOPageGenerator(value) self.skip.update(skip_page_gen) - del skip_page_gen elif arg == 'neverlink': self.neverlink += value.split(',') elif arg == 'ignore': @@ -540,7 +539,6 @@ elif arg == 'ignorefile': ignore_page_gen = pagegenerators.TextIOPageGenerator(value) self.ignore.update(ignore_page_gen) - del ignore_page_gen elif arg == 'showpage': self.showtextlink += self.showtextlinkadd elif arg == 'graph': diff --git a/scripts/welcome.py b/scripts/welcome.py index 5b544bd..b07e770 100755 --- a/scripts/welcome.py +++ b/scripts/welcome.py @@ -577,7 +577,6 @@ self.show_status(Msg.WARN) pywikibot.info("The bad word page doesn't exist!") self._blacklist = elenco + elenco_others + list_loaded - del elenco, elenco_others, list_loaded if not hasattr(self, '_whitelist') or force: # initialize whitelist @@ -599,7 +598,6 @@ # Join the whitelist words. self._whitelist = list_white + whitelist_default - del list_white, whitelist_default with suppress(UnicodeEncodeError): for wname in self._whitelist: diff --git a/tests/page_tests.py b/tests/page_tests.py index 0f58193..5a5c061 100755 --- a/tests/page_tests.py +++ b/tests/page_tests.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 """Tests for the page module.""" # -# (C) Pywikibot team, 2008-2024 +# (C) Pywikibot team, 2008-2025 # # Distributed under the terms of the MIT license. # @@ -875,7 +875,6 @@ page = pywikibot.Page(self.site, 'Pywikibot nobots test') page.text = content self.assertFalse(page.botMayEdit()) - del page def test_real_page(self) -> None: """Test botMayEdit for real example due to T377651.""" -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1155376?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: I9f07af1b30222a160578c9ced018b50448791a9b Gerrit-Change-Number: 1155376 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]: login.py: Recognise * in config.usernames
by jenkins-bot (Code Review) 10 Jun '25

10 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1112370?usp=email ) Change subject: login.py: Recognise * in config.usernames ...................................................................... login.py: Recognise * in config.usernames If there is an '*' in config.usernames as the language for a certain family, expand it to all codes that are found in the family file if the code is not already given. Note: you may use -async to speed-up login process. Bug: T110411 Change-Id: I5af62457d34709209c3a4ce76e54bb603e3729a3 --- M pywikibot/scripts/login.py 1 file changed, 19 insertions(+), 5 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/scripts/login.py b/pywikibot/scripts/login.py index c1af7f6..eacc7f9 100755 --- a/pywikibot/scripts/login.py +++ b/pywikibot/scripts/login.py @@ -41,10 +41,14 @@ subdirectory. .. versionchanged:: 7.4 - moved to :mod:`pywikibot.scripts` folder + moved to :mod:`pywikibot.scripts` folder. +.. versionchanged:: 7.7 + *-async* option was added. +.. versionchanged:: 10.2 + wildcard site codes in ``usernames`` dict are supported. """ # -# (C) Pywikibot team, 2003-2024 +# (C) Pywikibot team, 2003-2025 # # Distributed under the terms of the MIT license. # @@ -56,6 +60,7 @@ import pywikibot from pywikibot import config from pywikibot.exceptions import NoUsernameError, SiteDefinitionError +from pywikibot.family import Family from pywikibot.login import OauthLoginManager from pywikibot.tools.threading import BoundedPoolExecutor @@ -161,11 +166,20 @@ BoundedPoolExecutor('ThreadPoolExecutor'))[asynchronous] with context as executor: for family_name in namedict: - for lang in namedict[family_name]: + family_codes = namedict[family_name] + + if '*' in family_codes: + user = family_codes['*'] + del family_codes['*'] + codes = (code for code in Family.load(family_name).codes + if code not in family_codes) + family_codes.update(dict.fromkeys(codes, user)) + + for code in family_codes: if asynchronous: - executor.submit(login_one_site, lang, family_name, *params) + executor.submit(login_one_site, code, family_name, *params) else: - login_one_site(lang, family_name, *params) + login_one_site(code, family_name, *params) if __name__ == '__main__': -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1112370?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: I5af62457d34709209c3a4ce76e54bb603e3729a3 Gerrit-Change-Number: 1112370 Gerrit-PatchSet: 6 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: Framawiki <framawiki(a)tools.wmflabs.org> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...i18n[master]: Localisation updates from https://translatewiki.net.
by jenkins-bot (Code Review) 09 Jun '25

09 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/i18n/+/1154797?usp=email ) Change subject: Localisation updates from https://translatewiki.net. ...................................................................... Localisation updates from https://translatewiki.net. Change-Id: I7783203f531052459c2f256b13bcd3ed54c83c3b --- M archivebot/ps.json A basic/ps.json A blockpageschecker/ps.json M category/ps.json A pywikibot/ps.json A replicate_wiki/el.json 6 files changed, 56 insertions(+), 3 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/archivebot/ps.json b/archivebot/ps.json index 88c7a23..e0bf4c6 100644 --- a/archivebot/ps.json +++ b/archivebot/ps.json @@ -7,5 +7,6 @@ }, "archivebot-archive-full": "(خونديځ ډک دی)", "archivebot-archive-summary": "روباټ: د [[%(from)s]] د %(count)d {{PLURAL:%(count)d|سرليکې|سرليکو}} خونديځول", - "archivebot-older-than": "له %(duration)s {{PLURAL:%(count)d|زړې}}" + "archivebot-older-than": "له %(duration)s {{PLURAL:%(count)d|زړې}}", + "archivebot-page-summary": "روباټ:د %(count)d {{PLURAL:%(count)d\n|سرليکې|سرليکو}} (%(why)s) ته %(archives)s خونديځول" } diff --git a/basic/ps.json b/basic/ps.json new file mode 100644 index 0000000..2755208 --- /dev/null +++ b/basic/ps.json @@ -0,0 +1,8 @@ +{ + "@metadata": { + "authors": [ + "شاه زمان پټان" + ] + }, + "basic-changing": "روباټ: بدلول..." +} diff --git a/blockpageschecker/ps.json b/blockpageschecker/ps.json new file mode 100644 index 0000000..827b8a5 --- /dev/null +++ b/blockpageschecker/ps.json @@ -0,0 +1,10 @@ +{ + "@metadata": { + "authors": [ + "شاه زمان پټان" + ] + }, + "blockpageschecker-adding": "روباټ: مخ تالې کينډۍ ورگډول", + "blockpageschecker-modifying": "روباټ: تېرمهاله کينډۍ بدلول", + "blockpageschecker-deleting": "روباټ: تېرمهاله کينډۍ ړنگول" +} diff --git a/category/ps.json b/category/ps.json index f3cc725..8312c19 100644 --- a/category/ps.json +++ b/category/ps.json @@ -1,9 +1,11 @@ { "@metadata": { "authors": [ - "Ahmed-Najib-Biabani-Ibrahimkhel" + "Ahmed-Najib-Biabani-Ibrahimkhel", + "شاه زمان پټان" ] }, "category-adding": "روباټ: وېشنيزه ورگډول [[:Category:%(newcat)s|%(newcat)s]]", - "category-also-in": "(همداراز په %(alsocat)s کې)" + "category-also-in": "(همداراز په %(alsocat)s کې)", + "category-clean": "روباټ: وېشنيزه لرې‌کول %(category)s ځکه چې له مخکې په %(child)s کې شته" } diff --git a/pywikibot/ps.json b/pywikibot/ps.json new file mode 100644 index 0000000..121ca28 --- /dev/null +++ b/pywikibot/ps.json @@ -0,0 +1,21 @@ +{ + "@metadata": { + "authors": [ + "شاه زمان پټان" + ] + }, + "pywikibot-bot-prefix": "روباټ:", + "pywikibot-cosmetic-changes": "؛سينگاري بدلونونه", + "pywikibot-enter-category-name": "مهرباني وکړئ د وېشنيزې نوم دننه کړئ:", + "pywikibot-enter-file-links-processing": "د کومې دوتنې مخ وېبتړنې بايد پرمخ يوړل شي؟", + "pywikibot-enter-finished-browser": "کله چې ښوونگر کې پای ته ورسېږي؛ نو Enter کېکاږئ.", + "pywikibot-enter-namespace-number": "مهرباني وکړئ نوم‌تشيال د هغې د شمېرې له مخې دننه کړئ:", + "pywikibot-enter-new-text": "مهرباني وکړئ نوی ليک دننه کړئ:", + "pywikibot-enter-page-processing": "کوم مخ بايد پرمخ يوړل شي؟", + "pywikibot-enter-xml-filename": "مهرباني وکړئ د اېکس‌اېم‌اېل انبار دوتنې‌نوم دننه کړئ:", + "pywikibot-fixes-fckeditor": "روباټ: د بډايه سمونگر اېچ‌ټي‌اېم‌اېل سمول", + "pywikibot-fixes-html": "روباټ: د اېچ‌ټي‌اېم‌اېل بدلول/سمول", + "pywikibot-fixes-isbn": "روباټ: آی‌اېس‌بي‌اېن بڼل", + "pywikibot-fixes-syntax": "روباټ: ويکي غونډلپوهه سمول", + "pywikibot-touch": "پی‌ويکي‌باټ لاس‌لگی سمون" +} diff --git a/replicate_wiki/el.json b/replicate_wiki/el.json new file mode 100644 index 0000000..ab07c43 --- /dev/null +++ b/replicate_wiki/el.json @@ -0,0 +1,11 @@ +{ + "@metadata": { + "authors": [ + "Jimkats" + ] + }, + "replicate_wiki-headline": "Σελίδες που διαφέρουν από το πρωτότυπο", + "replicate_wiki-missing-users": "Διαχειριστές από το πρωτότυπο που λείπουν εδώ", + "replicate_wiki-same-pages": "Όλες οι σημαντικές σελίδες είναι ίδιες", + "replicate_wiki-same-users": "Όλοι οι χρήστες από το αρχικό είναι επίσης παρόντες σε αυτό το wiki" +} -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/i18n/+/1154797?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/i18n Gerrit-Branch: master Gerrit-Change-Id: I7783203f531052459c2f256b13bcd3ed54c83c3b Gerrit-Change-Number: 1154797 Gerrit-PatchSet: 3 Gerrit-Owner: L10n-bot <l10n-bot(a)translatewiki.net> Gerrit-Reviewer: L10n-bot <l10n-bot(a)translatewiki.net> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: [BUG] exturlusage: protocol can't be a list
by jenkins-bot (Code Review) 08 Jun '25

08 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154488?usp=email ) Change subject: [BUG] exturlusage: protocol can't be a list ...................................................................... [BUG] exturlusage: protocol can't be a list Change-Id: I66d697546268560953a888e6a5e88a9554f0adc6 --- M pywikibot/site/_generators.py M tests/site_generators_tests.py 2 files changed, 9 insertions(+), 22 deletions(-) Approvals: JJMC89: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/site/_generators.py b/pywikibot/site/_generators.py index debd456..fe44f35 100644 --- a/pywikibot/site/_generators.py +++ b/pywikibot/site/_generators.py @@ -1317,7 +1317,7 @@ def exturlusage( self, url: str | None = None, - protocol: str | list[str] | None = None, + protocol: str | None = None, namespaces: NamespaceArgType = None, total: int | None = None, content: bool = False, @@ -1331,11 +1331,9 @@ of the hostname :param namespaces: list of namespace numbers to fetch contribs from :param total: Maximum number of pages to retrieve in total - :param protocol: list of protocols to search for, http and https by - default. Full list shown on Special:LinkSearch wikipage + :param protocol: protocol to search for, http and https by default. + Full list shown on Special:LinkSearch wikipage """ - if isinstance(protocol, str): - protocol = [protocol] if url is not None: found_protocol, _, url = url.rpartition('://') @@ -1345,18 +1343,12 @@ url = None if found_protocol: - if protocol: - if len(protocol) > 1: - raise ValueError( - 'More than one protocol was specified and a ' - 'protocol was found in searched url' - ) - if protocol[0] != found_protocol: - raise ValueError( - f'Protocol {protocol!r} was specified, but ' - f'{found_protocol!r} was found in searched url' - ) - protocol = [found_protocol] + if protocol and protocol != found_protocol: + raise ValueError( + f'Protocol {protocol!r} was specified, but ' + f'{found_protocol!r} was found in searched url' + ) + protocol = found_protocol return self._generator(api.PageGenerator, type_arg='exturlusage', geuquery=url, geuprotocol=protocol, diff --git a/tests/site_generators_tests.py b/tests/site_generators_tests.py index 7bf8655..8ee081f 100755 --- a/tests/site_generators_tests.py +++ b/tests/site_generators_tests.py @@ -596,11 +596,6 @@ mysite.exturlusage('https://www.google.com', protocol='http') with self.assertRaises(ValueError): mysite.exturlusage('http://www.google.com', protocol='https') - with self.assertRaises(ValueError): - mysite.exturlusage( - 'https://www.google.com', - protocol=['http', 'https'], - ) def test_protectedpages_create(self) -> None: """Test that protectedpages returns protected page titles.""" -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154488?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: I66d697546268560953a888e6a5e88a9554f0adc6 Gerrit-Change-Number: 1154488 Gerrit-PatchSet: 1 Gerrit-Owner: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com> Gerrit-Reviewer: jenkins-bot

1 0

[Gerrit] ...core[master]: pre-commit: Update pre-commit dependency
by Xqt (Code Review) 08 Jun '25

08 Jun '25

Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154454?usp=email ) Change subject: pre-commit: Update pre-commit dependency ...................................................................... pre-commit: Update pre-commit dependency Change-Id: Ica5822e10c995d29fccfe912db48b52b5ef7152f --- M dev-requirements.txt M tox.ini 2 files changed, 2 insertions(+), 2 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/dev-requirements.txt b/dev-requirements.txt index 694e5d1..c5465e1 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -7,7 +7,7 @@ pytest-attrib>=0.1.3 pytest-xvfb>=3.0.0 -pre-commit >= 4.1.0; python_version > "3.8" +pre-commit >= 4.2.0; python_version > "3.8" pre-commit == 3.5.0; python_version < "3.9" coverage==7.6.1; python_version < "3.9" coverage>=7.6.12; python_version > "3.8" diff --git a/tox.ini b/tox.ini index 9585eed..58e901d 100644 --- a/tox.ini +++ b/tox.ini @@ -43,7 +43,7 @@ fasttest: pytest --version fasttest: pytest -a 'not net' deps = - lint: pre-commit >= 2.17.0 + lint: pre-commit >= 3.5.0 fasttest: pytest >= 7.0.1 fasttest: pytest-attrib>=0.1.3 -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154454?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: Ica5822e10c995d29fccfe912db48b52b5ef7152f Gerrit-Change-Number: 1154454 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: replace codecs.open() with open() in parser_function_count.py
by jenkins-bot (Code Review) 08 Jun '25

08 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1152437?usp=email ) Change subject: IMPR: replace codecs.open() with open() in parser_function_count.py ...................................................................... IMPR: replace codecs.open() with open() in parser_function_count.py Bug: T395187 Change-Id: I57225980e75ab26fbe3806cb60e7bfdbe024f32a --- M scripts/parser_function_count.py 1 file changed, 2 insertions(+), 7 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/parser_function_count.py b/scripts/parser_function_count.py index 5900508..60c02ed 100755 --- a/scripts/parser_function_count.py +++ b/scripts/parser_function_count.py @@ -43,13 +43,12 @@ functions will be listed. """ # -# (C) Pywikibot team, 2013-2022 +# (C) Pywikibot team, 2013-2025 # # Distributed under the terms of the MIT license. # from __future__ import annotations -import codecs import re from collections import Counter @@ -163,12 +162,8 @@ # File operations: if self.opt.save: - # This opens in strict error mode, that means bot will stop - # on encoding errors with ValueError. - # See https://docs.python.org/3/library/codecs.html#codecs.open try: - with codecs.open( - self.opt.save, encoding='utf-8', mode='a') as f: + with open(self.opt.save, 'a', encoding='utf-8') as f: f.write(resultlist) except OSError as e: pywikibot.error(e) -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1152437?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: I57225980e75ab26fbe3806cb60e7bfdbe024f32a Gerrit-Change-Number: 1152437 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]: [Bugfix] Fix i18n.translate calls
by jenkins-bot (Code Review) 08 Jun '25

08 Jun '25

jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154390?usp=email ) Change subject: [Bugfix] Fix i18n.translate calls ...................................................................... [Bugfix] Fix i18n.translate calls i18n.translate() does not raise a KeyError if the key does not exists but just returns None. Therefore use the following variants: - suppress TypeError if the result is to be unpacked in more than one variable - check whether the result is None to continue - add additional checks to solve_disambiguation.py Bug: T219094 Change-Id: Iae2ac3af3229be160940062f3f2f14d6050ec435 --- M pywikibot/cosmetic_changes.py M scripts/category.py M scripts/commonscat.py M scripts/imagetransfer.py M scripts/interwiki.py M scripts/solve_disambiguation.py 6 files changed, 47 insertions(+), 55 deletions(-) Approvals: jenkins-bot: Verified Meno25: Looks good to me, but someone else must approve Lichinsol: Looks good to me, but someone else must approve Xqt: Looks good to me, approved diff --git a/pywikibot/cosmetic_changes.py b/pywikibot/cosmetic_changes.py index ffc66cd..c397430 100644 --- a/pywikibot/cosmetic_changes.py +++ b/pywikibot/cosmetic_changes.py @@ -50,7 +50,7 @@ 'your_script_name_2'] """ # -# (C) Pywikibot team, 2006-2024 +# (C) Pywikibot team, 2006-2025 # # Distributed under the terms of the MIT license. # @@ -373,11 +373,9 @@ if not self.talkpage: subpage = False if self.template: - try: - tmpl, loc = i18n.translate(self.site.code, moved_links) - del tmpl - except KeyError: - loc = None + loc = None + with suppress(TypeError): + _tmpl, loc = i18n.translate(self.site.code, moved_links) if loc is not None and loc in self.title: subpage = True diff --git a/scripts/category.py b/scripts/category.py index 7cd95e1..100b4ef 100755 --- a/scripts/category.py +++ b/scripts/category.py @@ -153,7 +153,7 @@ :mod:`pagegenerators` are supported with "move" and "remove" action. """ # -# (C) Pywikibot team, 2004-2024 +# (C) Pywikibot team, 2004-2025 # # Distributed under the terms of the MIT license. # @@ -301,7 +301,7 @@ return page tmpl: Sequence = [] - with suppress(KeyError): + with suppress(TypeError): tmpl, _loc = i18n.translate(page.site.code, moved_links) if not isinstance(tmpl, list): diff --git a/scripts/commonscat.py b/scripts/commonscat.py index 1c7c4e0..298a8ba 100755 --- a/scripts/commonscat.py +++ b/scripts/commonscat.py @@ -40,7 +40,7 @@ # *Found one template. Add this template # *Found more templates. Ask the user <- still have to implement this # -# (C) Pywikibot team, 2008-2024 +# (C) Pywikibot team, 2008-2025 # # Distributed under the terms of the MIT license. # @@ -260,10 +260,8 @@ @staticmethod def skipPage(page) -> bool: """Determine if the page should be skipped.""" - try: - templates_to_ignore = i18n.translate(page.site.code, - ignoreTemplates) - except KeyError: + templates_to_ignore = i18n.translate(page.site.code, ignoreTemplates) + if not templates_to_ignore: return False for template in templates_to_ignore: diff --git a/scripts/imagetransfer.py b/scripts/imagetransfer.py index a1820a7..89855f9 100755 --- a/scripts/imagetransfer.py +++ b/scripts/imagetransfer.py @@ -43,7 +43,7 @@ &params; """ # -# (C) Pywikibot team, 2004-2024 +# (C) Pywikibot team, 2004-2025 # # Distributed under the terms of the MIT license. # @@ -206,7 +206,7 @@ :return: the filename which was used to upload the image """ - def delete_source(old_filename, target_filename): + def delete_source(_old_filename: str, target_filename: str) -> None: """Delete source image or tag nowCommons template to it. This function is called when upload to Commons was @@ -223,16 +223,14 @@ and sourceImagePage.delete(reason): return - if sourceSite.lang in nowCommonsTemplate \ - and sourceSite.family.name in config.usernames \ - and sourceSite.lang in config.usernames[sourceSite.family.name]: + tmpl = i18n.translate(sourceSite.code, nowCommonsTemplate) + if tmpl and sourceSite.family.name in config.usernames \ + and sourceSite.code in config.usernames[sourceSite.family.name]: # add the nowCommons template. pywikibot.info('Adding nowCommons template to ' + sourceImagePage.title()) sourceImagePage.put(sourceImagePage.get() + '\n\n' - + i18n.translate(sourceSite.code, - nowCommonsTemplate) - % target_filename, + + tmpl % target_filename, summary=reason) sourceSite = sourceImagePage.site diff --git a/scripts/interwiki.py b/scripts/interwiki.py index e357276..de7913c 100755 --- a/scripts/interwiki.py +++ b/scripts/interwiki.py @@ -343,7 +343,7 @@ ``-continue`` next time. """ # -# (C) Pywikibot team, 2003-2024 +# (C) Pywikibot team, 2003-2025 # # Distributed under the terms of the MIT license. # @@ -1864,9 +1864,8 @@ continue if page.namespace() == 10: loc = None - with suppress(KeyError): - tmpl, loc = i18n.translate(page.site.code, moved_links) - del tmpl + with suppress(TypeError): + _tpl, loc = i18n.translate(page.site.code, moved_links) if loc is not None and loc in page.title(): pywikibot.info( f'Skipping: {page.title()} is a templates subpage') @@ -2084,19 +2083,18 @@ def botMayEdit(page) -> bool: """Test for allowed edits.""" tmpl = [] - with suppress(KeyError): + with suppress(TypeError): tmpl, _ = i18n.translate(page.site.code, moved_links) if not isinstance(tmpl, list): tmpl = [tmpl] - with suppress(KeyError): - tmpl += i18n.translate(page.site.code, ignoreTemplates, - fallback=i18n.DEFAULT_FALLBACK) + with suppress(TypeError): + tmpl += i18n.translate(page.site.code, ignoreTemplates) - tmpl += i18n.translate('_default', ignoreTemplates, - fallback=i18n.DEFAULT_FALLBACK) - if tmpl != []: + tmpl += i18n.translate('_default', ignoreTemplates) + + if tmpl: templates = page.templatesWithParams() for template in templates: if template[0].title(with_ns=False).lower() in tmpl: diff --git a/scripts/solve_disambiguation.py b/scripts/solve_disambiguation.py index ef114b1..fd530e8 100755 --- a/scripts/solve_disambiguation.py +++ b/scripts/solve_disambiguation.py @@ -74,7 +74,7 @@ """ # -# (C) Pywikibot team, 2003-2024 +# (C) Pywikibot team, 2003-2025 # # Distributed under the terms of the MIT license. # @@ -1025,24 +1025,25 @@ :return: True if everything goes fine, False otherwise """ if page.isRedirectPage() and not self.opt.primary: + topic = None primary = i18n.translate(page.site, self.primary_redir_template) if primary: - primary_page = pywikibot.Page(page.site, - 'Template:' + primary) - if primary and primary_page in page.itertemplates( + primary_page = pywikibot.Page(page.site, 'Template:' + primary) + topic = i18n.translate(self.site.code, primary_topic_format) + + if topic and primary_page in page.itertemplates( namespaces=Namespace.TEMPLATE): baseTerm = page.title() for template, params in page.templatesWithParams(): if params and template == primary_page: baseTerm = params[1] break - disambTitle = i18n.translate( - self.site.lang, - primary_topic_format) % baseTerm + + disamb_title = topic % baseTerm try: page2 = pywikibot.Page( - pywikibot.Link(disambTitle, self.site)) + pywikibot.Link(disamb_title, self.site)) links = page2.linkedPages() if self.opt.first: links = self.firstize(page2, links) @@ -1050,7 +1051,7 @@ for link in links] except NoPageError: pywikibot.info( - f'No page at {disambTitle}, using redirect target.') + f'No page at {disamb_title}, using redirect target.') links = page.linkedPages()[:1] links = [correctcap(link, page.get(get_redirect=True)) @@ -1065,34 +1066,30 @@ user_input = pywikibot.input("""\ Please enter the name of the page where the redirect should have pointed at, or press enter to quit:""") - if user_input == '': - self.quit() - else: - self.opt.pos.append(user_input) + if not user_input: + self.quit() # raises QuitKeyboardInterrupt + + self.opt.pos.append(user_input) except IsNotRedirectPageError: pywikibot.info( 'The specified page is not a redirect. Skipping.') return False + elif self.opt.just: # not page.isRedirectPage() or self.opt.primary try: - if self.opt.primary: + topic = i18n.translate(self.site.lang, primary_topic_format) + if topic and self.opt.primary: try: - page2 = pywikibot.Page( - pywikibot.Link( - i18n.translate(self.site.lang, - primary_topic_format) - % page.title(), - self.site)) + page2 = pywikibot.Page(self.site, topic % page.title()) links = page2.linkedPages() if self.opt.first: links = self.firstize(page2, links) links = [correctcap(link, page2.get()) for link in links] except NoPageError: - pywikibot.info( - 'Page does not exist; using first ' - f'link in page {page.title()}.') + pywikibot.info('Page does not exist; using first ' + f'link in page {page.title()}.') links = page.linkedPages()[:1] links = [correctcap(link, page.get()) for link in links] @@ -1106,10 +1103,13 @@ except NoPageError: pywikibot.info('Page does not exist, skipping.') return False + except IsRedirectPageError: pywikibot.info('Page is a redirect, skipping.') return False + self.opt.pos += links + return True def setSummaryMessage( -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154390?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: Iae2ac3af3229be160940062f3f2f14d6050ec435 Gerrit-Change-Number: 1154390 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Lichinsol <vaibhavjoshi1411(a)gmail.com> Gerrit-Reviewer: Meno25 <meno25mail(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot

1 0

← Newer
1
2
3
4
5
6
7
8
9
10
Older →

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits June 2025